feature #28176 [DI] [FrameworkBundle] Add LoggerAwareInterface to auto configuration (GaryPEGEOT)

nicolas-grekas · nicolas-grekas · commit 09344649934c · 2018-08-14T17:12:50.000+02:00
This PR was squashed before being merged into the 4.2-dev branch (closes #28176). Discussion ---------- [DI] [FrameworkBundle] Add LoggerAwareInterface to auto configuration | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | Add the method call `setLogger` for every service implementing `Psr\Log\LoggerAwareInterface` Commits ------- afda3c8 [DI] [FrameworkBundle] Add LoggerAwareInterface to auto configuration
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -8,6 +8,7 @@ CHANGELOG
  * Allowed configuring PDO-based cache pools via a new `cache.adapter.pdo` abstract service
  * Deprecated auto-injection of the container in AbstractController instances, register them as service subscribers instead
  * Deprecated processing of services tagged `security.expression_language_provider` in favor of a new `AddExpressionLanguageProvidersPass` in SecurityBundle.
+ * Enabled autoconfiguration for `Psr\Log\LoggerAwareInterface`
 
 4.1.0
 -----
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -13,6 +13,7 @@
 
 use Doctrine\Common\Annotations\AnnotationRegistry;
 use Doctrine\Common\Annotations\Reader;
+use Psr\Log\LoggerAwareInterface;
 use Symfony\Bridge\Monolog\Processor\DebugProcessor;
 use Symfony\Bridge\Monolog\Processor\ProcessorInterface;
 use Symfony\Bridge\Twig\Extension\CsrfExtension;
@@ -360,6 +361,8 @@ public function load(array $configs, ContainerBuilder $container)
             ->addTag('messenger.message_handler');
         $container->registerForAutoconfiguration(TransportFactoryInterface::class)
             ->addTag('messenger.transport_factory');
+        $container->registerForAutoconfiguration(LoggerAwareInterface::class)
+            ->addMethodCall('setLogger', array(new Reference('logger')));
 
         if (!$container->getParameter('kernel.debug')) {
             // remove tagged iterator argument for resource checkers
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
@@ -12,6 +12,7 @@
 namespace Symfony\Bundle\FrameworkBundle\Tests\DependencyInjection;
 
 use Doctrine\Common\Annotations\Annotation;
+use Psr\Log\LoggerAwareInterface;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\AddAnnotationsCachedReaderPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\FrameworkExtension;
 use Symfony\Bundle\FrameworkBundle\Tests\TestCase;
@@ -26,6 +27,7 @@
 use Symfony\Component\Cache\Adapter\RedisAdapter;
 use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\Compiler\ResolveInstanceofConditionalsPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Definition;
@@ -1224,6 +1226,22 @@ public function testRemovesResourceCheckerConfigCacheFactoryArgumentOnlyIfNoDebu
         $this->assertEmpty($container->getDefinition('config_cache_factory')->getArguments());
     }
 
+    public function testLoggerAwareRegistration()
+    {
+        $container = $this->createContainerFromFile('full', array(), true, false);
+        $container->addCompilerPass(new ResolveInstanceofConditionalsPass());
+        $container->register('foo', LoggerAwareInterface::class)
+            ->setAutoconfigured(true);
+        $container->compile();
+
+        $calls = $container->findDefinition('foo')->getMethodCalls();
+
+        $this->assertCount(1, $calls, 'Definition should contain 1 method call');
+        $this->assertSame('setLogger', $calls[0][0], 'Method name should be "setLogger"');
+        $this->assertInstanceOf(Reference::class, $calls[0][1][0]);
+        $this->assertSame('logger', (string) $calls[0][1][0], 'Argument should be a reference to "logger"');
+    }
+
     protected function createContainer(array $data = array())
     {
         return new ContainerBuilder(new ParameterBag(array_merge(array(
