bug #254 Make channel selection work with autowired arguments (stof)

This PR was merged into the 3.x-dev branch.

Discussion
----------

Make channel selection work with autowired arguments

This only works on Symfony 3.4+, not on Symfony 3.3, but 3.3 is EOL already so this is fine.

Closes #218
Closes #228
Replaces #251

Commits
-------

457032a Make channel selection work with autowired arguments

Author: stof

DependencyInjection/Compiler/LoggerChannelPass.php

@@ -11,6 +11,7 @@
 
 namespace Symfony\Bundle\MonologBundle\DependencyInjection\Compiler;
 
+use Symfony\Component\DependencyInjection\Argument\BoundArgument;
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -61,6 +62,20 @@ public function process(ContainerBuilder $container)
                     }
                 }
                 $definition->setMethodCalls($calls);
+
+                if (!$definition instanceof ChildDefinition && \method_exists($definition, 'getBindings')) {
+                    $binding = new BoundArgument(new Reference($loggerId));
+
+                    // Mark the binding as used already, to avoid reporting it as unused if the service does not use a
+                    // logger injected through the LoggerInterface alias.
+                    $values = $binding->getValues();
+                    $values[2] = true;
+                    $binding->setValues($values);
+
+                    $bindings = $definition->getBindings();
+                    $bindings['Psr\Log\LoggerInterface'] = $binding;
+                    $definition->setBindings($bindings);
+                }
             }
         }
 

Tests/DependencyInjection/Compiler/LoggerChannelPassTest.php

@@ -12,6 +12,7 @@
 namespace Symfony\Bundle\MonologBundle\Tests\DependencyInjection\Compiler;
 
 use PHPUnit\Framework\TestCase;
+use Psr\Log\LoggerInterface;
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -63,7 +64,55 @@ public function testProcessSetters()
         $this->assertEquals('monolog.logger.test', (string) $calls[0][1][0], '->process replaces the logger by the new one in setters');
     }
 
-    protected function getContainer()
+    public function testAutowiredLoggerArgumentsAreReplacedWithChannelLogger()
+    {
+        if (!\method_exists('Symfony\Component\DependencyInjection\Definition', 'getBindings')) {
+            $this->markTestSkipped('Need DependencyInjection 3.4+ to autowire channel logger.');
+        }
+
+        $container = $this->getFunctionalContainer();
+
+        $dummyService = $container->register('dummy_service', 'Symfony\Bundle\MonologBundle\Tests\DependencyInjection\Compiler\DummyService')
+            ->setAutowired(true)
+            ->setPublic(true)
+            ->addTag('monolog.logger', array('channel' => 'test'));
+
+        $container->compile();
+
+        $this->assertEquals('monolog.logger.test', (string) $dummyService->getArgument(0));
+    }
+
+    public function testAutowiredLoggerArgumentsAreNotReplacedWithChannelLoggerIfLoggerArgumentIsConfiguredExplicitly()
+    {
+        if (!\method_exists('Symfony\Component\DependencyInjection\Definition', 'getBindings')) {
+            $this->markTestSkipped('Need DependencyInjection 3.4+ to autowire channel logger.');
+        }
+
+        $container = $this->getFunctionalContainer();
+
+        $dummyService = $container->register('dummy_service', 'Symfony\Bundle\MonologBundle\Tests\DependencyInjection\Compiler\DummyService')
+            ->setAutowired(true)
+            ->addArgument(new Reference('monolog.logger'))
+            ->addTag('monolog.logger', array('channel' => 'test'));
+
+        $container->compile();
+
+        $this->assertEquals('monolog.logger', (string) $dummyService->getArgument(0));
+    }
+
+    public function testTagNotBreakingIfNoLogger()
+    {
+        $container = $this->getFunctionalContainer();
+
+        $dummyService = $container->register('dummy_service', 'stdClass')
+            ->addTag('monolog.logger', array('channel' => 'test'));
+
+        $container->compile();
+
+        $this->assertEquals(array(), $dummyService->getArguments());
+    }
+
+    private function getContainer()
     {
         $container = new ContainerBuilder();
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../../../Resources/config'));
@@ -105,7 +154,7 @@ protected function getContainer()
         return $container;
     }
 
-    protected function getContainerWithSetter()
+    private function getContainerWithSetter()
     {
         $container = new ContainerBuilder();
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../../../Resources/config'));
@@ -130,4 +179,29 @@ protected function getContainerWithSetter()
 
         return $container;
     }
+
+    private function getFunctionalContainer()
+    {
+        $container = new ContainerBuilder();
+        $container->setParameter('monolog.additional_channels', array());
+        $container->setParameter('monolog.handlers_to_channels', array());
+        $container->setParameter('monolog.use_microseconds', true);
+
+        $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../../../Resources/config'));
+        $loader->load('monolog.xml');
+
+        $container->addCompilerPass(new LoggerChannelPass());
+
+        // disable removing passes to be able to inspect the container before all the inlining optimizations
+        $container->getCompilerPassConfig()->setRemovingPasses(array());
+
+        return $container;
+    }
+}
+
+class DummyService
+{
+    public function __construct(LoggerInterface $logger)
+    {
+    }
 }