Release v2.0.0

Author: imjoehaines

.github/workflows/test-package.yml

@@ -8,14 +8,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-version: ['5.5', '5.6', '7.0', '7.1', '7.2', '7.3', '7.4', '8.0', '8.1']
-        psr-log-version: ['^1.0']
-
-        include:
-          - php-version: '8.0'
-            psr-log-version: '^2.0'
-          - php-version: '8.1'
-            psr-log-version: '^2.0'
+        php-version: ['8.0', '8.1']
+        psr-log-version: ['^2.0', '^3.0']
 
     steps:
     - uses: actions/checkout@v2

CHANGELOG.md

@@ -1,6 +1,23 @@
 Changelog
 =========
 
+## 2.0.0 (2022-01-12)
+
+### Enhancements
+
+* Support PSR Log v3
+  [#51](https://github.com/bugsnag/bugsnag-psr-logger/pull/51)
+
+### Breaking changes
+
+* PSR Log v1 is no longer supported. Use `bugsnag/bugsnag-psr-logger:^1.0` for PSR Log v1 support
+
+The following changes are breaking for users extending any of the classes provided by this package, but should not otherwise be noticeable:
+
+* Removed `Bugsnag\PsrLogger\AbstractLogger` in favour of using `Psr\Log\AbstractLogger` directly
+* Added parameter and return types throughout `Bugsnag\PsrLogger\BugsnagLogger` and `Bugsnag\PsrLogger\MultiLogger`
+* Removed protected `Bugsnag\PsrLogger\BugsnagLogger::limit` method
+
 ## 1.4.5 (2021-12-13)
 
 ### Deprecations

composer.json

@@ -11,14 +11,14 @@
         "homepage": "https://bugsnag.com"
     }],
     "require": {
-        "php": ">=5.5",
+        "php": ">=8.0",
         "bugsnag/bugsnag": "^3.10",
-        "psr/log": "^1.0|^2.0"
+        "psr/log": "^2.0|^3.0"
     },
     "require-dev": {
         "graham-campbell/testbench-core": "^1.1",
-        "mockery/mockery": "^0.9.4|^1.3.1",
-        "phpunit/phpunit": "^4.8.36|^7.5.15|^9.4.3"
+        "mockery/mockery": "^1.3.1",
+        "phpunit/phpunit": "^9.4.3"
     },
     "autoload": {
         "psr-4" : {
@@ -29,12 +29,5 @@
         "psr-4" : {
             "Bugsnag\\PsrLogger\\Tests\\" : "tests/"
         }
-    },
-    "extra": {
-        "branch-alias": {
-            "dev-master": "1.5-dev"
-        }
-    },
-    "minimum-stability": "dev",
-    "prefer-stable": true
+    }
 }

src/AbstractLogger.php

@@ -4,7 +4,7 @@
 
 use Bugsnag\Client;
 use Bugsnag\Report;
-use Exception;
+use Psr\Log\AbstractLogger;
 use Psr\Log\LogLevel;
 use Throwable;
 
@@ -15,7 +15,7 @@ class BugsnagLogger extends AbstractLogger
      *
      * @var \Bugsnag\Client
      */
-    protected $client;
+    protected Client $client;
 
     /**
      * The minimum level required to notify bugsnag.
@@ -24,7 +24,7 @@ class BugsnagLogger extends AbstractLogger
      *
      * @var string
      */
-    protected $notifyLevel = LogLevel::NOTICE;
+    protected string $notifyLevel = LogLevel::NOTICE;
 
     /**
      * Create a new bugsnag logger instance.
@@ -45,7 +45,7 @@ public function __construct(Client $client)
      *
      * @return void
      */
-    public function setNotifyLevel($notifyLevel)
+    public function setNotifyLevel(string $notifyLevel): void
     {
         if (!in_array($notifyLevel, $this->getLogLevelOrder())) {
             syslog(LOG_WARNING, 'Bugsnag Warning: Invalid notify level supplied to Bugsnag Logger');
@@ -57,13 +57,13 @@ public function setNotifyLevel($notifyLevel)
     /**
      * Log a message to the logs.
      *
-     * @param string $level
-     * @param mixed  $message
-     * @param array  $context
+     * @param mixed              $level
+     * @param string|\Stringable $message
+     * @param mixed[]            $context
      *
      * @return void
      */
-    public function log($level, $message, array $context = [])
+    public function log(mixed $level, string|\Stringable $message, array $context = []): void
     {
         $title = 'Log '.$level;
         if (isset($context['title'])) {
@@ -72,10 +72,10 @@ public function log($level, $message, array $context = [])
         }
 
         $exception = null;
-        if (isset($context['exception']) && ($context['exception'] instanceof Exception || $context['exception'] instanceof Throwable)) {
+        if (isset($context['exception']) && $context['exception'] instanceof Throwable) {
             $exception = $context['exception'];
             unset($context['exception']);
-        } elseif ($message instanceof Exception || $message instanceof Throwable) {
+        } elseif ($message instanceof Throwable) {
             $exception = $message;
         }
 
@@ -118,12 +118,12 @@ public function log($level, $message, array $context = [])
     /**
      * Checks whether the selected level is above another level.
      *
-     * @param string $level
+     * @param mixed  $level
      * @param string $base
      *
      * @return bool
      */
-    protected function aboveLevel($level, $base)
+    protected function aboveLevel(mixed $level, string $base): bool
     {
         $levelOrder = $this->getLogLevelOrder();
         $baseIndex = array_search($base, $levelOrder);
@@ -137,7 +137,7 @@ protected function aboveLevel($level, $base)
      *
      * @return string[]
      */
-    protected function getLogLevelOrder()
+    protected function getLogLevelOrder(): array
     {
         return [
             LogLevel::DEBUG,
@@ -154,11 +154,11 @@ protected function getLogLevelOrder()
     /**
      * Get the severity for the logger.
      *
-     * @param string $level
+     * @param mixed $level
      *
      * @return string
      */
-    protected function getSeverity($level)
+    protected function getSeverity(mixed $level): string
     {
         if ($this->aboveLevel($level, 'error')) {
             return 'error';
@@ -172,32 +172,16 @@ protected function getSeverity($level)
     /**
      * Format the parameters for the logger.
      *
-     * @param mixed $message
+     * @param string|\Stringable $message
      *
      * @return string
      */
-    protected function formatMessage($message)
+    protected function formatMessage(string|\Stringable $message): string
     {
-        if (is_array($message)) {
-            return var_export($message, true);
+        if (is_string($message)) {
+            return $message;
         }
 
-        return $message;
-    }
-
-    /**
-     * Ensure the given string is less than 100 characters.
-     *
-     * @param string $str
-     *
-     * @return string
-     */
-    protected function limit($str)
-    {
-        if (strlen($str) <= 100) {
-            return $str;
-        }
-
-        return rtrim(substr($str, 0, 97)).'...';
+        return (string) $message;
     }
 }

src/BugsnagLogger.php

@@ -2,14 +2,16 @@
 
 namespace Bugsnag\PsrLogger;
 
+use Psr\Log\AbstractLogger;
+
 class MultiLogger extends AbstractLogger
 {
     /**
      * The registered loggers.
      *
      * @var \Psr\Log\LoggerInterface[]
      */
-    protected $loggers;
+    protected array $loggers;
 
     /**
      * Create a new multi logger instance.
@@ -26,13 +28,13 @@ public function __construct(array $loggers)
     /**
      * Log a message to the logs.
      *
-     * @param string $level
-     * @param mixed  $message
-     * @param array  $context
+     * @param mixed              $level
+     * @param string|\Stringable $message
+     * @param mixed[]            $context
      *
      * @return void
      */
-    public function log($level, $message, array $context = [])
+    public function log(mixed $level, string|\Stringable $message, array $context = []): void
     {
         foreach ($this->loggers as $logger) {
             $logger->log($level, $message, $context);

src/MultiLogger.php

@@ -8,6 +8,7 @@
 use GrahamCampbell\TestBenchCore\MockeryTrait;
 use Mockery;
 use PHPUnit\Framework\TestCase;
+use Psr\Log\LoggerInterface;
 
 class ReportStub
 {
@@ -276,12 +277,12 @@ public function testInvalidLogLevelCallsSyslog()
         $this->assertEquals($sysmes, 'Bugsnag Warning: Invalid notify level supplied to Bugsnag Logger');
     }
 
-    public function testIsAbstractLogger()
+    public function testIsLoggerInterface()
     {
         $client = Mockery::mock(Client::class);
         $logger = new BugsnagLogger($client);
 
-        $this->assertInstanceOf(AbstractLogger::class, $logger);
+        $this->assertInstanceOf(LoggerInterface::class, $logger);
     }
 
     /**

tests/BugsnagLoggerTest.php

@@ -5,6 +5,7 @@
 use GrahamCampbell\TestBenchCore\MockeryTrait;
 use Mockery;
 use PHPUnit\Framework\TestCase;
+use Psr\Log\LoggerInterface;
 
 class MultiLoggerTest extends TestCase
 {
@@ -34,11 +35,11 @@ public function testWarning()
         $multi->warning('hi!', ['foo' => 'baz']);
     }
 
-    public function testIsAbstractLogger()
+    public function testIsLoggerInterface()
     {
         $one = Mockery::mock(LoggerInterface::class);
         $logger = new MultiLogger([$one]);
 
-        $this->assertInstanceOf(AbstractLogger::class, $logger);
+        $this->assertInstanceOf(LoggerInterface::class, $logger);
     }
 }