ACP2E-1287: log exception to exception.log

Author: alzota

lib/internal/Magento/Framework/Logger/LoggerProxy.php

@@ -99,6 +99,7 @@ private function getLogger(): LoggerInterface
      */
     public function emergency($message, array $context = [])
     {
+        $context = $this->addExceptionToContext($message, $context);
         $this->getLogger()->emergency($message, $context);
     }
 
@@ -107,6 +108,7 @@ public function emergency($message, array $context = [])
      */
     public function alert($message, array $context = [])
     {
+        $context = $this->addExceptionToContext($message, $context);
         $this->getLogger()->alert($message, $context);
     }
 
@@ -115,6 +117,7 @@ public function alert($message, array $context = [])
      */
     public function critical($message, array $context = [])
     {
+        $context = $this->addExceptionToContext($message, $context);
         $this->getLogger()->critical($message, $context);
     }
 
@@ -165,4 +168,19 @@ public function log($level, $message, array $context = [])
     {
         $this->getLogger()->log($level, $message, $context);
     }
+
+    /**
+     * Ensure exception logging by adding it to context
+     *
+     * @param $message
+     * @param array $context
+     * @return array
+     */
+    protected function addExceptionToContext($message, array $context = []): array
+    {
+        if ($message instanceof \Throwable) {
+            $context['exception'] = $message;
+        }
+        return $context;
+    }
 }

lib/internal/Magento/Framework/Logger/Test/Unit/LoggerProxyTest.php

@@ -99,4 +99,39 @@ public function createWithArguments(): void
         $loggerProxy = new LoggerProxy($objectManager);
         $loggerProxy->log(LogLevel::ALERT, 'test');
     }
+
+    /**
+     * @test
+     *
+     * @param $method
+     *
+     * @return void
+     * @dataProvider methodsList
+     */
+    public function logException($method): void
+    {
+        $deploymentConfig = $this->getMockBuilder(DeploymentConfig::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $objectManager = $this->getMockBuilder(ObjectManagerInterface::class)
+            ->getMockForAbstractClass();
+
+        $logger = $this->getMockBuilder(LoggerInterface::class)
+            ->getMockForAbstractClass();
+
+        $objectManager
+            ->method('get')
+            ->withConsecutive([DeploymentConfig::class], [Monolog::class])
+            ->willReturnOnConsecutiveCalls($deploymentConfig, $logger);
+
+        if (in_array($method, ['critical', 'emergency', 'alert'])) {
+            $message = new \Exception('This is an exception.');
+        } else {
+            $message = 'test';
+        }
+        $logger->expects($this->once())->method($method)->with($message);
+
+        $loggerProxy = new LoggerProxy($objectManager);
+        $loggerProxy->$method($message);
+    }
 }