bug #36343 [Form] Fixed handling groups sequence validation (HeahDude)
This PR was merged into the 3.4 branch.
Discussion
----------
[Form] Fixed handling groups sequence validation
| Q | A
| ------------- | ---
| Branch? | 3.4
| Bug fix? | yes
| New feature? | no
| Deprecations? | no
| Tickets | FIx https://github.com/symfony/symfony/issues/9939#issuecomment-607459505, Fix #35556
| License | MIT
| Doc PR | ~
This is not the same as the original issue fixed by #36245, that was reported in https://github.com/symfony/symfony/issues/9939#issuecomment-607459505.
The form also fails to cascade sequence validation properly because each nested field is validated against the sequence, and one can fail at a step independently from another which could failed in another step. I've added a lot of tests to ensure this is working properly and tested in a website skeleton too.
This PR aims to close #35556 which tries to fix the same issue but afterwards in its implementation as said in https://github.com/symfony/symfony/pull/35556#discussion_r379289230.
Commits
-------
dfb61c204c
[Form] Fixed handling groups sequence validation
This commit is contained in:
commit
0f1a5c452e
@ -24,6 +24,8 @@ use Symfony\Component\Validator\Exception\UnexpectedTypeException;
|
||||
*/
|
||||
class FormValidator extends ConstraintValidator
|
||||
{
|
||||
private $resolvedGroups;
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
@ -44,42 +46,68 @@ class FormValidator extends ConstraintValidator
|
||||
|
||||
if ($form->isSubmitted() && $form->isSynchronized()) {
|
||||
// Validate the form data only if transformation succeeded
|
||||
$groups = self::getValidationGroups($form);
|
||||
$groups = $this->getValidationGroups($form);
|
||||
|
||||
if (!$groups) {
|
||||
return;
|
||||
}
|
||||
|
||||
$data = $form->getData();
|
||||
|
||||
// Validate the data against its own constraints
|
||||
if ($form->isRoot() && (\is_object($data) || \is_array($data))) {
|
||||
if (($groups && \is_array($groups)) || ($groups instanceof GroupSequence && $groups->groups)) {
|
||||
$validator->atPath('data')->validate($form->getData(), null, $groups);
|
||||
}
|
||||
}
|
||||
$validateDataGraph = $form->isRoot()
|
||||
&& (\is_object($data) || \is_array($data))
|
||||
&& (($groups && \is_array($groups)) || ($groups instanceof GroupSequence && $groups->groups))
|
||||
;
|
||||
|
||||
// Validate the data against the constraints defined
|
||||
// in the form
|
||||
// Validate the data against the constraints defined in the form
|
||||
/** @var Constraint[] $constraints */
|
||||
$constraints = $config->getOption('constraints', []);
|
||||
|
||||
if ($groups instanceof GroupSequence) {
|
||||
$validator->atPath('data')->validate($form->getData(), $constraints, $groups);
|
||||
// Otherwise validate a constraint only once for the first
|
||||
// matching group
|
||||
foreach ($groups as $group) {
|
||||
if (\in_array($group, $formConstraint->groups)) {
|
||||
$validator->atPath('data')->validate($form->getData(), $formConstraint, $group);
|
||||
if (\count($this->context->getViolations()) > 0) {
|
||||
break;
|
||||
// Validate the data, the form AND nested fields in sequence
|
||||
$violationsCount = $this->context->getViolations()->count();
|
||||
$fieldPropertyPath = \is_object($data) ? 'children[%s]' : 'children%s';
|
||||
$hasChildren = $form->count() > 0;
|
||||
$this->resolvedGroups = $hasChildren ? new \SplObjectStorage() : null;
|
||||
|
||||
foreach ($groups->groups as $group) {
|
||||
if ($validateDataGraph) {
|
||||
$validator->atPath('data')->validate($data, null, $group);
|
||||
}
|
||||
|
||||
if ($groupedConstraints = self::getConstraintsInGroups($constraints, $group)) {
|
||||
$validator->atPath('data')->validate($data, $groupedConstraints, $group);
|
||||
}
|
||||
|
||||
foreach ($form->all() as $field) {
|
||||
if ($field->isSubmitted()) {
|
||||
// remember to validate this field is one group only
|
||||
// otherwise resolving the groups would reuse the same
|
||||
// sequence recursively, thus some fields could fail
|
||||
// in different steps without breaking early enough
|
||||
$this->resolvedGroups[$field] = (array) $group;
|
||||
$validator->atPath(sprintf($fieldPropertyPath, $field->getPropertyPath()))->validate($field, $formConstraint);
|
||||
}
|
||||
}
|
||||
|
||||
if ($violationsCount < $this->context->getViolations()->count()) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if ($hasChildren) {
|
||||
// destroy storage at the end of the sequence to avoid memory leaks
|
||||
$this->resolvedGroups = null;
|
||||
}
|
||||
} else {
|
||||
if ($validateDataGraph) {
|
||||
$validator->atPath('data')->validate($data, null, $groups);
|
||||
}
|
||||
|
||||
foreach ($constraints as $constraint) {
|
||||
// For the "Valid" constraint, validate the data in all groups
|
||||
if ($constraint instanceof Valid) {
|
||||
$validator->atPath('data')->validate($form->getData(), $constraint, $groups);
|
||||
$validator->atPath('data')->validate($data, $constraint, $groups);
|
||||
|
||||
continue;
|
||||
}
|
||||
@ -88,7 +116,7 @@ class FormValidator extends ConstraintValidator
|
||||
// matching group
|
||||
foreach ($groups as $group) {
|
||||
if (\in_array($group, $constraint->groups)) {
|
||||
$validator->atPath('data')->validate($form->getData(), $constraint, $group);
|
||||
$validator->atPath('data')->validate($data, $constraint, $group);
|
||||
|
||||
// Prevent duplicate validation
|
||||
if (!$constraint instanceof Composite) {
|
||||
@ -147,7 +175,7 @@ class FormValidator extends ConstraintValidator
|
||||
*
|
||||
* @return string|GroupSequence|(string|GroupSequence)[] The validation groups
|
||||
*/
|
||||
private static function getValidationGroups(FormInterface $form)
|
||||
private function getValidationGroups(FormInterface $form)
|
||||
{
|
||||
// Determine the clicked button of the complete form tree
|
||||
$clickedButton = null;
|
||||
@ -171,6 +199,10 @@ class FormValidator extends ConstraintValidator
|
||||
return self::resolveValidationGroups($groups, $form);
|
||||
}
|
||||
|
||||
if (isset($this->resolvedGroups[$form])) {
|
||||
return $this->resolvedGroups[$form];
|
||||
}
|
||||
|
||||
$form = $form->getParent();
|
||||
} while (null !== $form);
|
||||
|
||||
@ -197,4 +229,11 @@ class FormValidator extends ConstraintValidator
|
||||
|
||||
return (array) $groups;
|
||||
}
|
||||
|
||||
private static function getConstraintsInGroups($constraints, $group)
|
||||
{
|
||||
return array_filter($constraints, static function (Constraint $constraint) use ($group) {
|
||||
return \in_array($group, $constraint->groups, true);
|
||||
});
|
||||
}
|
||||
}
|
||||
|
@ -7,7 +7,7 @@
|
||||
<class name="Symfony\Component\Form\Form">
|
||||
<constraint name="Symfony\Component\Form\Extension\Validator\Constraints\Form" />
|
||||
<property name="children">
|
||||
<constraint name="Valid" />
|
||||
<constraint name="Valid" />
|
||||
</property>
|
||||
</class>
|
||||
</constraint-mapping>
|
||||
|
@ -401,8 +401,8 @@ class FormValidatorTest extends ConstraintValidatorTestCase
|
||||
$form = $this->getCompoundForm($object, $options);
|
||||
$form->submit([]);
|
||||
|
||||
$this->expectValidateAt(0, 'data', $object, new GroupSequence(['group1', 'group2']));
|
||||
$this->expectValidateAt(1, 'data', $object, new GroupSequence(['group1', 'group2']));
|
||||
$this->expectValidateAt(0, 'data', $object, 'group1');
|
||||
$this->expectValidateAt(1, 'data', $object, 'group2');
|
||||
|
||||
$this->validator->validate($form, new Form());
|
||||
|
||||
@ -756,6 +756,39 @@ class FormValidatorTest extends ConstraintValidatorTestCase
|
||||
$this->assertSame('data[field2]', $context->getViolations()[1]->getPropertyPath());
|
||||
}
|
||||
|
||||
public function testCompositeConstraintValidatedInSequence()
|
||||
{
|
||||
$form = $this->getCompoundForm([], [
|
||||
'constraints' => [
|
||||
new Collection([
|
||||
'field1' => new NotBlank([
|
||||
'groups' => ['field1'],
|
||||
]),
|
||||
'field2' => new NotBlank([
|
||||
'groups' => ['field2'],
|
||||
]),
|
||||
]),
|
||||
],
|
||||
'validation_groups' => new GroupSequence(['field1', 'field2']),
|
||||
])
|
||||
->add($this->getForm('field1'))
|
||||
->add($this->getForm('field2'))
|
||||
;
|
||||
|
||||
$form->submit([
|
||||
'field1' => '',
|
||||
'field2' => '',
|
||||
]);
|
||||
|
||||
$context = new ExecutionContext(Validation::createValidator(), $form, new IdentityTranslator());
|
||||
$this->validator->initialize($context);
|
||||
$this->validator->validate($form, new Form());
|
||||
|
||||
$this->assertCount(1, $context->getViolations());
|
||||
$this->assertSame('This value should not be blank.', $context->getViolations()[0]->getMessage());
|
||||
$this->assertSame('data[field1]', $context->getViolations()[0]->getPropertyPath());
|
||||
}
|
||||
|
||||
protected function createValidator()
|
||||
{
|
||||
return new FormValidator();
|
||||
@ -784,7 +817,7 @@ class FormValidatorTest extends ConstraintValidatorTestCase
|
||||
|
||||
private function getCompoundForm($data, array $options = [])
|
||||
{
|
||||
return $this->getBuilder('name', \get_class($data), $options)
|
||||
return $this->getBuilder('name', \is_object($data) ? \get_class($data) : null, $options)
|
||||
->setData($data)
|
||||
->setCompound(true)
|
||||
->setDataMapper(new PropertyPathMapper())
|
||||
|
@ -12,15 +12,19 @@
|
||||
namespace Symfony\Component\Form\Tests\Extension\Validator\Type;
|
||||
|
||||
use Symfony\Component\Form\Extension\Validator\ValidatorExtension;
|
||||
use Symfony\Component\Form\Form;
|
||||
use Symfony\Component\Form\Forms;
|
||||
use Symfony\Component\Form\Test\Traits\ValidatorExtensionTrait;
|
||||
use Symfony\Component\Form\Tests\Extension\Core\Type\FormTypeTest;
|
||||
use Symfony\Component\Form\Tests\Extension\Core\Type\TextTypeTest;
|
||||
use Symfony\Component\Validator\Constraints\Email;
|
||||
use Symfony\Component\Form\Tests\Fixtures\Author;
|
||||
use Symfony\Component\Validator\Constraints\GroupSequence;
|
||||
use Symfony\Component\Validator\Constraints\Length;
|
||||
use Symfony\Component\Validator\Constraints\NotBlank;
|
||||
use Symfony\Component\Validator\Constraints\Valid;
|
||||
use Symfony\Component\Validator\ConstraintViolationList;
|
||||
use Symfony\Component\Validator\Mapping\ClassMetadata;
|
||||
use Symfony\Component\Validator\Mapping\Factory\MetadataFactoryInterface;
|
||||
use Symfony\Component\Validator\Validation;
|
||||
|
||||
class FormTypeValidatorExtensionTest extends BaseValidatorExtensionTest
|
||||
@ -64,14 +68,69 @@ class FormTypeValidatorExtensionTest extends BaseValidatorExtensionTest
|
||||
->add('field', TextTypeTest::TESTED_TYPE, [
|
||||
'constraints' => [
|
||||
new Length(['min' => 10, 'groups' => ['First']]),
|
||||
new Email(['groups' => ['Second']]),
|
||||
new NotBlank(['groups' => ['Second']]),
|
||||
],
|
||||
])
|
||||
;
|
||||
|
||||
$form->submit(['field' => 'wrong']);
|
||||
|
||||
$this->assertCount(1, $form->getErrors(true));
|
||||
$errors = $form->getErrors(true);
|
||||
|
||||
$this->assertCount(1, $errors);
|
||||
$this->assertInstanceOf(Length::class, $errors[0]->getCause()->getConstraint());
|
||||
}
|
||||
|
||||
public function testManyFieldsGroupSequenceWithConstraintsOption()
|
||||
{
|
||||
$formMetadata = new ClassMetadata(Form::class);
|
||||
$authorMetadata = (new ClassMetadata(Author::class))
|
||||
->addPropertyConstraint('firstName', new NotBlank(['groups' => 'Second']))
|
||||
;
|
||||
$metadataFactory = $this->createMock(MetadataFactoryInterface::class);
|
||||
$metadataFactory->expects($this->any())
|
||||
->method('getMetadataFor')
|
||||
->willReturnCallback(static function ($classOrObject) use ($formMetadata, $authorMetadata) {
|
||||
if (Author::class === $classOrObject || $classOrObject instanceof Author) {
|
||||
return $authorMetadata;
|
||||
}
|
||||
|
||||
if (Form::class === $classOrObject || $classOrObject instanceof Form) {
|
||||
return $formMetadata;
|
||||
}
|
||||
|
||||
return new ClassMetadata(\is_string($classOrObject) ? $classOrObject : \get_class($classOrObject));
|
||||
})
|
||||
;
|
||||
|
||||
$validator = Validation::createValidatorBuilder()
|
||||
->setMetadataFactory($metadataFactory)
|
||||
->getValidator()
|
||||
;
|
||||
$form = Forms::createFormFactoryBuilder()
|
||||
->addExtension(new ValidatorExtension($validator))
|
||||
->getFormFactory()
|
||||
->create(FormTypeTest::TESTED_TYPE, new Author(), (['validation_groups' => new GroupSequence(['First', 'Second'])]))
|
||||
->add('firstName', TextTypeTest::TESTED_TYPE)
|
||||
->add('lastName', TextTypeTest::TESTED_TYPE, [
|
||||
'constraints' => [
|
||||
new Length(['min' => 10, 'groups' => ['First']]),
|
||||
],
|
||||
])
|
||||
->add('australian', TextTypeTest::TESTED_TYPE, [
|
||||
'constraints' => [
|
||||
new NotBlank(['groups' => ['Second']]),
|
||||
],
|
||||
])
|
||||
;
|
||||
|
||||
$form->submit(['firstName' => '', 'lastName' => 'wrong_1', 'australian' => '']);
|
||||
|
||||
$errors = $form->getErrors(true);
|
||||
|
||||
$this->assertCount(1, $errors);
|
||||
$this->assertInstanceOf(Length::class, $errors[0]->getCause()->getConstraint());
|
||||
$this->assertSame('children[lastName].data', $errors[0]->getCause()->getPropertyPath());
|
||||
}
|
||||
|
||||
protected function createForm(array $options = [])
|
||||
|
@ -13,6 +13,8 @@ namespace Symfony\Component\Form\Tests\Extension\Validator;
|
||||
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use Symfony\Component\Form\AbstractType;
|
||||
use Symfony\Component\Form\Extension\Core\Type\FormType;
|
||||
use Symfony\Component\Form\Extension\Core\Type\TextType;
|
||||
use Symfony\Component\Form\Extension\Validator\Constraints\Form as FormConstraint;
|
||||
use Symfony\Component\Form\Extension\Validator\ValidatorExtension;
|
||||
use Symfony\Component\Form\Extension\Validator\ValidatorTypeGuesser;
|
||||
@ -20,6 +22,8 @@ use Symfony\Component\Form\Form;
|
||||
use Symfony\Component\Form\FormBuilderInterface;
|
||||
use Symfony\Component\Form\FormFactoryBuilder;
|
||||
use Symfony\Component\OptionsResolver\OptionsResolver;
|
||||
use Symfony\Component\Validator\Constraints\GroupSequence;
|
||||
use Symfony\Component\Validator\Constraints\Length;
|
||||
use Symfony\Component\Validator\Constraints\NotBlank;
|
||||
use Symfony\Component\Validator\Mapping\CascadingStrategy;
|
||||
use Symfony\Component\Validator\Mapping\ClassMetadata;
|
||||
@ -49,6 +53,8 @@ class ValidatorExtensionTest extends TestCase
|
||||
$this->assertCount(1, $metadata->getConstraints());
|
||||
$this->assertInstanceOf(FormConstraint::class, $metadata->getConstraints()[0]);
|
||||
|
||||
$this->assertSame(CascadingStrategy::NONE, $metadata->cascadingStrategy);
|
||||
$this->assertSame(TraversalStrategy::IMPLICIT, $metadata->traversalStrategy);
|
||||
$this->assertSame(CascadingStrategy::CASCADE, $metadata->getPropertyMetadata('children')[0]->cascadingStrategy);
|
||||
$this->assertSame(TraversalStrategy::IMPLICIT, $metadata->getPropertyMetadata('children')[0]->traversalStrategy);
|
||||
}
|
||||
@ -86,7 +92,53 @@ class ValidatorExtensionTest extends TestCase
|
||||
$this->assertFalse($form->get('baz')->isValid());
|
||||
}
|
||||
|
||||
private function createForm($type)
|
||||
public function testFieldsValidateInSequence()
|
||||
{
|
||||
$form = $this->createForm(FormType::class, null, [
|
||||
'validation_groups' => new GroupSequence(['group1', 'group2']),
|
||||
])
|
||||
->add('foo', TextType::class, [
|
||||
'constraints' => [new Length(['min' => 10, 'groups' => ['group1']])],
|
||||
])
|
||||
->add('bar', TextType::class, [
|
||||
'constraints' => [new NotBlank(['groups' => ['group2']])],
|
||||
])
|
||||
;
|
||||
|
||||
$form->submit(['foo' => 'invalid', 'bar' => null]);
|
||||
|
||||
$errors = $form->getErrors(true);
|
||||
|
||||
$this->assertCount(1, $errors);
|
||||
$this->assertInstanceOf(Length::class, $errors[0]->getCause()->getConstraint());
|
||||
}
|
||||
|
||||
public function testFieldsValidateInSequenceWithNestedGroupsArray()
|
||||
{
|
||||
$form = $this->createForm(FormType::class, null, [
|
||||
'validation_groups' => new GroupSequence([['group1', 'group2'], 'group3']),
|
||||
])
|
||||
->add('foo', TextType::class, [
|
||||
'constraints' => [new Length(['min' => 10, 'groups' => ['group1']])],
|
||||
])
|
||||
->add('bar', TextType::class, [
|
||||
'constraints' => [new Length(['min' => 10, 'groups' => ['group2']])],
|
||||
])
|
||||
->add('baz', TextType::class, [
|
||||
'constraints' => [new NotBlank(['groups' => ['group3']])],
|
||||
])
|
||||
;
|
||||
|
||||
$form->submit(['foo' => 'invalid', 'bar' => 'invalid', 'baz' => null]);
|
||||
|
||||
$errors = $form->getErrors(true);
|
||||
|
||||
$this->assertCount(2, $errors);
|
||||
$this->assertInstanceOf(Length::class, $errors[0]->getCause()->getConstraint());
|
||||
$this->assertInstanceOf(Length::class, $errors[1]->getCause()->getConstraint());
|
||||
}
|
||||
|
||||
private function createForm($type, $data = null, array $options = [])
|
||||
{
|
||||
$validator = Validation::createValidatorBuilder()
|
||||
->setMetadataFactory(new LazyLoadingMetadataFactory(new StaticMethodLoader()))
|
||||
@ -95,7 +147,7 @@ class ValidatorExtensionTest extends TestCase
|
||||
$formFactoryBuilder->addExtension(new ValidatorExtension($validator));
|
||||
$formFactory = $formFactoryBuilder->getFormFactory();
|
||||
|
||||
return $formFactory->create($type);
|
||||
return $formFactory->create($type, $data, $options);
|
||||
}
|
||||
}
|
||||
|
||||
|
Reference in New Issue
Block a user