add test for CollectionType error property paths

cristoforocervino · cristoforocervino · commit f75a3a29d7f1 · 2021-04-13T20:02:24.000+02:00
diff --git a/src/Symfony/Component/Form/Tests/Extension/Validator/Type/FormTypeValidatorExtensionTest.php b/src/Symfony/Component/Form/Tests/Extension/Validator/Type/FormTypeValidatorExtensionTest.php
@@ -16,9 +16,12 @@
 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\CollectionTypeTest;
 use Symfony\Component\Form\Tests\Extension\Core\Type\FormTypeTest;
 use Symfony\Component\Form\Tests\Extension\Core\Type\TextTypeTest;
 use Symfony\Component\Form\Tests\Fixtures\Author;
+use Symfony\Component\Form\Tests\Fixtures\AuthorType;
+use Symfony\Component\Form\Tests\Fixtures\Organization;
 use Symfony\Component\Validator\Constraints\GroupSequence;
 use Symfony\Component\Validator\Constraints\Length;
 use Symfony\Component\Validator\Constraints\NotBlank;
@@ -158,4 +161,92 @@ protected function createForm(array $options = [])
     {
         return $this->factory->create(FormTypeTest::TESTED_TYPE, null, $options);
     }
+
+    public function testErrorPathOnCollections()
+    {
+        $formMetadata = new ClassMetadata(Form::class);
+        $authorMetadata = (new ClassMetadata(Author::class))
+            ->addPropertyConstraint('firstName', new NotBlank());
+        $organizationMetadata = (new ClassMetadata(Organization::class))
+            ->addPropertyConstraint('authors', new Valid());
+        $metadataFactory = $this->createMock(MetadataFactoryInterface::class);
+        $metadataFactory->expects($this->any())
+            ->method('getMetadataFor')
+            ->willReturnCallback(static function ($classOrObject) use ($formMetadata, $authorMetadata, $organizationMetadata) {
+                if (Author::class === $classOrObject || $classOrObject instanceof Author) {
+                    return $authorMetadata;
+                }
+
+                if (Organization::class === $classOrObject || $classOrObject instanceof Organization) {
+                    return $organizationMetadata;
+                }
+
+                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 Organization([]), [
+                'data_class' => Organization::class,
+                'by_reference' => false,
+            ])
+            ->add('authors', CollectionTypeTest::TESTED_TYPE, [
+                'entry_type' => AuthorType::class,
+                'allow_add' => true,
+                'allow_delete' => true,
+            ])
+        ;
+
+        $form->submit([
+            'authors' => [
+                0 => [
+                    'firstName' => '', // Fires a Not Blank Error
+                    'lastName' => 'lastName1',
+                ],
+                // key "1" could be missing if we add 4 blank form entries and then remove it.
+                2 => [
+                    'firstName' => '', // Fires a Not Blank Error
+                    'lastName' => 'lastName3',
+                ],
+                3 => [
+                    'firstName' => '', // Fires a Not Blank Error
+                    'lastName' => 'lastName3',
+                ],
+            ],
+        ]);
+
+        //Form behaves right (...?). It has index 0, 2 and 3 (1 has been removed)
+        $this->assertTrue($form->get('authors')->has('0'));
+        $this->assertFalse($form->get('authors')->has('1'));
+        $this->assertTrue($form->get('authors')->has('2'));
+        $this->assertTrue($form->get('authors')->has('3'));
+
+        //Form does have 3 not blank errors
+        $errors = $form->getErrors(true);
+        $this->assertCount(3, $errors);
+
+        //But errors property paths are messing up
+        $errorPaths = [
+            $errors[0]->getCause()->getPropertyPath(),
+            $errors[1]->getCause()->getPropertyPath(),
+            $errors[2]->getCause()->getPropertyPath(),
+        ];
+
+        $this->assertContains('data.authors[0].firstName', $errorPaths);
+        $this->assertNotContains('data.authors[1].firstName', $errorPaths);
+        $this->assertContains('data.authors[2].firstName', $errorPaths);
+        $this->assertContains('data.authors[3].firstName', $errorPaths);
+
+        //In fact, root form should NOT contain errors but it does
+        $this->assertCount(0, $form->getErrors(false));
+    }
 }
diff --git a/src/Symfony/Component/Form/Tests/Fixtures/Organization.php b/src/Symfony/Component/Form/Tests/Fixtures/Organization.php
@@ -0,0 +1,32 @@
+<?php
+
+namespace Symfony\Component\Form\Tests\Fixtures;
+
+class Organization
+{
+    public $authors = [];
+
+    public function __construct(array $authors = [])
+    {
+        $this->authors = $authors;
+    }
+
+    public function getAuthors(): array
+    {
+        return $this->authors;
+    }
+
+    public function addAuthor(Author $author): self
+    {
+        $this->authors[] = $author;
+        return $this;
+    }
+
+    public function removeAuthor(Author $author): self
+    {
+        if (false !== $key = array_search($author, $this->authors, true)) {
+            array_splice($this->authors, $key, 1);
+        }
+        return $this;
+    }
+}
