#28001

pending completion

Build # #28001

Build Type

push

github

Committed by

web-flow

Commit Message

<a href="https://github.com/api-platform/core/commit/<a class=hub.com/api-platform/core/commit/0996ed2c74e570b48bea33ef505b1b05a5d80749">0996ed2c7<a href="https://github.com/api-platform/core/commit/0996ed2c74e570b48bea33ef505b1b05a5d80749">">Merge </a><a class="double-link" href="https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/da184ba7d3d3a6a72a0591d68bbea10dc920b8bb">da184ba7d</a>">da184ba7d</a><a href="https://github.com/api-platform/core/commit/0996ed2c74e570b48bea33ef505b1b05a5d80749"> into 2625c8159">2625c8159</a>

Run Details

198 of 198 new or added lines in 12 files covered. (100.0%)

13634 of 17055 relevant lines covered (79.94%)

14.85 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

83.17

/src/Metadata/Resource/Factory/AttributesResourceMetadataCollectionFactory.php

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\Metadata\Resource\Factory;

use ApiPlatform\Exception\ResourceClassNotFoundException;
use ApiPlatform\Exception\RuntimeException;
use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\Delete;
use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\GetCollection;
use ApiPlatform\Metadata\GraphQl\Mutation;
use ApiPlatform\Metadata\GraphQl\Operation as GraphQlOperation;
use ApiPlatform\Metadata\GraphQl\Query;
use ApiPlatform\Metadata\GraphQl\QueryCollection;
use ApiPlatform\Metadata\GraphQl\Subscription;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\Metadata\Operations;
use ApiPlatform\Metadata\Patch;
use ApiPlatform\Metadata\Post;
use ApiPlatform\Metadata\Put;
use ApiPlatform\Metadata\Resource\DeprecationMetadataTrait;
use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;

/**
 * Creates a resource metadata from {@see ApiResource} annotations.
 *
 * @author Antoine Bluchet <soyuka@gmail.com>
 * @experimental
 */
final class AttributesResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
{
    use DeprecationMetadataTrait;

    private $defaults;
    private $decorated;
    private $logger;
    private $graphQlEnabled;

    public function __construct(ResourceMetadataCollectionFactoryInterface $decorated = null, LoggerInterface $logger = null, array $defaults = [], bool $graphQlEnabled = false)
    {
        $this->defaults = $defaults + ['attributes' => []];
        $this->decorated = $decorated;
        $this->logger = $logger ?? new NullLogger();
        $this->graphQlEnabled = $graphQlEnabled;
    }

    /**
     * {@inheritdoc}
     */
    public function create(string $resourceClass): ResourceMetadataCollection
    {
        $resourceMetadataCollection = new ResourceMetadataCollection($resourceClass);
        if ($this->decorated) {
            $resourceMetadataCollection = $this->decorated->create($resourceClass);
        }

        try {
            $reflectionClass = new \ReflectionClass($resourceClass);
        } catch (\ReflectionException $reflectionException) {
            throw new ResourceClassNotFoundException(sprintf('Resource "%s" not found.', $resourceClass));
        }

        if (\PHP_VERSION_ID >= 80000 && $this->hasResourceAttributes($reflectionClass)) {
            foreach ($this->buildResourceOperations($reflectionClass->getAttributes(), $resourceClass) as $i => $resource) {
                if (0 === $i && $this->graphQlEnabled && null === $resource->getGraphQlOperations()) {
                    $resource = $this->addDefaultGraphQlOperations($resource);
                }

                $resourceMetadataCollection[] = $resource;
            }
        }

        return $resourceMetadataCollection;
    }

    /**
     * Builds resource operations to support:
     * Resource
     * Get
     * Post
     * Resource
     * Put
     * Get
     * In the future, we will be able to use nested attributes (https://wiki.php.net/rfc/new_in_initializers).
     *
     * @return ApiResource[]
     */
    private function buildResourceOperations(array $attributes, string $resourceClass): array
    {
        $shortName = (false !== $pos = strrpos($resourceClass, '\\')) ? substr($resourceClass, $pos + 1) : $resourceClass;
        $resources = [];
        $index = -1;
        $operationPriority = 0;

        foreach ($attributes as $attribute) {
            if (ApiResource::class === $attribute->getName()) {
                $resources[++$index] = $this->getResourceWithDefaults($resourceClass, $shortName, $attribute->newInstance());
                continue;
            }

            if (!is_subclass_of($attribute->getName(), Operation::class) && !is_subclass_of($attribute->getName(), GraphQlOperation::class)) {
                continue;
            }

            $operationAttribute = $attribute->newInstance();

            if ($operationAttribute instanceof GraphQlOperation) {
                [$key, $operation] = $this->getOperationWithDefaults($resources[$index], $operationAttribute);
                $graphQlOperations = $resources[$index]->getGraphQlOperations();
                $graphQlOperations[$key] = $operation;
                $resources[$index] = $resources[$index]->withGraphQlOperations($graphQlOperations);
                continue;
            }

            if (-1 === $index || $this->hasSameOperation($resources[$index], $attribute->getName(), $operationAttribute)) {
                $resources[++$index] = $this->getResourceWithDefaults($resourceClass, $shortName, new ApiResource());
            }

            [$key, $operation] = $this->getOperationWithDefaults($resources[$index], $operationAttribute);
            $operation = $operation->withPriority(++$operationPriority);
            $operations = $resources[$index]->getOperations() ?? new Operations();
            $resources[$index] = $resources[$index]->withOperations($operations->add($key, $operation)->sort());
        }

        // Loop again and set default operations if none where found
        foreach ($resources as $index => $resource) {
            if (\count($resource->getOperations() ?? [])) {
                continue;
            }

            $operations = [];
            foreach ([new Get(), new GetCollection(), new Post(), new Put(), new Patch(), new Delete()] as $i => $operation) {
                [$key, $operation] = $this->getOperationWithDefaults($resource, $operation);
                $operations[$key] = $operation;
            }

            $resources[$index] = $resources[$index]->withOperations(new Operations($operations));
        }

        return $resources;
    }

    /**
     * @param Operation|GraphQlOperation $operation
     */
    private function getOperationWithDefaults(ApiResource $resource, $operation): array
    {
        foreach ($this->defaults['attributes'] as $key => $value) {
            [$key, $value] = $this->getKeyValue($key, $value);
            if (method_exists($operation, 'get'.ucfirst($key)) && !$operation->{'get'.ucfirst($key)}()) {
                $operation = $operation->{'with'.ucfirst($key)}($value);
            }
        }

        foreach (get_class_methods($resource) as $methodName) {
            if (0 !== strpos($methodName, 'get')) {
                continue;
            }

            if (!method_exists($operation, $methodName) || $operation->{$methodName}()) {
                continue;
            }

            if (null === ($value = $resource->{$methodName}())) {
                continue;
            }

            // TODO: remove in 3.0
            if ($operation instanceof Operation && 'getUriVariables' === $methodName && !$operation->getUriTemplate() && $operation->isCollection() && !$operation->getUriVariables()) {
                trigger_deprecation('api-platform', '2.7', 'Identifiers are declared on the default #[ApiResource] but you did not specify identifiers on the collection operation. In 3.0 the collection operations can have identifiers, you should specify identifiers on the operation not on the resource to avoid unwanted behavior.');
                continue;
            }

            $operation = $operation->{'with'.substr($methodName, 3)}($value);
        }

        if ($operation instanceof GraphQlOperation) {
            if (!$operation->getName()) {
                throw new RuntimeException('No GraphQL operation name.');
            }

            if ($operation instanceof Mutation) {
                $operation = $operation->withDescription(ucfirst("{$operation->getName()}s a {$resource->getShortName()}."));
            }

            return [$operation->getName(), $operation];
        }

        // Check for name conflict
        if ($operation->getName()) {
            if (null !== $resource->getOperations() && !$resource->getOperations()->has($operation->getName())) {
                return [$operation->getName(), $operation];
            }

            $this->logger->warning(sprintf('The operation "%s" already exists on the resource "%s", pick a different name or leave it empty. In the meantime we will generate a unique name.', $operation->getName(), $resource->getClass()));
            $operation = $operation->withName('');
        }

        return [
            sprintf('_api_%s_%s%s', $operation->getUriTemplate() ?: $operation->getShortName(), strtolower($operation->getMethod() ?? Operation::METHOD_GET), $operation instanceof GetCollection ? '_collection' : ''),
            $operation,
        ];
    }

    private function getResourceWithDefaults(string $resourceClass, string $shortName, ApiResource $resource): ApiResource
    {
        $resource = $resource
            ->withShortName($shortName)
            ->withClass($resourceClass);

        foreach ($this->defaults['attributes'] as $key => $value) {
            [$key, $value] = $this->getKeyValue($key, $value);
            if (method_exists($resource, 'get'.ucfirst($key)) && !$resource->{'get'.ucfirst($key)}()) {
                $resource = $resource->{'with'.ucfirst($key)}($value);
            }
        }

        return $resource;
    }

    private function hasResourceAttributes(\ReflectionClass $reflectionClass): bool
    {
        foreach ($reflectionClass->getAttributes() as $attribute) {
            if (ApiResource::class === $attribute->getName() || is_subclass_of($attribute->getName(), Operation::class) || is_subclass_of($attribute->getName(), GraphQlOperation::class)) {
                return true;
            }
        }

        return false;
    }

    /**
     * Does the resource already have an operation of the $operationClass type?
     * Useful to determine if we need to create a new ApiResource when the class has only operation attributes, for example:.
     *
     * #[Get]
     * #[Get(uriTemplate: '/alternate')]
     * class Example {}
     */
    private function hasSameOperation(ApiResource $resource, string $operationClass, Operation $operation): bool
    {
        foreach ($resource->getOperations() ?? [] as $o) {
            if ($o instanceof $operationClass && $operation->getUriTemplate() === $o->getUriTemplate() && $operation->getName() === $o->getName() && $operation->getRouteName() === $o->getRouteName()) {
                return true;
            }
        }

        return false;
    }

    private function addDefaultGraphQlOperations(ApiResource $resource): ApiResource
    {
        $graphQlOperations = [];
        foreach ([new QueryCollection(), new Query(), (new Mutation())->withName('update'), (new Mutation())->withName('delete'), (new Mutation())->withName('create')] as $i => $operation) {
            [$key, $operation] = $this->getOperationWithDefaults($resource, $operation);
            $graphQlOperations[$key] = $operation;
        }

        if ($resource->getMercure()) {
            [$key, $operation] = $this->getOperationWithDefaults($resource, (new Subscription())->withDescription("Subscribes to the update event of a {$operation->getShortName()}."));
            $graphQlOperations[$key] = $operation;
        }

        return $resource->withGraphQlOperations($graphQlOperations);
    }
}

1	<?php
2
3	/*
4	* This file is part of the API Platform project.
5	*
6	* (c) Kévin Dunglas <dunglas@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace ApiPlatform\Metadata\Resource\Factory;
15
16	use ApiPlatform\Exception\ResourceClassNotFoundException;
17	use ApiPlatform\Exception\RuntimeException;
18	use ApiPlatform\Metadata\ApiResource;
19	use ApiPlatform\Metadata\Delete;
20	use ApiPlatform\Metadata\Get;
21	use ApiPlatform\Metadata\GetCollection;
22	use ApiPlatform\Metadata\GraphQl\Mutation;
23	use ApiPlatform\Metadata\GraphQl\Operation as GraphQlOperation;
24	use ApiPlatform\Metadata\GraphQl\Query;
25	use ApiPlatform\Metadata\GraphQl\QueryCollection;
26	use ApiPlatform\Metadata\GraphQl\Subscription;
27	use ApiPlatform\Metadata\Operation;
28	use ApiPlatform\Metadata\Operations;
29	use ApiPlatform\Metadata\Patch;
30	use ApiPlatform\Metadata\Post;
31	use ApiPlatform\Metadata\Put;
32	use ApiPlatform\Metadata\Resource\DeprecationMetadataTrait;
33	use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
34	use Psr\Log\LoggerInterface;
35	use Psr\Log\NullLogger;
36
37	/**
38	* Creates a resource metadata from {@see ApiResource} annotations.
39	*
40	* @author Antoine Bluchet <soyuka@gmail.com>
41	* @experimental
42	*/
43	final class AttributesResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
44	{
45	use DeprecationMetadataTrait;
46
47	private $defaults;
48	private $decorated;
49	private $logger;
50	private $graphQlEnabled;
51
52	public function __construct(ResourceMetadataCollectionFactoryInterface $decorated = null, LoggerInterface $logger = null, array $defaults = [], bool $graphQlEnabled = false)
53	{
54	$this->defaults = $defaults + ['attributes' => []];	43✔
55	$this->decorated = $decorated;	43✔
56	$this->logger = $logger ?? new NullLogger();	43✔
57	$this->graphQlEnabled = $graphQlEnabled;	43✔
58	}	43✔
59
60	/**
61	* {@inheritdoc}
62	*/
63	public function create(string $resourceClass): ResourceMetadataCollection
64	{
65	$resourceMetadataCollection = new ResourceMetadataCollection($resourceClass);	7✔
66	if ($this->decorated) {	7✔
67	$resourceMetadataCollection = $this->decorated->create($resourceClass);	×
68	}
69
70	try {
71	$reflectionClass = new \ReflectionClass($resourceClass);	7✔
72	} catch (\ReflectionException $reflectionException) {	1✔
73	throw new ResourceClassNotFoundException(sprintf('Resource "%s" not found.', $resourceClass));	1✔
74	}
75
76	if (\PHP_VERSION_ID >= 80000 && $this->hasResourceAttributes($reflectionClass)) {	6✔
77	foreach ($this->buildResourceOperations($reflectionClass->getAttributes(), $resourceClass) as $i => $resource) {	5✔
78	if (0 === $i && $this->graphQlEnabled && null === $resource->getGraphQlOperations()) {	5✔
79	$resource = $this->addDefaultGraphQlOperations($resource);	2✔
80	}
81
82	$resourceMetadataCollection[] = $resource;	5✔
83	}
84	}
85
86	return $resourceMetadataCollection;	6✔
87	}
88
89	/**
90	* Builds resource operations to support:
91	* Resource
92	* Get
93	* Post
94	* Resource
95	* Put
96	* Get
97	* In the future, we will be able to use nested attributes (https://wiki.php.net/rfc/new_in_initializers).
98	*
99	* @return ApiResource[]
100	*/
101	private function buildResourceOperations(array $attributes, string $resourceClass): array
102	{
103	$shortName = (false !== $pos = strrpos($resourceClass, '\\')) ? substr($resourceClass, $pos + 1) : $resourceClass;	5✔
104	$resources = [];	5✔
105	$index = -1;	5✔
106	$operationPriority = 0;	5✔
107
108	foreach ($attributes as $attribute) {	5✔
109	if (ApiResource::class === $attribute->getName()) {	5✔
110	$resources[++$index] = $this->getResourceWithDefaults($resourceClass, $shortName, $attribute->newInstance());	3✔
111	continue;	3✔
112	}
113
114	if (!is_subclass_of($attribute->getName(), Operation::class) && !is_subclass_of($attribute->getName(), GraphQlOperation::class)) {	5✔
115	continue;	×
116	}
117
118	$operationAttribute = $attribute->newInstance();	5✔
119
120	if ($operationAttribute instanceof GraphQlOperation) {	5✔
121	[$key, $operation] = $this->getOperationWithDefaults($resources[$index], $operationAttribute);	×
122	$graphQlOperations = $resources[$index]->getGraphQlOperations();	×
123	$graphQlOperations[$key] = $operation;	×
124	$resources[$index] = $resources[$index]->withGraphQlOperations($graphQlOperations);	×
125	continue;	×
126	}
127
128	if (-1 === $index \|\| $this->hasSameOperation($resources[$index], $attribute->getName(), $operationAttribute)) {	5✔
129	$resources[++$index] = $this->getResourceWithDefaults($resourceClass, $shortName, new ApiResource());	3✔
130	}
131
132	[$key, $operation] = $this->getOperationWithDefaults($resources[$index], $operationAttribute);	5✔
133	$operation = $operation->withPriority(++$operationPriority);	5✔
134	$operations = $resources[$index]->getOperations() ?? new Operations();	5✔
135	$resources[$index] = $resources[$index]->withOperations($operations->add($key, $operation)->sort());	5✔
136	}
137
138	// Loop again and set default operations if none where found
139	foreach ($resources as $index => $resource) {	5✔
140	if (\count($resource->getOperations() ?? [])) {	5✔
141	continue;	5✔
142	}
143
144	$operations = [];	1✔
145	foreach ([new Get(), new GetCollection(), new Post(), new Put(), new Patch(), new Delete()] as $i => $operation) {	1✔
146	[$key, $operation] = $this->getOperationWithDefaults($resource, $operation);	1✔
147	$operations[$key] = $operation;	1✔
148	}
149
150	$resources[$index] = $resources[$index]->withOperations(new Operations($operations));	1✔
151	}
152
153	return $resources;	5✔
154	}
155
156	/**
157	* @param Operation\|GraphQlOperation $operation
158	*/
159	private function getOperationWithDefaults(ApiResource $resource, $operation): array
160	{
161	foreach ($this->defaults['attributes'] as $key => $value) {	5✔
162	[$key, $value] = $this->getKeyValue($key, $value);	2✔
163	if (method_exists($operation, 'get'.ucfirst($key)) && !$operation->{'get'.ucfirst($key)}()) {	2✔
164	$operation = $operation->{'with'.ucfirst($key)}($value);	2✔
165	}
166	}
167
168	foreach (get_class_methods($resource) as $methodName) {	5✔
169	if (0 !== strpos($methodName, 'get')) {	5✔
170	continue;	5✔
171	}
172
173	if (!method_exists($operation, $methodName) \|\| $operation->{$methodName}()) {	5✔
174	continue;	5✔
175	}
176
177	if (null === ($value = $resource->{$methodName}())) {	5✔
178	continue;	5✔
179	}
180
181	// TODO: remove in 3.0
182	if ($operation instanceof Operation && 'getUriVariables' === $methodName && !$operation->getUriTemplate() && $operation->isCollection() && !$operation->getUriVariables()) {	5✔
183	trigger_deprecation('api-platform', '2.7', 'Identifiers are declared on the default #[ApiResource] but you did not specify identifiers on the collection operation. In 3.0 the collection operations can have identifiers, you should specify identifiers on the operation not on the resource to avoid unwanted behavior.');	×
184	continue;	×
185	}
186
187	$operation = $operation->{'with'.substr($methodName, 3)}($value);	5✔
188	}
189
190	if ($operation instanceof GraphQlOperation) {	5✔
191	if (!$operation->getName()) {	2✔
192	throw new RuntimeException('No GraphQL operation name.');	×
193	}
194
195	if ($operation instanceof Mutation) {	2✔
196	$operation = $operation->withDescription(ucfirst("{$operation->getName()}s a {$resource->getShortName()}."));	2✔
197	}
198
199	return [$operation->getName(), $operation];	2✔
200	}
201
202	// Check for name conflict
203	if ($operation->getName()) {	5✔
204	if (null !== $resource->getOperations() && !$resource->getOperations()->has($operation->getName())) {	×
205	return [$operation->getName(), $operation];	×
206	}
207
208	$this->logger->warning(sprintf('The operation "%s" already exists on the resource "%s", pick a different name or leave it empty. In the meantime we will generate a unique name.', $operation->getName(), $resource->getClass()));	×
209	$operation = $operation->withName('');	×
210	}
211
212	return [
213	sprintf('_api_%s_%s%s', $operation->getUriTemplate() ?: $operation->getShortName(), strtolower($operation->getMethod() ?? Operation::METHOD_GET), $operation instanceof GetCollection ? '_collection' : ''),	5✔
214	$operation,	5✔
215	];
216	}
217
218	private function getResourceWithDefaults(string $resourceClass, string $shortName, ApiResource $resource): ApiResource
219	{
220	$resource = $resource	5✔
221	->withShortName($shortName)	5✔
222	->withClass($resourceClass);	5✔
223
224	foreach ($this->defaults['attributes'] as $key => $value) {	5✔
225	[$key, $value] = $this->getKeyValue($key, $value);	2✔
226	if (method_exists($resource, 'get'.ucfirst($key)) && !$resource->{'get'.ucfirst($key)}()) {	2✔
227	$resource = $resource->{'with'.ucfirst($key)}($value);	2✔
228	}
229	}
230
231	return $resource;	5✔
232	}
233
234	private function hasResourceAttributes(\ReflectionClass $reflectionClass): bool
235	{
236	foreach ($reflectionClass->getAttributes() as $attribute) {	6✔
237	if (ApiResource::class === $attribute->getName() \|\| is_subclass_of($attribute->getName(), Operation::class) \|\| is_subclass_of($attribute->getName(), GraphQlOperation::class)) {	5✔
238	return true;	5✔
239	}
240	}
241
242	return false;	2✔
243	}
244
245	/**
246	* Does the resource already have an operation of the $operationClass type?
247	* Useful to determine if we need to create a new ApiResource when the class has only operation attributes, for example:.
248	*
249	* #[Get]
250	* #[Get(uriTemplate: '/alternate')]
251	* class Example {}
252	*/
253	private function hasSameOperation(ApiResource $resource, string $operationClass, Operation $operation): bool
254	{
255	foreach ($resource->getOperations() ?? [] as $o) {	4✔
256	if ($o instanceof $operationClass && $operation->getUriTemplate() === $o->getUriTemplate() && $operation->getName() === $o->getName() && $operation->getRouteName() === $o->getRouteName()) {	4✔
257	return true;	×
258	}
259	}
260
261	return false;	4✔
262	}
263
264	private function addDefaultGraphQlOperations(ApiResource $resource): ApiResource
265	{
266	$graphQlOperations = [];	2✔
267	foreach ([new QueryCollection(), new Query(), (new Mutation())->withName('update'), (new Mutation())->withName('delete'), (new Mutation())->withName('create')] as $i => $operation) {	2✔
268	[$key, $operation] = $this->getOperationWithDefaults($resource, $operation);	2✔
269	$graphQlOperations[$key] = $operation;	2✔
270	}
271
272	if ($resource->getMercure()) {	2✔
273	[$key, $operation] = $this->getOperationWithDefaults($resource, (new Subscription())->withDescription("Subscribes to the update event of a {$operation->getShortName()}."));	×
274	$graphQlOperations[$key] = $operation;	×
275	}
276
277	return $resource->withGraphQlOperations($graphQlOperations);	2✔
278	}
279	}

api-platform / core / #28001

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous