Make logger implement DebugLoggerInterface

MatTheCat · MatTheCat · commit db1fa179d6ac · 2022-09-04T14:38:26.000+02:00
diff --git a/src/Symfony/Component/HttpKernel/DependencyInjection/LoggerPass.php b/src/Symfony/Component/HttpKernel/DependencyInjection/LoggerPass.php
@@ -14,7 +14,11 @@
 use Psr\Log\LoggerInterface;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpKernel\Log\Logger;
+use Symfony\Component\HttpKernel\Log\Recorder;
 
 /**
  * Registers the default logger if necessary.
@@ -32,7 +36,21 @@ public function process(ContainerBuilder $container)
             return;
         }
 
+        $recorder = null;
+        if ($container->getParameter('kernel.debug')) {
+            $recorder = new Definition(Recorder::class, ['$requestStack' => new Reference(RequestStack::class)]);
+        }
+
         $container->register('logger', Logger::class)
-            ->setPublic(false);
+            ->setPublic(false)
+            ->addMethodCall('setRecorder', [$recorder])
+            ->setConfigurator([__CLASS__, 'configureLogger']);
+    }
+
+    public static function configureLogger(mixed $logger)
+    {
+        if (\is_object($logger) && method_exists($logger, 'setRecorder') && \in_array(\PHP_SAPI, ['cli', 'phpdbg'], true)) {
+            $logger->setRecorder(null);
+        }
     }
 }
diff --git a/src/Symfony/Component/HttpKernel/Log/Logger.php b/src/Symfony/Component/HttpKernel/Log/Logger.php
@@ -14,13 +14,14 @@
 use Psr\Log\AbstractLogger;
 use Psr\Log\InvalidArgumentException;
 use Psr\Log\LogLevel;
+use Symfony\Component\HttpFoundation\Request;
 
 /**
  * Minimalist PSR-3 logger designed to write in stderr or any other stream.
  *
  * @author Kévin Dunglas <dunglas@gmail.com>
  */
-class Logger extends AbstractLogger
+class Logger extends AbstractLogger implements DebugLoggerInterface
 {
     private const LEVELS = [
         LogLevel::DEBUG => 0,
@@ -39,6 +40,9 @@ class Logger extends AbstractLogger
     /** @var resource|null */
     private $handle;
 
+    /** @var Recorder|null */
+    private $recorder;
+
     /**
      * @param string|resource|null $output
      */
@@ -69,6 +73,11 @@ public function __construct(string $minLevel = null, $output = null, callable $f
         }
     }
 
+    public function setRecorder(?Recorder $recorder): void
+    {
+        $this->recorder = $recorder;
+    }
+
     public function log($level, $message, array $context = []): void
     {
         if (!isset(self::LEVELS[$level])) {
@@ -85,6 +94,25 @@ public function log($level, $message, array $context = []): void
         } else {
             error_log($formatter($level, $message, $context, false));
         }
+
+        if ($this->recorder) {
+            $this->recorder->record($level, $message, $context);
+        }
+    }
+
+    public function getLogs(Request $request = null)
+    {
+        return $this->recorder?->getLogs($request) ?? [];
+    }
+
+    public function countErrors(Request $request = null)
+    {
+        return $this->recorder?->countErrors($request) ?? 0;
+    }
+
+    public function clear()
+    {
+        $this->recorder?->clear();
     }
 
     private function format(string $level, string $message, array $context, bool $prefixDate = true): string
diff --git a/src/Symfony/Component/HttpKernel/Log/Recorder.php b/src/Symfony/Component/HttpKernel/Log/Recorder.php
@@ -0,0 +1,86 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\HttpKernel\Log;
+
+use Psr\Log\LogLevel;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestStack;
+
+class Recorder implements DebugLoggerInterface
+{
+    private const PRIORITIES = [
+        LogLevel::DEBUG => 100,
+        LogLevel::INFO => 200,
+        LogLevel::NOTICE => 250,
+        LogLevel::WARNING => 300,
+        LogLevel::ERROR => 400,
+        LogLevel::CRITICAL => 500,
+        LogLevel::ALERT => 550,
+        LogLevel::EMERGENCY => 600,
+    ];
+
+    private array $logs = [];
+    private array $errorCount = [];
+
+    public function __construct(private readonly RequestStack $requestStack)
+    {
+    }
+
+    public function record($level, $message, array $context): void
+    {
+        $request = $this->requestStack->getCurrentRequest();
+        $hash = $request ? spl_object_hash($request) : '';
+
+        $this->logs[$hash][] = [
+            'channel' => null,
+            'context' => $context,
+            'message' => $message,
+            'priority' => self::PRIORITIES[$level],
+            'priorityName' => $level,
+            'timestamp' => time(),
+            'timestamp_rfc3339' => date(\DATE_RFC3339_EXTENDED),
+        ];
+
+        $this->errorCount[$hash] ??= 0;
+        switch ($level) {
+            case LogLevel::ERROR:
+            case LogLevel::CRITICAL:
+            case LogLevel::ALERT:
+            case LogLevel::EMERGENCY:
+                ++$this->errorCount[$hash];
+        }
+    }
+
+    public function getLogs(Request $request = null): array
+    {
+        if ($request) {
+            return $this->logs[spl_object_hash($request)] ?? [];
+        }
+
+        return array_merge(...array_values($this->logs));
+    }
+
+    public function countErrors(Request $request = null): int
+    {
+        if ($request) {
+            return $this->errorCount[spl_object_hash($request)] ?? 0;
+        }
+
+        return array_sum($this->errorCount);
+    }
+
+    public function clear()
+    {
+        $this->logs = [];
+        $this->errorCount = [];
+    }
+}
