Fix Monolog handler instantiation (laravel#30123)

i-bajrai · Oct 4, 2019 · 1ce67e8 · 1ce67e8
1 parent 790e78a
commit 1ce67e8
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 2 deletions.
diff --git a/src/Illuminate/Log/LogManager.php b/src/Illuminate/Log/LogManager.php
@@ -7,6 +7,7 @@
 use InvalidArgumentException;
 use Monolog\Formatter\LineFormatter;
 use Monolog\Handler\ErrorLogHandler;
+use Monolog\Handler\FormattableHandlerInterface;
 use Monolog\Handler\HandlerInterface;
 use Monolog\Handler\RotatingFileHandler;
 use Monolog\Handler\SlackWebhookHandler;
@@ -393,9 +394,17 @@ protected function prepareHandlers(array $handlers)
      */
     protected function prepareHandler(HandlerInterface $handler, array $config = [])
     {
-        if (! isset($config['formatter'])) {
+        $isHandlerFormattable = false;
+
+        if (Monolog::API === 1) {
+            $isHandlerFormattable = true;
+        } elseif (Monolog::API === 2 && $handler instanceof FormattableHandlerInterface) {
+            $isHandlerFormattable = true;
+        }
+
+        if ($isHandlerFormattable && ! isset($config['formatter'])) {
             $handler->setFormatter($this->formatter());
-        } elseif ($config['formatter'] !== 'default') {
+        } elseif ($isHandlerFormattable && $config['formatter'] !== 'default') {
             $handler->setFormatter($this->app->make($config['formatter'], $config['formatter_with'] ?? []));
         }
 

diff --git a/tests/Log/LogManagerTest.php b/tests/Log/LogManagerTest.php
@@ -9,6 +9,7 @@
 use Monolog\Formatter\NormalizerFormatter;
 use Monolog\Handler\LogEntriesHandler;
 use Monolog\Handler\NewRelicHandler;
+use Monolog\Handler\NullHandler;
 use Monolog\Handler\StreamHandler;
 use Monolog\Handler\SyslogHandler;
 use Monolog\Logger as Monolog;
@@ -164,6 +165,44 @@ public function testLogManagerCreatesMonologHandlerWithConfiguredFormatter()
         $this->assertSame('Y/m/d--test', $dateFormat->getValue($formatter));
     }
 
+    public function testLogManagerCreatesMonologHandlerWithProperFormatter()
+    {
+        $config = $this->app->make('config');
+        $config->set('logging.channels.null', [
+            'driver' => 'monolog',
+            'handler' => NullHandler::class,
+            'formatter' => HtmlFormatter::class,
+        ]);
+
+        $manager = new LogManager($this->app);
+
+        // create logger with handler specified from configuration
+        $logger = $manager->channel('null');
+        $handler = $logger->getLogger()->getHandlers()[0];
+
+        if (Monolog::API === 1) {
+            $this->assertInstanceOf(NullHandler::class, $handler);
+            $this->assertInstanceOf(HtmlFormatter::class, $handler->getFormatter());
+        } else {
+            $this->assertInstanceOf(NullHandler::class, $handler);
+        }
+
+        $config->set('logging.channels.null2', [
+            'driver' => 'monolog',
+            'handler' => NullHandler::class,
+        ]);
+
+        $logger = $manager->channel('null2');
+        $handler = $logger->getLogger()->getHandlers()[0];
+
+        if (Monolog::API === 1) {
+            $this->assertInstanceOf(NullHandler::class, $handler);
+            $this->assertInstanceOf(LineFormatter::class, $handler->getFormatter());
+        } else {
+            $this->assertInstanceOf(NullHandler::class, $handler);
+        }
+    }
+
     public function testLogManagerCreateSingleDriverWithConfiguredFormatter()
     {
         $config = $this->app['config'];