Merge branch '5.x' into 5.next

LordSimal · LordSimal · commit d6e1bd93b7f1 · 2025-08-23T08:13:31.000+02:00
diff --git a/.github/workflows/deploy_docs_4x.yml b/.github/workflows/deploy_docs_4x.yml
@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Cloning repo
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           fetch-depth: 0
 
diff --git a/.github/workflows/deploy_docs_5x.yml b/.github/workflows/deploy_docs_5x.yml
@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Cloning repo
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           fetch-depth: 0
 
diff --git a/.phive/phars.xml b/.phive/phars.xml
@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-  <phar name="phpstan" version="2.1.0" installed="2.1.0" location="./tools/phpstan" copy="false"/>
-  <phar name="psalm" version="5.26.1" installed="5.26.1" location="./tools/psalm" copy="false"/>
+  <phar name="phpstan" version="2.1.17" installed="2.1.17" location="./tools/phpstan" copy="false"/>
 </phive>
diff --git a/composer.json b/composer.json
@@ -63,12 +63,7 @@
         "cs-check": "phpcs --colors --parallel=16 -p src/ tests/",
         "cs-fix": "phpcbf --colors --parallel=16 -p src/ tests/",
         "phpstan": "tools/phpstan analyse",
-        "psalm": "tools/psalm --show-info=false",
-        "psalm-baseline": "tools/psalm  --set-baseline=psalm-baseline.xml",
-        "stan": [
-            "@phpstan",
-            "@psalm"
-        ],
+        "stan": "@phpstan",
         "stan-baseline": "tools/phpstan --generate-baseline",
         "stan-setup": "phive install",
         "test": "phpunit"
diff --git a/docs/en/index.rst b/docs/en/index.rst
@@ -41,8 +41,8 @@ Configuration
 * ``DebugKit.safeTld`` - Set an array of whitelisted TLDs for local development.
   This can be used to make sure DebugKit displays on hosts it otherwise determines unsafe. ::
 
-    // Allow e.g. http://foo.bar.dev or http://my-shop.local domains locally
-    Configure::write('DebugKit.safeTld', ['dev', 'local', 'example']);
+    // Allow e.g. http://foo.bar.test or http://my-shop.local domains locally
+    Configure::write('DebugKit.safeTld', ['test', 'local', 'example']);
 
 * ``DebugKit.forceEnable`` - Force DebugKit to display. Careful with this, it is usually
   safer to simply whitelist your local TLDs. Example usage::
diff --git a/src/Cache/Engine/DebugEngine.php b/src/Cache/Engine/DebugEngine.php
@@ -82,7 +82,6 @@ public function __construct(CacheEngine|array $config, string $name, LoggerInter
      */
     public function init(array $config = []): bool
     {
-        /** @psalm-suppress RedundantPropertyInitializationCheck */
         if (!isset($this->_engine)) {
             $registry = new CacheRegistry();
             $this->_engine = $registry->load('spies', $this->_config);
@@ -335,7 +334,6 @@ public function clearGroup(string $group): bool
      */
     public function __toString(): string
     {
-        /** @psalm-suppress RedundantPropertyInitializationCheck */
         if (isset($this->_engine)) {
             // phpcs:ignore SlevomatCodingStandard.Variables.UnusedVariable.UnusedVariable
             [$ns, $class] = namespaceSplit(get_class($this->_engine));
diff --git a/src/Database/Log/DebugLog.php b/src/Database/Log/DebugLog.php
@@ -203,7 +203,6 @@ public function log($level, string|Stringable $message, array $context = []): vo
      */
     protected function isSchemaQuery(LoggedQuery $query): bool
     {
-        /** @psalm-suppress InternalMethod */
         $querystring = $query->jsonSerialize()['query'];
 
         return // Multiple engines
diff --git a/src/DebugInclude.php b/src/DebugInclude.php
@@ -82,7 +82,6 @@ public function __construct()
      */
     public function includePaths(): array
     {
-        /** @psalm-suppress RedundantCast */
         $paths = explode(PATH_SEPARATOR, (string)get_include_path());
         $paths = array_filter($paths, function ($path) {
             if ($path === '.' || strlen($path) === 0) {
diff --git a/src/Mailer/Transport/DebugKitTransport.php b/src/Mailer/Transport/DebugKitTransport.php
@@ -57,7 +57,6 @@ public function __construct(array $config = [], ?AbstractTransport $originalTran
 
         if ($className) {
             unset($config['originalClassName'], $config['debugKitLog']);
-            /** @psalm-suppress UnsafeInstantiation */
             $this->originalTransport = new $className($config);
         }
     }
diff --git a/src/Middleware/DebugKitMiddleware.php b/src/Middleware/DebugKitMiddleware.php
@@ -63,7 +63,6 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
             return $response;
         }
 
-        /** @psalm-suppress ArgumentTypeCoercion */
         $row = $this->service->saveData($request, $response);
         if (!$row) {
             return $response;
diff --git a/src/Model/Behavior/TimedBehavior.php b/src/Model/Behavior/TimedBehavior.php
@@ -30,20 +30,22 @@ class TimedBehavior extends Behavior
      *
      * @param \Cake\Event\EventInterface $event The beforeFind event
      * @param \Cake\ORM\Query\SelectQuery $query SelectQuery
-     * @return \Cake\ORM\Query\SelectQuery
+     * @return void
      */
-    public function beforeFind(EventInterface $event, SelectQuery $query): SelectQuery
+    public function beforeFind(EventInterface $event, SelectQuery $query): void
     {
         /** @var \Cake\Datasource\RepositoryInterface $table */
         $table = $event->getSubject();
         $alias = $table->getAlias();
         DebugTimer::start($alias . '_find', $alias . '->find()');
 
-        return $query->formatResults(function ($results) use ($alias) {
+        $formattedQuery = $query->formatResults(function ($results) use ($alias) {
             DebugTimer::stop($alias . '_find');
 
             return $results;
         });
+
+        $event->setResult($formattedQuery);
     }
 
     /**
diff --git a/src/Model/Table/SqlTraceTrait.php b/src/Model/Table/SqlTraceTrait.php
@@ -57,11 +57,11 @@ public function deleteQuery(): DeleteQuery
      *
      * @template T of \Cake\ORM\Query\SelectQuery|\Cake\ORM\Query\UpdateQuery|\Cake\ORM\Query\DeleteQuery
      * @param \Cake\ORM\Query\SelectQuery|\Cake\ORM\Query\UpdateQuery|\Cake\ORM\Query\DeleteQuery $query The Query to insert a comment into.
-     * @psalm-param T $query
+     * @phpstan-param T $query
      * @param int $start How many entries in the stack trace to skip.
      * @param bool $debugOnly False to always stamp queries with a comment.
      * @return \Cake\ORM\Query\SelectQuery|\Cake\ORM\Query\UpdateQuery|\Cake\ORM\Query\DeleteQuery
-     * @psalm-return T
+     * @phpstan-return T
      */
     protected function fileStamp(
         SelectQuery|UpdateQuery|DeleteQuery $query,
diff --git a/src/Panel/PanelRegistry.php b/src/Panel/PanelRegistry.php
@@ -87,7 +87,7 @@ protected function _throwMissingClassError(string $class, ?string $plugin): void
     protected function _create(object|string $class, string $alias, array $config): DebugPanel
     {
         if (is_string($class)) {
-            $instance = new $class($this, $config);
+            $instance = new $class();
         } else {
             $instance = $class;
         }
diff --git a/src/Panel/SqlLogPanel.php b/src/Panel/SqlLogPanel.php
@@ -34,7 +34,7 @@ class SqlLogPanel extends DebugPanel
      *
      * @var array
      */
-    protected array $_loggers = [];
+    protected static array $_loggers = [];
 
     /**
      * Initialize hook - configures logger.
@@ -47,34 +47,52 @@ class SqlLogPanel extends DebugPanel
     public function initialize(): void
     {
         $configs = ConnectionManager::configured();
-        $includeSchemaReflection = (bool)Configure::read('DebugKit.includeSchemaReflection');
 
         foreach ($configs as $name) {
-            $connection = ConnectionManager::get($name);
-            if ($connection->configName() === 'debug_kit') {
-                continue;
-            }
-            $driver = $connection->getDriver();
-            $logger = null;
-            if ($driver instanceof Driver) {
-                $logger = $driver->getLogger();
-            } elseif (method_exists($connection, 'getLogger')) {
-                // ElasticSearch connection holds the logger, not the Elastica Driver
-                $logger = $connection->getLogger();
-            }
-
-            if ($logger instanceof DebugLog) {
-                $logger->setIncludeSchema($includeSchemaReflection);
-                $this->_loggers[] = $logger;
-                continue;
-            }
-            $logger = new DebugLog($logger, $name, $includeSchemaReflection);
-
-            /** @var \Cake\Database\Driver $driver */
-            $driver->setLogger($logger);
-
-            $this->_loggers[] = $logger;
+            static::addConnection($name);
+        }
+    }
+
+    /**
+     * Add a connection to the list of loggers.
+     *
+     * @param string $name The name of the connection to add.
+     * @return void
+     */
+    public static function addConnection(string $name): void
+    {
+        $includeSchemaReflection = (bool)Configure::read('DebugKit.includeSchemaReflection');
+
+        $connection = ConnectionManager::get($name);
+        if ($connection->configName() === 'debug_kit') {
+            return;
+        }
+        $driver = $connection->getDriver();
+
+        if (!method_exists($driver, 'setLogger')) {
+            return;
+        }
+
+        $logger = null;
+        if ($driver instanceof Driver) {
+            $logger = $driver->getLogger();
+        } elseif (method_exists($connection, 'getLogger')) {
+            // ElasticSearch connection holds the logger, not the Elastica Driver
+            $logger = $connection->getLogger();
         }
+
+        if ($logger instanceof DebugLog) {
+            $logger->setIncludeSchema($includeSchemaReflection);
+            static::$_loggers[] = $logger;
+
+            return;
+        }
+        $logger = new DebugLog($logger, $name, $includeSchemaReflection);
+
+        /** @var \Cake\Database\Driver $driver */
+        $driver->setLogger($logger);
+
+        static::$_loggers[] = $logger;
     }
 
     /**
@@ -88,7 +106,7 @@ public function data(): array
             'tables' => array_map(function (Table $table) {
                 return $table->getAlias();
             }, $this->getTableLocator()->genericInstances()),
-            'loggers' => $this->_loggers,
+            'loggers' => static::$_loggers,
         ];
     }
 
@@ -100,7 +118,7 @@ public function data(): array
     public function summary(): string
     {
         $count = $time = 0;
-        foreach ($this->_loggers as $logger) {
+        foreach (static::$_loggers as $logger) {
             $count += count($logger->queries());
             $time += $logger->totalTime();
         }
diff --git a/tests/TestCase/Panel/SqlLogPanelTest.php b/tests/TestCase/Panel/SqlLogPanelTest.php
@@ -124,4 +124,21 @@ public function testSummary()
         $result = $this->panel->summary();
         $this->assertMatchesRegularExpression('/\d+ \\/ \d+(\.\d+)? ms/', $result);
     }
+
+    /**
+     * Testing a simple connection (no set/getLogger on driver).
+     *
+     * @return void
+     */
+    public function testWithSimpleConnection()
+    {
+        ConnectionManager::setConfig('simple', [
+            'className' => 'DebugKit\TestApp\Stub\SimpleConnectionStub',
+        ]);
+
+        $this->panel->addConnection('simple'); // should not throw an error
+        $this->assertTrue(true);
+
+        ConnectionManager::drop('simple');
+    }
 }
diff --git a/tests/test_app/Stub/SimpleConnectionStub.php b/tests/test_app/Stub/SimpleConnectionStub.php
@@ -0,0 +1,37 @@
+<?php
+declare(strict_types=1);
+
+namespace DebugKit\TestApp\Stub;
+
+use Cake\Cache\Cache;
+use Cake\Datasource\ConnectionInterface;
+use Psr\SimpleCache\CacheInterface;
+use stdClass;
+
+class SimpleConnectionStub implements ConnectionInterface
+{
+    public function getDriver(string $role = self::ROLE_WRITE): object
+    {
+        return new stdClass();
+    }
+
+    public function setCacher(CacheInterface $cacher)
+    {
+        return $this;
+    }
+
+    public function getCacher(): CacheInterface
+    {
+        return Cache::pool('_simple_connection_stub_');
+    }
+
+    public function configName(): string
+    {
+        return 'simple_connection_stub';
+    }
+
+    public function config(): array
+    {
+        return [];
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -203,7 +203,6 @@ public function log($level, string\|Stringable $message, array $context = []): vo`
`203`	`203`	`*/`
`204`	`204`	`protected function isSchemaQuery(LoggedQuery $query): bool`
`205`	`205`	`{`
`206`		`- /** @psalm-suppress InternalMethod */`
`207`	`206`	`$querystring = $query->jsonSerialize()['query'];`
`208`	`207`
`209`	`208`	`return // Multiple engines`
Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,6 @@ public function __construct()`
`82`	`82`	`*/`
`83`	`83`	`public function includePaths(): array`
`84`	`84`	`{`
`85`		`- /** @psalm-suppress RedundantCast */`
`86`	`85`	`$paths = explode(PATH_SEPARATOR, (string)get_include_path());`
`87`	`86`	`$paths = array_filter($paths, function ($path) {`
`88`	`87`	`if ($path === '.' \|\| strlen($path) === 0) {`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,6 @@ public function __construct(array $config = [], ?AbstractTransport $originalTran`
`57`	`57`
`58`	`58`	`if ($className) {`
`59`	`59`	`unset($config['originalClassName'], $config['debugKitLog']);`
`60`		`- /** @psalm-suppress UnsafeInstantiation */`
`61`	`60`	`$this->originalTransport = new $className($config);`
`62`	`61`	`}`
`63`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,6 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface`
`63`	`63`	`return $response;`
`64`	`64`	`}`
`65`	`65`
`66`		`- /** @psalm-suppress ArgumentTypeCoercion */`
`67`	`66`	`$row = $this->service->saveData($request, $response);`
`68`	`67`	`if (!$row) {`
`69`	`68`	`return $response;`