#6622 Logger refactoring: simplified the formatters by removing the ErrorTextFormatter

config/global.php

@@ -6,7 +6,6 @@ use Piwik\Log;
 use Piwik\Log\Backend\StdErrBackend;
 use Piwik\Log\Formatter\AddRequestIdFormatter;
 use Piwik\Log\Formatter\ErrorHtmlFormatter;
-use Piwik\Log\Formatter\ErrorTextFormatter;
 use Piwik\Log\Formatter\ExceptionHtmlFormatter;
 use Piwik\Log\Formatter\ExceptionTextFormatter;
 use Piwik\Log\Formatter\HtmlPreFormatter;
@@ -130,16 +129,11 @@ return array(
         return $logPath;
     }),
     'log.formatter.text' => DI\factory(function (ContainerInterface $c) {
-        // Chain of responsibility pattern
-        $lineFormatter = new LineMessageFormatter($c->get('log.format'));
-
         $exceptionFormatter = new ExceptionTextFormatter();
-        $exceptionFormatter->setNext($lineFormatter);
-
-        $errorFormatter = new ErrorTextFormatter();
-        $errorFormatter->setNext($exceptionFormatter);
-
-        return $errorFormatter;
+        $exceptionFormatter->setNext(
+            new LineMessageFormatter($c->get('log.format'))
+        );
+        return $exceptionFormatter;
     }),
     'log.formatter.html' => DI\factory(function (ContainerInterface $c) {
         // Chain of responsibility pattern

core/Log/Formatter/ErrorTextFormatter.php

-<?php
-/**
- * Piwik - free/libre analytics platform
- *
- * @link http://piwik.org
- * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
- */
-
-namespace Piwik\Log\Formatter;
-
-use Piwik\Error;
-use Piwik\Log;
-
-/**
- * Formats a log message containing a Piwik\Error object into a textual string.
- */
-class ErrorTextFormatter extends Formatter
-{
-    public function format(array $record)
-    {
-        if (! $this->contextContainsError($record)) {
-            return $this->next($record);
-        }
-
-        /** @var \ErrorException $exception */
-        $exception = $record['context']['exception'];
-
-        $trace = Log::$debugBacktraceForTests ?: $exception->getTraceAsString();
-
-        $record['message'] = $exception->getFile() . '(' . $exception->getLine() . '): ' . Error::getErrNoString($exception->getSeverity())
-            . ' - ' . $exception->getMessage() . "\n" . $trace;
-
-        // Remove the exception so that it's not formatted again by another formatter
-        unset($record['context']['exception']);
-
-        return $this->next($record);
-    }
-
-    private function contextContainsError($record)
-    {
-        return isset($record['context']['exception'])
-            && $record['context']['exception'] instanceof \ErrorException;
-    }
-}

core/Log/Formatter/ExceptionTextFormatter.php

@@ -8,7 +8,7 @@
 
 namespace Piwik\Log\Formatter;
 
-use Piwik\ExceptionHandler;
+use Piwik\Error;
 use Piwik\Log;
 
 /**
@@ -25,10 +25,14 @@ class ExceptionTextFormatter extends Formatter
         /** @var \Exception $exception */
         $exception = $record['context']['exception'];
 
-        $record['message'] = sprintf("%s(%d): %s\n%s", $exception->getFile(), $exception->getLine(), $exception->getMessage(),
-            Log::$debugBacktraceForTests ?: $exception->getTraceAsString());
+        $record['message'] = sprintf(
+            "%s(%d): %s\n%s",
+            $exception->getFile(),
+            $exception->getLine(),
+            $this->getMessage($exception),
+            $this->getStackTrace($exception)
+        );
 
-        // Remove the exception so that it's not formatted again by another formatter
         unset($record['context']['exception']);
 
         return $this->next($record);
@@ -39,4 +43,18 @@ class ExceptionTextFormatter extends Formatter
         return isset($record['context']['exception'])
             && $record['context']['exception'] instanceof \Exception;
     }
+
+    private function getMessage(\Exception $exception)
+    {
+        if ($exception instanceof \ErrorException) {
+            return Error::getErrNoString($exception->getSeverity()) . ' - ' . $exception->getMessage();
+        }
+
+        return $exception->getMessage();
+    }
+
+    private function getStackTrace(\Exception $exception)
+    {
+        return Log::$debugBacktraceForTests ?: $exception->getTraceAsString();
+    }
 }