remove dependency on validator

Author: jdeniau

features/filter/filter_validation.feature

@@ -2,14 +2,14 @@ Feature: Validate filters based upon filter description
 
   @createSchema
   Scenario: Required filter should not throw an error if set
-    When I am on "/filter_validators?foo=bar"
+    When I am on "/filter_validators?required=foo"
     Then the response status code should be 200
 
-    When I am on "/filter_validators?foo="
+    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 `foo` is required"
+    And the JSON node "detail" should be equal to 'Query parameter "required" is required'

src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php

@@ -13,6 +13,7 @@
 
 namespace ApiPlatform\Core\Bridge\Symfony\Bundle\DependencyInjection;
 
+use ApiPlatform\Core\Exception\FilterValidationException;
 use ApiPlatform\Core\Exception\InvalidArgumentException;
 use FOS\UserBundle\FOSUserBundle;
 use GraphQL\GraphQL;
@@ -248,6 +249,7 @@ private function addExceptionToStatusSection(ArrayNodeDefinition $rootNode)
                     ->defaultValue([
                         ExceptionInterface::class => Response::HTTP_BAD_REQUEST,
                         InvalidArgumentException::class => Response::HTTP_BAD_REQUEST,
+                        FilterValidationException::class => Response::HTTP_BAD_REQUEST,
                     ])
                     ->info('The list of exceptions mapped to their HTTP status code.')
                     ->normalizeKeys(false)

src/Bridge/Symfony/Bundle/Resources/config/validator.xml

@@ -25,7 +25,6 @@
 
         <service id="ApiPlatform\Core\Filter\QueryParameterValidateListener">
             <argument type="service" id="api_platform.metadata.resource.metadata_factory" />
-            <argument type="service" id="validator" />
             <argument type="service" id="api_platform.filter_locator" />
 
             <tag name="kernel.event_listener" event="kernel.request" method="onKernelRequest" priority="16" />

src/Exception/FilterValidationException.php

@@ -0,0 +1,36 @@
+<?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\Exception;
+
+/**
+ * Filter validation exception.
+ *
+ * @author Julien DENIAU <[email protected]>
+ */
+class FilterValidationException extends \Exception implements ExceptionInterface
+{
+    private $constraintViolationList;
+
+    public function __construct(array $constraintViolationList, string $message = '', int $code = 0, \Exception $previous = null)
+    {
+        $this->constraintViolationList = $constraintViolationList;
+
+        parent::__construct($message ?: $this->__toString(), $code, $previous);
+    }
+
+    public function __toString(): string
+    {
+        return implode("\n", $this->constraintViolationList);
+    }
+}

src/Filter/QueryParameterValidateListener.php

@@ -14,15 +14,14 @@
 namespace ApiPlatform\Core\Filter;
 
 use ApiPlatform\Core\Api\FilterLocatorTrait;
-use ApiPlatform\Core\Bridge\Symfony\Validator\Exception\ValidationException;
+use ApiPlatform\Core\Exception\FilterValidationException;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
 use ApiPlatform\Core\Util\RequestAttributesExtractor;
+use Psr\Container\ContainerInterface;
 use Symfony\Component\HttpKernel\Event\GetResponseEvent;
-use Symfony\Component\Validator\Constraints as Assert;
-use Symfony\Component\Validator\Validator\ValidatorInterface as SymfonyValidatorInterface;
 
 /**
- * Validate query parameters depending on filter description.
+ * Validates query parameters depending on filter description.
  *
  * @author Julien Deniau <[email protected]>
  */
@@ -32,12 +31,9 @@ class QueryParameterValidateListener
 
     private $resourceMetadataFactory;
 
-    private $validator;
-
-    public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, SymfonyValidatorInterface $validator, $filterLocator)
+    public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, ContainerInterface $filterLocator)
     {
         $this->resourceMetadataFactory = $resourceMetadataFactory;
-        $this->validator = $validator;
         $this->setFilterLocator($filterLocator);
     }
 
@@ -62,14 +58,14 @@ public function onKernelRequest(GetResponseEvent $event)
             }
 
             foreach ($filter->getDescription($attributes['resource_class']) as $name => $data) {
-                if ($data['required'] ?? false) {
-                    $requiredConstraint = new Assert\NotNull();
-                    $requiredConstraint->message = sprintf('query parameter `%s` is required', $name);
-                    $errorList = $this->validator->validate($request->query->get($name), $requiredConstraint);
+                $errorList = [];
+
+                if (($data['required'] ?? false) && null === $request->query->get($name)) {
+                    $errorList[] = sprintf('Query parameter "%s" is required', $name);
+                }
 
-                    if (count($errorList) > 0) {
-                        throw new ValidationException($errorList);
-                    }
+                if ($errorList) {
+                    throw new FilterValidationException($errorList);
                 }
             }
         }

tests/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtensionTest.php

@@ -28,6 +28,7 @@
 use ApiPlatform\Core\DataProvider\CollectionDataProviderInterface;
 use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
 use ApiPlatform\Core\DataProvider\SubresourceDataProviderInterface;
+use ApiPlatform\Core\Exception\FilterValidationException;
 use ApiPlatform\Core\Exception\InvalidArgumentException;
 use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
 use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
@@ -451,7 +452,11 @@ private function getPartialContainerBuilderProphecy($test = false)
             'api_platform.description' => 'description',
             'api_platform.error_formats' => ['jsonproblem' => ['application/problem+json'], 'jsonld' => ['application/ld+json']],
             'api_platform.formats' => ['jsonld' => ['application/ld+json'], 'jsonhal' => ['application/hal+json']],
-            'api_platform.exception_to_status' => [ExceptionInterface::class => Response::HTTP_BAD_REQUEST, InvalidArgumentException::class => Response::HTTP_BAD_REQUEST],
+            'api_platform.exception_to_status' => [
+                ExceptionInterface::class => Response::HTTP_BAD_REQUEST,
+                InvalidArgumentException::class => Response::HTTP_BAD_REQUEST,
+                FilterValidationException::class => Response::HTTP_BAD_REQUEST,
+            ],
             'api_platform.title' => 'title',
             'api_platform.version' => 'version',
             'api_platform.allow_plain_identifiers' => false,

tests/Bridge/Symfony/Bundle/DependencyInjection/ConfigurationTest.php

@@ -14,6 +14,7 @@
 namespace ApiPlatform\Core\Tests\Bridge\Symfony\Bundle\DependencyInjection;
 
 use ApiPlatform\Core\Bridge\Symfony\Bundle\DependencyInjection\Configuration;
+use ApiPlatform\Core\Exception\FilterValidationException;
 use ApiPlatform\Core\Exception\InvalidArgumentException;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
@@ -67,6 +68,7 @@ public function testDefaultConfig()
             'exception_to_status' => [
                 ExceptionInterface::class => Response::HTTP_BAD_REQUEST,
                 InvalidArgumentException::class => Response::HTTP_BAD_REQUEST,
+                FilterValidationException::class => Response::HTTP_BAD_REQUEST,
             ],
             'default_operation_path_resolver' => 'api_platform.operation_path_resolver.underscore',
             'path_segment_name_generator' => 'api_platform.path_segment_name_generator.underscore',

tests/Fixtures/TestBundle/Entity/FilterValidator.php

@@ -15,8 +15,7 @@
 
 use ApiPlatform\Core\Annotation\ApiProperty;
 use ApiPlatform\Core\Annotation\ApiResource;
-use ApiPlatform\Core\Tests\Fixtures\TestBundle\Filter\NotRequiredBarFilter;
-use ApiPlatform\Core\Tests\Fixtures\TestBundle\Filter\RequiredFooFilter;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Filter\RequiredFilter;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
@@ -26,8 +25,7 @@
  *
  * @ApiResource(attributes={
  *     "filters"={
- *         NotRequiredBarFilter::class,
- *         RequiredFooFilter::class
+ *         RequiredFilter::class
  *     }
  * })
  * @ORM\Entity

tests/Fixtures/TestBundle/Filter/NotRequiredBarFilter.php renamed to tests/Fixtures/TestBundle/Filter/RequiredFilter.php

@@ -17,7 +17,7 @@
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
 use Doctrine\ORM\QueryBuilder;
 
-class NotRequiredBarFilter extends AbstractFilter
+class RequiredFilter extends AbstractFilter
 {
     protected function filterProperty(string $property, $value, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null)
     {
@@ -27,8 +27,13 @@ protected function filterProperty(string $property, $value, QueryBuilder $queryB
     public function getDescription(string $resourceClass): array
     {
         return [
-            'bar' => [
-                'property' => 'bar',
+            'required' => [
+                'property' => 'required',
+                'type' => 'string',
+                'required' => true,
+            ],
+            'not-required' => [
+                'property' => 'not-required',
                 'type' => 'string',
                 'required' => false,
             ],