bug #46427 [FrameworkBundle] fix wiring of annotations.cached_reader (nicolas-grekas)

nicolas-grekas · nicolas-grekas · commit 6eee263fb57f · 2022-05-23T12:22:55.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [FrameworkBundle] fix wiring of annotations.cached_reader | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Fix #46202 | License | MIT | Doc PR | - Also fixes symfony/symfony#26088 (comment) Instead of trying to hack the compilation of the container to prevent it from inlining `annotations.cached_reader`, this PR relies on an `container.do_not_inline` tag that just does that, prevent inlining so that removing passes can reliably fetch the corresponding services from the container by id or by tag. Commits ------- e32b7b15ec [FrameworkBundle] fix wiring of annotations.cached_reader
diff --git a/DependencyInjection/Compiler/AddAnnotationsCachedReaderPass.php b/DependencyInjection/Compiler/AddAnnotationsCachedReaderPass.php
@@ -29,7 +29,6 @@ public function process(ContainerBuilder $container)
         // "annotation_reader" at build time don't get any cache
         foreach ($container->findTaggedServiceIds('annotations.cached_reader') as $id => $tags) {
             $reader = $container->getDefinition($id);
-            $reader->setPublic(false);
             $properties = $reader->getProperties();
 
             if (isset($properties['cacheProviderBackup'])) {
diff --git a/DependencyInjection/Compiler/UnusedTagsPass.php b/DependencyInjection/Compiler/UnusedTagsPass.php
@@ -28,6 +28,7 @@ class UnusedTagsPass implements CompilerPassInterface
         'cache.pool.clearer',
         'config_cache.resource_checker',
         'console.command',
+        'container.do_not_inline',
         'container.env_var_loader',
         'container.env_var_processor',
         'container.hot_path',
diff --git a/DependencyInjection/FrameworkExtension.php b/DependencyInjection/FrameworkExtension.php
@@ -469,6 +469,8 @@ public function load(array $configs, ContainerBuilder $container)
             ->addTag('routing.route_loader');
 
         $container->setParameter('container.behavior_describing_tags', [
+            'annotations.cached_reader',
+            'container.do_not_inline',
             'container.service_locator',
             'container.service_subscriber',
             'kernel.event_subscriber',
@@ -1463,11 +1465,9 @@ private function registerAnnotationsConfiguration(array $config, ContainerBuilde
 
             $container
                 ->getDefinition('annotations.cached_reader')
-                ->setPublic(true) // set to false in AddAnnotationsCachedReaderPass
                 ->replaceArgument(2, $config['debug'])
                 // reference the cache provider without using it until AddAnnotationsCachedReaderPass runs
                 ->addArgument(new ServiceClosureArgument(new Reference($cacheService)))
-                ->addTag('annotations.cached_reader')
             ;
 
             $container->setAlias('annotation_reader', 'annotations.cached_reader')->setPrivate(true);
diff --git a/Resources/config/annotations.xml b/Resources/config/annotations.xml
@@ -31,6 +31,8 @@
                 </service>
             </argument>
             <argument /><!-- Debug-Flag -->
+            <tag name="annotations.cached_reader" />
+            <tag name="container.do_not_inline" />
         </service>
 
         <service id="annotations.filesystem_cache_adapter" class="Symfony\Component\Cache\Adapter\FilesystemAdapter">
diff --git a/Tests/DependencyInjection/FrameworkExtensionTest.php b/Tests/DependencyInjection/FrameworkExtensionTest.php
@@ -1699,6 +1699,8 @@ public function testRegisterParameterCollectingBehaviorDescribingTags()
 
         $this->assertTrue($container->hasParameter('container.behavior_describing_tags'));
         $this->assertEquals([
+            'annotations.cached_reader',
+            'container.do_not_inline',
             'container.service_locator',
             'container.service_subscriber',
             'kernel.event_subscriber',
