use internal RequestParser instead of $request->query->all()

api-platform · Jan 28, 2019 · 6412b76 · 6412b76
1 parent 5ab40f2
commit 6412b76
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 18 deletions.
diff --git a/src/EventListener/QueryParameterValidateListener.php b/src/EventListener/QueryParameterValidateListener.php
@@ -16,6 +16,7 @@
 use ApiPlatform\Core\Filter\QueryParameterValidator;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
 use ApiPlatform\Core\Util\RequestAttributesExtractor;
+use ApiPlatform\Core\Util\RequestParser;
 use Symfony\Component\HttpKernel\Event\GetResponseEvent;
 
 /**
@@ -46,10 +47,12 @@ public function onKernelRequest(GetResponseEvent $event)
         ) {
             return;
         }
+        $queryString = RequestParser::getQueryString($request);
+        $queryParameters = $queryString ? RequestParser::parseRequestParams($queryString) : [];
 
         $resourceMetadata = $this->resourceMetadataFactory->create($attributes['resource_class']);
         $resourceFilters = $resourceMetadata->getCollectionOperationAttribute($operationName, 'filters', [], true);
 
-        $this->queryParameterValidator->validateFilters($attributes['resource_class'], $resourceFilters, $request);
+        $this->queryParameterValidator->validateFilters($attributes['resource_class'], $resourceFilters, $queryParameters);
     }
 }
diff --git a/src/Filter/QueryParameterValidator.php b/src/Filter/QueryParameterValidator.php
@@ -16,7 +16,6 @@
 use ApiPlatform\Core\Api\FilterLocatorTrait;
 use ApiPlatform\Core\Exception\FilterValidationException;
 use Psr\Container\ContainerInterface;
-use Symfony\Component\HttpFoundation\Request;
 
 /**
  * Validates query parameters depending on filter description.
@@ -44,17 +43,18 @@ public function __construct(ContainerInterface $filterLocator)
         ];
     }
 
-    public function validateFilters(string $resourceClass, array $resourceFilters, Request $request): void
+    public function validateFilters(string $resourceClass, array $resourceFilters, array $queryParameters): void
     {
         $errorList = [];
+
         foreach ($resourceFilters as $filterId) {
             if (!$filter = $this->getFilter($filterId)) {
                 continue;
             }
 
             foreach ($filter->getDescription($resourceClass) as $name => $data) {
                 foreach ($this->validators as $validator) {
-                    $errorList = array_merge($errorList, $validator->validate($name, $data, $request->query->all()));
+                    $errorList = array_merge($errorList, $validator->validate($name, $data, $queryParameters));
                 }
             }
         }

diff --git a/src/Filter/Validator/Required.php b/src/Filter/Validator/Required.php
@@ -61,7 +61,7 @@ private function requestHasQueryParameter(array $queryParameters, string $name):
         if (\is_array($matches[$rootName])) {
             $keyName = array_keys($matches[$rootName])[0];
 
-            $queryParameter = $queryParameters[(string) $rootName];
+            $queryParameter = $queryParameters[(string) $rootName] ?? null;
 
             return \is_array($queryParameter) && isset($queryParameter[$keyName]);
         }
@@ -90,7 +90,7 @@ private function requestGetQueryParameter(array $queryParameters, string $name)
         if (\is_array($matches[$rootName])) {
             $keyName = array_keys($matches[$rootName])[0];
 
-            $queryParameter = $queryParameters[(string) $rootName];
+            $queryParameter = $queryParameters[(string) $rootName] ?? null;
 
             if (\is_array($queryParameter) && isset($queryParameter[$keyName])) {
                 return $queryParameter[$keyName];

diff --git a/tests/EventListener/QueryParameterValidateListenerTest.php b/tests/EventListener/QueryParameterValidateListenerTest.php
@@ -59,7 +59,7 @@ public function testOnKernelRequestWithWrongFilter()
         $eventProphecy = $this->prophesize(GetResponseEvent::class);
         $eventProphecy->getRequest()->willReturn($request)->shouldBeCalled();
 
-        $this->queryParameterValidor->validateFilters(Dummy::class, ['some_inexistent_filter'], $request)->shouldBeCalled();
+        $this->queryParameterValidor->validateFilters(Dummy::class, ['some_inexistent_filter'], [])->shouldBeCalled();
 
         $this->assertNull(
             $this->testedInstance->onKernelRequest($eventProphecy->reveal())
@@ -80,7 +80,7 @@ public function testOnKernelRequestWithRequiredFilterNotSet()
         $eventProphecy->getRequest()->willReturn($request)->shouldBeCalled();
 
         $this->queryParameterValidor
-            ->validateFilters(Dummy::class, ['some_filter'], $request)
+            ->validateFilters(Dummy::class, ['some_filter'], [])
             ->shouldBeCalled()
             ->willThrow(new FilterValidationException(['Query parameter "required" is required']))
         ;
@@ -97,17 +97,20 @@ public function testOnKernelRequestWithRequiredFilter()
         $this->setUpWithFilters(['some_filter']);
 
         $request = new Request(
-            ['required' => 'foo'],
             [],
-            ['_api_resource_class' => Dummy::class, '_api_collection_operation_name' => 'get']
+            [],
+            ['_api_resource_class' => Dummy::class, '_api_collection_operation_name' => 'get'],
+            [],
+            [],
+            ['QUERY_STRING' => 'required=foo']
         );
         $request->setMethod('GET');
 
         $eventProphecy = $this->prophesize(GetResponseEvent::class);
         $eventProphecy->getRequest()->willReturn($request)->shouldBeCalled();
 
         $this->queryParameterValidor
-            ->validateFilters(Dummy::class, ['some_filter'], $request)
+            ->validateFilters(Dummy::class, ['some_filter'], ['required' => 'foo'])
             ->shouldBeCalled()
         ;
 

diff --git a/tests/Filter/QueryParameterValidatorTest.php b/tests/Filter/QueryParameterValidatorTest.php
@@ -19,7 +19,6 @@
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Dummy;
 use PHPUnit\Framework\TestCase;
 use Psr\Container\ContainerInterface;
-use Symfony\Component\HttpFoundation\Request;
 
 /**
  * Class QueryParameterValidatorTest.
@@ -45,7 +44,7 @@ public function setUp()
      */
     public function testOnKernelRequestWithUnsafeMethod()
     {
-        $request = new Request();
+        $request = [];
 
         $this->assertNull(
             $this->testedInstance->validateFilters(Dummy::class, [], $request)
@@ -57,7 +56,7 @@ public function testOnKernelRequestWithUnsafeMethod()
      */
     public function testOnKernelRequestWithWrongFilter()
     {
-        $request = new Request();
+        $request = [];
 
         $this->assertNull(
             $this->testedInstance->validateFilters(Dummy::class, ['some_inexistent_filter'], $request)
@@ -69,7 +68,7 @@ public function testOnKernelRequestWithWrongFilter()
      */
     public function testOnKernelRequestWithRequiredFilterNotSet()
     {
-        $request = new Request();
+        $request = [];
 
         $filterProphecy = $this->prophesize(FilterInterface::class);
         $filterProphecy
@@ -102,9 +101,7 @@ public function testOnKernelRequestWithRequiredFilterNotSet()
      */
     public function testOnKernelRequestWithRequiredFilter()
     {
-        $request = new Request(
-            ['required' => 'foo']
-        );
+        $request = ['required' => 'foo'];
 
         $this->filterLocatorProphecy
             ->has('some_filter')