[JsonEncoder] Add Encodable attribute

mtarld · mtarld · commit ad8e5a0806dc · 2025-01-08T15:18:54.000+01:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -99,6 +99,7 @@
 use Symfony\Component\HttpKernel\DataCollector\DataCollectorInterface;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 use Symfony\Component\HttpKernel\Log\DebugLoggerConfigurator;
+use Symfony\Component\JsonEncoder\Attribute\Encodable;
 use Symfony\Component\JsonEncoder\Decode\Denormalizer\DenormalizerInterface as JsonEncoderDenormalizerInterface;
 use Symfony\Component\JsonEncoder\DecoderInterface as JsonEncoderDecoderInterface;
 use Symfony\Component\JsonEncoder\Encode\Normalizer\NormalizerInterface as JsonEncoderNormalizerInterface;
@@ -741,6 +742,10 @@ static function (ChildDefinition $definition, AsPeriodicTask|AsCronTask $attribu
                 }
             );
         }
+        $container->registerAttributeForAutoconfiguration(Encodable::class, static function (ChildDefinition $definition): void {
+            $definition->addTag('json_encoder.encodable');
+            $definition->addTag('container.excluded');
+        });
 
         if (!$container->getParameter('kernel.debug')) {
             // remove tagged iterator argument for resource checkers
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/JsonEncoderTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/JsonEncoderTest.php
@@ -12,6 +12,7 @@
 namespace Symfony\Bundle\FrameworkBundle\Tests\Functional;
 
 use Symfony\Bundle\FrameworkBundle\Tests\Functional\app\JsonEncoder\Dto\Dummy;
+use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\JsonEncoder\DecoderInterface;
 use Symfony\Component\JsonEncoder\EncoderInterface;
 use Symfony\Component\TypeInfo\Type;
@@ -21,10 +22,15 @@
  */
 class JsonEncoderTest extends AbstractWebTestCase
 {
-    public function testEncode()
+    protected function setUp(): void
     {
+        parent::setUp();
+
         static::bootKernel(['test_case' => 'JsonEncoder']);
+    }
 
+    public function testEncode()
+    {
         /** @var EncoderInterface $encoder */
         $encoder = static::getContainer()->get('json_encoder.encoder.alias');
 
@@ -33,8 +39,6 @@ public function testEncode()
 
     public function testDecode()
     {
-        static::bootKernel(['test_case' => 'JsonEncoder']);
-
         /** @var DecoderInterface $decoder */
         $decoder = static::getContainer()->get('json_encoder.decoder.alias');
 
@@ -44,4 +48,22 @@ public function testDecode()
 
         $this->assertEquals($expected, $decoder->decode('{"@name": "DUMMY", "range": "0..1"}', Type::object(Dummy::class)));
     }
+
+    public function testWarmupEncodableClasses()
+    {
+        /** @var Filesystem $fs */
+        $fs = static::getContainer()->get('filesystem');
+
+        $encodersDir = \sprintf('%s/json_encoder/encoder/', static::getContainer()->getParameter('kernel.cache_dir'));
+
+        // clear already created encoders
+        if ($fs->exists($encodersDir)) {
+            $fs->remove($encodersDir);
+        }
+
+        static::getContainer()->get('json_encoder.cache_warmer.encoder_decoder.alias')->warmUp(static::getContainer()->getParameter('kernel.cache_dir'));
+
+        $this->assertFileExists($encodersDir);
+        $this->assertCount(1, glob($encodersDir.'/*'));
+    }
 }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/JsonEncoder/Dto/Dummy.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/JsonEncoder/Dto/Dummy.php
@@ -13,12 +13,14 @@
 
 use Symfony\Bundle\FrameworkBundle\Tests\Functional\app\JsonEncoder\RangeNormalizer;
 use Symfony\Component\JsonEncoder\Attribute\Denormalizer;
+use Symfony\Component\JsonEncoder\Attribute\Encodable;
 use Symfony\Component\JsonEncoder\Attribute\EncodedName;
 use Symfony\Component\JsonEncoder\Attribute\Normalizer;
 
 /**
  * @author Mathias Arlaud <mathias.arlaud@gmail.com>
  */
+#[Encodable]
 class Dummy
 {
     #[EncodedName('@name')]
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/JsonEncoder/config.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/JsonEncoder/config.yml
@@ -18,4 +18,9 @@ services:
         alias: json_encoder.decoder
         public: true
 
+    json_encoder.cache_warmer.encoder_decoder.alias:
+        alias: .json_encoder.cache_warmer.encoder_decoder
+        public: true
+
+    Symfony\Bundle\FrameworkBundle\Tests\Functional\app\JsonEncoder\Dto\Dummy: ~
     Symfony\Bundle\FrameworkBundle\Tests\Functional\app\JsonEncoder\RangeNormalizer: ~
diff --git a/src/Symfony/Component/JsonEncoder/Attribute/Encodable.php b/src/Symfony/Component/JsonEncoder/Attribute/Encodable.php
@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\JsonEncoder\Attribute;
+
+/**
+ * Mark a class as encodable.
+ *
+ * @author Mathias Arlaud <mathias.arlaud@gmail.com>
+ *
+ * @experimental
+ */
+#[\Attribute(\Attribute::TARGET_CLASS)]
+final class Encodable
+{
+}
diff --git a/src/Symfony/Component/JsonEncoder/DependencyInjection/EncodablePass.php b/src/Symfony/Component/JsonEncoder/DependencyInjection/EncodablePass.php
@@ -30,7 +30,11 @@ public function process(ContainerBuilder $container): void
         $encodableClassNames = [];
 
         // retrieve concrete services tagged with "json_encoder.encodable" tag
-        foreach ($container->findTaggedServiceIds('json_encoder.encodable') as $id => $tags) {
+        foreach ($container->getDefinitions() as $id => $definition) {
+            if (!$definition->hasTag('json_encoder.encodable')) {
+                continue;
+            }
+
             if (($className = $container->getDefinition($id)->getClass()) && !$container->getDefinition($id)->isAbstract()) {
                 $encodableClassNames[] = $className;
             }
