feat: add closure-based database transaction helper (#10148)

Author: memleakd

system/Database/BaseConnection.php

@@ -1066,6 +1066,52 @@ public function afterRollback(callable $callback): static
         return $this;
     }
 
+    /**
+     * Run the callback inside a transaction.
+     *
+     * @template TReturn
+     *
+     * @param callable(self): TReturn $callback
+     *
+     * @return false|TReturn
+     */
+    public function transaction(callable $callback): mixed
+    {
+        if (! $this->transEnabled) {
+            return $callback($this);
+        }
+
+        if (! $this->transBegin()) {
+            return false;
+        }
+
+        try {
+            $result = $callback($this);
+        } catch (Throwable $e) {
+            try {
+                $this->transRollback();
+            } catch (Throwable $rollbackException) {
+                log_message('error', 'Database: Transaction callback threw an exception before rollback failed: ' . $e);
+
+                throw $rollbackException;
+            } finally {
+                if ($this->transDepth > 0) {
+                    $this->transStatus = false;
+                } elseif ($this->transStrict === false) {
+                    $this->transStatus = true;
+                }
+            }
+
+            throw $e;
+        }
+
+        if (! $this->transComplete()) {
+            return false;
+        }
+
+        return $result;
+    }
+
     /**
      * Begin Transaction
      */

system/Database/ConnectionInterface.php

@@ -133,6 +133,17 @@ public function afterCommit(callable $callback): static;
      */
     public function afterRollback(callable $callback): static;
 
+    /**
+     * Run the callback inside a transaction.
+     *
+     * @template TReturn
+     *
+     * @param callable(self): TReturn $callback
+     *
+     * @return false|TReturn
+     */
+    public function transaction(callable $callback): mixed;
+
     /**
      * Returns an instance of the query builder for this connection.
      *

tests/system/Database/BaseConnectionTest.php

@@ -624,6 +624,40 @@ protected function _transRollback(): bool
         $this->assertSame(['rolled back'], $callbacks);
     }
 
+    public function testTransactionReturnsFalseWhenTransactionCannotBegin(): void
+    {
+        $callbackRan = false;
+
+        $db = new class ($this->options) extends MockConnection {
+            protected function _transBegin(): bool
+            {
+                return false;
+            }
+        };
+
+        $result = $db->transaction(static function () use (&$callbackRan): void {
+            $callbackRan = true;
+        });
+
+        $this->assertFalse($result);
+        $this->assertFalse($callbackRan);
+    }
+
+    public function testTransactionRunsCallbackWhenTransactionsAreDisabled(): void
+    {
+        $db = new MockConnection($this->options);
+        $db->transOff();
+
+        $result = $db->transaction(static function (BaseConnection $connection): string {
+            $connection->afterCommit(static function (): void {});
+
+            return 'not wrapped';
+        });
+
+        $this->assertSame('not wrapped', $result);
+        $this->assertSame(0, $db->transDepth);
+    }
+
     public function testCallFunctionDoesNotDoublePrefixAlreadyPrefixedName(): void
     {
         $db = new class ($this->options) extends MockConnection {