feature #263 [Live] migrate Hydration system to standard Symfony normalizers (kbond)

This PR was merged into the 2.x branch.

Discussion
----------

[Live] migrate Hydration system to standard Symfony normalizers

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | yes
| Tickets       | n/a
| License       | MIT

This removes our custom hydration system and uses `symfony/serializer` directly. Hydrators are now just (de)normalizer's registered with Symfony as normal.

The serializer context (`['live-component' => true]`) can be used to restrict (de)normalizers to just live component properties.

Commits
-------

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

Author: weaverryan

src/LiveComponent/CHANGELOG.md

@@ -21,11 +21,16 @@
 -   Ability to send live action arguments to backend
 
 -   [BC BREAK] Remove `init_live_component()` twig function, use `{{ attributes }}` instead:
+
     ```diff
     - <div {{ init_live_component() }}>
     + <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

@@ -2,11 +2,11 @@
 
 namespace Symfony\UX\LiveComponent\DependencyInjection\Compiler;
 
+use Symfony\Component\DependencyInjection\Argument\IteratorArgument;
 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 +16,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 IteratorArgument([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;
@@ -22,7 +21,6 @@
 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\Twig\LiveComponentExtension as LiveComponentTwigExtension;
 use Symfony\UX\LiveComponent\Twig\LiveComponentRuntime;
 use Symfony\UX\TwigComponent\ComponentFactory;
@@ -52,13 +50,9 @@ function (ChildDefinition $definition, AsLiveComponent $attribute) {
             }
         );
 
-        $container->registerForAutoconfiguration(PropertyHydratorInterface::class)
-            ->addTag('twig.component.property_hydrator')
-        ;
-
         $container->register('ux.live_component.component_hydrator', LiveComponentHydrator::class)
             ->setArguments([
-                new TaggedIteratorArgument('twig.component.property_hydrator'),
+                new Reference('serializer'),
                 new Reference('property_accessor'),
                 '%kernel.secret%',
             ])

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);
     }
 }

src/LiveComponent/src/Hydrator/NormalizerBridgePropertyHydrator.php

@@ -14,9 +14,10 @@
 use Symfony\Component\HttpKernel\Exception\UnprocessableEntityHttpException;
 use Symfony\Component\PropertyAccess\Exception\UnexpectedTypeException;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
+use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
 use Symfony\UX\LiveComponent\Attribute\LivePropContext;
-use Symfony\UX\LiveComponent\Exception\UnsupportedHydrationException;
 use Symfony\UX\TwigComponent\ComponentAttributes;
 use Symfony\UX\TwigComponent\MountedComponent;
 
@@ -29,23 +30,16 @@
  */
 final class LiveComponentHydrator
 {
+    public const LIVE_CONTEXT = 'live-component';
     private const CHECKSUM_KEY = '_checksum';
     private const EXPOSED_PROP_KEY = '_id';
     private const ATTRIBUTES_KEY = '_attributes';
 
-    /** @var PropertyHydratorInterface[] */
-    private iterable $propertyHydrators;
-    private PropertyAccessorInterface $propertyAccessor;
-    private string $secret;
-
-    /**
-     * @param PropertyHydratorInterface[] $propertyHydrators
-     */
-    public function __construct(iterable $propertyHydrators, PropertyAccessorInterface $propertyAccessor, string $secret)
-    {
-        $this->propertyHydrators = $propertyHydrators;
-        $this->propertyAccessor = $propertyAccessor;
-        $this->secret = $secret;
+    public function __construct(
+        private NormalizerInterface|DenormalizerInterface $normalizer,
+        private PropertyAccessorInterface $propertyAccessor,
+        private string $secret
+    ) {
     }
 
     public function dehydrate(MountedComponent $mounted): array
@@ -75,6 +69,7 @@ public function dehydrate(MountedComponent $mounted): array
 
                 throw new \LogicException($message);
             }
+
             $frontendPropertyNames[$frontendName] = $name;
 
             if ($liveProp->isReadonly()) {
@@ -83,13 +78,13 @@ public function dehydrate(MountedComponent $mounted): array
 
             // TODO: improve error message if not readable
             $value = $this->propertyAccessor->getValue($component, $name);
-
             $dehydratedValue = null;
+
             if ($method = $liveProp->dehydrateMethod()) {
                 // TODO: Error checking
                 $dehydratedValue = $component->$method($value);
-            } else {
-                $dehydratedValue = $this->dehydrateProperty($value, $name, $component);
+            } elseif (\is_object($dehydratedValue = $value)) {
+                $dehydratedValue = $this->normalizer->normalize($dehydratedValue, 'json', [self::LIVE_CONTEXT => true]);
             }
 
             if (\count($liveProp->exposed()) > 0) {
@@ -98,7 +93,7 @@ public function dehydrate(MountedComponent $mounted): array
                 ];
                 foreach ($liveProp->exposed() as $propertyPath) {
                     $value = $this->propertyAccessor->getValue($component, sprintf('%s.%s', $name, $propertyPath));
-                    $data[$frontendName][$propertyPath] = $this->dehydrateProperty($value, $propertyPath, $component);
+                    $data[$frontendName][$propertyPath] = \is_object($value) ? $this->normalizer->normalize($value, 'json', [self::LIVE_CONTEXT => true]) : $value;
                 }
             } else {
                 $data[$frontendName] = $dehydratedValue;
@@ -168,11 +163,13 @@ public function hydrate(object $component, array $data, string $componentName):
                 unset($data[$frontendName][self::EXPOSED_PROP_KEY]);
             }
 
+            $value = $dehydratedValue;
+
             if ($method = $liveProp->hydrateMethod()) {
                 // TODO: Error checking
                 $value = $component->$method($dehydratedValue);
-            } else {
-                $value = $this->hydrateProperty($property, $dehydratedValue);
+            } elseif ($property->getType() instanceof \ReflectionNamedType && !$property->getType()->isBuiltin()) {
+                $value = $this->normalizer->denormalize($value, $property->getType()->getName(), 'json', [self::LIVE_CONTEXT => true]);
             }
 
             foreach ($liveProp->exposed() as $exposedProperty) {
@@ -237,57 +234,6 @@ private function verifyChecksum(array $data, array $readonlyProperties): void
         }
     }
 
-    /**
-     * @param scalar|array|null $value
-     *
-     * @return mixed
-     */
-    private function hydrateProperty(\ReflectionProperty $property, $value)
-    {
-        if (!$property->getType() || !$property->getType() instanceof \ReflectionNamedType || $property->getType()->isBuiltin()) {
-            return $value;
-        }
-
-        foreach ($this->propertyHydrators as $hydrator) {
-            try {
-                return $hydrator->hydrate($property->getType()->getName(), $value);
-            } catch (UnsupportedHydrationException $e) {
-                continue;
-            }
-        }
-
-        return $value;
-    }
-
-    /**
-     * @param mixed $value
-     *
-     * @return scalar|array|null
-     */
-    private function dehydrateProperty($value, string $name, object $component)
-    {
-        if (is_scalar($value) || \is_array($value) || null === $value) {
-            // nothing to dehydrate...
-            return $value;
-        }
-
-        foreach ($this->propertyHydrators as $hydrator) {
-            try {
-                $value = $hydrator->dehydrate($value);
-
-                break;
-            } catch (UnsupportedHydrationException $e) {
-                continue;
-            }
-        }
-
-        if (!is_scalar($value) && !\is_array($value) && null !== $value) {
-            throw new \LogicException(sprintf('Cannot dehydrate property "%s" of "%s". The value "%s" does not have a dehydrator.', $name, \get_class($component), get_debug_type($value)));
-        }
-
-        return $value;
-    }
-
     /**
      * Transforms a path like `post.name` into `[post][name]`.
      *