[WIP][Live] migrate Hydration system to standard Symfony normalizers

Author: kbond

src/LiveComponent/CHANGELOG.md

@@ -21,6 +21,10 @@
     + <div {{ attributes }}>
     ```
 
+-   [BC BREAK] Replace property hydration system with `symfony/serializer` normalizers. This
+    is a BC break if you've created custom hydrators. They'll need to be converted to
+    normalizers.
+
 ## 2.0.0
 
 -   Support for `stimulus` version 2 was removed and support for `@hotwired/stimulus`

src/LiveComponent/composer.json

@@ -27,6 +27,7 @@
     },
     "require": {
         "php": ">=8.0",
+        "symfony/serializer": "^5.4|^6.0",
         "symfony/ux-twig-component": "^2.1"
     },
     "require-dev": {
@@ -38,7 +39,6 @@
         "symfony/framework-bundle": "^5.4|^6.0",
         "symfony/phpunit-bridge": "^6.0",
         "symfony/security-csrf": "^5.4|^6.0",
-        "symfony/serializer": "^5.4|^6.0",
         "symfony/twig-bundle": "^5.4|^6.0",
         "symfony/validator": "^5.4|^6.0",
         "zenstruck/browser": "^0.9.1",

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

@@ -5,8 +5,7 @@
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
-use Symfony\UX\LiveComponent\Hydrator\DoctrineEntityPropertyHydrator;
-use Symfony\UX\LiveComponent\Hydrator\NormalizerBridgePropertyHydrator;
+use Symfony\UX\LiveComponent\Normalizer\DoctrineObjectNormalizer;
 
 /**
  * @author Kevin Bond <[email protected]>
@@ -16,16 +15,9 @@ final class OptionalDependencyPass implements CompilerPassInterface
     public function process(ContainerBuilder $container): void
     {
         if ($container->hasDefinition('doctrine')) {
-            $container->register('ux.live_component.doctrine_entity_property_hydrator', DoctrineEntityPropertyHydrator::class)
-                ->setArguments([[new Reference('doctrine')]])
-                ->addTag('twig.component.property_hydrator', ['priority' => -100])
-            ;
-        }
-
-        if ($container->hasDefinition('serializer')) {
-            $container->register('ux.live_component.serializer_property_hydrator', NormalizerBridgePropertyHydrator::class)
-                ->setArguments([new Reference('serializer')])
-                ->addTag('twig.component.property_hydrator', ['priority' => -200])
+            $container->register('ux.live_component.doctrine_object_normalizer', DoctrineObjectNormalizer::class)
+                ->setArguments([[new Reference('doctrine')]]) // todo add other object managers (mongo)
+                ->addTag('serializer.normalizer', ['priority' => 100])
             ;
         }
     }

src/LiveComponent/src/DependencyInjection/LiveComponentExtension.php

@@ -11,7 +11,6 @@
 
 namespace Symfony\UX\LiveComponent\DependencyInjection;
 
-use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
 use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Extension\Extension;
@@ -24,7 +23,7 @@
 use Symfony\UX\LiveComponent\EventListener\AddLiveAttributesSubscriber;
 use Symfony\UX\LiveComponent\EventListener\LiveComponentSubscriber;
 use Symfony\UX\LiveComponent\LiveComponentHydrator;
-use Symfony\UX\LiveComponent\PropertyHydratorInterface;
+use Symfony\UX\LiveComponent\Normalizer\LiveComponentNormalizer;
 use Symfony\UX\LiveComponent\Twig\LiveComponentExtension as LiveComponentTwigExtension;
 use Symfony\UX\LiveComponent\Twig\LiveComponentRuntime;
 use Symfony\UX\TwigComponent\ComponentFactory;
@@ -54,16 +53,16 @@ function (ChildDefinition $definition, AsLiveComponent $attribute) {
             }
         );
 
-        $container->registerForAutoconfiguration(PropertyHydratorInterface::class)
-            ->addTag('twig.component.property_hydrator')
-        ;
-
-        $container->register('ux.live_component.component_hydrator', LiveComponentHydrator::class)
+        $container->register('ux.live_component.live_component_normalizer', LiveComponentNormalizer::class)
             ->setArguments([
-                new TaggedIteratorArgument('twig.component.property_hydrator'),
                 new Reference('property_accessor'),
                 '%kernel.secret%',
             ])
+            ->addTag('serializer.normalizer', ['priority' => 100])
+        ;
+
+        $container->register('ux.live_component.component_hydrator', LiveComponentHydrator::class)
+            ->setArguments([new Reference('serializer')])
         ;
 
         $container->register('ux.live_component.event_subscriber', LiveComponentSubscriber::class)

src/LiveComponent/src/Hydrator/DoctrineEntityPropertyHydrator.php

@@ -11,6 +11,7 @@
 
 namespace Symfony\UX\LiveComponent;
 
+use Symfony\Component\DependencyInjection\Compiler\PassConfig;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 use Symfony\UX\LiveComponent\DependencyInjection\Compiler\OptionalDependencyPass;
@@ -24,6 +25,7 @@ final class LiveComponentBundle extends Bundle
 {
     public function build(ContainerBuilder $container): void
     {
-        $container->addCompilerPass(new OptionalDependencyPass());
+        // must run before Symfony\Component\Serializer\DependencyInjection\SerializerPass
+        $container->addCompilerPass(new OptionalDependencyPass(), PassConfig::TYPE_BEFORE_OPTIMIZATION, 100);
     }
 }