fix(validator): handle nested groups and group sequences

.php-cs-fixer.dist.php

@@ -48,6 +48,7 @@
         ],
         'array_indentation' => true,
         'compact_nullable_typehint' => true,
+        'declare_strict_types' => true,
         'doctrine_annotation_array_assignment' => [
             'operator' => '=',
         ],
@@ -123,4 +124,3 @@
         new SymfonyServiceClassConstantFixer(),
     ])
     ->setFinder($finder);
-

src/Symfony/Tests/Validator/Metadata/Property/ValidatorPropertyMetadataFactoryTest.php

@@ -49,6 +49,7 @@
 use Prophecy\PhpUnit\ProphecyTrait;
 use Symfony\Component\PropertyInfo\Type as LegacyType;
 use Symfony\Component\TypeInfo\Type;
+use Symfony\Component\Validator\Constraints\GroupSequence;
 use Symfony\Component\Validator\Constraints\Hostname;
 use Symfony\Component\Validator\Constraints\Ulid;
 use Symfony\Component\Validator\Mapping\ClassMetadata;
@@ -198,6 +199,29 @@ public function testCreateWithPropertyWithRightValidationGroupsAndRequiredConstr
         $this->assertEquals($expectedPropertyMetadata, $resultedPropertyMetadata);
     }
 
+    public function testCreateWithPropertyWithGroupSequenceValidationGroupsAndRequiredConstraints(): void
+    {
+        $propertyMetadata = (new ApiProperty())->withDescription('A dummy group')->withReadable(true)->withWritable(true);
+        $expectedPropertyMetadata = $propertyMetadata->withRequired(true);
+
+        $groups = [new GroupSequence(['dummy'])];
+
+        $decoratedPropertyMetadataFactory = $this->prophesize(PropertyMetadataFactoryInterface::class);
+        $decoratedPropertyMetadataFactory->create(DummyValidatedEntity::class, 'dummyGroup', ['validation_groups' => $groups])->willReturn($propertyMetadata)->shouldBeCalled();
+
+        $validatorMetadataFactory = $this->prophesize(MetadataFactoryInterface::class);
+        $validatorMetadataFactory->getMetadataFor(DummyValidatedEntity::class)->willReturn($this->validatorClassMetadata)->shouldBeCalled();
+
+        $validatorPropertyMetadataFactory = new ValidatorPropertyMetadataFactory(
+            $validatorMetadataFactory->reveal(),
+            $decoratedPropertyMetadataFactory->reveal(),
+            []
+        );
+        $resultedPropertyMetadata = $validatorPropertyMetadataFactory->create(DummyValidatedEntity::class, 'dummyGroup', ['validation_groups' => $groups]);
+
+        $this->assertEquals($expectedPropertyMetadata, $resultedPropertyMetadata);
+    }
+
     public function testCreateWithPropertyWithBadValidationGroupsAndRequiredConstraints(): void
     {
         $propertyMetadata = (new ApiProperty())->withDescription('A dummy group')->withReadable(true)->withWritable(true);

src/Symfony/Validator/Metadata/Property/ValidatorPropertyMetadataFactory.php

@@ -156,16 +156,16 @@ private function getValidationGroups(ValidatorClassMetadataInterface $classMetad
     {
         if (isset($options['validation_groups'])) {
             if ($options['validation_groups'] instanceof GroupSequence) {
-                return $this->getGroupSequenceValidationGroups($options['validation_groups']);
+                return $this->flattenValidationGroups($options['validation_groups']->groups);
             }
 
-            if (!\is_callable($options['validation_groups'])) {
-                return $options['validation_groups'];
+            if (\is_array($options['validation_groups']) && !\is_callable($options['validation_groups'])) {
+                return $this->flattenValidationGroups($options['validation_groups']);
             }
         }
 
         if ($classMetadata->hasGroupSequence()) {
-            return $this->getGroupSequenceValidationGroups($classMetadata->getGroupSequence());
+            return $this->flattenValidationGroups($classMetadata->getGroupSequence()->groups);
         }
 
         if (!method_exists($classMetadata, 'getDefaultGroup')) {
@@ -176,22 +176,24 @@ private function getValidationGroups(ValidatorClassMetadataInterface $classMetad
     }
 
     /**
-     * @return array<string>
+     * @param array<string|string[]|GroupSequence> $groups
+     *
+     * @return string[]
      */
-    private function getGroupSequenceValidationGroups(GroupSequence $groupSequence): array
+    private function flattenValidationGroups(array $groups): array
     {
-        $groups = [];
-        foreach ($groupSequence->groups as $subGroup) {
-            if (\is_array($subGroup)) {
-                $groups[] = $subGroup;
-            } elseif ($subGroup instanceof GroupSequence) {
-                $groups[] = $this->getGroupSequenceValidationGroups($subGroup);
+        $flattenGroups = [];
+        foreach ($groups as $group) {
+            if (\is_array($group)) {
+                $flattenGroups[] = $this->flattenValidationGroups($group);
+            } elseif ($group instanceof GroupSequence) {
+                $flattenGroups[] = $this->flattenValidationGroups($group->groups);
             } else {
-                $groups[] = [$subGroup];
+                $flattenGroups[] = [$group];
             }
         }
 
-        return array_merge([], ...$groups);
+        return array_merge([], ...$flattenGroups);
     }
 
     /**