Merge pull request #289 from php-enqueue/impr-set-logger-extension

[consumption] Add ability to overwrite logger.

Author: makasim

Diff for: docs/cookbook/symfony/how-to-change-consume-command-logger.md

@@ -0,0 +1,28 @@
+# How to change consume command logger
+
+By default `bin/console enqueue:consume` (or `bin/console enqueue:transport:consume`) command prints messages to output.
+The amount of info could be controlled by verbosity option (-v, -vv, -vvv).
+
+In order to change the default logger used by a command you have to register a `LoggerExtension` just before the default one.
+The extension asks you for a logger service, so just pass the one you want to use. 
+Here's how you can do it. 
+
+```yaml
+// config/services.yaml
+
+services:
+    app_logger_extension:
+        class: 'Enqueue\Consumption\Extension\LoggerExtension'
+        public: false
+        arguments: ['@logger']
+        tags:
+            - { name: 'enqueue.consumption.extension', priority: 255 }
+
+```
+
+The logger extension with the highest priority will set its logger.
+
+[back to index](../index.md)  
+
+
+

Diff for: docs/index.md

@@ -51,6 +51,11 @@
 * [Development](#development)
     - [Contribution](contribution.md)
 
+## Cookbook
+
+* [Symfony](#symfony-cookbook)
+    - [How to change consume command logger](cookbook/symfony/how-to-change-consume-command-logger.md)
+
 # Blogs
 
 * [Getting Started with RabbitMQ in PHP](https://blog.forma-pro.com/getting-started-with-rabbitmq-in-php-84d331e20a66)

Diff for: pkg/enqueue/Consumption/Extension/LoggerExtension.php

@@ -31,8 +31,16 @@ public function __construct(LoggerInterface $logger)
      */
     public function onStart(Context $context)
     {
-        $context->setLogger($this->logger);
-        $this->logger->debug(sprintf('Set context\'s logger %s', get_class($this->logger)));
+        if ($context->getLogger()) {
+            $context->getLogger()->debug(sprintf(
+                'Skip setting context\'s logger "%s". Another one "%s" has already been set.',
+                get_class($context->getLogger()),
+                get_class($this->logger)
+            ));
+        } else {
+            $context->setLogger($this->logger);
+            $this->logger->debug(sprintf('Set context\'s logger "%s"', get_class($this->logger)));
+        }
     }
 
     /**

Diff for: pkg/enqueue/Tests/Consumption/Extension/LoggerExtensionTest.php

@@ -151,6 +151,29 @@ public function testShouldNotLogAckMessageStatusIfReasonIsEmpty()
         $extension->onPostReceived($context);
     }
 
+    public function testShouldNotSetLoggerIfOneHasBeenSetOnStart()
+    {
+        $logger = $this->createLogger();
+
+        $alreadySetLogger = $this->createLogger();
+        $alreadySetLogger
+            ->expects($this->once())
+            ->method('debug')
+            ->with(sprintf(
+                'Skip setting context\'s logger "%s". Another one "%s" has already been set.',
+                get_class($logger),
+                get_class($alreadySetLogger)
+            ))
+        ;
+
+        $extension = new LoggerExtension($logger);
+
+        $context = new Context($this->createPsrContextMock());
+        $context->setLogger($alreadySetLogger);
+
+        $extension->onStart($context);
+    }
+
     /**
      * @return \PHPUnit_Framework_MockObject_MockObject|PsrContext
      */