13814792797

Committed 12 Mar 2025 03:09PM UTC coverage: 5.889% (-1.4%) from 7.289%

Build # 13814792797

Build Type

Pull #7012

github

Committed by

web-flow

Commit Message

Merge 199d44919 into 284937039

Pull Request Pull Request #7012: doc: comment typo in ApiResource.php

Run Details

10048 of 170615 relevant lines covered (5.89%)

5.17 hits per line

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

96.51

/src/Validator/Metadata/Resource/Factory/ParameterValidationResourceMetadataCollectionFactory.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\Validator\Metadata\Resource\Factory;

use ApiPlatform\Metadata\HttpOperation;
use ApiPlatform\Metadata\Parameter;
use ApiPlatform\Metadata\Parameters;
use ApiPlatform\Metadata\QueryParameter;
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
use ApiPlatform\OpenApi\Model\Parameter as OpenApiParameter;
use Psr\Container\ContainerInterface;
use Symfony\Component\Validator\Constraints\Choice;
use Symfony\Component\Validator\Constraints\Count;
use Symfony\Component\Validator\Constraints\DivisibleBy;
use Symfony\Component\Validator\Constraints\GreaterThan;
use Symfony\Component\Validator\Constraints\GreaterThanOrEqual;
use Symfony\Component\Validator\Constraints\Length;
use Symfony\Component\Validator\Constraints\LessThan;
use Symfony\Component\Validator\Constraints\LessThanOrEqual;
use Symfony\Component\Validator\Constraints\NotBlank;
use Symfony\Component\Validator\Constraints\NotNull;
use Symfony\Component\Validator\Constraints\Regex;
use Symfony\Component\Validator\Constraints\Type;
use Symfony\Component\Validator\Constraints\Unique;

final class ParameterValidationResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
{
    public function __construct(
        private readonly ?ResourceMetadataCollectionFactoryInterface $decorated = null,
        private readonly ?ContainerInterface $filterLocator = null,
    ) {
    }

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

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

            foreach ($operations as $operationName => $operation) {
                $parameters = $operation->getParameters() ?? new Parameters();
                foreach ($parameters as $key => $parameter) {
                    $parameters->add($key, $this->addSchemaValidation($parameter));
                }

                // As we deprecate the parameter validator, we declare a parameter for each filter transfering validation to the new system
                if ($operation->getFilters() && 0 === $parameters->count()) {
                    $parameters = $this->addFilterValidation($operation);
                }

                if (\count($parameters) > 0) {
                    $operations->add($operationName, $operation->withParameters($parameters));
                }
            }

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

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

            foreach ($graphQlOperations as $operationName => $operation) {
                $parameters = $operation->getParameters() ?? new Parameters();
                foreach ($operation->getParameters() ?? [] as $key => $parameter) {
                    $parameters->add($key, $this->addSchemaValidation($parameter));
                }

                if (\count($parameters) > 0) {
                    $graphQlOperations[$operationName] = $operation->withParameters($parameters);
                }
            }

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

        return $resourceMetadataCollection;
    }

    private function addSchemaValidation(Parameter $parameter, ?array $schema = null, ?bool $required = null, ?OpenApiParameter $openApi = null): Parameter
    {
        if (null !== $parameter->getConstraints()) {
            return $parameter;
        }

        $schema ??= $parameter->getSchema();
        $required ??= $parameter->getRequired() ?? false;
        $openApi ??= $parameter->getOpenApi();

        // When it's an array of openapi parameters take the first one as it's probably just a variant of the query parameter,
        // only getAllowEmptyValue is used here anyways
        if (\is_array($openApi)) {
            $openApi = $openApi[0];
        } elseif (false === $openApi) {
            $openApi = null;
        }

        $assertions = [];

        if ($required && false !== ($allowEmptyValue = $openApi?->getAllowEmptyValue())) {
            $assertions[] = new NotNull(message: \sprintf('The parameter "%s" is required.', $parameter->getKey()));
        }

        if (false === ($allowEmptyValue ?? $openApi?->getAllowEmptyValue())) {
            $assertions[] = new NotBlank(allowNull: !$required);
        }

        if (isset($schema['exclusiveMinimum'])) {
            $assertions[] = new GreaterThan(value: $schema['exclusiveMinimum']);
        }

        if (isset($schema['exclusiveMaximum'])) {
            $assertions[] = new LessThan(value: $schema['exclusiveMaximum']);
        }

        if (isset($schema['minimum'])) {
            $assertions[] = new GreaterThanOrEqual(value: $schema['minimum']);
        }

        if (isset($schema['maximum'])) {
            $assertions[] = new LessThanOrEqual(value: $schema['maximum']);
        }

        if (isset($schema['pattern'])) {
            $assertions[] = new Regex('#'.$schema['pattern'].'#');
        }

        if (isset($schema['maxLength']) || isset($schema['minLength'])) {
            $assertions[] = new Length(min: $schema['minLength'] ?? null, max: $schema['maxLength'] ?? null);
        }

        if (isset($schema['minItems']) || isset($schema['maxItems'])) {
            $assertions[] = new Count(min: $schema['minItems'] ?? null, max: $schema['maxItems'] ?? null);
        }

        if (isset($schema['multipleOf'])) {
            $assertions[] = new DivisibleBy(value: $schema['multipleOf']);
        }

        if ($schema['uniqueItems'] ?? false) {
            $assertions[] = new Unique();
        }

        if (isset($schema['enum'])) {
            $assertions[] = new Choice(choices: $schema['enum']);
        }

        if (isset($schema['type']) && 'array' === $schema['type']) {
            $assertions[] = new Type(type: 'array');
        }

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

        if (1 === \count($assertions)) {
            return $parameter->withConstraints($assertions[0]);
        }

        return $parameter->withConstraints($assertions);
    }

    private function addFilterValidation(HttpOperation $operation): Parameters
    {
        $parameters = new Parameters();
        $internalPriority = -1;

        foreach ($operation->getFilters() as $filter) {
            if (!$this->filterLocator->has($filter)) {
                continue;
            }

            $filter = $this->filterLocator->get($filter);
            foreach ($filter->getDescription($operation->getClass()) as $parameterName => $definition) {
                $key = $parameterName;
                $required = $definition['required'] ?? false;
                $schema = $definition['schema'] ?? null;

                $openApi = null;
                if (isset($definition['openapi']) && $definition['openapi'] instanceof OpenApiParameter) {
                    $openApi = $definition['openapi'];
                }

                // The query parameter validator forced this, lets maintain BC on filters
                if (true === $required && !$openApi) {
                    $openApi = new OpenApiParameter(name: $key, in: 'query', allowEmptyValue: false);
                }

                $parameters->add($key, $this->addSchemaValidation(
                    // we disable openapi and hydra on purpose as their docs comes from filters see the condition for addFilterValidation above
                    new QueryParameter(key: $key, property: $definition['property'] ?? null, priority: $internalPriority--, schema: $schema, openApi: false, hydra: false),
                    $schema,
                    $required,
                    $openApi
                ));
            }
        }

        return $parameters;
    }
}

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\Validator\Metadata\Resource\Factory;
15
16	use ApiPlatform\Metadata\HttpOperation;
17	use ApiPlatform\Metadata\Parameter;
18	use ApiPlatform\Metadata\Parameters;
19	use ApiPlatform\Metadata\QueryParameter;
20	use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
21	use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
22	use ApiPlatform\OpenApi\Model\Parameter as OpenApiParameter;
23	use Psr\Container\ContainerInterface;
24	use Symfony\Component\Validator\Constraints\Choice;
25	use Symfony\Component\Validator\Constraints\Count;
26	use Symfony\Component\Validator\Constraints\DivisibleBy;
27	use Symfony\Component\Validator\Constraints\GreaterThan;
28	use Symfony\Component\Validator\Constraints\GreaterThanOrEqual;
29	use Symfony\Component\Validator\Constraints\Length;
30	use Symfony\Component\Validator\Constraints\LessThan;
31	use Symfony\Component\Validator\Constraints\LessThanOrEqual;
32	use Symfony\Component\Validator\Constraints\NotBlank;
33	use Symfony\Component\Validator\Constraints\NotNull;
34	use Symfony\Component\Validator\Constraints\Regex;
35	use Symfony\Component\Validator\Constraints\Type;
36	use Symfony\Component\Validator\Constraints\Unique;
37
38	final class ParameterValidationResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
39	{
40	public function __construct(
41	private readonly ?ResourceMetadataCollectionFactoryInterface $decorated = null,
42	private readonly ?ContainerInterface $filterLocator = null,
43	) {
44	}	465✔
45
46	public function create(string $resourceClass): ResourceMetadataCollection
47	{
48	$resourceMetadataCollection = $this->decorated?->create($resourceClass) ?? new ResourceMetadataCollection($resourceClass);	84✔
49
50	foreach ($resourceMetadataCollection as $i => $resource) {	84✔
51	$operations = $resource->getOperations();	81✔
52
53	foreach ($operations as $operationName => $operation) {	81✔
54	$parameters = $operation->getParameters() ?? new Parameters();	81✔
55	foreach ($parameters as $key => $parameter) {	81✔
56	$parameters->add($key, $this->addSchemaValidation($parameter));	18✔
57	}
58
59	// As we deprecate the parameter validator, we declare a parameter for each filter transfering validation to the new system
60	if ($operation->getFilters() && 0 === $parameters->count()) {	81✔
61	$parameters = $this->addFilterValidation($operation);	6✔
62	}
63
64	if (\count($parameters) > 0) {	81✔
65	$operations->add($operationName, $operation->withParameters($parameters));	24✔
66	}
67	}
68
69	$resourceMetadataCollection[$i] = $resource->withOperations($operations->sort());	81✔
70
71	if (!$graphQlOperations = $resource->getGraphQlOperations()) {	81✔
72	continue;	48✔
73	}
74
75	foreach ($graphQlOperations as $operationName => $operation) {	63✔
76	$parameters = $operation->getParameters() ?? new Parameters();	63✔
77	foreach ($operation->getParameters() ?? [] as $key => $parameter) {	63✔
78	$parameters->add($key, $this->addSchemaValidation($parameter));	3✔
79	}
80
81	if (\count($parameters) > 0) {	63✔
82	$graphQlOperations[$operationName] = $operation->withParameters($parameters);	3✔
83	}
84	}
85
86	$resourceMetadataCollection[$i] = $resource->withGraphQlOperations($graphQlOperations);	63✔
87	}
88
89	return $resourceMetadataCollection;	84✔
90	}
91
92	private function addSchemaValidation(Parameter $parameter, ?array $schema = null, ?bool $required = null, ?OpenApiParameter $openApi = null): Parameter
93	{
94	if (null !== $parameter->getConstraints()) {	24✔
95	return $parameter;	6✔
96	}
97
98	$schema ??= $parameter->getSchema();	21✔
99	$required ??= $parameter->getRequired() ?? false;	21✔
100	$openApi ??= $parameter->getOpenApi();	21✔
101
102	// When it's an array of openapi parameters take the first one as it's probably just a variant of the query parameter,
103	// only getAllowEmptyValue is used here anyways
104	if (\is_array($openApi)) {	21✔
105	$openApi = $openApi[0];	×
106	} elseif (false === $openApi) {	21✔
107	$openApi = null;	9✔
108	}
109
110	$assertions = [];	21✔
111
112	if ($required && false !== ($allowEmptyValue = $openApi?->getAllowEmptyValue())) {	21✔
113	$assertions[] = new NotNull(message: \sprintf('The parameter "%s" is required.', $parameter->getKey()));	3✔
114	}
115
116	if (false === ($allowEmptyValue ?? $openApi?->getAllowEmptyValue())) {	21✔
117	$assertions[] = new NotBlank(allowNull: !$required);	6✔
118	}
119
120	if (isset($schema['exclusiveMinimum'])) {	21✔
121	$assertions[] = new GreaterThan(value: $schema['exclusiveMinimum']);	3✔
122	}
123
124	if (isset($schema['exclusiveMaximum'])) {	21✔
125	$assertions[] = new LessThan(value: $schema['exclusiveMaximum']);	3✔
126	}
127
128	if (isset($schema['minimum'])) {	21✔
129	$assertions[] = new GreaterThanOrEqual(value: $schema['minimum']);	3✔
130	}
131
132	if (isset($schema['maximum'])) {	21✔
133	$assertions[] = new LessThanOrEqual(value: $schema['maximum']);	3✔
134	}
135
136	if (isset($schema['pattern'])) {	21✔
137	$assertions[] = new Regex('#'.$schema['pattern'].'#');	3✔
138	}
139
140	if (isset($schema['maxLength']) \|\| isset($schema['minLength'])) {	21✔
141	$assertions[] = new Length(min: $schema['minLength'] ?? null, max: $schema['maxLength'] ?? null);	3✔
142	}
143
144	if (isset($schema['minItems']) \|\| isset($schema['maxItems'])) {	21✔
145	$assertions[] = new Count(min: $schema['minItems'] ?? null, max: $schema['maxItems'] ?? null);	3✔
146	}
147
148	if (isset($schema['multipleOf'])) {	21✔
149	$assertions[] = new DivisibleBy(value: $schema['multipleOf']);	3✔
150	}
151
152	if ($schema['uniqueItems'] ?? false) {	21✔
153	$assertions[] = new Unique();	3✔
154	}
155
156	if (isset($schema['enum'])) {	21✔
157	$assertions[] = new Choice(choices: $schema['enum']);	6✔
158	}
159
160	if (isset($schema['type']) && 'array' === $schema['type']) {	21✔
161	$assertions[] = new Type(type: 'array');	3✔
162	}
163
164	if (!$assertions) {	21✔
165	return $parameter;	21✔
166	}
167
168	if (1 === \count($assertions)) {	6✔
169	return $parameter->withConstraints($assertions[0]);	6✔
170	}
171
172	return $parameter->withConstraints($assertions);	3✔
173	}
174
175	private function addFilterValidation(HttpOperation $operation): Parameters
176	{
177	$parameters = new Parameters();	6✔
178	$internalPriority = -1;	6✔
179
180	foreach ($operation->getFilters() as $filter) {	6✔
181	if (!$this->filterLocator->has($filter)) {	6✔
182	continue;	×
183	}
184
185	$filter = $this->filterLocator->get($filter);	6✔
186	foreach ($filter->getDescription($operation->getClass()) as $parameterName => $definition) {	6✔
187	$key = $parameterName;	6✔
188	$required = $definition['required'] ?? false;	6✔
189	$schema = $definition['schema'] ?? null;	6✔
190
191	$openApi = null;	6✔
192	if (isset($definition['openapi']) && $definition['openapi'] instanceof OpenApiParameter) {	6✔
193	$openApi = $definition['openapi'];	3✔
194	}
195
196	// The query parameter validator forced this, lets maintain BC on filters
197	if (true === $required && !$openApi) {	6✔
198	$openApi = new OpenApiParameter(name: $key, in: 'query', allowEmptyValue: false);	×
199	}
200
201	$parameters->add($key, $this->addSchemaValidation(	6✔
202	// we disable openapi and hydra on purpose as their docs comes from filters see the condition for addFilterValidation above
203	new QueryParameter(key: $key, property: $definition['property'] ?? null, priority: $internalPriority--, schema: $schema, openApi: false, hydra: false),	6✔
204	$schema,	6✔
205	$required,	6✔
206	$openApi	6✔
207	));	6✔
208	}
209	}
210
211	return $parameters;	6✔
212	}
213	}

api-platform / core / 13814792797

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