fix: prevent non-shared DB instances from polluting shared cache (#9679)

* fix: prevent non-shared DB instances from polluting shared cache

* Update user_guide_src/source/changelogs/v4.6.4.rst

Co-authored-by: John Paul E. Balandan, CPA <[email protected]>

---------

Co-authored-by: John Paul E. Balandan, CPA <[email protected]>

Author: michalsn

system/Database/Config.php

@@ -81,7 +81,9 @@ public static function connect($group = null, bool $getShared = true)
 
         $connection = static::$factory->load($config, $group);
 
-        static::$instances[$group] = $connection;
+        if ($getShared) {
+            static::$instances[$group] = $connection;
+        }
 
         return $connection;
     }

tests/system/Database/Live/ConnectTest.php

@@ -115,4 +115,22 @@ public function testConnectWithFailover(): void
 
         $this->assertGreaterThanOrEqual(0, count($db1->listTables()));
     }
+
+    public function testNonSharedInstanceDoesNotAffectSharedInstances(): void
+    {
+        $firstSharedDb      = Database::connect('tests');
+        $originalDebugValue = (bool) self::getPrivateProperty($firstSharedDb, 'DBDebug');
+
+        $nonSharedDb = Database::connect('tests', false);
+        self::setPrivateProperty($nonSharedDb, 'DBDebug', ! $originalDebugValue);
+
+        $secondSharedDb = Database::connect('tests');
+
+        $this->assertSame($firstSharedDb, $secondSharedDb);
+        $this->assertNotSame($firstSharedDb, $nonSharedDb);
+
+        $this->assertSame($originalDebugValue, self::getPrivateProperty($firstSharedDb, 'DBDebug'));
+        $this->assertSame($originalDebugValue, self::getPrivateProperty($secondSharedDb, 'DBDebug'));
+        $this->assertSame(! $originalDebugValue, self::getPrivateProperty($nonSharedDb, 'DBDebug'));
+    }
 }

user_guide_src/source/changelogs/v4.6.4.rst

@@ -30,6 +30,8 @@ Deprecations
 Bugs Fixed
 **********
 
+- **Database:** Fixed a bug in ``Database::connect()`` which was causing to store non-shared connection instances in shared cache.
+
 See the repo's
 `CHANGELOG.md <https://github.com/codeigniter4/CodeIgniter4/blob/develop/CHANGELOG.md>`_
 for a complete list of bugs fixed.