12650664077

Committed 07 Jan 2025 11:27AM UTC coverage: 62.123% (-0.001%) from 62.124%

Build # 12650664077

Build Type

Pull #6886

github

Committed by

web-flow

Commit Message

Merge c6a756cfd into f8dae8e11

Pull Request Pull Request #6886: fix(openapi): not forbidden response on openAPI doc

Run Details

2 of 2 new or added lines in 1 file covered. (100.0%)

1 existing line in 1 file now uncovered.

11499 of 18510 relevant lines covered (62.12%)

68.99 hits per line

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

92.11

/src/Symfony/Validator/State/ParameterValidatorProvider.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\Symfony\Validator\State;

use ApiPlatform\Metadata\Operation;
use ApiPlatform\Metadata\Parameter;
use ApiPlatform\State\ParameterNotFound;
use ApiPlatform\State\ProviderInterface;
use ApiPlatform\State\Util\ParameterParserTrait;
use ApiPlatform\Validator\Exception\ValidationException;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Validator\ConstraintViolation;
use Symfony\Component\Validator\ConstraintViolationInterface;
use Symfony\Component\Validator\ConstraintViolationList;
use Symfony\Component\Validator\Validator\ValidatorInterface;

/**
 * Validates parameters using the Symfony validator.
 *
 * @experimental
 */
final class ParameterValidatorProvider implements ProviderInterface
{
    use ParameterParserTrait;

    public function __construct(
        private readonly ValidatorInterface $validator,
        private readonly ProviderInterface $decorated,
    ) {
    }

    public function provide(Operation $operation, array $uriVariables = [], array $context = []): object|array|null
    {
        if (!($request = $context['request']) instanceof Request) {
            return $this->decorated->provide($operation, $uriVariables, $context);
        }

        $operation = $request->attributes->get('_api_operation') ?? $operation;
        if (!($operation->getQueryParameterValidationEnabled() ?? true)) {
            return $this->decorated->provide($operation, $uriVariables, $context);
        }

        $constraintViolationList = new ConstraintViolationList();
        foreach ($operation->getParameters() ?? [] as $parameter) {
            if (!$constraints = $parameter->getConstraints()) {
                continue;
            }

            $value = $parameter->getValue();
            if ($value instanceof ParameterNotFound) {
                $value = null;
            }

            $violations = $this->validator->validate($value, $constraints);
            foreach ($violations as $violation) {
                $constraintViolationList->add(new ConstraintViolation(
                    $violation->getMessage(),
                    $violation->getMessageTemplate(),
                    $violation->getParameters(),
                    $violation->getRoot(),
                    $this->getProperty($parameter, $violation),
                    $violation->getInvalidValue(),
                    $violation->getPlural(),
                    $violation->getCode(),
                    $violation->getConstraint(),
                    $violation->getCause()
                ));
            }
        }

        if (0 !== \count($constraintViolationList)) {
            throw new ValidationException($constraintViolationList);
        }

        return $this->decorated->provide($operation, $uriVariables, $context);
    }

    // There's a `property` inside Parameter but it's used for hydra:search only as here we want the parameter name instead
    private function getProperty(Parameter $parameter, ConstraintViolationInterface $violation): string
    {
        $key = $parameter->getKey();

        if (str_contains($key, '[:property]')) {
            return str_replace('[:property]', $violation->getPropertyPath(), $key);
        }

        if (str_contains($key, ':property')) {
            return str_replace(':property', $violation->getPropertyPath(), $key);
        }

        if ($p = $violation->getPropertyPath()) {
            return $p;
        }

        return $key;
    }
}

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\Symfony\Validator\State;
15
16	use ApiPlatform\Metadata\Operation;
17	use ApiPlatform\Metadata\Parameter;
18	use ApiPlatform\State\ParameterNotFound;
19	use ApiPlatform\State\ProviderInterface;
20	use ApiPlatform\State\Util\ParameterParserTrait;
21	use ApiPlatform\Validator\Exception\ValidationException;
22	use Symfony\Component\HttpFoundation\Request;
23	use Symfony\Component\Validator\ConstraintViolation;
24	use Symfony\Component\Validator\ConstraintViolationInterface;
25	use Symfony\Component\Validator\ConstraintViolationList;
26	use Symfony\Component\Validator\Validator\ValidatorInterface;
27
28	/**
29	* Validates parameters using the Symfony validator.
30	*
31	* @experimental
32	*/
33	final class ParameterValidatorProvider implements ProviderInterface
34	{
35	use ParameterParserTrait;
36
37	public function __construct(
38	private readonly ValidatorInterface $validator,
39	private readonly ProviderInterface $decorated,
40	) {
41	}	444✔
42
43	public function provide(Operation $operation, array $uriVariables = [], array $context = []): object\|array\|null
44	{
45	if (!($request = $context['request']) instanceof Request) {	444✔
46	return $this->decorated->provide($operation, $uriVariables, $context);	×
47	}
48
49	$operation = $request->attributes->get('_api_operation') ?? $operation;	444✔
50	if (!($operation->getQueryParameterValidationEnabled() ?? true)) {	444✔
51	return $this->decorated->provide($operation, $uriVariables, $context);	4✔
52	}
53
54	$constraintViolationList = new ConstraintViolationList();	440✔
55	foreach ($operation->getParameters() ?? [] as $parameter) {	440✔
56	if (!$constraints = $parameter->getConstraints()) {	140✔
57	continue;	132✔
58	}
59
60	$value = $parameter->getValue();	76✔
61	if ($value instanceof ParameterNotFound) {	76✔
62	$value = null;	68✔
63	}
64
65	$violations = $this->validator->validate($value, $constraints);	76✔
66	foreach ($violations as $violation) {	76✔
67	$constraintViolationList->add(new ConstraintViolation(	48✔
68	$violation->getMessage(),	48✔
69	$violation->getMessageTemplate(),	48✔
70	$violation->getParameters(),	48✔
71	$violation->getRoot(),	48✔
72	$this->getProperty($parameter, $violation),	48✔
73	$violation->getInvalidValue(),	48✔
74	$violation->getPlural(),	48✔
75	$violation->getCode(),	48✔
76	$violation->getConstraint(),	48✔
77	$violation->getCause()	48✔
78	));	48✔
79	}
80	}
81
82	if (0 !== \count($constraintViolationList)) {	440✔
83	throw new ValidationException($constraintViolationList);	48✔
84	}
85
86	return $this->decorated->provide($operation, $uriVariables, $context);	440✔
87	}
88
89	// There's a `property` inside Parameter but it's used for hydra:search only as here we want the parameter name instead
90	private function getProperty(Parameter $parameter, ConstraintViolationInterface $violation): string
91	{
92	$key = $parameter->getKey();	48✔
93
94	if (str_contains($key, '[:property]')) {	48✔
95	return str_replace('[:property]', $violation->getPropertyPath(), $key);	8✔
96	}
97
98	if (str_contains($key, ':property')) {	44✔
99	return str_replace(':property', $violation->getPropertyPath(), $key);	×
100	}
101
102	if ($p = $violation->getPropertyPath()) {	44✔
UNCOV 103	return $p;	×
104	}
105
106	return $key;	44✔
107	}
108	}

api-platform / core / 12650664077

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