Rolling back Symfony Logger extending Monolog\Logger; Added deprecati…

…on messages
symfony · joaojacome · Mar 21, 2023 · Mar 21, 2023 · Mar 28, 2023 · Mar 28, 2023
commit 9e46c79797eac9ca788bd0bc7d81264d4226701d
diff --git a/src/Symfony/Bridge/Monolog/Logger.php b/src/Symfony/Bridge/Monolog/Logger.php
@@ -23,7 +23,7 @@
 /**
  * @author Fabien Potencier <fabien@symfony.com>
  */
-class Logger implements LoggerInterface, DebugLoggerInterface, ResetInterface
+class Logger extends BaseLogger implements LoggerInterface, DebugLoggerInterface, ResetInterface
 {
     use MonologApiTrait;
 
@@ -152,47 +152,47 @@ private function getDebugLogger(): ?DebugLoggerInterface
         return null;
     }
 
-    public function emergency(\Stringable|string $message, array $context = []): void
+    public function emergency($message, array $context = []): void
     {
         $this->logger->emergency($message, $context);
     }
 
-    public function alert(\Stringable|string $message, array $context = []): void
+    public function alert($message, array $context = []): void
     {
         $this->logger->alert($message, $context);
     }
 
-    public function critical(\Stringable|string $message, array $context = []): void
+    public function critical($message, array $context = []): void
     {
         $this->logger->critical($message, $context);
     }
 
-    public function error(\Stringable|string $message, array $context = []): void
+    public function error($message, array $context = []): void
     {
         $this->logger->error($message, $context);
     }
 
-    public function warning(\Stringable|string $message, array $context = []): void
+    public function warning($message, array $context = []): void
     {
         $this->logger->warning($message, $context);
     }
 
-    public function notice(\Stringable|string $message, array $context = []): void
+    public function notice($message, array $context = []): void
     {
         $this->logger->notice($message, $context);
     }
 
-    public function info(\Stringable|string $message, array $context = []): void
+    public function info($message, array $context = []): void
     {
         $this->logger->info($message, $context);
     }
 
-    public function debug(\Stringable|string $message, array $context = []): void
+    public function debug($message, array $context = []): void
     {
         $this->logger->debug($message, $context);
     }
 
-    public function log($level, \Stringable|string $message, array $context = []): void
+    public function log($level, $message, array $context = []): void
     {
         $this->logger->log($level, $message, $context);
     }

diff --git a/src/Symfony/Bridge/Monolog/MonologApiTrait.php b/src/Symfony/Bridge/Monolog/MonologApiTrait.php
@@ -32,50 +32,51 @@ trait MonologApiTrait
      * @see BaseLogger::$name
      * @deprecated This has been copied over from \Monolog\Logger for compatibility reasons, and might be removed eventually.
      */
-    protected string $name;
+    protected $name;
 
     /**
      * @see BaseLogger::$handlers
      * @deprecated This has been copied over from \Monolog\Logger for compatibility reasons, and might be removed eventually.
      *
      * @var list<HandlerInterface>
      */
-    protected array $handlers;
+    protected $handlers;
 
     /**
      * @see BaseLogger::$processors
      * @deprecated This has been copied over from \Monolog\Logger for compatibility reasons, and might be removed eventually.
      *
      * @var array<(callable(LogRecord): LogRecord)|ProcessorInterface>
      */
-    protected array $processors;
+    protected $processors;
 
     /**
      * @see BaseLogger::$microsecondTimestamps
      * @deprecated This has been copied over from \Monolog\Logger for compatibility reasons, and might be removed eventually.
      */
-    protected bool $microsecondTimestamps = true;
+    protected $microsecondTimestamps = true;
 
     /**
      * @see BaseLogger::$timezone
      * @deprecated This has been copied over from \Monolog\Logger for compatibility reasons, and might be removed eventually.
      */
-    protected DateTimeZone $timezone;
+    protected $timezone;
 
     /**
      * @see BaseLogger::$exceptionHandler
      * @deprecated This has been copied over from \Monolog\Logger for compatibility reasons, and might be removed eventually.
      */
-    protected Closure|null $exceptionHandler = null;
+    protected $exceptionHandler = null;
 
     /**
      * @see BaseLogger::__construct
-     * @deprecated This has been copied over from \Monolog\Logger for compatibility reasons, and might be removed eventually.
+     * @deprecated Creating an instance of Monolog\Logger through this method is deprecated. Please use ::setLogger
      */
     public function __construct() // string $name, array $handlers = [], array $processors = [], DateTimeZone|null $timezone = null
     {
         $args = \func_get_args();
         if ([] !== $args) {
+            trigger_deprecation('symfony/monolog-bridge', '6.3', 'The "%s" class extending "%s" is deprecated. In the future, this class will stop extending it.', self::class, BaseLogger::class);
             $this->logger = new BaseLogger(...$args);
         }
     }
@@ -125,9 +126,9 @@ public function popHandler(): HandlerInterface
      * @see BaseLogger::removeHandler
      * @deprecated This has been copied over from \Monolog\Logger for compatibility reasons, and might be removed eventually.
      */
-    public function removeHandler(int $handlerIndex): void
+    public function removeHandler(callable $callback): void
     {
-        $this->logger->removeHandler($handlerIndex);
+        $this->logger->removeHandler($callback);
     }
 
     /**
@@ -174,9 +175,9 @@ public function popProcessor(): callable
      * @see BaseLogger::removeProcessor
      * @deprecated This has been copied over from \Monolog\Logger for compatibility reasons, and might be removed eventually.
      */
-    public function removeProcessor(int $processorIndex): void
+    public function removeProcessor(callable $callback): void
     {
-        $this->logger->removeProcessor($processorIndex);
+        $this->logger->removeProcessor($callback);
     }
 
     /**
@@ -241,7 +242,7 @@ public static function getLevelName(int|Level $level): string
      * @see BaseLogger::toMonologLevel
      * @deprecated This has been copied over from \Monolog\Logger for compatibility reasons, and might be removed eventually.
      */
-    public static function toMonologLevel(string|int|Level $level): Level
+    public static function toMonologLevel($level): int
     {
         return BaseLogger::toMonologLevel($level);
     }
@@ -259,7 +260,7 @@ public function isHandling(int|string|Level $level): bool
      * @see BaseLogger::setExceptionHandler
      * @deprecated This has been copied over from \Monolog\Logger for compatibility reasons, and might be removed eventually.
      */
-    public function setExceptionHandler(Closure|null $callback): self
+    public function setExceptionHandler(?callable $callback): self
     {
         $this->logger->setExceptionHandler($callback);
 
@@ -270,7 +271,7 @@ public function setExceptionHandler(Closure|null $callback): self
      * @see BaseLogger::getExceptionHandler
      * @deprecated This has been copied over from \Monolog\Logger for compatibility reasons, and might be removed eventually.
      */
-    public function getExceptionHandler(): Closure|null
+    public function getExceptionHandler(): ?callable
     {
         return $this->logger->getExceptionHandler();
     }
@@ -299,7 +300,7 @@ public function getTimezone(): DateTimeZone
      * @see BaseLogger::handleException
      * @deprecated This has been copied over from \Monolog\Logger for compatibility reasons, and might be removed eventually.
      */
-    protected function handleException(Throwable $e, LogRecord $record): void
+    protected function handleException(Throwable $e, array $record): void
     {
         $this->logger->handleException($e, $record);
     }

diff --git a/src/Symfony/Bridge/Monolog/Tests/LegacyLoggerTest.php b/src/Symfony/Bridge/Monolog/Tests/LegacyLoggerTest.php
@@ -16,10 +16,22 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Bridge\Monolog\Logger;
 use Symfony\Bridge\Monolog\Processor\DebugProcessor;
+use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
 use Symfony\Component\HttpFoundation\Request;
 
+/**
+ * @group legacy
+ */
 class LegacyLoggerTest extends TestCase
 {
+    use ExpectDeprecationTrait;
+
+    public function testConstructWillTriggerDeprecation()
+    {
+        $this->expectDeprecation('Since symfony/monolog-bridge 6.3: The "Symfony\Bridge\Monolog\Logger" class extending "Monolog\Logger" is deprecated. In the future, this class will stop extending it.');
+        new Logger(__METHOD__);
+    }
+
     public function testGetLogsWithoutDebugProcessor()
     {
         $handler = new TestHandler();

diff --git a/src/Symfony/Bridge/Monolog/composer.json b/src/Symfony/Bridge/Monolog/composer.json
@@ -20,7 +20,8 @@
         "monolog/monolog": "dev-remove-handlers-processors",
         "symfony/service-contracts": "^2.5|^3",
         "symfony/http-kernel": "^5.4|^6.0",
-        "psr/log": "^2.0 || ^3.0"
+        "psr/log": "^2.0 || ^3.0",
+        "symfony/deprecation-contracts": "^2.5|^3"
     },
     "require-dev": {
         "symfony/console": "^5.4|^6.0",