bug symfony#59287 [JsonEncoder] Fix retrieving encodable classes (mtarld)

This PR was merged into the 7.3 branch.

Discussion
----------

[JsonEncoder] Fix retrieving encodable classes

| Q             | A
| ------------- | ---
| Branch?       | 7.3
| Bug fix?      | yes
| New feature?  | no
| Deprecations? | no
| Issues        |
| License       | MIT

Fix encodable classes retrievable.

They now can be retrieved if they are services tagged with `json_encoder.encodable`.

This as well lay the foundations for a next PR that will allow defining specific types to warm up in configuration.

Commits
-------

c94098f [JsonEncoder] Fix retrieving encodable classes

Author: nicolas-grekas

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

@@ -2595,16 +2595,6 @@ private function addJsonEncoderSection(ArrayNodeDefinition $rootNode, callable $
                 ->arrayNode('json_encoder')
                     ->info('JSON encoder configuration')
                     ->{$enableIfStandalone('symfony/json-encoder', EncoderInterface::class)}()
-                    ->fixXmlConfig('path')
-                    ->children()
-                        ->arrayNode('paths')
-                            ->info('Namespaces and paths of encodable/decodable classes.')
-                            ->normalizeKeys(false)
-                            ->useAttributeAsKey('namespace')
-                            ->scalarPrototype()->end()
-                            ->defaultValue([])
-                        ->end()
-                    ->end()
                 ->end()
             ->end()
         ;

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

@@ -2029,15 +2029,6 @@ private function registerJsonEncoderConfiguration(array $config, ContainerBuilde
         $container->setParameter('.json_encoder.decoders_dir', '%kernel.cache_dir%/json_encoder/decoder');
         $container->setParameter('.json_encoder.lazy_ghosts_dir', '%kernel.cache_dir%/json_encoder/lazy_ghost');
 
-        $encodableDefinition = (new Definition())
-            ->setAbstract(true)
-            ->addTag('container.excluded')
-            ->addTag('json_encoder.encodable');
-
-        foreach ($config['paths'] as $namespace => $path) {
-            $loader->registerClasses($encodableDefinition, $namespace, $path);
-        }
-
         if (\PHP_VERSION_ID >= 80400) {
             $container->removeDefinition('.json_encoder.cache_warmer.lazy_ghost');
         }

src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php

@@ -54,6 +54,7 @@
 use Symfony\Component\HttpKernel\DependencyInjection\RemoveEmptyControllerArgumentLocatorsPass;
 use Symfony\Component\HttpKernel\DependencyInjection\ResettableServicePass;
 use Symfony\Component\HttpKernel\KernelEvents;
+use Symfony\Component\JsonEncoder\DependencyInjection\EncodablePass;
 use Symfony\Component\Messenger\DependencyInjection\MessengerPass;
 use Symfony\Component\Mime\DependencyInjection\AddMimeTypeGuesserPass;
 use Symfony\Component\PropertyInfo\DependencyInjection\PropertyInfoConstructorPass;
@@ -188,6 +189,7 @@ public function build(ContainerBuilder $container): void
         $container->addCompilerPass(new ErrorLoggerCompilerPass(), PassConfig::TYPE_BEFORE_OPTIMIZATION, -32);
         $container->addCompilerPass(new VirtualRequestStackPass());
         $container->addCompilerPass(new TranslationUpdateCommandPass(), PassConfig::TYPE_BEFORE_REMOVING);
+        $container->addCompilerPass(new EncodablePass());
 
         if ($container->getParameter('kernel.debug')) {
             $container->addCompilerPass(new AddDebugLogProcessorPass(), PassConfig::TYPE_BEFORE_OPTIMIZATION, 2);

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

@@ -107,7 +107,7 @@
         // cache
         ->set('.json_encoder.cache_warmer.encoder_decoder', EncoderDecoderCacheWarmer::class)
             ->args([
-                tagged_iterator('json_encoder.encodable'),
+                abstract_arg('encodable class names'),
                 service('json_encoder.encode.property_metadata_loader'),
                 service('json_encoder.decode.property_metadata_loader'),
                 param('.json_encoder.encoders_dir'),
@@ -118,7 +118,7 @@
 
         ->set('.json_encoder.cache_warmer.lazy_ghost', LazyGhostCacheWarmer::class)
             ->args([
-                tagged_iterator('json_encoder.encodable'),
+                abstract_arg('encodable class names'),
                 param('.json_encoder.lazy_ghosts_dir'),
             ])
             ->tag('kernel.cache_warmer')

src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd

@@ -1007,11 +1007,7 @@
     </xsd:complexType>
 
     <xsd:complexType name="json-encoder">
-        <xsd:choice minOccurs="0" maxOccurs="unbounded">
-            <xsd:sequence>
-                <xsd:element name="default-context" type="metadata" minOccurs="0" maxOccurs="1" />
-            </xsd:sequence>
-        </xsd:choice>
         <xsd:attribute name="enabled" type="xsd:boolean" />
     </xsd:complexType>
+
 </xsd:schema>

src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php

@@ -973,7 +973,6 @@ class_exists(SemaphoreStore::class) && SemaphoreStore::isSupported() ? 'semaphor
             ],
             'json_encoder' => [
                 'enabled' => !class_exists(FullStack::class) && class_exists(JsonEncoder::class),
-                'paths' => [],
             ],
         ];
     }

src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/JsonEncoder/config.yml

@@ -4,10 +4,7 @@ imports:
 framework:
     http_method_override: false
     type_info: ~
-    json_encoder:
-        enabled: true
-        paths:
-            Symfony\Bundle\FrameworkBundle\Tests\Functional\app\JsonEncoder\Dto\: '../../Tests/Functional/app/JsonEncoder/Dto/*'
+    json_encoder: ~
 
 services:
     _defaults:

src/Symfony/Component/JsonEncoder/DependencyInjection/EncodablePass.php

@@ -0,0 +1,49 @@
+<?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\DependencyInjection;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/**
+ * Sets the encodable classes to the services that need them.
+ *
+ * @author Mathias Arlaud <mathias.arlaud@gmail.com>
+ */
+class EncodablePass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container): void
+    {
+        if (!$container->hasDefinition('json_encoder.encoder')) {
+            return;
+        }
+
+        $encodableClassNames = [];
+
+        // retrieve concrete services tagged with "json_encoder.encodable" tag
+        foreach ($container->findTaggedServiceIds('json_encoder.encodable') as $id => $tags) {
+            if (($className = $container->getDefinition($id)->getClass()) && !$container->getDefinition($id)->isAbstract()) {
+                $encodableClassNames[] = $className;
+            }
+
+            $container->removeDefinition($id);
+        }
+
+        $container->getDefinition('.json_encoder.cache_warmer.encoder_decoder')
+            ->replaceArgument(0, $encodableClassNames);
+
+        if ($container->hasDefinition('.json_encoder.cache_warmer.lazy_ghost')) {
+            $container->getDefinition('.json_encoder.cache_warmer.lazy_ghost')
+                ->replaceArgument(0, $encodableClassNames);
+        }
+    }
+}

src/Symfony/Component/JsonEncoder/Tests/DependencyInjection/EncodablePassTest.php

@@ -0,0 +1,43 @@
+<?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\Tests\DependencyInjection;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\JsonEncoder\DependencyInjection\EncodablePass;
+
+class EncodablePassTest extends TestCase
+{
+    public function testSetEncodableClassNames()
+    {
+        $container = new ContainerBuilder();
+
+        $container->register('json_encoder.encoder');
+        $container->register('.json_encoder.cache_warmer.encoder_decoder')->setArguments([null]);
+        $container->register('.json_encoder.cache_warmer.lazy_ghost')->setArguments([null]);
+
+        $container->register('encodable')->setClass('Foo')->addTag('json_encoder.encodable');
+        $container->register('abstractEncodable')->setClass('Bar')->addTag('json_encoder.encodable')->setAbstract(true);
+        $container->register('notEncodable')->setClass('Baz');
+
+        $pass = new EncodablePass();
+        $pass->process($container);
+
+        $encoderDecoderCacheWarmer = $container->getDefinition('.json_encoder.cache_warmer.encoder_decoder');
+        $lazyGhostCacheWarmer = $container->getDefinition('.json_encoder.cache_warmer.lazy_ghost');
+
+        $expectedEncodableClassNames = ['Foo'];
+
+        $this->assertSame($expectedEncodableClassNames, $encoderDecoderCacheWarmer->getArgument(0));
+        $this->assertSame($expectedEncodableClassNames, $lazyGhostCacheWarmer->getArgument(0));
+    }
+}

src/Symfony/Component/JsonEncoder/composer.json

@@ -26,6 +26,7 @@
     },
     "require-dev": {
         "phpstan/phpdoc-parser": "^1.0",
+        "symfony/dependency-injection": "^7.2",
         "symfony/http-kernel": "^7.2"
     },
     "autoload": {