[LiveComponent] Fix BC break when dealing with entities (implementing an interface) on LiveProp

Author: Kocal

src/LiveComponent/tests/Fixtures/Component/FormWithUserInterfaceComponent.php

@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\LiveComponent\Tests\Fixtures\Component;
+
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\Form\FormInterface;
+use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
+use Symfony\UX\LiveComponent\Attribute\LiveProp;
+use Symfony\UX\LiveComponent\ComponentWithFormTrait;
+use Symfony\UX\LiveComponent\DefaultActionTrait;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Entity\User;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Form\UserFormType;
+
+#[AsLiveComponent('form_with_user_interface', template: 'components/form_with_user_interface.html.twig')]
+class FormWithUserInterfaceComponent extends AbstractController
+{
+    use ComponentWithFormTrait;
+    use DefaultActionTrait;
+
+    #[LiveProp]
+    public User $user;
+
+    protected function instantiateForm(): FormInterface
+    {
+        return $this->createForm(UserFormType::class, $this->user);
+    }
+}

src/LiveComponent/tests/Fixtures/Entity/User.php

@@ -0,0 +1,57 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\LiveComponent\Tests\Fixtures\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Security\Core\User\UserInterface;
+
+#[ORM\Entity]
+class User implements UserInterface
+{
+    #[ORM\Id]
+    #[ORM\GeneratedValue]
+    #[ORM\Column(type: 'integer')]
+    public $id;
+
+    #[ORM\Column(type: 'string', length: 180, unique: true)]
+    public $username;
+
+    public function getRoles(): array
+    {
+        return ['ROLE_USER'];
+    }
+
+    public function eraseCredentials(): void
+    {
+        // no-op
+    }
+
+    public function getUsername(): string
+    {
+        return $this->getUserIdentifier();
+    }
+
+    public function getUserIdentifier(): string
+    {
+        return $this->username;
+    }
+
+    public function getPassword(): ?string
+    {
+        return null;
+    }
+
+    public function getSalt(): ?string
+    {
+        return null;
+    }
+}

src/LiveComponent/tests/Fixtures/Form/UserFormType.php

@@ -0,0 +1,35 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\LiveComponent\Tests\Fixtures\Form;
+
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\TextType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Entity\User;
+
+class UserFormType extends AbstractType
+{
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        $builder
+            ->add('username', TextType::class)
+        ;
+    }
+
+    public function configureOptions(OptionsResolver $resolver)
+    {
+        $resolver->setDefaults([
+            'data_class' => User::class,
+        ]);
+    }
+}

src/LiveComponent/tests/Fixtures/templates/components/form_with_user_interface.html.twig

@@ -0,0 +1,3 @@
+<div{{ attributes }}>
+    {{ form(form) }}
+</div>

src/LiveComponent/tests/Functional/Form/ComponentWithFormTest.php

@@ -15,13 +15,17 @@
 use Symfony\Component\DomCrawler\Crawler;
 use Symfony\Component\Form\FormFactoryInterface;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Component\FormWithCollectionTypeComponent;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Entity\User;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Factory\CategoryFixtureEntityFactory;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Form\BlogPostFormType;
 use Symfony\UX\LiveComponent\Tests\LiveComponentTestHelper;
 use Zenstruck\Browser\Test\HasBrowser;
 use Zenstruck\Foundry\Test\Factories;
 use Zenstruck\Foundry\Test\ResetDatabase;
 
+use function Zenstruck\Foundry\Persistence\persist;
+use function Zenstruck\Foundry\Persistence\refresh;
+
 /**
  * @author Jakub Caban <[email protected]>
  */
@@ -450,4 +454,38 @@ public function testDataModelAttributeAutomaticallyAdded(): void
             ->assertElementAttributeContains('form', 'data-model', 'on(change)|*')
         ;
     }
+
+    public function testFormWithLivePropContainingAnEntityImplementingAnInterface(): void
+    {
+        $user = persist(User::class, ['username' => 'Fabien']);
+        self::assertInstanceOf(User::class, $user);
+        self::assertEquals(1, $user->id);
+        self::assertEquals('Fabien', $user->username);
+
+        $mounted = $this->mountComponent('form_with_user_interface', [
+            'user' => $user,
+        ]);
+
+        $dehydrated = $this->dehydrateComponent($mounted)->getProps();
+
+        $this->browser()
+            ->post('/_components/form_with_user_interface', [
+                'body' => [
+                    'data' => json_encode([
+                        'props' => $dehydrated,
+                        'updated' => [
+                            'user_form.username' => 'Nicolas',
+                            'validatedFields' => ['user_form.username'],
+                        ],
+                    ]),
+                ],
+            ])
+            ->assertStatus(200)
+            ->assertElementAttributeContains('form', 'data-model', 'on(change)|*')
+        ;
+
+        refresh($user);
+        self::assertEquals(1, $user->id);
+        self::assertEquals('Nicolas', $user->username);
+    }
 }

src/LiveComponent/tests/Integration/LiveComponentHydratorTest.php

@@ -37,6 +37,7 @@
 use Symfony\UX\LiveComponent\Tests\Fixtures\Entity\Entity1;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Entity\Entity2;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Entity\ProductFixtureEntity;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Entity\User;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Enum\EmptyStringEnum;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Enum\IntEnum;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Enum\StringEnum;
@@ -336,6 +337,27 @@ public function onEntireEntityUpdated($oldValue)
             ;
         }];
 
+        yield 'Persisted entity: (de)hydration works correctly to/from id, when the entity implements an interface' => [function () {
+            $user = persist(User::class, [
+                'username' => 'Fabien',
+            ]);
+            \assert($user instanceof User);
+
+            return HydrationTest::create(new class {
+                #[LiveProp]
+                public User $user;
+            })
+                ->mountWith(['user' => $user])
+                ->assertDehydratesTo(['user' => $user->id])
+                ->assertObjectAfterHydration(function (object $object) use ($user) {
+                    self::assertSame(
+                        $user->id,
+                        $object->user->id
+                    );
+                })
+            ;
+        }];
+
         yield 'Persisted entity: writable CAN be changed via id' => [function () {
             $entityOriginal = persist(Entity1::class);
             $entityNext = persist(Entity1::class);