[FrameworkBundle] fix wiring of annotations.cached_reader

nicolas-grekas · nicolas-grekas · commit db7ec1c6f6b9 · 2022-05-22T18:33:50.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/AddAnnotationsCachedReaderPass.php b/src/Symfony/Bundle/FrameworkBundle/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/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/UnusedTagsPass.php b/src/Symfony/Bundle/FrameworkBundle/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/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/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/src/Symfony/Bundle/FrameworkBundle/Resources/config/annotations.xml b/src/Symfony/Bundle/FrameworkBundle/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/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php b/src/Symfony/Bundle/FrameworkBundle/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',
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/DecoratorServicePass.php b/src/Symfony/Component/DependencyInjection/Compiler/DecoratorServicePass.php
@@ -40,6 +40,10 @@ public function process(ContainerBuilder $container)
         }
         $decoratingDefinitions = [];
 
+        $tagsToKeep = $container->hasParameter('container.behavior_describing_tags')
+            ? $container->getParameter('container.behavior_describing_tags')
+            : ['container.do_not_inline', 'container.service_locator', 'container.service_subscriber'];
+
         foreach ($definitions as [$id, $definition]) {
             $decoratedService = $definition->getDecoratedService();
             [$inner, $renamedId] = $decoratedService;
@@ -89,8 +93,8 @@ public function process(ContainerBuilder $container)
                 $decoratingTags = $decoratingDefinition->getTags();
                 $resetTags = [];
 
-                // container.service_locator and container.service_subscriber have special logic and they must not be transferred out to decorators
-                foreach (['container.service_locator', 'container.service_subscriber'] as $containerTag) {
+                // Behavior-describing tags must not be transferred out to decorators
+                foreach ($tagsToKeep as $containerTag) {
                     if (isset($decoratingTags[$containerTag])) {
                         $resetTags[$containerTag] = $decoratingTags[$containerTag];
                         unset($decoratingTags[$containerTag]);
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/InlineServiceDefinitionsPass.php b/src/Symfony/Component/DependencyInjection/Compiler/InlineServiceDefinitionsPass.php
@@ -177,7 +177,7 @@ protected function processValue($value, $isRoot = false)
      */
     private function isInlineableDefinition(string $id, Definition $definition): bool
     {
-        if ($definition->hasErrors() || $definition->isDeprecated() || $definition->isLazy() || $definition->isSynthetic()) {
+        if ($definition->hasErrors() || $definition->isDeprecated() || $definition->isLazy() || $definition->isSynthetic() || $definition->hasTag('container.do_not_inline')) {
             return false;
         }
 
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/RemoveUnusedDefinitionsPass.php b/src/Symfony/Component/DependencyInjection/Compiler/RemoveUnusedDefinitionsPass.php
@@ -41,12 +41,9 @@ public function process(ContainerBuilder $container)
             $this->enableExpressionProcessing();
             $this->container = $container;
             $connectedIds = [];
-            $aliases = $container->getAliases();
 
-            foreach ($aliases as $id => $alias) {
-                if ($alias->isPublic()) {
-                    $this->connectedIds[] = (string) $aliases[$id];
-                }
+            foreach ($container->getAliases() as $alias) {
+                $this->connectedIds[] = (string) $alias;
             }
 
             foreach ($container->getDefinitions() as $id => $definition) {
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ReplaceAliasByActualDefinitionPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ReplaceAliasByActualDefinitionPass.php
@@ -61,7 +61,7 @@ public function process(ContainerBuilder $container)
 
                 throw $e;
             }
-            if ($definition->isPublic()) {
+            if ($definition->isPublic() || $definition->hasTag('container.do_not_inline')) {
                 continue;
             }
             // Remove private definition and schedule for replacement

Original file line number	Diff line number	Diff line change
`@@ -177,7 +177,7 @@ protected function processValue($value, $isRoot = false)`
`177`	`177`	`*/`
`178`	`178`	`private function isInlineableDefinition(string $id, Definition $definition): bool`
`179`	`179`	`{`
`180`		`- if ($definition->hasErrors() \|\| $definition->isDeprecated() \|\| $definition->isLazy() \|\| $definition->isSynthetic()) {`
	`180`	`+ if ($definition->hasErrors() \|\| $definition->isDeprecated() \|\| $definition->isLazy() \|\| $definition->isSynthetic() \|\| $definition->hasTag('container.do_not_inline')) {`
`181`	`181`	`return false;`
`182`	`182`	`}`
`183`	`183`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ public function process(ContainerBuilder $container)`
`61`	`61`
`62`	`62`	`throw $e;`
`63`	`63`	`}`
`64`		`- if ($definition->isPublic()) {`
	`64`	`+ if ($definition->isPublic() \|\| $definition->hasTag('container.do_not_inline')) {`
`65`	`65`	`continue;`
`66`	`66`	`}`
`67`	`67`	`// Remove private definition and schedule for replacement`