Merge pull request #1032 from cakephp/5.x-transaction-styling

add styling for queries which are run inside a transaction

Author: markstory

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
      *
@@ -162,11 +169,25 @@ 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,
         ];
+
+        if ($isCommitOrRollback) {
+            $this->inTransaction = false;
+        }
     }
 
     /**

templates/element/sql_log_panel.php

@@ -73,7 +73,7 @@
                     </thead>
                     <tbody>
                         <?php foreach ($queries as $query) : ?>
-                        <tr>
+                        <tr<?= $query['inTransaction'] ? ' class="in-transaction"' : '' ?>>
                             <td>
                                 <?=
                                     (new SqlFormatter(
@@ -91,6 +91,12 @@
                             <td><?= h($query['rows']) ?></td>
                             <td><?= h($query['took']) ?></td>
                         </tr>
+                        <?php if ($query['isCommitOrRollback']): ?>
+                            <tr>
+                                <td colspan="3" class="commit-or-rollback">
+                                </td>
+                            </tr>
+                        <?php endif; ?>
                         <?php endforeach; ?>
                     </tbody>
                 </table>
@@ -99,6 +105,6 @@
     <?php endif; ?>
 
     <?php if ($noOutput) : ?>
-    <div class="c-flash c-flash--warning">No active database connections</div>
+        <div class="c-flash c-flash--warning">No active database connections</div>
     <?php endif ?>
 </div>

webroot/css/style.css

@@ -605,6 +605,10 @@ strong {
     box-shadow: 0 2px 0 var(--routes-btn-active-border);
 }
 
+.c-sql-log-panel__entry .in-transaction {
+    background: var(--cake-light-gray);
+}
+
 .c-toolbar {
     display: flex;
     background: var(--toolbar-bg);