Merge pull request #7967 from kenjis/psr-log-v2

fix: update psr/log to v2 and fix Logger interface
codeigniter4 · Sep 28, 2023 · fb30ae2 · fb30ae2
2 parents 8e3dd0e + 7dd0ffd
commit fb30ae2
Show file tree

Hide file tree

Showing 14 changed files with 99 additions and 194 deletions.
diff --git a/admin/framework/composer.json b/admin/framework/composer.json
@@ -15,7 +15,7 @@
         "ext-json": "*",
         "ext-mbstring": "*",
         "laminas/laminas-escaper": "^2.9",
-        "psr/log": "^1.1"
+        "psr/log": "^2.0"
     },
     "require-dev": {
         "codeigniter/coding-standard": "^1.5",

diff --git a/composer.json b/composer.json
@@ -15,7 +15,7 @@
         "ext-json": "*",
         "ext-mbstring": "*",
         "laminas/laminas-escaper": "^2.9",
-        "psr/log": "^1.1"
+        "psr/log": "^2.0"
     },
     "require-dev": {
         "codeigniter/coding-standard": "^1.5",

diff --git a/system/Common.php b/system/Common.php
@@ -794,7 +794,7 @@ function lang(string $line, array $args = [], ?string $locale = null)
      *  - info
      *  - debug
      *
-     * @return bool
+     * @return void
      */
     function log_message(string $level, string $message, array $context = [])
     {
@@ -804,10 +804,12 @@ function log_message(string $level, string $message, array $context = [])
         if (ENVIRONMENT === 'testing') {
             $logger = new TestLogger(new Logger());
 
-            return $logger->log($level, $message, $context);
+            $logger->log($level, $message, $context);
+
+            return;
         }
 
-        return Services::logger(true)->log($level, $message, $context); // @codeCoverageIgnore
+        Services::logger(true)->log($level, $message, $context); // @codeCoverageIgnore
     }
 }
 

diff --git a/system/ComposerScripts.php b/system/ComposerScripts.php
@@ -56,7 +56,7 @@ final class ComposerScripts
         ],
         'psr-log' => [
             'license' => __DIR__ . '/../vendor/psr/log/LICENSE',
-            'from'    => __DIR__ . '/../vendor/psr/log/Psr/Log/',
+            'from'    => __DIR__ . '/../vendor/psr/log/src/',
             'to'      => __DIR__ . '/ThirdParty/PSR/Log/',
         ],
     ];
@@ -84,7 +84,6 @@ public static function postUpdate()
         }
 
         self::copyKintInitFiles();
-        self::recursiveDelete(self::$dependencies['psr-log']['to'] . 'Test/');
     }
 
     /**

diff --git a/system/Log/Logger.php b/system/Log/Logger.php
@@ -15,6 +15,7 @@
 use CodeIgniter\Log\Handlers\HandlerInterface;
 use Psr\Log\LoggerInterface;
 use RuntimeException;
+use Stringable;
 use Throwable;
 
 /**
@@ -157,9 +158,9 @@ public function __construct($config, bool $debug = CI_DEBUG)
      *
      * @param string $message
      */
-    public function emergency($message, array $context = []): bool
+    public function emergency(string|Stringable $message, array $context = []): void
     {
-        return $this->log('emergency', $message, $context);
+        $this->log('emergency', $message, $context);
     }
 
     /**
@@ -170,9 +171,9 @@ public function emergency($message, array $context = []): bool
      *
      * @param string $message
      */
-    public function alert($message, array $context = []): bool
+    public function alert(string|Stringable $message, array $context = []): void
     {
-        return $this->log('alert', $message, $context);
+        $this->log('alert', $message, $context);
     }
 
     /**
@@ -182,9 +183,9 @@ public function alert($message, array $context = []): bool
      *
      * @param string $message
      */
-    public function critical($message, array $context = []): bool
+    public function critical(string|Stringable $message, array $context = []): void
     {
-        return $this->log('critical', $message, $context);
+        $this->log('critical', $message, $context);
     }
 
     /**
@@ -193,9 +194,9 @@ public function critical($message, array $context = []): bool
      *
      * @param string $message
      */
-    public function error($message, array $context = []): bool
+    public function error(string|Stringable $message, array $context = []): void
     {
-        return $this->log('error', $message, $context);
+        $this->log('error', $message, $context);
     }
 
     /**
@@ -206,19 +207,19 @@ public function error($message, array $context = []): bool
      *
      * @param string $message
      */
-    public function warning($message, array $context = []): bool
+    public function warning(string|Stringable $message, array $context = []): void
     {
-        return $this->log('warning', $message, $context);
+        $this->log('warning', $message, $context);
     }
 
     /**
      * Normal but significant events.
      *
      * @param string $message
      */
-    public function notice($message, array $context = []): bool
+    public function notice(string|Stringable $message, array $context = []): void
     {
-        return $this->log('notice', $message, $context);
+        $this->log('notice', $message, $context);
     }
 
     /**
@@ -228,19 +229,19 @@ public function notice($message, array $context = []): bool
      *
      * @param string $message
      */
-    public function info($message, array $context = []): bool
+    public function info(string|Stringable $message, array $context = []): void
     {
-        return $this->log('info', $message, $context);
+        $this->log('info', $message, $context);
     }
 
     /**
      * Detailed debug information.
      *
      * @param string $message
      */
-    public function debug($message, array $context = []): bool
+    public function debug(string|Stringable $message, array $context = []): void
     {
-        return $this->log('debug', $message, $context);
+        $this->log('debug', $message, $context);
     }
 
     /**
@@ -249,7 +250,7 @@ public function debug($message, array $context = []): bool
      * @param string $level
      * @param string $message
      */
-    public function log($level, $message, array $context = []): bool
+    public function log($level, string|Stringable $message, array $context = []): void
     {
         if (is_numeric($level)) {
             $level = array_search((int) $level, $this->logLevels, true);
@@ -262,7 +263,7 @@ public function log($level, $message, array $context = []): bool
 
         // Does the app want to log this right now?
         if (! in_array($level, $this->loggableLevels, true)) {
-            return false;
+            return;
         }
 
         // Parse our placeholders
@@ -295,8 +296,6 @@ public function log($level, $message, array $context = []): bool
                 break;
             }
         }
-
-        return true;
     }
 
     /**

diff --git a/system/Test/TestLogger.php b/system/Test/TestLogger.php
@@ -12,6 +12,7 @@
 namespace CodeIgniter\Test;
 
 use CodeIgniter\Log\Logger;
+use Stringable;
 
 /**
  * @see \CodeIgniter\Test\TestLoggerTest
@@ -27,7 +28,7 @@ class TestLogger extends Logger
      * @param string $level
      * @param string $message
      */
-    public function log($level, $message, array $context = []): bool
+    public function log($level, string|Stringable $message, array $context = []): void
     {
         // While this requires duplicate work, we want to ensure
         // we have the final message to test against.
@@ -52,7 +53,7 @@ public function log($level, $message, array $context = []): bool
         ];
 
         // Let the parent do it's thing.
-        return parent::log($level, $message, $context);
+        parent::log($level, $message, $context);
     }
 
     /**

diff --git a/system/ThirdParty/PSR/Log/AbstractLogger.php b/system/ThirdParty/PSR/Log/AbstractLogger.php
@@ -11,118 +11,5 @@
  */
 abstract class AbstractLogger implements LoggerInterface
 {
-    /**
-     * System is unusable.
-     *
-     * @param string  $message
-     * @param mixed[] $context
-     *
-     * @return void
-     */
-    public function emergency($message, array $context = array())
-    {
-        $this->log(LogLevel::EMERGENCY, $message, $context);
-    }
-
-    /**
-     * Action must be taken immediately.
-     *
-     * Example: Entire website down, database unavailable, etc. This should
-     * trigger the SMS alerts and wake you up.
-     *
-     * @param string  $message
-     * @param mixed[] $context
-     *
-     * @return void
-     */
-    public function alert($message, array $context = array())
-    {
-        $this->log(LogLevel::ALERT, $message, $context);
-    }
-
-    /**
-     * Critical conditions.
-     *
-     * Example: Application component unavailable, unexpected exception.
-     *
-     * @param string  $message
-     * @param mixed[] $context
-     *
-     * @return void
-     */
-    public function critical($message, array $context = array())
-    {
-        $this->log(LogLevel::CRITICAL, $message, $context);
-    }
-
-    /**
-     * Runtime errors that do not require immediate action but should typically
-     * be logged and monitored.
-     *
-     * @param string  $message
-     * @param mixed[] $context
-     *
-     * @return void
-     */
-    public function error($message, array $context = array())
-    {
-        $this->log(LogLevel::ERROR, $message, $context);
-    }
-
-    /**
-     * Exceptional occurrences that are not errors.
-     *
-     * Example: Use of deprecated APIs, poor use of an API, undesirable things
-     * that are not necessarily wrong.
-     *
-     * @param string  $message
-     * @param mixed[] $context
-     *
-     * @return void
-     */
-    public function warning($message, array $context = array())
-    {
-        $this->log(LogLevel::WARNING, $message, $context);
-    }
-
-    /**
-     * Normal but significant events.
-     *
-     * @param string  $message
-     * @param mixed[] $context
-     *
-     * @return void
-     */
-    public function notice($message, array $context = array())
-    {
-        $this->log(LogLevel::NOTICE, $message, $context);
-    }
-
-    /**
-     * Interesting events.
-     *
-     * Example: User logs in, SQL logs.
-     *
-     * @param string  $message
-     * @param mixed[] $context
-     *
-     * @return void
-     */
-    public function info($message, array $context = array())
-    {
-        $this->log(LogLevel::INFO, $message, $context);
-    }
-
-    /**
-     * Detailed debug information.
-     *
-     * @param string  $message
-     * @param mixed[] $context
-     *
-     * @return void
-     */
-    public function debug($message, array $context = array())
-    {
-        $this->log(LogLevel::DEBUG, $message, $context);
-    }
+    use LoggerTrait;
 }
diff --git a/system/ThirdParty/PSR/Log/LoggerAwareTrait.php b/system/ThirdParty/PSR/Log/LoggerAwareTrait.php
@@ -12,7 +12,7 @@ trait LoggerAwareTrait
      *
      * @var LoggerInterface|null
      */
-    protected $logger;
+    protected ?LoggerInterface $logger = null;
 
     /**
      * Sets a logger.