bug #33999 [Form] Make sure to collect child forms created on *_SET_DATA events (yceruto)

This PR was merged into the 3.4 branch.

Discussion
----------

[Form] Make sure to collect child forms created on *_SET_DATA events

| Q             | A
| ------------- | ---
| Branch?       | 3.4
| Bug fix?      | yes
| New feature?  | no
| Deprecations? | no
| Tickets       | Fix #29291
| License       | MIT
| Doc PR        | -

See reproducer provided by @WubbleWobble https://github.com/WubbleWobble/symfony-issue-29291.

Commits
-------

50efc1a Make sure to collect child forms created on *_SET_DATA events

Author: yceruto

Extension/DataCollector/FormDataCollector.php

@@ -128,7 +128,8 @@ public function collectDefaultData(FormInterface $form)
         $hash = spl_object_hash($form);
 
         if (!isset($this->dataByForm[$hash])) {
-            $this->dataByForm[$hash] = [];
+            // field was created by form event
+            $this->collectConfiguration($form);
         }
 
         $this->dataByForm[$hash] = array_replace(

Tests/Extension/DataCollector/FormDataCollectorTest.php

@@ -13,10 +13,20 @@
 
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\EventDispatcher\EventDispatcher;
+use Symfony\Component\Form\Extension\Core\CoreExtension;
+use Symfony\Component\Form\Extension\Core\DataMapper\PropertyPathMapper;
+use Symfony\Component\Form\Extension\Core\Type\CollectionType;
+use Symfony\Component\Form\Extension\Core\Type\FormType;
+use Symfony\Component\Form\Extension\Core\Type\TextType;
 use Symfony\Component\Form\Extension\DataCollector\FormDataCollector;
 use Symfony\Component\Form\Form;
 use Symfony\Component\Form\FormBuilder;
+use Symfony\Component\Form\FormFactory;
+use Symfony\Component\Form\FormInterface;
+use Symfony\Component\Form\FormRegistry;
 use Symfony\Component\Form\FormView;
+use Symfony\Component\Form\ResolvedFormTypeFactory;
 
 class FormDataCollectorTest extends TestCase
 {
@@ -69,9 +79,9 @@ protected function setUp()
     {
         $this->dataExtractor = $this->getMockBuilder('Symfony\Component\Form\Extension\DataCollector\FormDataExtractorInterface')->getMock();
         $this->dataCollector = new FormDataCollector($this->dataExtractor);
-        $this->dispatcher = $this->getMockBuilder('Symfony\Component\EventDispatcher\EventDispatcherInterface')->getMock();
-        $this->factory = $this->getMockBuilder('Symfony\Component\Form\FormFactoryInterface')->getMock();
-        $this->dataMapper = $this->getMockBuilder('Symfony\Component\Form\DataMapperInterface')->getMock();
+        $this->dispatcher = new EventDispatcher();
+        $this->factory = new FormFactory(new FormRegistry([new CoreExtension()], new ResolvedFormTypeFactory()));
+        $this->dataMapper = new PropertyPathMapper();
         $this->form = $this->createForm('name');
         $this->childForm = $this->createForm('child');
         $this->view = new FormView();
@@ -726,6 +736,56 @@ public function testReset()
         );
     }
 
+    public function testCollectMissingDataFromChildFormAddedOnFormEvents()
+    {
+        $form = $this->factory->createNamedBuilder('root', FormType::class, ['items' => null])
+            ->add('items', CollectionType::class, [
+                'entry_type' => TextType::class,
+                'allow_add' => true,
+                // data is locked and modelData (null) is different to the
+                // configured data, so modifications of the configured data
+                // won't be allowed at this point. It also means *_SET_DATA
+                // events won't dispatched either. Therefore, no child form
+                // is created during the mapping of data to the form.
+                'data' => ['foo'],
+            ])
+            ->getForm()
+        ;
+        $this->dataExtractor->expects($extractConfiguration = $this->exactly(4))
+            ->method('extractConfiguration')
+            ->willReturn([])
+        ;
+        $this->dataExtractor->expects($extractDefaultData = $this->exactly(4))
+            ->method('extractDefaultData')
+            ->willReturnCallback(static function (FormInterface $form) {
+                // this simulate the call in extractDefaultData() method
+                // where (if defaultDataSet is false) it fires *_SET_DATA
+                // events, adding the form related to the configured data
+                $form->getNormData();
+
+                return [];
+            })
+        ;
+        $this->dataExtractor->expects($this->exactly(4))
+            ->method('extractSubmittedData')
+            ->willReturn([])
+        ;
+
+        $this->dataCollector->collectConfiguration($form);
+        $this->assertSame(2, $extractConfiguration->getInvocationCount(), 'only "root" and "items" forms were collected, the "items" children do not exist yet.');
+
+        $this->dataCollector->collectDefaultData($form);
+        $this->assertSame(3, $extractConfiguration->getInvocationCount(), 'extracted missing configuration of the "items" children ["0" => foo].');
+        $this->assertSame(3, $extractDefaultData->getInvocationCount());
+        $this->assertSame(['foo'], $form->get('items')->getData());
+
+        $form->submit(['items' => ['foo', 'bar']]);
+        $this->dataCollector->collectSubmittedData($form);
+        $this->assertSame(4, $extractConfiguration->getInvocationCount(), 'extracted missing configuration of the "items" children ["1" => bar].');
+        $this->assertSame(4, $extractDefaultData->getInvocationCount(), 'extracted missing default data of the "items" children ["1" => bar].');
+        $this->assertSame(['foo', 'bar'], $form->get('items')->getData());
+    }
+
     private function createForm($name)
     {
         $builder = new FormBuilder($name, null, $this->dispatcher, $this->factory);