Merge pull request #1198 from dunglas/validator_service

Allow to use a service for dynamic validation groups

Author: dunglas

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

@@ -13,6 +13,7 @@
         <service id="api_platform.listener.view.validate" class="ApiPlatform\Core\Bridge\Symfony\Validator\EventListener\ValidateListener">
             <argument type="service" id="validator" />
             <argument type="service" id="api_platform.metadata.resource.metadata_factory" />
+            <argument type="service" id="service_container" />
 
             <tag name="kernel.event_listener" event="kernel.view" method="onKernelView" priority="64" />
         </service>

src/Bridge/Symfony/Validator/EventListener/ValidateListener.php

@@ -16,6 +16,7 @@
 use ApiPlatform\Core\Bridge\Symfony\Validator\Exception\ValidationException;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
 use ApiPlatform\Core\Util\RequestAttributesExtractor;
+use Psr\Container\ContainerInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent;
 use Symfony\Component\Validator\Validator\ValidatorInterface;
@@ -29,11 +30,13 @@ final class ValidateListener
 {
     private $validator;
     private $resourceMetadataFactory;
+    private $container;
 
-    public function __construct(ValidatorInterface $validator, ResourceMetadataFactoryInterface $resourceMetadataFactory)
+    public function __construct(ValidatorInterface $validator, ResourceMetadataFactoryInterface $resourceMetadataFactory, ContainerInterface $container = null)
     {
         $this->validator = $validator;
         $this->resourceMetadataFactory = $resourceMetadataFactory;
+        $this->container = $container;
     }
 
     /**
@@ -69,7 +72,14 @@ public function onKernelView(GetResponseForControllerResultEvent $event)
             $validationGroups = $resourceMetadata->getAttributes()['validation_groups'] ?? null;
         }
 
-        if (is_callable($validationGroups)) {
+        if (
+            $this->container &&
+            $this->container->has($validationGroups) &&
+            ($service = $this->container->get($validationGroups)) &&
+            is_callable($service)
+        ) {
+            $validationGroups = $service($data);
+        } elseif (is_callable($validationGroups)) {
             $validationGroups = call_user_func_array($validationGroups, [$data]);
         }
 

tests/Bridge/Symfony/Validator/EventListener/ValidateListenerTest.php

@@ -17,6 +17,7 @@
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
 use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
 use ApiPlatform\Core\Tests\Fixtures\DummyEntity;
+use Psr\Container\ContainerInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
@@ -63,6 +64,49 @@ public function testValidatorIsCalled()
         $validationViewListener->onKernelView($event);
     }
 
+    public function testGetGroupsFromCallable()
+    {
+        $data = new DummyEntity();
+        $expectedValidationGroups = ['a', 'b', 'c'];
+
+        $validatorProphecy = $this->prophesize(ValidatorInterface::class);
+        $validatorProphecy->validate($data, null, $expectedValidationGroups)->shouldBeCalled();
+        $validator = $validatorProphecy->reveal();
+
+        $closure = function ($data) use ($expectedValidationGroups): array {
+            return $data instanceof DummyEntity ? $expectedValidationGroups : [];
+        };
+
+        list($resourceMetadataFactory, $event) = $this->createEventObject($closure, $data);
+
+        $validationViewListener = new ValidateListener($validator, $resourceMetadataFactory);
+        $validationViewListener->onKernelView($event);
+    }
+
+    public function testGetGroupsFromService()
+    {
+        $data = new DummyEntity();
+
+        $validatorProphecy = $this->prophesize(ValidatorInterface::class);
+        $validatorProphecy->validate($data, null, ['a', 'b', 'c'])->shouldBeCalled();
+        $validator = $validatorProphecy->reveal();
+
+        list($resourceMetadataFactory, $event) = $this->createEventObject('groups_builder', $data);
+
+        $containerProphecy = $this->prophesize(ContainerInterface::class);
+        $containerProphecy->has('groups_builder')->willReturn(true)->shouldBeCalled();
+        $containerProphecy->get('groups_builder')->willReturn(new class() {
+            public function __invoke($data): array
+            {
+                return $data instanceof DummyEntity ? ['a', 'b', 'c'] : [];
+            }
+        }
+        )->shouldBeCalled();
+
+        $validationViewListener = new ValidateListener($validator, $resourceMetadataFactory, $containerProphecy->reveal());
+        $validationViewListener->onKernelView($event);
+    }
+
     public function testDoNotCallWhenReceiveFlagIsFalse()
     {
         $data = new DummyEntity();
@@ -100,19 +144,10 @@ public function testThrowsValidationExceptionWithViolationsFound()
         $validationViewListener->onKernelView($event);
     }
 
-    /**
-     * @param array $expectedValidationGroups
-     * @param mixed $data
-     * @param bool  $receive
-     *
-     * @return array
-     */
-    private function createEventObject($expectedValidationGroups, $data, bool $receive = true)
+    private function createEventObject($expectedValidationGroups, $data, bool $receive = true): array
     {
         $resourceMetadata = new ResourceMetadata(null, null, null, [
-            'create' => [
-                'validation_groups' => $expectedValidationGroups,
-            ],
+            'create' => ['validation_groups' => $expectedValidationGroups],
         ]);
 
         $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);