split context builders and remove cache trait

Author: mtarld

src/Symfony/Bundle/FrameworkBundle/CacheWarmer/SerDesCacheWarmer.php

@@ -15,7 +15,7 @@
 use Psr\Log\NullLogger;
 use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
 use Symfony\Component\SerDes\Attribute\Serializable;
-use Symfony\Component\SerDes\Context\ContextBuilderInterface;
+use Symfony\Component\SerDes\Context\ContextBuilder\SerializeContextBuilderInterface;
 use Symfony\Component\SerDes\Exception\ExceptionInterface;
 use Symfony\Component\SerDes\SerializableResolverInterface;
 use Symfony\Component\VarExporter\ProxyHelper;
@@ -30,8 +30,8 @@
 final class SerDesCacheWarmer implements CacheWarmerInterface
 {
     /**
-     * @param iterable<ContextBuilderInterface> $contextBuilders
-     * @param list<string>                      $formats
+     * @param iterable<SerializeContextBuilderInterface> $contextBuilders
+     * @param list<string>                               $formats
      */
     public function __construct(
         private readonly SerializableResolverInterface $serializableResolver,
@@ -84,10 +84,13 @@ private function warmClassTemplate(string $class, Serializable $attribute, strin
         }
 
         try {
-            $context = ['cache_dir' => $this->templateCacheDir];
+            $context = [
+                'cache_dir' => $this->templateCacheDir,
+                'template_exists' => false,
+            ];
 
             foreach ($this->contextBuilders as $contextBuilder) {
-                $context = $contextBuilder->buildSerializeContext($context, true);
+                $context = $contextBuilder->build($context, true);
             }
 
             file_put_contents($path, serialize_generate($class, $format, $context));

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

@@ -16,6 +16,8 @@
 use Http\Client\HttpAsyncClient;
 use Http\Client\HttpClient;
 use Symfony\Component\SerDes\Context\ContextBuilderInterface;
+use Symfony\Component\SerDes\Context\ContextBuilder\DeserializeContextBuilderInterface;
+use Symfony\Component\SerDes\Context\ContextBuilder\SerializeContextBuilderInterface;
 use Symfony\Component\SerDes\SerializerInterface as SerDesSerializerInterface;
 use phpDocumentor\Reflection\DocBlockFactoryInterface;
 use phpDocumentor\Reflection\Types\ContextFactory;
@@ -697,8 +699,10 @@ public function load(array $configs, ContainerBuilder $container)
             ->addTag('mime.mime_type_guesser');
         $container->registerForAutoconfiguration(LoggerAwareInterface::class)
             ->addMethodCall('setLogger', [new Reference('logger')]);
-        $container->registerForAutoconfiguration(ContextBuilderInterface::class)
-            ->addTag('ser_des.context_builder');
+        $container->registerForAutoconfiguration(SerializeContextBuilderInterface::class)
+            ->addTag('ser_des.context_builder.serialize');
+        $container->registerForAutoconfiguration(DeserializeContextBuilderInterface::class)
+            ->addTag('ser_des.context_builder.deserialize');
 
         $container->registerAttributeForAutoconfiguration(AsEventListener::class, static function (ChildDefinition $definition, AsEventListener $attribute, \ReflectionClass|\ReflectionMethod $reflector) {
             $tagAttributes = get_object_vars($attribute);

src/Symfony/Bundle/FrameworkBundle/Resources/config/ser_des.php

@@ -13,11 +13,13 @@
 
 use Symfony\Bundle\FrameworkBundle\CacheWarmer\SerDesCacheWarmer;
 use Symfony\Component\SerDes\CachedSerializableResolver;
-use Symfony\Component\SerDes\Context\ContextBuilder\CachedContextBuilder;
-use Symfony\Component\SerDes\Context\ContextBuilder\FormatterAttributeContextBuilder;
-use Symfony\Component\SerDes\Context\ContextBuilder\HookContextBuilder;
-use Symfony\Component\SerDes\Context\ContextBuilder\InstantiatorContextBuilder;
-use Symfony\Component\SerDes\Context\ContextBuilder\NameAttributeContextBuilder;
+use Symfony\Component\SerDes\Context\ContextBuilder\Deserialize\DeserializeFormatterAttributeContextBuilder;
+use Symfony\Component\SerDes\Context\ContextBuilder\Deserialize\DeserializeHookContextBuilder;
+use Symfony\Component\SerDes\Context\ContextBuilder\Deserialize\DeserializeInstantiatorContextBuilder;
+use Symfony\Component\SerDes\Context\ContextBuilder\Deserialize\DeserializeNameAttributeContextBuilder;
+use Symfony\Component\SerDes\Context\ContextBuilder\Serialize\SerializeFormatterAttributeContextBuilder;
+use Symfony\Component\SerDes\Context\ContextBuilder\Serialize\SerializeHookContextBuilder;
+use Symfony\Component\SerDes\Context\ContextBuilder\Serialize\SerializeNameAttributeContextBuilder;
 use Symfony\Component\SerDes\Instantiator\LazyInstantiator;
 use Symfony\Component\SerDes\SerializableResolver;
 use Symfony\Component\SerDes\SerializableResolverInterface;
@@ -39,7 +41,8 @@
         // Serializer
         ->set('ser_des.serializer', Serializer::class)
             ->args([
-                tagged_iterator('ser_des.context_builder'),
+                tagged_iterator('ser_des.context_builder.serialize'),
+                tagged_iterator('ser_des.context_builder.deserialize'),
                 param('ser_des.cache_dir.template')
             ])
         ->alias(SerializerInterface::class, 'ser_des.serializer')
@@ -60,48 +63,47 @@
         ->alias('ser_des.type_extractor', 'ser_des.type_extractor.reflection')
 
         // Context builders
-        ->set('ser_des.context_builder.hook', HookContextBuilder::class)
+        ->set('ser_des.context_builder.serialize.hook', SerializeHookContextBuilder::class)
             ->args([
                 tagged_iterator('ser_des.hook.serialize', 'name'),
-                tagged_iterator('ser_des.hook.deserialize', 'name'),
             ])
-            ->tag('ser_des.context_builder', ['priority' => -1024])
+            ->tag('ser_des.context_builder.serialize', ['priority' => -1024])
 
-        ->set('ser_des.context_builder.instantiator', InstantiatorContextBuilder::class)
+        ->set('ser_des.context_builder.serialize.name_attribute', SerializeNameAttributeContextBuilder::class)
             ->args([
-                service('ser_des.instantiator.lazy'),
+                service('ser_des.serializable_resolver'),
             ])
-            ->tag('ser_des.context_builder', ['priority' => -1024])
+            ->tag('ser_des.context_builder.serialize', ['priority' => -1024])
 
-        ->set('ser_des.context_builder.name_attribute', NameAttributeContextBuilder::class)
+        ->set('ser_des.context_builder.serialize.formatter_attribute', SerializeFormatterAttributeContextBuilder::class)
             ->args([
                 service('ser_des.serializable_resolver'),
             ])
-            ->tag('ser_des.context_builder', ['priority' => -1024])
+            ->tag('ser_des.context_builder.serialize', ['priority' => -1024])
 
-        ->set('ser_des.context_builder.name_attribute.cached', CachedContextBuilder::class)
-            ->decorate('ser_des.context_builder.name_attribute')
+        ->set('ser_des.context_builder.deserialize.hook', DeserializeHookContextBuilder::class)
             ->args([
-                service('ser_des.context_builder.name_attribute.cached.inner'),
-                'property_name',
-                'ser_des.context.name_attribute',
-                service('cache.ser_des')->ignoreOnInvalid(),
+                tagged_iterator('ser_des.hook.deserialize', 'name'),
             ])
+            ->tag('ser_des.context_builder.deserialize', ['priority' => -1024])
 
-        ->set('ser_des.context_builder.formatter_attribute', FormatterAttributeContextBuilder::class)
+        ->set('ser_des.context_builder.deserialize.name_attribute', DeserializeNameAttributeContextBuilder::class)
             ->args([
                 service('ser_des.serializable_resolver'),
             ])
-            ->tag('ser_des.context_builder', ['priority' => -1024])
+            ->tag('ser_des.context_builder.deserialize', ['priority' => -1024])
 
-        ->set('ser_des.context_builder.formatter_attribute.cached', CachedContextBuilder::class)
-            ->decorate('ser_des.context_builder.formatter_attribute')
+        ->set('ser_des.context_builder.deserialize.formatter_attribute', DeserializeFormatterAttributeContextBuilder::class)
             ->args([
-                service('ser_des.context_builder.formatter_attribute.cached.inner'),
-                'property_formatter',
-                'ser_des.context.formatter_attribute',
-                service('cache.ser_des')->ignoreOnInvalid(),
+                service('ser_des.serializable_resolver'),
+            ])
+            ->tag('ser_des.context_builder.deserialize', ['priority' => -1024])
+
+        ->set('ser_des.context_builder.deserialize.instantiator', DeserializeInstantiatorContextBuilder::class)
+            ->args([
+                service('ser_des.instantiator.lazy'),
             ])
+            ->tag('ser_des.context_builder.deserialize', ['priority' => -1024])
 
         // Hooks
         ->set('ser_des.hook.serialize.object', SerializeHook\ObjectHook::class)

src/Symfony/Component/SerDes/CachedSerializableResolver.php

@@ -11,16 +11,14 @@
 
 namespace Symfony\Component\SerDes;
 
+use Psr\Cache\CacheException;
 use Psr\Cache\CacheItemPoolInterface;
-use Symfony\Component\SerDes\Util\CachedTrait;
 
 /**
  * @author Mathias Arlaud <[email protected]>
  */
 final class CachedSerializableResolver implements SerializableResolverInterface
 {
-    use CachedTrait;
-
     public function __construct(
         private readonly SerializableResolverInterface $resolver,
         private readonly CacheItemPoolInterface|null $cacheItemPool = null,
@@ -29,13 +27,24 @@ public function __construct(
 
     public function resolve(): iterable
     {
-        yield from $this->getCached('ser_des.serializable', function (): array {
-            $serializables = [];
-            foreach ($this->resolver->resolve() as $class => $serializable) {
-                $serializables[$class] = $serializable;
-            }
-
-            return $serializables;
-        });
+        if (null === $this->cacheItemPool) {
+            yield from $this->resolver->resolve();
+
+            return;
+        }
+
+        try {
+            $item = $this->cacheItemPool->getItem('ser_des.serializable');
+        } catch (CacheException) {
+            yield from $this->resolver->resolve();
+
+            return;
+        }
+
+        if (!$item->isHit()) {
+            $item->set(iterator_to_array($this->resolver->resolve()));
+        }
+
+        yield from $item->get();
     }
 }

src/Symfony/Component/SerDes/Context/ContextBuilder/CachedContextBuilder.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Symfony\Component\SerDes\Context;
+namespace Symfony\Component\SerDes\Context\ContextBuilder;
 
 /**
  * @author Mathias Arlaud <[email protected]>
@@ -23,12 +23,5 @@ interface ContextBuilderInterface
      *
      * @return array<string, mixed>
      */
-    public function buildSerializeContext(array $context, bool $willGenerateTemplate): array;
-
-    /**
-     * @param array<string, mixed> $context
-     *
-     * @return array<string, mixed>
-     */
-    public function buildDeserializeContext(array $context): array;
+    public function build(array $context): array;
 }

src/Symfony/Component/SerDes/Context/ContextBuilderInterface.php renamed to src/Symfony/Component/SerDes/Context/ContextBuilder/ContextBuilderInterface.php

@@ -0,0 +1,82 @@
+<?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\Component\SerDes\Context\ContextBuilder\Deserialize;
+
+use Symfony\Component\SerDes\Attribute\Formatter;
+use Symfony\Component\SerDes\Context\ContextBuilder\DeserializeContextBuilderInterface;
+use Symfony\Component\SerDes\SerializableResolverInterface;
+
+/**
+ * @author Mathias Arlaud <[email protected]>
+ *
+ * @experimental in 7.0
+ */
+final class DeserializeFormatterAttributeContextBuilder implements DeserializeContextBuilderInterface
+{
+    /**
+     * @var array<string, string|array{0: string, 1: string}>
+     */
+    private static ?array $cache = null;
+
+    public function __construct(
+        private readonly SerializableResolverInterface $serializableResolver,
+    ) {
+    }
+
+    public function build(array $context): array
+    {
+        if (null === self::$cache) {
+            $propertyFormatters = [];
+
+            foreach ($this->serializableResolver->resolve() as $className => $_) {
+                $propertyFormatters += $this->propertyFormatters($className);
+            }
+
+            self::$cache = $propertyFormatters;
+        }
+
+        $context['_symfony']['property_formatter'] = self::$cache;
+
+        return $context;
+    }
+
+    /**
+     * @param class-string $className
+     *
+     * @return array<string, string|array{0: string, 1: string}>
+     */
+    private function propertyFormatters(string $className): array
+    {
+        $propertyFormatters = [];
+
+        foreach ((new \ReflectionClass($className))->getProperties() as $property) {
+            foreach ($property->getAttributes() as $attribute) {
+                if (Formatter::class !== $attribute->getName()) {
+                    continue;
+                }
+
+                /** @var Formatter $attributeInstance */
+                $attributeInstance = $attribute->newInstance();
+
+                if (null === $attributeInstance->onDeserialize) {
+                    break;
+                }
+
+                $propertyFormatters[sprintf('%s::$%s', $property->getDeclaringClass()->getName(), $property->getName())]['deserialize'] = $attributeInstance->onDeserialize;
+
+                break;
+            }
+        }
+
+        return $propertyFormatters;
+    }
+}