fix(state): store parameter value without its key (#6456)

api-platform · Jul 8, 2024 · 93e4b3d · 93e4b3d
1 parent 83745df
commit 93e4b3d
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 21 deletions.
diff --git a/src/Doctrine/Common/ParameterValueExtractorTrait.php b/src/Doctrine/Common/ParameterValueExtractorTrait.php
@@ -13,24 +13,20 @@
 
 namespace ApiPlatform\Doctrine\Common;
 
+use ApiPlatform\Metadata\Parameter;
+
 trait ParameterValueExtractorTrait
 {
     /**
-     * @param array<string, mixed> $values
-     *
      * @return array<string, mixed>
      */
-    private function extractParameterValue(array $values): array
+    private function extractParameterValue(Parameter $parameter, mixed $value): array
     {
-        if (!$values) {
-            return $values;
-        }
-
-        $key = key($values);
+        $key = $parameter->getKey();
         if (!str_contains($key, ':property')) {
-            return $values;
+            return [$key => $value];
         }
 
-        return [str_replace('[:property]', '', $key) => $values[$key]];
+        return [str_replace('[:property]', '', $key) => $value];
     }
 }
diff --git a/src/Doctrine/Odm/Extension/ParameterExtension.php b/src/Doctrine/Odm/Extension/ParameterExtension.php
@@ -16,6 +16,7 @@
 use ApiPlatform\Doctrine\Common\ParameterValueExtractorTrait;
 use ApiPlatform\Doctrine\Odm\Filter\FilterInterface;
 use ApiPlatform\Metadata\Operation;
+use ApiPlatform\State\ParameterNotFound;
 use Doctrine\ODM\MongoDB\Aggregation\Builder;
 use Psr\Container\ContainerInterface;
 
@@ -35,11 +36,11 @@ public function __construct(private readonly ContainerInterface $filterLocator)
     private function applyFilter(Builder $aggregationBuilder, ?string $resourceClass = null, ?Operation $operation = null, array &$context = []): void
     {
         foreach ($operation->getParameters() ?? [] as $parameter) {
-            $values = $this->extractParameterValue($parameter->getValue() ?? []);
-            if (!$values) {
+            if (!($v = $parameter->getValue()) || $v instanceof ParameterNotFound) {
                 continue;
             }
 
+            $values = $this->extractParameterValue($parameter, $v);
             if (null === ($filterId = $parameter->getFilter())) {
                 continue;
             }

diff --git a/src/Doctrine/Orm/Extension/ParameterExtension.php b/src/Doctrine/Orm/Extension/ParameterExtension.php
@@ -17,6 +17,7 @@
 use ApiPlatform\Doctrine\Orm\Filter\FilterInterface;
 use ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface;
 use ApiPlatform\Metadata\Operation;
+use ApiPlatform\State\ParameterNotFound;
 use Doctrine\ORM\QueryBuilder;
 use Psr\Container\ContainerInterface;
 
@@ -39,11 +40,11 @@ public function __construct(private readonly ContainerInterface $filterLocator)
     private function applyFilter(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, ?Operation $operation = null, array $context = []): void
     {
         foreach ($operation?->getParameters() ?? [] as $parameter) {
-            $values = $this->extractParameterValue($parameter->getValue() ?? []);
-            if (!$values) {
+            if (!($v = $parameter->getValue()) || $v instanceof ParameterNotFound) {
                 continue;
             }
 
+            $values = $this->extractParameterValue($parameter, $v);
             if (null === ($filterId = $parameter->getFilter())) {
                 continue;
             }

diff --git a/src/State/Provider/ParameterProvider.php b/src/State/Provider/ParameterProvider.php
@@ -64,7 +64,7 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
             }
 
             $parameters->add($parameter->getKey(), $parameter = $parameter->withExtraProperties(
-                $parameter->getExtraProperties() + ['_api_values' => [$parameter->getKey() => $value]]
+                $parameter->getExtraProperties() + ['_api_values' => $value]
             ));
 
             if (null === ($provider = $parameter->getProvider())) {

diff --git a/src/State/Tests/ParameterProviderTest.php b/src/State/Tests/ParameterProviderTest.php
@@ -59,8 +59,8 @@ public function has(string $id): bool
         $operation = $request->attributes->get('_api_operation');
 
         $this->assertEquals('ok', $operation->getName());
-        $this->assertEquals(['order' => ['foo' => 'asc']], $operation->getParameters()->get('order', QueryParameter::class)->getValue());
-        $this->assertEquals(['search[:property]' => ['a' => 'bar']], $operation->getParameters()->get('search[:property]', QueryParameter::class)->getValue());
+        $this->assertEquals(['foo' => 'asc'], $operation->getParameters()->get('order', QueryParameter::class)->getValue());
+        $this->assertEquals(['a' => 'bar'], $operation->getParameters()->get('search[:property]', QueryParameter::class)->getValue());
     }
 
     public static function provide(): void

diff --git a/src/Symfony/Validator/State/ParameterValidatorProvider.php b/src/Symfony/Validator/State/ParameterValidatorProvider.php
@@ -14,6 +14,7 @@
 namespace ApiPlatform\Symfony\Validator\State;
 
 use ApiPlatform\Metadata\Operation;
+use ApiPlatform\State\ParameterNotFound;
 use ApiPlatform\State\ProviderInterface;
 use ApiPlatform\State\Util\ParameterParserTrait;
 use ApiPlatform\Validator\Exception\ValidationException;
@@ -39,19 +40,27 @@ public function __construct(
 
     public function provide(Operation $operation, array $uriVariables = [], array $context = []): object|array|null
     {
-        if (!($request = $context['request']) instanceof Request || false === $operation->getQueryParameterValidationEnabled()) {
+        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;
             }
 
             $key = $parameter->getKey();
-            $value = $parameter->getValue()[$key] ?? null;
+            $value = $parameter->getValue();
+            if ($value instanceof ParameterNotFound) {
+                $value = null;
+            }
+
             $violations = $this->validator->validate($value, $constraints);
             foreach ($violations as $violation) {
                 $constraintViolationList->add(new ConstraintViolation(

diff --git a/tests/Functional/Parameters/ParameterTest.php b/tests/Functional/Parameters/ParameterTest.php
@@ -75,8 +75,8 @@ public function testHeaderAndQuery(): void
     {
         $response = self::createClient()->request('GET', 'with_parameters_header_and_query?q=blabla', ['headers' => ['q' => '(complex stuff)']]);
         $this->assertEquals($response->toArray(), [
-            ['q' => ['(complex stuff)']],
-            ['q' => 'blabla'],
+            ['(complex stuff)'],
+            'blabla',
         ]);
     }
 }