feat: do not throw exceptions during transactions by default

Author: kenjis

system/Database/BaseConnection.php

@@ -29,7 +29,7 @@
  * @property string     $DBDriver
  * @property string     $DBPrefix
  * @property string     $DSN
- * @property mixed      $encrypt
+ * @property array|bool $encrypt
  * @property array      $failover
  * @property string     $hostname
  * @property Query      $lastQuery
@@ -320,6 +320,11 @@ abstract class BaseConnection implements ConnectionInterface
      */
     protected $transFailure = false;
 
+    /**
+     * Whether to throw exceptions during transaction
+     */
+    protected bool $transException = false;
+
     /**
      * Array of table aliases.
      *
@@ -610,7 +615,15 @@ public function query(string $sql, $binds = null, bool $setEscapeFlags = true, s
                 $this->transStatus = false;
             }
 
-            if ($this->DBDebug) {
+            if (
+                $this->DBDebug
+                && (
+                    // Not in transactions
+                    $this->transDepth === 0
+                    // In transactions, do not throw exception by default.
+                    || $this->transException
+                )
+            ) {
                 // We call this function in order to roll-back queries
                 // if transactions are enabled. If we don't call this here
                 // the error message will trigger an exit, causing the
@@ -721,6 +734,18 @@ public function transStart(bool $testMode = false): bool
         return $this->transBegin($testMode);
     }
 
+    /**
+     * If set to true, exceptions are thrown during transactions.
+     *
+     * @return $this
+     */
+    public function transException(bool $transExcetion)
+    {
+        $this->transException = $transExcetion;
+
+        return $this;
+    }
+
     /**
      * Complete Transaction
      */

tests/system/Database/Live/TransactionDBDebugFalseTest.php

@@ -0,0 +1,59 @@
+<?php
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <[email protected]>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace CodeIgniter\Database\Live;
+
+/**
+ * @group DatabaseLive
+ *
+ * @internal
+ */
+final class TransactionDBDebugFalseTest extends TransactionDBDebugTrueTest
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->disableDBDebug();
+    }
+
+    protected function tearDown(): void
+    {
+        parent::tearDown();
+
+        $this->enableDBDebug();
+    }
+
+    public function testTransStartTransException()
+    {
+        $builder = $this->db->table('job');
+
+        $this->db->transException(true)->transStart();
+
+        $jobData = [
+            'name'        => 'Grocery Sales',
+            'description' => 'Discount!',
+        ];
+        $builder->insert($jobData);
+
+        // Duplicate entry '1' for key 'PRIMARY'
+        $jobData = [
+            'id'          => 1,
+            'name'        => 'Comedian',
+            'description' => 'Theres something in your teeth',
+        ];
+        $builder->insert($jobData);
+
+        $this->db->transComplete();
+
+        $this->dontSeeInDatabase('job', ['name' => 'Grocery Sales']);
+    }
+}

tests/system/Database/Live/TransactionTest.php renamed to tests/system/Database/Live/TransactionDBDebugTrueTest.php

@@ -21,8 +21,10 @@
  * @group DatabaseLive
  *
  * @internal
+ *
+ * @no-final
  */
-final class TransactionTest extends CIUnitTestCase
+class TransactionDBDebugTrueTest extends CIUnitTestCase
 {
     use DatabaseTestTrait;
 
@@ -55,13 +57,38 @@ protected function enableDBDebug(): void
         $this->setPrivateProperty($this->db, 'DBDebug', true);
     }
 
-    public function testTransStartDBDebugTrue()
+    public function testTransStart()
+    {
+        $builder = $this->db->table('job');
+
+        $this->db->transStart();
+
+        $jobData = [
+            'name'        => 'Grocery Sales',
+            'description' => 'Discount!',
+        ];
+        $builder->insert($jobData);
+
+        // Duplicate entry '1' for key 'PRIMARY'
+        $jobData = [
+            'id'          => 1,
+            'name'        => 'Comedian',
+            'description' => 'Theres something in your teeth',
+        ];
+        $builder->insert($jobData);
+
+        $this->db->transComplete();
+
+        $this->dontSeeInDatabase('job', ['name' => 'Grocery Sales']);
+    }
+
+    public function testTransStartTransException()
     {
         $builder = $this->db->table('job');
         $e       = null;
 
         try {
-            $this->db->transStart();
+            $this->db->transException(true)->transStart();
 
             $jobData = [
                 'name'        => 'Grocery Sales',
@@ -86,43 +113,8 @@ public function testTransStartDBDebugTrue()
         $this->dontSeeInDatabase('job', ['name' => 'Grocery Sales']);
     }
 
-    public function testTransStartDBDebugFalse()
+    public function testTransStrictTrue()
     {
-        $this->disableDBDebug();
-
-        $builder = $this->db->table('job');
-
-        $this->db->transStart();
-
-        $jobData = [
-            'name'        => 'Grocery Sales',
-            'description' => 'Discount!',
-        ];
-        $builder->insert($jobData);
-
-        $this->assertTrue($this->db->transStatus());
-
-        // Duplicate entry '1' for key 'PRIMARY'
-        $jobData = [
-            'id'          => 1,
-            'name'        => 'Comedian',
-            'description' => 'Theres something in your teeth',
-        ];
-        $builder->insert($jobData);
-
-        $this->assertFalse($this->db->transStatus());
-
-        $this->db->transComplete();
-
-        $this->dontSeeInDatabase('job', ['name' => 'Grocery Sales']);
-
-        $this->enableDBDebug();
-    }
-
-    public function testTransStrictTrueAndDBDebugFalse()
-    {
-        $this->disableDBDebug();
-
         $builder = $this->db->table('job');
 
         // The first transaction group
@@ -164,14 +156,10 @@ public function testTransStrictTrueAndDBDebugFalse()
         $this->db->transComplete();
 
         $this->dontSeeInDatabase('job', ['name' => 'Comedian']);
-
-        $this->enableDBDebug();
     }
 
-    public function testTransStrictFalseAndDBDebugFalse()
+    public function testTransStrictFalse()
     {
-        $this->disableDBDebug();
-
         $builder = $this->db->table('job');
 
         $this->db->transStrict(false);
@@ -215,7 +203,5 @@ public function testTransStrictFalseAndDBDebugFalse()
         $this->db->transComplete();
 
         $this->seeInDatabase('job', ['name' => 'Comedian']);
-
-        $this->enableDBDebug();
     }
 }