bug #453 [Live] Lower the normalizer priority of DoctrineObjectNormalizer and fix embeddables (kbond)

This PR was merged into the 2.x branch.

Discussion
----------

[Live] Lower the normalizer priority of `DoctrineObjectNormalizer` and fix embeddables

| Q             | A
| ------------- | ---
| Bug fix?      | yes
| New feature?  | no
| Tickets       | Fix #452
| License       | MIT

Changed from 100 to -100, we want a user's entity normalizers to run before. We also want `DoctrineObjectNormalizer` to run before the default object normalizer.

Tests added to cover the following ways object properties on a component are normalized:
- entity with no custom normalizer (uses `DoctrineObjectNormalizer`)
- entity with custom normalizer
- dto with custom normalizer
- dto with no custom normalizer (uses the default object normalizer)
- entity with embeddable (mapped using annotations)
- entity with embeddable (mapped using xml)
- dto with embeddable (mapped using annotations)
- dto with embeddable (mapped using xml)

Commits
-------

d295fa8 [Live] lower the normalizer priority of `DoctrineObjectNormalizer`

Author: weaverryan

src/LiveComponent/src/DependencyInjection/Compiler/OptionalDependencyPass.php

@@ -22,7 +22,7 @@ public function process(ContainerBuilder $container): void
         if ($container->hasDefinition('doctrine')) {
             $container->register('ux.live_component.doctrine_object_normalizer', DoctrineObjectNormalizer::class)
                 ->setArguments([new IteratorArgument([new Reference('doctrine')])]) // todo add other object managers (mongo)
-                ->addTag('serializer.normalizer', ['priority' => 100])
+                ->addTag('serializer.normalizer', ['priority' => -100])
             ;
         }
     }

src/LiveComponent/src/Normalizer/DoctrineObjectNormalizer.php

@@ -11,6 +11,7 @@
 
 namespace Symfony\UX\LiveComponent\Normalizer;
 
+use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\Persistence\ManagerRegistry;
 use Doctrine\Persistence\ObjectManager;
 use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
@@ -83,10 +84,29 @@ private function objectManagerFor(string $class): ?ObjectManager
         // todo cache/warmup an array of classes that are "doctrine objects"
         foreach ($this->managerRegistries as $registry) {
             if ($om = $registry->getManagerForClass($class)) {
-                return $om;
+                return self::ensureManagedObject($om, $class);
             }
         }
 
         return null;
     }
+
+    /**
+     * Ensure the $class is not embedded or a mapped superclass.
+     */
+    private static function ensureManagedObject(ObjectManager $om, string $class): ?ObjectManager
+    {
+        if (!$om instanceof EntityManagerInterface) {
+            // todo might need to add some checks once ODM support is added
+            return $om;
+        }
+
+        $metadata = $om->getClassMetadata($class);
+
+        if ($metadata->isEmbeddedClass || $metadata->isMappedSuperclass) {
+            return null;
+        }
+
+        return $om;
+    }
 }

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

@@ -0,0 +1,37 @@
+<?php
+
+namespace Symfony\UX\LiveComponent\Tests\Fixtures\Component;
+
+use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
+use Symfony\UX\LiveComponent\Attribute\LiveProp;
+use Symfony\UX\LiveComponent\DefaultActionTrait;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Dto\Embeddable2;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Dto\Money;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Dto\Temperature;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Entity\Embeddable1;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Entity\Entity1;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Entity\Entity2;
+
+#[AsLiveComponent('with_objects')]
+final class WithObjects
+{
+    use DefaultActionTrait;
+
+    #[LiveProp]
+    public Money $money;
+
+    #[LiveProp]
+    public Temperature $temperature;
+
+    #[LiveProp]
+    public Entity1 $entity1;
+
+    #[LiveProp]
+    public Entity2 $entity2;
+
+    #[LiveProp]
+    public Embeddable1 $embeddable1;
+
+    #[LiveProp]
+    public Embeddable2 $embeddable2;
+}

src/LiveComponent/tests/Fixtures/Dto/Embeddable2.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Symfony\UX\LiveComponent\Tests\Fixtures\Dto;
+
+final class Embeddable2
+{
+    public function __construct(public string $name)
+    {
+    }
+}

src/LiveComponent/tests/Fixtures/Dto/Money.php

@@ -0,0 +1,22 @@
+<?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\Dto;
+
+/**
+ * @author Kevin Bond <[email protected]>
+ */
+final class Money
+{
+    public function __construct(public int $amount, public string $currency)
+    {
+    }
+}

src/LiveComponent/tests/Fixtures/Dto/Temperature.php

@@ -0,0 +1,22 @@
+<?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\Dto;
+
+/**
+ * @author Kevin Bond <[email protected]>
+ */
+final class Temperature
+{
+    public function __construct(public int $degrees, public string $uom)
+    {
+    }
+}

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

@@ -0,0 +1,30 @@
+<?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;
+
+/**
+ * @ORM\Embeddable
+ */
+final class Embeddable1
+{
+    /**
+     * @ORM\Column
+     */
+    public string $name;
+
+    public function __construct(string $name)
+    {
+        $this->name = $name;
+    }
+}

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

@@ -0,0 +1,38 @@
+<?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\UX\LiveComponent\Tests\Fixtures\Dto\Embeddable2;
+
+/**
+ * @ORM\Entity
+ */
+class Entity2
+{
+    /**
+     * @ORM\Id
+     * @ORM\GeneratedValue
+     * @ORM\Column(type="integer")
+     */
+    public $id;
+
+    /**
+     * @ORM\Embedded(Embeddable1::class)
+     */
+    public Embeddable1 $embedded1;
+
+    /**
+     * @ORM\Embedded(Embeddable2::class)
+     */
+    public Embeddable2 $embedded2;
+}

src/LiveComponent/tests/Fixtures/Kernel.php

@@ -21,6 +21,8 @@
 use Symfony\Component\HttpKernel\Kernel as BaseKernel;
 use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
 use Symfony\UX\LiveComponent\LiveComponentBundle;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Serializer\Entity2Normalizer;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Serializer\MoneyNormalizer;
 use Symfony\UX\TwigComponent\TwigComponentBundle;
 use Twig\Environment;
 
@@ -73,12 +75,19 @@ protected function configureContainer(ContainerConfigurator $c): void
                 'auto_generate_proxy_classes' => true,
                 'auto_mapping' => true,
                 'mappings' => [
-                    'Test' => [
+                    'Default' => [
                         'is_bundle' => false,
                         'type' => 'annotation',
                         'dir' => '%kernel.project_dir%/tests/Fixtures/Entity',
                         'prefix' => 'Symfony\UX\LiveComponent\Tests\Fixtures\Entity',
-                        'alias' => 'Test',
+                        'alias' => 'Default',
+                    ],
+                    'XML' => [
+                        'is_bundle' => false,
+                        'type' => 'xml',
+                        'dir' => '%kernel.project_dir%/tests/Fixtures/config/doctrine',
+                        'prefix' => 'Symfony\UX\LiveComponent\Tests\Fixtures\Dto',
+                        'alias' => 'XML',
                     ],
                 ],
             ],
@@ -90,6 +99,8 @@ protected function configureContainer(ContainerConfigurator $c): void
                 ->autoconfigure()
             // disable logging errors to the console
             ->set('logger', NullLogger::class)
+            ->set(MoneyNormalizer::class)->autoconfigure()->autowire()
+            ->set(Entity2Normalizer::class)->autoconfigure()->autowire()
             ->load(__NAMESPACE__.'\\Component\\', __DIR__.'/Component')
         ;
     }

src/LiveComponent/tests/Fixtures/Serializer/Entity2Normalizer.php

@@ -0,0 +1,49 @@
+<?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\Serializer;
+
+use Doctrine\Persistence\ManagerRegistry;
+use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Entity\Entity2;
+
+/**
+ * @author Kevin Bond <[email protected]>
+ */
+final class Entity2Normalizer implements NormalizerInterface, DenormalizerInterface
+{
+    public function __construct(private ManagerRegistry $doctrine)
+    {
+    }
+
+    public function denormalize(mixed $data, string $type, string $format = null, array $context = [])
+    {
+        [, $id] = \explode(':', $data);
+
+        return $this->doctrine->getRepository(Entity2::class)->find($id);
+    }
+
+    public function supportsDenormalization(mixed $data, string $type, string $format = null)
+    {
+        return Entity2::class === $type;
+    }
+
+    public function normalize(mixed $object, string $format = null, array $context = [])
+    {
+        return 'entity2:'.$object->id;
+    }
+
+    public function supportsNormalization(mixed $data, string $format = null)
+    {
+        return $data instanceof Entity2;
+    }
+}

src/LiveComponent/tests/Fixtures/Serializer/MoneyNormalizer.php

@@ -0,0 +1,39 @@
+<?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\Serializer;
+
+use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Dto\Money;
+
+final class MoneyNormalizer implements NormalizerInterface, DenormalizerInterface
+{
+    public function denormalize(mixed $data, string $type, string $format = null, array $context = [])
+    {
+        return new Money(...\explode('|', $data));
+    }
+
+    public function supportsDenormalization(mixed $data, string $type, string $format = null)
+    {
+        return Money::class === $type;
+    }
+
+    public function normalize(mixed $object, string $format = null, array $context = [])
+    {
+        return \implode('|', [$object->amount, $object->currency]);
+    }
+
+    public function supportsNormalization(mixed $data, string $format = null)
+    {
+        return $data instanceof Money;
+    }
+}

src/LiveComponent/tests/Fixtures/config/doctrine/Embeddable2.orm.xml

@@ -0,0 +1,5 @@
+<doctrine-mapping>
+    <embeddable name="Symfony\UX\LiveComponent\Tests\Fixtures\Dto\Embeddable2">
+        <field name="name" type="string" />
+    </embeddable>
+</doctrine-mapping>