fix issue with array notation filter name

Author: jdeniau

features/filter/filter_validation.feature

@@ -8,8 +8,32 @@ Feature: Validate filters based upon filter description
     When I am on "/filter_validators?required="
     Then the response status code should be 200
 
-  @dropSchema
   Scenario: Required filter should throw an error if not set
     When I am on "/filter_validators"
     Then the response status code should be 400
     And the JSON node "detail" should be equal to 'Query parameter "required" is required'
+
+  Scenario: Required filter should not throw an error if set
+    When I am on "/array_filter_validators?arrayRequired[]=foo&indexedArrayRequired[foo]=foo"
+    Then the response status code should be 200
+
+  Scenario: Required filter should throw an error if not set
+    When I am on "/array_filter_validators"
+    Then the response status code should be 400
+    And the JSON node "detail" should be equal to 'Query parameter "arrayRequired[]" is required'
+
+    When I am on "/array_filter_validators?arrayRequired=foo&indexedArrayRequired[foo]=foo"
+    Then the response status code should be 400
+    And the JSON node "detail" should be equal to 'Query parameter "arrayRequired[]" is required'
+
+    When I am on "/array_filter_validators?arrayRequired[foo]=foo"
+    Then the response status code should be 400
+    And the JSON node "detail" should be equal to 'Query parameter "arrayRequired[]" is required'
+
+    When I am on "/array_filter_validators?arrayRequired[]=foo"
+    Then the response status code should be 400
+    And the JSON node "detail" should be equal to 'Query parameter "indexedArrayRequired[foo]" is required'
+
+    When I am on "/array_filter_validators?arrayRequired[]=foo&indexedArrayRequired[bar]=bar"
+    Then the response status code should be 400
+    And the JSON node "detail" should be equal to 'Query parameter "indexedArrayRequired[foo]" is required'

src/Filter/QueryParameterValidateListener.php

@@ -60,7 +60,15 @@ public function onKernelRequest(GetResponseEvent $event)
             foreach ($filter->getDescription($attributes['resource_class']) as $name => $data) {
                 $errorList = [];
 
-                if (($data['required'] ?? false) && null === $request->query->get($name)) {
+                if (!($data['required'] ?? false)) { // property is not required
+                    continue;
+                }
+
+                if (false !== strpos($name, '[')) { // array notation of filter
+                    if (!$this->isArrayNotationFilterValid($name, $request)) {
+                        $errorList[] = sprintf('Query parameter "%s" is required', $name);
+                    }
+                } elseif (null === $request->query->get($name)) {
                     $errorList[] = sprintf('Query parameter "%s" is required', $name);
                 }
 
@@ -70,4 +78,15 @@ public function onKernelRequest(GetResponseEvent $event)
             }
         }
     }
+
+    private function isArrayNotationFilterValid($name, $request): bool
+    {
+        $matches = [];
+        preg_match('/([^[]+)\[(.*)\]/', $name, $matches);
+        list(, $rootName, $keyName) = $matches;
+        $keyName = $keyName ?: 0; // array without index should test the first key
+        $queryParameter = $request->query->get($rootName);
+
+        return is_array($queryParameter) && isset($queryParameter[$keyName]);
+    }
 }

tests/Fixtures/TestBundle/Entity/ArrayFilterValidator.php

@@ -0,0 +1,71 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * 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\Core\Tests\Fixtures\TestBundle\Entity;
+
+use ApiPlatform\Core\Annotation\ApiProperty;
+use ApiPlatform\Core\Annotation\ApiResource;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Filter\ArrayRequiredFilter;
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * Filter Validator entity.
+ *
+ * @author Julien Deniau <[email protected]>
+ *
+ * @ApiResource(attributes={
+ *     "filters"={
+ *         ArrayRequiredFilter::class
+ *     }
+ * })
+ * @ORM\Entity
+ */
+class ArrayFilterValidator
+{
+    /**
+     * @var int The id
+     *
+     * @ORM\Column(type="integer")
+     * @ORM\Id
+     * @ORM\GeneratedValue(strategy="AUTO")
+     */
+    private $id;
+
+    /**
+     * @var string A name
+     *
+     * @ORM\Column
+     * @ApiProperty(iri="http://schema.org/name")
+     */
+    private $name;
+
+    public function getId()
+    {
+        return $this->id;
+    }
+
+    public function setId($id)
+    {
+        $this->id = $id;
+    }
+
+    public function setName($name)
+    {
+        $this->name = $name;
+    }
+
+    public function getName()
+    {
+        return $this->name;
+    }
+}

tests/Fixtures/TestBundle/Filter/ArrayRequiredFilter.php

@@ -0,0 +1,42 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * 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\Core\Tests\Fixtures\TestBundle\Filter;
+
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\AbstractFilter;
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
+use Doctrine\ORM\QueryBuilder;
+
+class ArrayRequiredFilter extends AbstractFilter
+{
+    protected function filterProperty(string $property, $value, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null)
+    {
+    }
+
+    // This function is only used to hook in documentation generators (supported by Swagger and Hydra)
+    public function getDescription(string $resourceClass): array
+    {
+        return [
+            'arrayRequired[]' => [
+                'property' => 'arrayRequired',
+                'type' => 'string',
+                'required' => true,
+            ],
+            'indexedArrayRequired[foo]' => [
+                'property' => 'indexedArrayRequired',
+                'type' => 'string',
+                'required' => true,
+            ],
+        ];
+    }
+}

tests/Fixtures/app/config/config_test.yml

@@ -169,6 +169,10 @@ services:
         arguments: [ '@doctrine' ]
         tags: [ 'api_platform.filter' ]
 
+    ApiPlatform\Core\Tests\Fixtures\TestBundle\Filter\ArrayRequiredFilter:
+        arguments: [ '@doctrine' ]
+        tags: [ 'api_platform.filter' ]
+
     app.config_dummy_resource.action:
         class: 'ApiPlatform\Core\Tests\Fixtures\TestBundle\Action\ConfigCustom'
         arguments: ['@api_platform.item_data_provider']