refactor: fix various phpstan errors in Log component (#9581)

* refactor Logs collector

* refactor Logger config

* refactor Logger

* refactor BaseHandler

* refactor FileHandler

* refactor Mock FileHandler

* refactor ErrorlogHandler

* refactor ChromeLoggerHandler

* regenerate baseline

* Fix per review

Author: paulbalandan

app/Config/Logger.php

@@ -4,6 +4,7 @@
 
 use CodeIgniter\Config\BaseConfig;
 use CodeIgniter\Log\Handlers\FileHandler;
+use CodeIgniter\Log\Handlers\HandlerInterface;
 
 class Logger extends BaseConfig
 {
@@ -73,7 +74,7 @@ class Logger extends BaseConfig
      * Handlers are executed in the order defined in this array, starting with
      * the handler on top and continuing down.
      *
-     * @var array<class-string, array<string, int|list<string>|string>>
+     * @var array<class-string<HandlerInterface>, array<string, int|list<string>|string>>
      */
     public array $handlers = [
         /*

system/Debug/Toolbar/Collectors/Logs.php

@@ -45,12 +45,14 @@ class Logs extends BaseCollector
     /**
      * Our collected data.
      *
-     * @var array
+     * @var list<array{level: string, msg: string}>
      */
     protected $data;
 
     /**
-     * Returns the data of this collector to be formatted in the toolbar
+     * Returns the data of this collector to be formatted in the toolbar.
+     *
+     * @return array{logs: list<array{level: string, msg: string}>}
      */
     public function display(): array
     {
@@ -66,7 +68,7 @@ public function isEmpty(): bool
     {
         $this->collectLogs();
 
-        return empty($this->data);
+        return $this->data !== [];
     }
 
     /**
@@ -82,14 +84,18 @@ public function icon(): string
     /**
      * Ensures the data has been collected.
      *
-     * @return array
+     * @return list<array{level: string, msg: string}>
      */
     protected function collectLogs()
     {
-        if (! empty($this->data)) {
+        if ($this->data !== []) {
             return $this->data;
         }
 
-        return $this->data = service('logger', true)->logCache ?? [];
+        $cache = service('logger')->logCache;
+
+        $this->data = $cache ?? [];
+
+        return $this->data;
     }
 }

system/Log/Handlers/BaseHandler.php

@@ -21,7 +21,7 @@ abstract class BaseHandler implements HandlerInterface
     /**
      * Handles
      *
-     * @var array
+     * @var list<string>
      */
     protected $handles;
 
@@ -33,7 +33,7 @@ abstract class BaseHandler implements HandlerInterface
     protected $dateFormat = 'Y-m-d H:i:s';
 
     /**
-     * Constructor
+     * @param array{handles?: list<string>} $config
      */
     public function __construct(array $config)
     {

system/Log/Handlers/ChromeLoggerHandler.php

@@ -16,8 +16,6 @@
 use CodeIgniter\HTTP\ResponseInterface;
 
 /**
- * Class ChromeLoggerHandler
- *
  * Allows for logging items to the Chrome console for debugging.
  * Requires the ChromeLogger extension installed in your browser.
  *
@@ -41,7 +39,16 @@ class ChromeLoggerHandler extends BaseHandler
     /**
      * The final data that is sent to the browser.
      *
-     * @var array
+     * @var array{
+     *   version: float,
+     *   columns: list<string>,
+     *   rows: list<array{
+     *     0: list<string>,
+     *     1: string,
+     *     2: string,
+     *   }>,
+     *   request_uri?: string,
+     * }
      */
     protected $json = [
         'version' => self::VERSION,
@@ -63,7 +70,7 @@ class ChromeLoggerHandler extends BaseHandler
     /**
      * Maps the log levels to the ChromeLogger types.
      *
-     * @var array
+     * @var array<string, string>
      */
     protected $levels = [
         'emergency' => 'error',
@@ -77,7 +84,7 @@ class ChromeLoggerHandler extends BaseHandler
     ];
 
     /**
-     * Constructor
+     * @param array{handles?: list<string>} $config
      */
     public function __construct(array $config = [])
     {
@@ -97,10 +104,8 @@ public function __construct(array $config = [])
      */
     public function handle($level, $message): bool
     {
-        // Format our message
         $message = $this->format($message);
 
-        // Generate Backtrace info
         $backtrace = debug_backtrace(0, $this->backtraceLevel);
         $backtrace = end($backtrace);
 
@@ -116,11 +121,7 @@ public function handle($level, $message): bool
             $type = $this->levels[$level];
         }
 
-        $this->json['rows'][] = [
-            [$message],
-            $backtraceMessage,
-            $type,
-        ];
+        $this->json['rows'][] = [[$message], $backtraceMessage, $type];
 
         $this->sendLogs();
 
@@ -130,9 +131,9 @@ public function handle($level, $message): bool
     /**
      * Converts the object to display nicely in the Chrome Logger UI.
      *
-     * @param array|int|object|string $object
+     * @param object|string $object
      *
-     * @return array
+     * @return array<string, mixed>|string
      */
     protected function format($object)
     {

system/Log/Handlers/ErrorlogHandler.php

@@ -38,14 +38,14 @@ class ErrorlogHandler extends BaseHandler
      * Says where the error should go. Currently supported are
      * 0 (`TYPE_OS`) and 4 (`TYPE_SAPI`).
      *
-     * @var int
+     * @var 0|4
      */
     protected $messageType = 0;
 
     /**
      * Constructor.
      *
-     * @param list<mixed> $config
+     * @param array{handles?: list<string>, messageType?: int} $config
      */
     public function __construct(array $config = [])
     {
@@ -79,6 +79,8 @@ public function handle($level, $message): bool
     /**
      * Extracted call to `error_log()` in order to be tested.
      *
+     * @param 0|4 $messageType
+     *
      * @codeCoverageIgnore
      */
     protected function errorLog(string $message, int $messageType): bool

system/Log/Handlers/FileHandler.php

@@ -45,18 +45,22 @@ class FileHandler extends BaseHandler
     protected $filePermissions;
 
     /**
-     * Constructor
+     * @param array{handles?: list<string>, path?: string, fileExtension?: string, filePermissions?: int} $config
      */
     public function __construct(array $config = [])
     {
         parent::__construct($config);
 
-        $this->path = empty($config['path']) ? WRITEPATH . 'logs/' : $config['path'];
+        $defaults = ['path' => WRITEPATH . 'logs/', 'fileExtension' => 'log', 'filePermissions' => 0644];
+        $config   = [...$defaults, ...$config];
 
-        $this->fileExtension = empty($config['fileExtension']) ? 'log' : $config['fileExtension'];
-        $this->fileExtension = ltrim($this->fileExtension, '.');
+        $this->path = $config['path'] === '' ? $defaults['path'] : $config['path'];
 
-        $this->filePermissions = $config['filePermissions'] ?? 0644;
+        $this->fileExtension = $config['fileExtension'] === ''
+            ? $defaults['fileExtension']
+            : ltrim($config['fileExtension'], '.');
+
+        $this->filePermissions = $config['filePermissions'];
     }
 
     /**
@@ -108,10 +112,8 @@ public function handle($level, $message): bool
 
         for ($written = 0, $length = strlen($msg); $written < $length; $written += $result) {
             if (($result = fwrite($fp, substr($msg, $written))) === false) {
-                // if we get this far, we'll never see this during travis-ci
-                // @codeCoverageIgnoreStart
-                break;
-                // @codeCoverageIgnoreEnd
+                // if we get this far, we'll never see this during unit testing
+                break; // @codeCoverageIgnore
             }
         }