bug #34464 [Form] group constraints when calling the validator (nicolas-grekas)

nicolas-grekas · nicolas-grekas · commit 2c1b1bad6ed2 · 2019-11-21T08:01:17.000+01:00
This PR was merged into the 4.4 branch. Discussion ---------- [Form] group constraints when calling the validator | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - Follow up of #34081 Spotted during the workshop at SymfonyCon, while trying to fix deprecation notices on symfony-demo: the Form component currently passes constraints one by one for validation, effectively preventing the validator from taking care of cross-constraints dependencies. This PR fixes it. This will prevent ppl from having to fix things like > Using the "Symfony\Component\Validator\Constraints\Length" constraint with the "min" option without setting the "allowEmptyString" one is deprecated and defaults to true. In 5.0, it will become optional and default to false. Commits ------- d15f77f [Form] group constraints when calling the validator
diff --git a/src/Symfony/Component/Form/Extension/Validator/Constraints/FormValidator.php b/src/Symfony/Component/Form/Extension/Validator/Constraints/FormValidator.php
@@ -76,6 +76,8 @@ public function validate($form, Constraint $formConstraint)
                     }
                 }
             } else {
+                $groupedConstraints = [];
+
                 foreach ($constraints as $constraint) {
                     // For the "Valid" constraint, validate the data in all groups
                     if ($constraint instanceof Valid) {
@@ -88,7 +90,7 @@ public function validate($form, Constraint $formConstraint)
                     // matching group
                     foreach ($groups as $group) {
                         if (\in_array($group, $constraint->groups)) {
-                            $validator->atPath('data')->validate($form->getData(), $constraint, $group);
+                            $groupedConstraints[$group][] = $constraint;
 
                             // Prevent duplicate validation
                             if (!$constraint instanceof Composite) {
@@ -97,6 +99,10 @@ public function validate($form, Constraint $formConstraint)
                         }
                     }
                 }
+
+                foreach ($groupedConstraints as $group => $constraint) {
+                    $validator->atPath('data')->validate($form->getData(), $constraint, $group);
+                }
             }
         } elseif (!$form->isSynchronized()) {
             $childrenSynchronized = true;
diff --git a/src/Symfony/Component/Form/Tests/Extension/Validator/Constraints/FormValidatorTest.php b/src/Symfony/Component/Form/Tests/Extension/Validator/Constraints/FormValidatorTest.php
@@ -26,6 +26,7 @@
 use Symfony\Component\Translation\IdentityTranslator;
 use Symfony\Component\Validator\Constraints\Collection;
 use Symfony\Component\Validator\Constraints\GroupSequence;
+use Symfony\Component\Validator\Constraints\Length;
 use Symfony\Component\Validator\Constraints\NotBlank;
 use Symfony\Component\Validator\Constraints\NotNull;
 use Symfony\Component\Validator\Constraints\Valid;
@@ -77,10 +78,11 @@ public function testValidateConstraints()
         $object = new \stdClass();
         $constraint1 = new NotNull(['groups' => ['group1', 'group2']]);
         $constraint2 = new NotBlank(['groups' => 'group2']);
+        $constraint3 = new Length(['groups' => 'group2', 'min' => 3]);
 
         $options = [
             'validation_groups' => ['group1', 'group2'],
-            'constraints' => [$constraint1, $constraint2],
+            'constraints' => [$constraint1, $constraint2, $constraint3],
         ];
         $form = $this->getCompoundForm($object, $options);
         $form->submit([]);
@@ -89,8 +91,8 @@ public function testValidateConstraints()
         $this->expectValidateAt(0, 'data', $object, ['group1', 'group2']);
 
         // Then custom constraints
-        $this->expectValidateValueAt(1, 'data', $object, $constraint1, 'group1');
-        $this->expectValidateValueAt(2, 'data', $object, $constraint2, 'group2');
+        $this->expectValidateValueAt(1, 'data', $object, [$constraint1], 'group1');
+        $this->expectValidateValueAt(2, 'data', $object, [$constraint2, $constraint3], 'group2');
 
         $this->validator->validate($form, new Form());
 
@@ -172,8 +174,8 @@ public function testValidateConstraintsOptionEvenIfNoValidConstraint()
         $parent->add($form);
         $parent->submit([]);
 
-        $this->expectValidateValueAt(0, 'data', $object, $constraint1, 'group1');
-        $this->expectValidateValueAt(1, 'data', $object, $constraint2, 'group2');
+        $this->expectValidateValueAt(0, 'data', $object, [$constraint1], 'group1');
+        $this->expectValidateValueAt(1, 'data', $object, [$constraint2], 'group2');
 
         $this->validator->validate($form, new Form());
 

Original file line number	Diff line number	Diff line change
`@@ -76,6 +76,8 @@ public function validate($form, Constraint $formConstraint)`
`76`	`76`	`}`
`77`	`77`	`}`
`78`	`78`	`} else {`
	`79`	`+ $groupedConstraints = [];`
	`80`	`+`
`79`	`81`	`foreach ($constraints as $constraint) {`
`80`	`82`	`// For the "Valid" constraint, validate the data in all groups`
`81`	`83`	`if ($constraint instanceof Valid) {`
`@@ -88,7 +90,7 @@ public function validate($form, Constraint $formConstraint)`
`88`	`90`	`// matching group`
`89`	`91`	`foreach ($groups as $group) {`
`90`	`92`	`if (\in_array($group, $constraint->groups)) {`
`91`		`- $validator->atPath('data')->validate($form->getData(), $constraint, $group);`
	`93`	`+ $groupedConstraints[$group][] = $constraint;`
`92`	`94`
`93`	`95`	`// Prevent duplicate validation`
`94`	`96`	`if (!$constraint instanceof Composite) {`
`@@ -97,6 +99,10 @@ public function validate($form, Constraint $formConstraint)`
`97`	`99`	`}`
`98`	`100`	`}`
`99`	`101`	`}`
	`102`	`+`
	`103`	`+ foreach ($groupedConstraints as $group => $constraint) {`
	`104`	`+ $validator->atPath('data')->validate($form->getData(), $constraint, $group);`
	`105`	`+ }`
`100`	`106`	`}`
`101`	`107`	`} elseif (!$form->isSynchronized()) {`
`102`	`108`	`$childrenSynchronized = true;`