Monolog 2 compatibility.

derrabus · derrabus · commit ebffece2d999 · 2018-12-02T12:37:25.000+01:00
diff --git a/UPGRADE-4.3.md b/UPGRADE-4.3.md
@@ -5,3 +5,41 @@ Config
 ------
 
  * Deprecated using environment variables with `cannotBeEmpty()` if the value is validated with `validate()`
+
+MonologBridge
+-------------
+
+* Handlers have been made compatible with the interfaces of Monolog 2. If you extend any handlers of MonologBridge,
+  you need to add return types to certain methods:
+  
+  Before:
+  ```php
+  class MyConsoleHandler extends \Symfony\Bridge\Monolog\Handler\ConsoleHandler
+  {
+      public function isHandling(array $record)
+      {
+          // ...
+      }
+
+      public function handle(array $record)
+      {
+          // ..
+      }
+  }
+  ```
+
+  After:
+  ```php
+  class MyConsoleHandler extends \Symfony\Bridge\Monolog\Handler\ConsoleHandler
+  {
+      public function isHandling(array $record): bool
+      {
+          // ...
+      }
+
+      public function handle(array $record): bool
+      {
+          // ..
+      }
+  }
+  ```
diff --git a/composer.json b/composer.json
@@ -97,7 +97,7 @@
         "doctrine/orm": "~2.4,>=2.4.5",
         "doctrine/reflection": "~1.0",
         "doctrine/doctrine-bundle": "~1.4",
-        "monolog/monolog": "~1.11",
+        "monolog/monolog": "~1.11 || ^2",
         "ocramius/proxy-manager": "~0.4|~1.0|~2.0",
         "predis/predis": "~1.1",
         "egulias/email-validator": "~1.2,>=1.2.8|~2.0",
diff --git a/src/Symfony/Bridge/Monolog/CHANGELOG.md b/src/Symfony/Bridge/Monolog/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+4.3.0
+-----
+
+ * added experimental support for Monolog 2.
+
 4.2.0
 -----
 
diff --git a/src/Symfony/Bridge/Monolog/Handler/ChromePhpHandler.php b/src/Symfony/Bridge/Monolog/Handler/ChromePhpHandler.php
@@ -55,7 +55,7 @@ public function onKernelResponse(FilterResponseEvent $event)
     /**
      * {@inheritdoc}
      */
-    protected function sendHeader($header, $content)
+    protected function sendHeader($header, $content): void
     {
         if (!$this->sendHeaders) {
             return;
@@ -71,7 +71,7 @@ protected function sendHeader($header, $content)
     /**
      * Override default behavior since we check it in onKernelResponse.
      */
-    protected function headersAccepted()
+    protected function headersAccepted(): bool
     {
         return true;
     }
diff --git a/src/Symfony/Bridge/Monolog/Handler/ConsoleHandler.php b/src/Symfony/Bridge/Monolog/Handler/ConsoleHandler.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Bridge\Monolog\Handler;
 
+use Monolog\Formatter\FormatterInterface;
 use Monolog\Formatter\LineFormatter;
 use Monolog\Handler\AbstractProcessingHandler;
 use Monolog\Logger;
@@ -71,15 +72,15 @@ public function __construct(OutputInterface $output = null, bool $bubble = true,
     /**
      * {@inheritdoc}
      */
-    public function isHandling(array $record)
+    public function isHandling(array $record): bool
     {
         return $this->updateLevel() && parent::isHandling($record);
     }
 
     /**
      * {@inheritdoc}
      */
-    public function handle(array $record)
+    public function handle(array $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)
@@ -97,7 +98,7 @@ public function setOutput(OutputInterface $output)
     /**
      * Disables the output.
      */
-    public function close()
+    public function close(): void
     {
         $this->output = null;
 
@@ -140,7 +141,7 @@ public static function getSubscribedEvents()
     /**
      * {@inheritdoc}
      */
-    protected function write(array $record)
+    protected function write(array $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());
@@ -149,7 +150,7 @@ protected function write(array $record)
     /**
      * {@inheritdoc}
      */
-    protected function getDefaultFormatter()
+    protected function getDefaultFormatter(): FormatterInterface
     {
         if (!class_exists(CliDumper::class)) {
             return new LineFormatter();
diff --git a/src/Symfony/Bridge/Monolog/Handler/FingersCrossed/HttpCodeActivationStrategy.php b/src/Symfony/Bridge/Monolog/Handler/FingersCrossed/HttpCodeActivationStrategy.php
@@ -45,7 +45,7 @@ public function __construct(RequestStack $requestStack, array $exclusions, $acti
         $this->exclusions = $exclusions;
     }
 
-    public function isHandlerActivated(array $record)
+    public function isHandlerActivated(array $record): bool
     {
         $isActivated = parent::isHandlerActivated($record);
 
diff --git a/src/Symfony/Bridge/Monolog/Handler/FingersCrossed/NotFoundActivationStrategy.php b/src/Symfony/Bridge/Monolog/Handler/FingersCrossed/NotFoundActivationStrategy.php
@@ -34,7 +34,7 @@ public function __construct(RequestStack $requestStack, array $excludedUrls, $ac
         $this->blacklist = '{('.implode('|', $excludedUrls).')}i';
     }
 
-    public function isHandlerActivated(array $record)
+    public function isHandlerActivated(array $record): bool
     {
         $isActivated = parent::isHandlerActivated($record);
 
diff --git a/src/Symfony/Bridge/Monolog/Handler/FirePHPHandler.php b/src/Symfony/Bridge/Monolog/Handler/FirePHPHandler.php
@@ -57,7 +57,7 @@ public function onKernelResponse(FilterResponseEvent $event)
     /**
      * {@inheritdoc}
      */
-    protected function sendHeader($header, $content)
+    protected function sendHeader($header, $content): void
     {
         if (!self::$sendHeaders) {
             return;
@@ -73,7 +73,7 @@ protected function sendHeader($header, $content)
     /**
      * Override default behavior since we check the user agent in onKernelResponse.
      */
-    protected function headersAccepted()
+    protected function headersAccepted(): bool
     {
         return true;
     }
diff --git a/src/Symfony/Bridge/Monolog/Handler/ServerLogHandler.php b/src/Symfony/Bridge/Monolog/Handler/ServerLogHandler.php
@@ -39,7 +39,7 @@ public function __construct(string $host, int $level = Logger::DEBUG, bool $bubb
     /**
      * {@inheritdoc}
      */
-    public function handle(array $record)
+    public function handle(array $record): bool
     {
         if (!$this->isHandling($record)) {
             return false;
diff --git a/src/Symfony/Bridge/Monolog/Handler/SwiftMailerHandler.php b/src/Symfony/Bridge/Monolog/Handler/SwiftMailerHandler.php
@@ -50,7 +50,7 @@ public function onCliTerminate(ConsoleTerminateEvent $event)
     /**
      * {@inheritdoc}
      */
-    protected function send($content, array $records)
+    protected function send($content, array $records): void
     {
         parent::send($content, $records);
 
diff --git a/src/Symfony/Bridge/Monolog/Logger.php b/src/Symfony/Bridge/Monolog/Logger.php
@@ -70,8 +70,12 @@ public function clear()
     /**
      * {@inheritdoc}
      */
-    public function reset()
+    public function reset(): void
     {
+        if (is_callable([parent::class, 'reset'])) {
+            parent::reset();
+        }
+
         $this->clear();
     }
 
diff --git a/src/Symfony/Bridge/Monolog/composer.json b/src/Symfony/Bridge/Monolog/composer.json
@@ -17,7 +17,7 @@
     ],
     "require": {
         "php": "^7.1.3",
-        "monolog/monolog": "~1.19",
+        "monolog/monolog": "~1.19 || ^2",
         "symfony/contracts": "^1.0",
         "symfony/http-kernel": "~3.4|~4.0"
     },

Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ public function onKernelResponse(FilterResponseEvent $event)`
`55`	`55`	`/**`
`56`	`56`	`* {@inheritdoc}`
`57`	`57`	`*/`
`58`		`- protected function sendHeader($header, $content)`
	`58`	`+ protected function sendHeader($header, $content): void`
`59`	`59`	`{`
`60`	`60`	`if (!$this->sendHeaders) {`
`61`	`61`	`return;`
`@@ -71,7 +71,7 @@ protected function sendHeader($header, $content)`
`71`	`71`	`/**`
`72`	`72`	`* Override default behavior since we check it in onKernelResponse.`
`73`	`73`	`*/`
`74`		`- protected function headersAccepted()`
	`74`	`+ protected function headersAccepted(): bool`
`75`	`75`	`{`
`76`	`76`	`return true;`
`77`	`77`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ public function __construct(RequestStack $requestStack, array $exclusions, $acti`
`45`	`45`	`$this->exclusions = $exclusions;`
`46`	`46`	`}`
`47`	`47`
`48`		`- public function isHandlerActivated(array $record)`
	`48`	`+ public function isHandlerActivated(array $record): bool`
`49`	`49`	`{`
`50`	`50`	`$isActivated = parent::isHandlerActivated($record);`
`51`	`51`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public function __construct(RequestStack $requestStack, array $excludedUrls, $ac`
`34`	`34`	`$this->blacklist = '{('.implode('\|', $excludedUrls).')}i';`
`35`	`35`	`}`
`36`	`36`
`37`		`- public function isHandlerActivated(array $record)`
	`37`	`+ public function isHandlerActivated(array $record): bool`
`38`	`38`	`{`
`39`	`39`	`$isActivated = parent::isHandlerActivated($record);`
`40`	`40`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ public function onKernelResponse(FilterResponseEvent $event)`
`57`	`57`	`/**`
`58`	`58`	`* {@inheritdoc}`
`59`	`59`	`*/`
`60`		`- protected function sendHeader($header, $content)`
	`60`	`+ protected function sendHeader($header, $content): void`
`61`	`61`	`{`
`62`	`62`	`if (!self::$sendHeaders) {`
`63`	`63`	`return;`
`@@ -73,7 +73,7 @@ protected function sendHeader($header, $content)`
`73`	`73`	`/**`
`74`	`74`	`* Override default behavior since we check the user agent in onKernelResponse.`
`75`	`75`	`*/`
`76`		`- protected function headersAccepted()`
	`76`	`+ protected function headersAccepted(): bool`
`77`	`77`	`{`
`78`	`78`	`return true;`
`79`	`79`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public function __construct(string $host, int $level = Logger::DEBUG, bool $bubb`
`39`	`39`	`/**`
`40`	`40`	`* {@inheritdoc}`
`41`	`41`	`*/`
`42`		`- public function handle(array $record)`
	`42`	`+ public function handle(array $record): bool`
`43`	`43`	`{`
`44`	`44`	`if (!$this->isHandling($record)) {`
`45`	`45`	`return false;`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ public function onCliTerminate(ConsoleTerminateEvent $event)`
`50`	`50`	`/**`
`51`	`51`	`* {@inheritdoc}`
`52`	`52`	`*/`
`53`		`- protected function send($content, array $records)`
	`53`	`+ protected function send($content, array $records): void`
`54`	`54`	`{`
`55`	`55`	`parent::send($content, $records);`
`56`	`56`