14954769666

Committed 11 May 2025 10:14AM UTC coverage: 0.0% (-8.5%) from 8.457%

Build # 14954769666

Build Type

Pull #7135

github

Committed by

web-flow

Commit Message

Merge bf21e0bc7 into 4dd0cdfc4

Pull Request Pull Request #7135: fix(symfony,laravel): InvalidUriVariableException status code (e400)

Run Details

0 of 2 new or added lines in 2 files covered. (0.0%)

11040 existing lines in 370 files now uncovered.

0 of 48303 relevant lines covered (0.0%)

0.0 hits per line

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

0.0

/src/Metadata/Resource/Factory/ParameterResourceMetadataCollectionFactory.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\Metadata\ApiProperty;
use ApiPlatform\Metadata\Exception\RuntimeException;
use ApiPlatform\Metadata\FilterInterface;
use ApiPlatform\Metadata\JsonSchemaFilterInterface;
use ApiPlatform\Metadata\OpenApiParameterFilterInterface;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\Metadata\Parameter;
use ApiPlatform\Metadata\ParameterProviderFilterInterface;
use ApiPlatform\Metadata\Parameters;
use ApiPlatform\Metadata\PropertiesAwareInterface;
use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
use ApiPlatform\OpenApi\Model\Parameter as OpenApiParameter;
use ApiPlatform\Serializer\Filter\FilterInterface as SerializerFilterInterface;
use ApiPlatform\State\Util\StateOptionsTrait;
use Psr\Container\ContainerInterface;
use Psr\Log\LoggerInterface;
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;

/**
 * Prepares Parameters documentation by reading its filter details and declaring an OpenApi parameter.
 *
 * @experimental
 */
final class ParameterResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
{
    use StateOptionsTrait;

    private array $localPropertyCache;

    public function __construct(
        private readonly PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory,
        private readonly PropertyMetadataFactoryInterface $propertyMetadataFactory,
        private readonly ?ResourceMetadataCollectionFactoryInterface $decorated = null,
        private readonly ?ContainerInterface $filterLocator = null,
        private readonly ?NameConverterInterface $nameConverter = null,
        private readonly ?LoggerInterface $logger = null,
    ) {
    }

    public function create(string $resourceClass): ResourceMetadataCollection
    {
        $resourceMetadataCollection = $this->decorated?->create($resourceClass) ?? new ResourceMetadataCollection($resourceClass);

        foreach ($resourceMetadataCollection as $i => $resource) {
            $operations = $resource->getOperations();

            $internalPriority = -1;
            foreach ($operations as $operationName => $operation) {
                $parameters = $this->getDefaultParameters($operation, $resourceClass, $internalPriority);
                if (\count($parameters) > 0) {
                    $operations->add($operationName, $operation->withParameters($parameters));
                }
            }

            $resourceMetadataCollection[$i] = $resource->withOperations($operations->sort());

            if (!$graphQlOperations = $resource->getGraphQlOperations()) {
                continue;
            }

            $internalPriority = -1;
            foreach ($graphQlOperations as $operationName => $operation) {
                $parameters = $this->getDefaultParameters($operation, $resourceClass, $internalPriority);
                if (\count($parameters) > 0) {
                    $graphQlOperations[$operationName] = $operation->withParameters($parameters);
                }
            }

            $resourceMetadataCollection[$i] = $resource->withGraphQlOperations($graphQlOperations);
        }

        return $resourceMetadataCollection;
    }

    /**
     * @return array{propertyNames: string[], properties: array<string, ApiProperty>}
     */
    private function getProperties(string $resourceClass, ?Parameter $parameter = null): array
    {
        $k = $resourceClass.($parameter?->getProperties() ? ($parameter->getKey() ?? '') : '');
        if (isset($this->localPropertyCache[$k])) {
            return $this->localPropertyCache[$k];
        }

        $propertyNames = [];
        $properties = [];
        foreach ($parameter?->getProperties() ?? $this->propertyNameCollectionFactory->create($resourceClass) as $property) {
            $propertyMetadata = $this->propertyMetadataFactory->create($resourceClass, $property);
            if ($propertyMetadata->isReadable()) {
                $propertyNames[] = $property;
                $properties[$property] = $propertyMetadata;
            }
        }

        $this->localPropertyCache[$k] = ['propertyNames' => $propertyNames, 'properties' => $properties];

        return $this->localPropertyCache[$k];
    }

    private function getDefaultParameters(Operation $operation, string $resourceClass, int &$internalPriority): Parameters
    {
        $propertyNames = $properties = [];
        $parameters = $operation->getParameters() ?? new Parameters();
        foreach ($parameters as $key => $parameter) {
            ['propertyNames' => $propertyNames, 'properties' => $properties] = $this->getProperties($resourceClass, $parameter);
            if (null === $parameter->getProvider() && (($f = $parameter->getFilter()) && $f instanceof ParameterProviderFilterInterface)) {
                $parameters->add($key, $parameter->withProvider($f->getParameterProvider()));
            }

            if (':property' === $key) {
                foreach ($propertyNames as $property) {
                    $converted = $this->nameConverter?->denormalize($property) ?? $property;
                    $propertyParameter = $this->setDefaults($converted, $parameter, $resourceClass, $properties, $operation);
                    $priority = $propertyParameter->getPriority() ?? $internalPriority--;
                    $parameters->add($converted, $propertyParameter->withPriority($priority)->withKey($converted));
                }

                $parameters->remove($key, $parameter::class);
                continue;
            }

            $key = $parameter->getKey() ?? $key;

            if (str_contains($key, ':property') || ((($f = $parameter->getFilter()) && is_a($f, PropertiesAwareInterface::class, true)) || $parameter instanceof PropertiesAwareInterface)) {
                $p = [];
                foreach ($propertyNames as $prop) {
                    $p[$this->nameConverter?->denormalize($prop) ?? $prop] = $prop;
                }

                $parameter = $parameter->withExtraProperties($parameter->getExtraProperties() + ['_properties' => $p]);
            }

            $parameter = $this->setDefaults($key, $parameter, $resourceClass, $properties, $operation);
            $priority = $parameter->getPriority() ?? $internalPriority--;
            $parameters->add($key, $parameter->withPriority($priority));
        }

        return $parameters;
    }

    private function addFilterMetadata(Parameter $parameter): Parameter
    {
        if (!($filterId = $parameter->getFilter())) {
            return $parameter;
        }

        if (!\is_object($filterId) && !$this->filterLocator->has($filterId)) {
            return $parameter;
        }

        $filter = \is_object($filterId) ? $filterId : $this->filterLocator->get($filterId);

        if ($filter instanceof ParameterProviderFilterInterface) {
            $parameter = $parameter->withProvider($filter::getParameterProvider());
        }

        if (!$filter) {
            return $parameter;
        }

        if (null === $parameter->getSchema() && $filter instanceof JsonSchemaFilterInterface && $schema = $filter->getSchema($parameter)) {
            $parameter = $parameter->withSchema($schema);
        }

        if (null === $parameter->getOpenApi() && $filter instanceof OpenApiParameterFilterInterface && ($openApiParameter = $filter->getOpenApiParameters($parameter))) {
            $parameter = $parameter->withOpenApi($openApiParameter);
        }

        return $parameter;
    }

    /**
     * @param array<string, ApiProperty> $properties
     */
    private function setDefaults(string $key, Parameter $parameter, string $resourceClass, array $properties, Operation $operation): Parameter
    {
        if (null === $parameter->getKey()) {
            $parameter = $parameter->withKey($key);
        }

        $filter = $parameter->getFilter();
        if (\is_string($filter) && $this->filterLocator->has($filter)) {
            $filter = $this->filterLocator->get($filter);
        }

        if ($filter instanceof SerializerFilterInterface && null === $parameter->getProvider()) {
            $parameter = $parameter->withProvider('api_platform.serializer.filter_parameter_provider');
        }
        $currentKey = $key;
        if (null === $parameter->getProperty() && isset($properties[$key])) {
            $parameter = $parameter->withProperty($key);
        }

        if (null === $parameter->getProperty() && $this->nameConverter && ($nameConvertedKey = $this->nameConverter->normalize($key)) && isset($properties[$nameConvertedKey])) {
            $parameter = $parameter->withProperty($key)->withExtraProperties(['_query_property' => $nameConvertedKey] + $parameter->getExtraProperties());
            $currentKey = $nameConvertedKey;
        }

        if ($this->nameConverter && $property = $parameter->getProperty()) {
            $parameter = $parameter->withProperty($this->nameConverter->normalize($property));
        }

        if (isset($properties[$currentKey]) && ($eloquentRelation = ($properties[$currentKey]->getExtraProperties()['eloquent_relation'] ?? null)) && isset($eloquentRelation['foreign_key'])) {
            $parameter = $parameter->withExtraProperties(['_query_property' => $eloquentRelation['foreign_key']] + $parameter->getExtraProperties());
        }

        $parameter = $this->addFilterMetadata($parameter);

        if ($filter instanceof FilterInterface) {
            try {
                return $this->getLegacyFilterMetadata($parameter, $operation, $filter);
            } catch (RuntimeException $exception) {
                $this->logger?->alert($exception->getMessage(), ['exception' => $exception]);

                return $parameter;
            }
        }

        return $parameter;
    }

    private function getLegacyFilterMetadata(Parameter $parameter, Operation $operation, FilterInterface $filter): Parameter
    {
        $description = $filter->getDescription($this->getStateOptionsClass($operation, $operation->getClass()));
        $key = $parameter->getKey();
        if (($schema = $description[$key]['schema'] ?? null) && null === $parameter->getSchema()) {
            $parameter = $parameter->withSchema($schema);
        }

        if (null === $parameter->getProperty() && ($property = $description[$key]['property'] ?? null)) {
            $parameter = $parameter->withProperty($property);
        }

        if (null === $parameter->getRequired() && ($required = $description[$key]['required'] ?? null)) {
            $parameter = $parameter->withRequired($required);
        }

        if (null === $parameter->getOpenApi() && ($openApi = $description[$key]['openapi'] ?? null) && $openApi instanceof OpenApiParameter) {
            $parameter = $parameter->withOpenApi($openApi);
        }

        return $parameter;
    }
}

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\Metadata\ApiProperty;
17	use ApiPlatform\Metadata\Exception\RuntimeException;
18	use ApiPlatform\Metadata\FilterInterface;
19	use ApiPlatform\Metadata\JsonSchemaFilterInterface;
20	use ApiPlatform\Metadata\OpenApiParameterFilterInterface;
21	use ApiPlatform\Metadata\Operation;
22	use ApiPlatform\Metadata\Parameter;
23	use ApiPlatform\Metadata\ParameterProviderFilterInterface;
24	use ApiPlatform\Metadata\Parameters;
25	use ApiPlatform\Metadata\PropertiesAwareInterface;
26	use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
27	use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
28	use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
29	use ApiPlatform\OpenApi\Model\Parameter as OpenApiParameter;
30	use ApiPlatform\Serializer\Filter\FilterInterface as SerializerFilterInterface;
31	use ApiPlatform\State\Util\StateOptionsTrait;
32	use Psr\Container\ContainerInterface;
33	use Psr\Log\LoggerInterface;
34	use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
35
36	/**
37	* Prepares Parameters documentation by reading its filter details and declaring an OpenApi parameter.
38	*
39	* @experimental
40	*/
41	final class ParameterResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
42	{
43	use StateOptionsTrait;
44
45	private array $localPropertyCache;
46
47	public function __construct(
48	private readonly PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory,
49	private readonly PropertyMetadataFactoryInterface $propertyMetadataFactory,
50	private readonly ?ResourceMetadataCollectionFactoryInterface $decorated = null,
51	private readonly ?ContainerInterface $filterLocator = null,
52	private readonly ?NameConverterInterface $nameConverter = null,
53	private readonly ?LoggerInterface $logger = null,
54	) {
UNCOV 55	}	×
56
57	public function create(string $resourceClass): ResourceMetadataCollection
58	{
UNCOV 59	$resourceMetadataCollection = $this->decorated?->create($resourceClass) ?? new ResourceMetadataCollection($resourceClass);	×
60
UNCOV 61	foreach ($resourceMetadataCollection as $i => $resource) {	×
UNCOV 62	$operations = $resource->getOperations();	×
63
UNCOV 64	$internalPriority = -1;	×
UNCOV 65	foreach ($operations as $operationName => $operation) {	×
UNCOV 66	$parameters = $this->getDefaultParameters($operation, $resourceClass, $internalPriority);	×
UNCOV 67	if (\count($parameters) > 0) {	×
UNCOV 68	$operations->add($operationName, $operation->withParameters($parameters));	×
69	}
70	}
71
UNCOV 72	$resourceMetadataCollection[$i] = $resource->withOperations($operations->sort());	×
73
UNCOV 74	if (!$graphQlOperations = $resource->getGraphQlOperations()) {	×
UNCOV 75	continue;	×
76	}
77
UNCOV 78	$internalPriority = -1;	×
UNCOV 79	foreach ($graphQlOperations as $operationName => $operation) {	×
UNCOV 80	$parameters = $this->getDefaultParameters($operation, $resourceClass, $internalPriority);	×
UNCOV 81	if (\count($parameters) > 0) {	×
UNCOV 82	$graphQlOperations[$operationName] = $operation->withParameters($parameters);	×
83	}
84	}
85
UNCOV 86	$resourceMetadataCollection[$i] = $resource->withGraphQlOperations($graphQlOperations);	×
87	}
88
UNCOV 89	return $resourceMetadataCollection;	×
90	}
91
92	/**
93	* @return array{propertyNames: string[], properties: array<string, ApiProperty>}
94	*/
95	private function getProperties(string $resourceClass, ?Parameter $parameter = null): array
96	{
UNCOV 97	$k = $resourceClass.($parameter?->getProperties() ? ($parameter->getKey() ?? '') : '');	×
UNCOV 98	if (isset($this->localPropertyCache[$k])) {	×
UNCOV 99	return $this->localPropertyCache[$k];	×
100	}
101
UNCOV 102	$propertyNames = [];	×
UNCOV 103	$properties = [];	×
UNCOV 104	foreach ($parameter?->getProperties() ?? $this->propertyNameCollectionFactory->create($resourceClass) as $property) {	×
UNCOV 105	$propertyMetadata = $this->propertyMetadataFactory->create($resourceClass, $property);	×
UNCOV 106	if ($propertyMetadata->isReadable()) {	×
UNCOV 107	$propertyNames[] = $property;	×
UNCOV 108	$properties[$property] = $propertyMetadata;	×
109	}
110	}
111
UNCOV 112	$this->localPropertyCache[$k] = ['propertyNames' => $propertyNames, 'properties' => $properties];	×
113
UNCOV 114	return $this->localPropertyCache[$k];	×
115	}
116
117	private function getDefaultParameters(Operation $operation, string $resourceClass, int &$internalPriority): Parameters
118	{
UNCOV 119	$propertyNames = $properties = [];	×
UNCOV 120	$parameters = $operation->getParameters() ?? new Parameters();	×
UNCOV 121	foreach ($parameters as $key => $parameter) {	×
UNCOV 122	['propertyNames' => $propertyNames, 'properties' => $properties] = $this->getProperties($resourceClass, $parameter);	×
UNCOV 123	if (null === $parameter->getProvider() && (($f = $parameter->getFilter()) && $f instanceof ParameterProviderFilterInterface)) {	×
124	$parameters->add($key, $parameter->withProvider($f->getParameterProvider()));	×
125	}
126
UNCOV 127	if (':property' === $key) {	×
UNCOV 128	foreach ($propertyNames as $property) {	×
UNCOV 129	$converted = $this->nameConverter?->denormalize($property) ?? $property;	×
UNCOV 130	$propertyParameter = $this->setDefaults($converted, $parameter, $resourceClass, $properties, $operation);	×
UNCOV 131	$priority = $propertyParameter->getPriority() ?? $internalPriority--;	×
UNCOV 132	$parameters->add($converted, $propertyParameter->withPriority($priority)->withKey($converted));	×
133	}
134
UNCOV 135	$parameters->remove($key, $parameter::class);	×
UNCOV 136	continue;	×
137	}
138
UNCOV 139	$key = $parameter->getKey() ?? $key;	×
140
UNCOV 141	if (str_contains($key, ':property') \|\| ((($f = $parameter->getFilter()) && is_a($f, PropertiesAwareInterface::class, true)) \|\| $parameter instanceof PropertiesAwareInterface)) {	×
UNCOV 142	$p = [];	×
UNCOV 143	foreach ($propertyNames as $prop) {	×
UNCOV 144	$p[$this->nameConverter?->denormalize($prop) ?? $prop] = $prop;	×
145	}
146
UNCOV 147	$parameter = $parameter->withExtraProperties($parameter->getExtraProperties() + ['_properties' => $p]);	×
148	}
149
UNCOV 150	$parameter = $this->setDefaults($key, $parameter, $resourceClass, $properties, $operation);	×
UNCOV 151	$priority = $parameter->getPriority() ?? $internalPriority--;	×
UNCOV 152	$parameters->add($key, $parameter->withPriority($priority));	×
153	}
154
UNCOV 155	return $parameters;	×
156	}
157
158	private function addFilterMetadata(Parameter $parameter): Parameter
159	{
UNCOV 160	if (!($filterId = $parameter->getFilter())) {	×
UNCOV 161	return $parameter;	×
162	}
163
UNCOV 164	if (!\is_object($filterId) && !$this->filterLocator->has($filterId)) {	×
165	return $parameter;	×
166	}
167
UNCOV 168	$filter = \is_object($filterId) ? $filterId : $this->filterLocator->get($filterId);	×
169
UNCOV 170	if ($filter instanceof ParameterProviderFilterInterface) {	×
171	$parameter = $parameter->withProvider($filter::getParameterProvider());	×
172	}
173
UNCOV 174	if (!$filter) {	×
175	return $parameter;	×
176	}
177
UNCOV 178	if (null === $parameter->getSchema() && $filter instanceof JsonSchemaFilterInterface && $schema = $filter->getSchema($parameter)) {	×
UNCOV 179	$parameter = $parameter->withSchema($schema);	×
180	}
181
UNCOV 182	if (null === $parameter->getOpenApi() && $filter instanceof OpenApiParameterFilterInterface && ($openApiParameter = $filter->getOpenApiParameters($parameter))) {	×
UNCOV 183	$parameter = $parameter->withOpenApi($openApiParameter);	×
184	}
185
UNCOV 186	return $parameter;	×
187	}
188
189	/**
190	* @param array<string, ApiProperty> $properties
191	*/
192	private function setDefaults(string $key, Parameter $parameter, string $resourceClass, array $properties, Operation $operation): Parameter
193	{
UNCOV 194	if (null === $parameter->getKey()) {	×
UNCOV 195	$parameter = $parameter->withKey($key);	×
196	}
197
UNCOV 198	$filter = $parameter->getFilter();	×
UNCOV 199	if (\is_string($filter) && $this->filterLocator->has($filter)) {	×
UNCOV 200	$filter = $this->filterLocator->get($filter);	×
201	}
202
UNCOV 203	if ($filter instanceof SerializerFilterInterface && null === $parameter->getProvider()) {	×
UNCOV 204	$parameter = $parameter->withProvider('api_platform.serializer.filter_parameter_provider');	×
205	}
UNCOV 206	$currentKey = $key;	×
UNCOV 207	if (null === $parameter->getProperty() && isset($properties[$key])) {	×
UNCOV 208	$parameter = $parameter->withProperty($key);	×
209	}
210
UNCOV 211	if (null === $parameter->getProperty() && $this->nameConverter && ($nameConvertedKey = $this->nameConverter->normalize($key)) && isset($properties[$nameConvertedKey])) {	×
212	$parameter = $parameter->withProperty($key)->withExtraProperties(['_query_property' => $nameConvertedKey] + $parameter->getExtraProperties());	×
213	$currentKey = $nameConvertedKey;	×
214	}
215
UNCOV 216	if ($this->nameConverter && $property = $parameter->getProperty()) {	×
UNCOV 217	$parameter = $parameter->withProperty($this->nameConverter->normalize($property));	×
218	}
219
UNCOV 220	if (isset($properties[$currentKey]) && ($eloquentRelation = ($properties[$currentKey]->getExtraProperties()['eloquent_relation'] ?? null)) && isset($eloquentRelation['foreign_key'])) {	×
221	$parameter = $parameter->withExtraProperties(['_query_property' => $eloquentRelation['foreign_key']] + $parameter->getExtraProperties());	×
222	}
223
UNCOV 224	$parameter = $this->addFilterMetadata($parameter);	×
225
UNCOV 226	if ($filter instanceof FilterInterface) {	×
227	try {
UNCOV 228	return $this->getLegacyFilterMetadata($parameter, $operation, $filter);	×
UNCOV 229	} catch (RuntimeException $exception) {	×
UNCOV 230	$this->logger?->alert($exception->getMessage(), ['exception' => $exception]);	×
231
UNCOV 232	return $parameter;	×
233	}
234	}
235
UNCOV 236	return $parameter;	×
237	}
238
239	private function getLegacyFilterMetadata(Parameter $parameter, Operation $operation, FilterInterface $filter): Parameter
240	{
UNCOV 241	$description = $filter->getDescription($this->getStateOptionsClass($operation, $operation->getClass()));	×
UNCOV 242	$key = $parameter->getKey();	×
UNCOV 243	if (($schema = $description[$key]['schema'] ?? null) && null === $parameter->getSchema()) {	×
244	$parameter = $parameter->withSchema($schema);	×
245	}
246
UNCOV 247	if (null === $parameter->getProperty() && ($property = $description[$key]['property'] ?? null)) {	×
248	$parameter = $parameter->withProperty($property);	×
249	}
250
UNCOV 251	if (null === $parameter->getRequired() && ($required = $description[$key]['required'] ?? null)) {	×
252	$parameter = $parameter->withRequired($required);	×
253	}
254
UNCOV 255	if (null === $parameter->getOpenApi() && ($openApi = $description[$key]['openapi'] ?? null) && $openApi instanceof OpenApiParameter) {	×
256	$parameter = $parameter->withOpenApi($openApi);	×
257	}
258
UNCOV 259	return $parameter;	×
260	}
261	}

api-platform / core / 14954769666

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