symfony · nicolas-grekas · May 4, 2022 · Apr 24, 2022
diff --git a/src/Symfony/Bridge/Monolog/CHANGELOG.md b/src/Symfony/Bridge/Monolog/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========

+6.1
+---
+
+ * Add support for Monolog 3
+
 6.0
 ---


diff --git a/src/Symfony/Bridge/Monolog/Formatter/CompatibilityFormatter.php b/src/Symfony/Bridge/Monolog/Formatter/CompatibilityFormatter.php
@@ -0,0 +1,57 @@
+<?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\Bridge\Monolog\Formatter;
+
+use Monolog\Logger;
+use Monolog\LogRecord;
+
+if (Logger::API >= 3) {
+    /**
+     * The base class for compatibility between Monolog 3 LogRecord and Monolog 1/2 array records.
+     *
+     * @author Jordi Boggiano <j.boggiano@seld.be>
+     *
+     * @internal
+     */
+    trait CompatibilityFormatter
+    {
+        abstract private function doFormat(array|LogRecord $record): mixed;
+
+        /**
+         * {@inheritdoc}
+         */
+        public function format(LogRecord $record): mixed
+        {
+            return $this->doFormat($record);
+        }
+    }
+} else {
+    /**
+     * The base class for compatibility between Monolog 3 LogRecord and Monolog 1/2 array records.
+     *
+     * @author Jordi Boggiano <j.boggiano@seld.be>
+     *
+     * @internal
+     */
+    trait CompatibilityFormatter
+    {
+        abstract private function doFormat(array|LogRecord $record): mixed;
+
+        /**
+         * {@inheritdoc}
+         */
+        public function format(array $record): mixed
+        {
+            return $this->doFormat($record);
+        }
+    }
+}
diff --git a/src/Symfony/Bridge/Monolog/Formatter/ConsoleFormatter.php b/src/Symfony/Bridge/Monolog/Formatter/ConsoleFormatter.php
@@ -13,6 +13,7 @@

 use Monolog\Formatter\FormatterInterface;
 use Monolog\Logger;
+use Monolog\LogRecord;
 use Symfony\Component\Console\Formatter\OutputFormatter;
 use Symfony\Component\VarDumper\Cloner\Data;
 use Symfony\Component\VarDumper\Cloner\Stub;
@@ -24,9 +25,13 @@
 *
 * @author Tobias Schultze <http://tobion.de>
 * @author Grégoire Pineau <lyrixx@lyrixx.info>
+ *
+ * @final since Symfony 6.1
 */
 class ConsoleFormatter implements FormatterInterface
 {
+    use CompatibilityFormatter;
+
    public const SIMPLE_FORMAT = "%datetime% %start_tag%%level_name%%end_tag% <comment>[%channel%]</> %message%%context%%extra%\n";
    public const SIMPLE_DATE = 'H:i:s';

@@ -98,11 +103,11 @@ public function formatBatch(array $records): mixed
        return $records;
    }

-    /**
-     * {@inheritdoc}
-     */
-    public function format(array $record): mixed
+    private function doFormat(array|LogRecord $record): mixed
    {
+        if ($record instanceof LogRecord) {
+            $record = $record->toArray();
+        }
        $record = $this->replacePlaceHolder($record);

        if (!$this->options['ignore_empty_context_and_extra'] || !empty($record['context'])) {

diff --git a/src/Symfony/Bridge/Monolog/Formatter/VarDumperFormatter.php b/src/Symfony/Bridge/Monolog/Formatter/VarDumperFormatter.php
@@ -12,25 +12,31 @@
 namespace Symfony\Bridge\Monolog\Formatter;

 use Monolog\Formatter\FormatterInterface;
+use Monolog\LogRecord;
 use Symfony\Component\VarDumper\Cloner\VarCloner;

 /**
 * @author Grégoire Pineau <lyrixx@lyrixx.info>
+ *
+ * @final since Symfony 6.1
 */
 class VarDumperFormatter implements FormatterInterface
 {
+    use CompatibilityFormatter;
+
    private VarCloner $cloner;

    public function __construct(VarCloner $cloner = null)
    {
        $this->cloner = $cloner ?? new VarCloner();
    }

-    /**
-     * {@inheritdoc}
-     */
-    public function format(array $record): mixed
+    private function doFormat(array|LogRecord $record): mixed
    {
+        if ($record instanceof LogRecord) {
+            $record = $record->toArray();
+        }
+
        $record['context'] = $this->cloner->cloneVar($record['context']);
        $record['extra'] = $this->cloner->cloneVar($record['extra']);


diff --git a/src/Symfony/Bridge/Monolog/Handler/CompatibilityHandler.php b/src/Symfony/Bridge/Monolog/Handler/CompatibilityHandler.php
@@ -0,0 +1,57 @@
+<?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\Bridge\Monolog\Handler;
+
+use Monolog\Logger;
+use Monolog\LogRecord;
+
+if (Logger::API >= 3) {
+    /**
+     * The base class for compatibility between Monolog 3 LogRecord and Monolog 1/2 array records.
+     *
+     * @author Jordi Boggiano <j.boggiano@seld.be>
+     *
+     * @internal
+     */
+    trait CompatibilityHandler
+    {
+        abstract private function doHandle(array|LogRecord $record): bool;
+
+        /**
+         * {@inheritdoc}
+         */
+        public function handle(LogRecord $record): bool
+        {
+            return $this->doHandle($record);
+        }
+    }
+} else {
+    /**
+     * The base class for compatibility between Monolog 3 LogRecord and Monolog 1/2 array records.
+     *
+     * @author Jordi Boggiano <j.boggiano@seld.be>
+     *
+     * @internal
+     */
+    trait CompatibilityHandler
+    {
+        abstract private function doHandle(array|LogRecord $record): bool;
+
+        /**
+         * {@inheritdoc}
+         */
+        public function handle(array $record): bool
+        {
+            return $this->doHandle($record);
+        }
+    }
+}
diff --git a/src/Symfony/Bridge/Monolog/Handler/CompatibilityProcessingHandler.php b/src/Symfony/Bridge/Monolog/Handler/CompatibilityProcessingHandler.php
@@ -0,0 +1,57 @@
+<?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\Bridge\Monolog\Handler;
+
+use Monolog\Logger;
+use Monolog\LogRecord;
+
+if (Logger::API >= 3) {
+    /**
+     * The base class for compatibility between Monolog 3 LogRecord and Monolog 1/2 array records.
+     *
+     * @author Jordi Boggiano <j.boggiano@seld.be>
+     *
+     * @internal
+     */
+    trait CompatibilityProcessingHandler
+    {
+        abstract private function doWrite(array|LogRecord $record): void;
+
+        /**
+         * {@inheritdoc}
+         */
+        protected function write(LogRecord $record): void
+        {
+            $this->doWrite($record);
+        }
+    }
+} else {
+    /**
+     * The base class for compatibility between Monolog 3 LogRecord and Monolog 1/2 array records.
+     *
+     * @author Jordi Boggiano <j.boggiano@seld.be>
+     *
+     * @internal
+     */
+    trait CompatibilityProcessingHandler
+    {
+        abstract private function doWrite(array|LogRecord $record): void;
+
+        /**
+         * {@inheritdoc}
+         */
+        protected function write(array $record): void
+        {
+            $this->doWrite($record);
+        }
+    }
+}
diff --git a/src/Symfony/Bridge/Monolog/Handler/ConsoleHandler.php b/src/Symfony/Bridge/Monolog/Handler/ConsoleHandler.php
@@ -15,6 +15,7 @@
 use Monolog\Formatter\LineFormatter;
 use Monolog\Handler\AbstractProcessingHandler;
 use Monolog\Logger;
+use Monolog\LogRecord;
 use Symfony\Bridge\Monolog\Formatter\ConsoleFormatter;
 use Symfony\Component\Console\ConsoleEvents;
 use Symfony\Component\Console\Event\ConsoleCommandEvent;
@@ -24,6 +25,48 @@
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\VarDumper\Dumper\CliDumper;

+if (Logger::API >= 3) {
+    /**
+     * The base class for compatibility between Monolog 3 LogRecord and Monolog 1/2 array records.
+     *
+     * @author Jordi Boggiano <j.boggiano@seld.be>
+     *
+     * @internal
+     */
+    trait CompatibilityIsHandlingHandler
+    {
+        abstract private function doIsHandling(array|LogRecord $record): bool;
+
+        /**
+         * {@inheritdoc}
+         */
+        public function isHandling(LogRecord $record): bool
+        {
+            return $this->doIsHandling($record);
+        }
+    }
+} else {
+    /**
+     * The base class for compatibility between Monolog 3 LogRecord and Monolog 1/2 array records.
+     *
+     * @author Jordi Boggiano <j.boggiano@seld.be>
+     *
+     * @internal
+     */
+    trait CompatibilityIsHandlingHandler
+    {
+        abstract private function doIsHandling(array|LogRecord $record): bool;
+
+        /**
+         * {@inheritdoc}
+         */
+        public function isHandling(array $record): bool
+        {
+            return $this->doIsHandling($record);
+        }
+    }
+}
+
 /**
 * Writes logs to the console output depending on its verbosity setting.
 *
@@ -40,9 +83,15 @@
 * This mapping can be customized with the $verbosityLevelMap constructor parameter.
 *
 * @author Tobias Schultze <http://tobion.de>
+ *
+ * @final since Symfony 6.1
 */
 class ConsoleHandler extends AbstractProcessingHandler implements EventSubscriberInterface
 {
+    use CompatibilityHandler;
+    use CompatibilityIsHandlingHandler;
+    use CompatibilityProcessingHandler;
+
    private ?OutputInterface $output;
    private array $verbosityLevelMap = [
        OutputInterface::VERBOSITY_QUIET => Logger::ERROR,
@@ -75,15 +124,15 @@ public function __construct(OutputInterface $output = null, bool $bubble = true,
    /**
     * {@inheritdoc}
     */
-    public function isHandling(array $record): bool
+    private function doIsHandling(array|LogRecord $record): bool
    {
        return $this->updateLevel() && parent::isHandling($record);
    }

    /**
     * {@inheritdoc}
     */
-    public function handle(array $record): bool
+    private function doHandle(array|LogRecord $record): bool
    {
        // we have to update the logging level each time because the verbosity of the
        // console output might have changed in the meantime (it is not immutable)
@@ -141,10 +190,7 @@ public static function getSubscribedEvents(): array
        ];
    }

-    /**
-     * {@inheritdoc}
-     */
-    protected function write(array $record): void
+    private function doWrite(array|LogRecord $record): void
    {
        // at this point we've determined for sure that we want to output the record, so use the output's own verbosity
        $this->output->write((string) $record['formatted'], false, $this->output->getVerbosity());