Merge branch '5.x' into 5.next

Author: LordSimal

.phive/phars.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-  <phar name="phpstan" version="2.0.1" installed="2.0.1" location="./tools/phpstan" copy="false"/>
+  <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"/>
 </phive>

README.md

@@ -28,11 +28,9 @@ php composer.phar require --dev cakephp/debug_kit:"^5.0"
 ```
 
 * [Load the plugin](https://book.cakephp.org/5/en/plugins.html#loading-a-plugin)
-```php
-// src/Application.php
-$this->addPlugin('DebugKit');
 ```
-* Set `'debug' => true,` in `config/app.php`.
+bin/cake plugin load DebugKit --only-debug
+```
 
 ## Is DebugKit not working?
 
@@ -69,3 +67,4 @@ Documentation for DebugKit can be found in the
 ## Panels
 Panels by other plugins:
 - `L10n` by [Setup plugin](https://github.com/dereuromark/cakephp-setup) to show current localization for Date, DateTime, Time objects/values.
+- `Twig` by [Twig plugin](https://github.com/cakephp/twig-view/) to list all templates.

phpstan.neon

@@ -2,7 +2,7 @@ includes:
 	- phpstan-baseline.neon
 
 parameters:
-	level: 6
+	level: 8
 	treatPhpDocTypesAsCertain: false
 	bootstrapFiles:
 		- tests/bootstrap.php

psalm-baseline.xml

@@ -2,6 +2,7 @@
 <files psalm-version="5.26.1@d747f6500b38ac4f7dfc5edbcae6e4b637d7add0">
   <file src="src/Database/Log/DebugLog.php">
     <InternalMethod>
+      <code><![CDATA[getContext]]></code>
       <code><![CDATA[jsonSerialize]]></code>
     </InternalMethod>
   </file>

src/Command/BenchmarkCommand.php

@@ -169,7 +169,7 @@ protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOption
     {
         $parser->setDescription(
             'Allows you to obtain some rough benchmarking statistics' .
-            'about a fully qualified URL.'
+            'about a fully qualified URL.',
         )
         ->addArgument('url', [
             'help' => 'The URL to request.',
@@ -187,7 +187,7 @@ protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOption
         ])
         ->setEpilog(
             'Example Use: `cake benchmark --n 10 --t 100 http://localhost/testsite`. ' .
-            '<info>Note:</info> this benchmark does not include browser render times.'
+            '<info>Note:</info> this benchmark does not include browser render times.',
         );
 
         return $parser;

src/Controller/DebugKitController.php

@@ -49,7 +49,7 @@ public function beforeFilter(EventInterface $event): void
                 Log::info(
                     'Cake Authorization plugin is enabled. If you would like ' .
                     'to force DebugKit to ignore it, set `DebugKit.ignoreAuthorization` ' .
-                    ' Configure option to true.'
+                    ' Configure option to true.',
                 );
             }
         }

src/Controller/MailPreviewController.php

@@ -254,8 +254,7 @@ protected function findPreferredPart(AbstractResult $email, ?string $partType):
             }
         }
 
-        /** @psalm-suppress PossiblyNullArgument */
-        return $this->findPart($email, $partType) ?: null;
+        return $this->findPart($email, (string)$partType) ?: null;
     }
 
     /**
@@ -285,7 +284,7 @@ protected function findPreview(string $previewName, string $emailName, string $p
             throw new NotFoundException(sprintf(
                 'Mailer preview `%s::%s` not found',
                 $previewName,
-                $emailName
+                $emailName,
             ));
         }
 

src/Database/Log/DebugLog.php

@@ -65,6 +65,13 @@ class DebugLog extends AbstractLogger
      */
     protected bool $_includeSchema = false;
 
+    /**
+     * Whether a transaction is currently open or not.
+     *
+     * @var bool
+     */
+    protected bool $inTransaction = false;
+
     /**
      * Constructor
      *
@@ -127,6 +134,7 @@ public function totalTime(): float
      */
     public function log($level, string|Stringable $message, array $context = []): void
     {
+        /** @var \Cake\Database\Log\LoggedQuery|object|null $query */
         $query = $context['query'] ?? null;
 
         if ($this->_logger) {
@@ -146,6 +154,9 @@ public function log($level, string|Stringable $message, array $context = []): vo
                 ], JSON_PRETTY_PRINT),
                 'took' => $took,
                 'rows' => $context['response']['hits']['total']['value'] ?? $context['response']['hits']['total'] ?? 0,
+                'inTransaction' => $this->inTransaction,
+                'isCommitOrRollback' => false,
+                'role' => '',
             ];
 
             return;
@@ -162,11 +173,26 @@ public function log($level, string|Stringable $message, array $context = []): vo
 
         $this->_totalTime += $data['took'];
 
+        $sql = (string)$query;
+        $isBegin = $sql === 'BEGIN';
+        $isCommitOrRollback = $sql === 'COMMIT' || $sql === 'ROLLBACK';
+
+        if ($isBegin) {
+            $this->inTransaction = true;
+        }
+
         $this->_queries[] = [
-            'query' => (string)$query,
+            'query' => $sql,
             'took' => $data['took'],
             'rows' => $data['numRows'],
+            'inTransaction' => $this->inTransaction,
+            'isCommitOrRollback' => $isCommitOrRollback,
+            'role' => $query->getContext()['role'],
         ];
+
+        if ($isCommitOrRollback) {
+            $this->inTransaction = false;
+        }
     }
 
     /**

src/DebugSql.php

@@ -72,7 +72,7 @@ public static function sql(
         Query $query,
         bool $showValues = true,
         ?bool $showHtml = null,
-        int $stackDepth = 0
+        int $stackDepth = 0,
     ): Query {
         if (!Configure::read('debug')) {
             return $query;
@@ -126,7 +126,7 @@ public static function sql(
                     HtmlHighlighter::HIGHLIGHT_WORD => 'style="color: #9c27b0;"',
                     HtmlHighlighter::HIGHLIGHT_PRE => 'style="color: #222; background-color: transparent;"',
                 ],
-                false
+                false,
             );
         } else {
             $highlighter = new NullHighlighter();
@@ -164,7 +164,7 @@ public static function sqld(
         Query $query,
         bool $showValues = true,
         ?bool $showHtml = null,
-        int $stackDepth = 1
+        int $stackDepth = 1,
     ): void {
         static::sql($query, $showValues, $showHtml, $stackDepth);
         die(1);
@@ -221,6 +221,6 @@ private static function interpolate(string $sql, array $bindings): string
             $keys[] = is_string($key) ? "/$key\b/" : '/[?]/';
         }
 
-        return preg_replace($keys, $params, $sql, $limit);
+        return (string)preg_replace($keys, $params, $sql, $limit);
     }
 }

src/Mailer/Transport/DebugKitTransport.php

@@ -51,7 +51,7 @@ public function __construct(array $config = [], ?AbstractTransport $originalTran
             $className = App::className(
                 $config['originalClassName'],
                 'Mailer/Transport',
-                'Transport'
+                'Transport',
             );
         }