[Live] lower the normalizer priority of DoctrineObjectNormalizer

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.

Author: kbond

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/tests/Fixtures/Component/WithObjects.php

@@ -0,0 +1,33 @@
+<?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\Money;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Dto\Temperature;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Entity\Embeddable;
+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 Embeddable $embeddable;
+}

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/Embeddable.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 Embeddable
+{
+    /**
+     * @ORM\Column
+     */
+    public string $name;
+
+    public function __construct(string $name)
+    {
+        $this->name = $name;
+    }
+}

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

@@ -0,0 +1,32 @@
+<?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\Entity
+ */
+class Entity2
+{
+    /**
+     * @ORM\Id
+     * @ORM\GeneratedValue
+     * @ORM\Column(type="integer")
+     */
+    public $id;
+
+    /**
+     * @ORM\Embedded
+     */
+    public Embeddable $embedded;
+}

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;
 
@@ -90,6 +92,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/Integration/LiveComponentHydratorTest.php

@@ -16,7 +16,11 @@
 use Symfony\UX\LiveComponent\Tests\Fixtures\Component\Component2;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Component\Component3;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Component\ComponentWithArrayProp;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Dto\Money;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Dto\Temperature;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Entity\Embeddable;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Entity\Entity1;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Entity\Entity2;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Enum\EmptyStringEnum;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Enum\IntEnum;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Enum\StringEnum;
@@ -339,4 +343,35 @@ public function testCanHydrateEnums(): void
 
         $this->assertSame(ZeroIntEnum::ZERO, $mounted->getComponent()->zeroInt);
     }
+
+    public function testComponentWithNormalizableObjects(): void
+    {
+        $mounted = $this->mountComponent('with_objects', [
+            'money' => new Money(500, 'CAD'),
+            'temperature' => new Temperature(30, 'C'),
+            'entity1' => $entity1 = create(Entity1::class)->object(),
+            'entity2' => $entity2 = create(Entity2::class, ['embedded' => new Embeddable('bar')])->object(),
+            'embeddable' => new Embeddable('foo'),
+        ]);
+
+        $dehydrated = $this->dehydrateComponent($mounted);
+
+        $this->assertSame('500|CAD', $dehydrated['money']);
+        $this->assertSame(['degrees' => 30, 'uom' => 'C'], $dehydrated['temperature']);
+        $this->assertSame($entity1->id, $dehydrated['entity1']);
+        $this->assertSame('entity2:'.$entity2->id, $dehydrated['entity2']);
+        $this->assertSame(['name' => 'foo'], $dehydrated['embeddable']);
+
+        $mounted = $this->hydrateComponent($this->getComponent('with_objects'), $dehydrated, $mounted->getName());
+        $component = $mounted->getComponent();
+
+        $this->assertSame(500, $component->money->amount);
+        $this->assertSame('CAD', $component->money->currency);
+        $this->assertSame(30, $component->temperature->degrees);
+        $this->assertSame('C', $component->temperature->uom);
+        $this->assertSame($entity1->id, $component->entity1->id);
+        $this->assertSame($entity2->id, $component->entity2->id);
+        $this->assertSame('bar', $component->entity2->embedded->name);
+        $this->assertSame('foo', $component->embeddable->name);
+    }
 }