Preserve dynamic database connections on reconnect (#53914)

* Add dynamic connection config to DatabaseManager. * Fix spacing issue in dynamic connection name assignment. * Remove unnecessary Mockery import in DatabaseConnectionsTest. * formatting * rename variable --------- Co-authored-by: Nicholas Hunt <[email protected]> Co-authored-by: Taylor Otwell <[email protected]>
laravel · Dec 16, 2024 · 28c0d24 · 28c0d24
1 parent 37d48c4
commit 28c0d24
Show file tree

Hide file tree

Showing 2 changed files with 69 additions and 9 deletions.
diff --git a/src/Illuminate/Database/DatabaseManager.php b/src/Illuminate/Database/DatabaseManager.php
@@ -5,6 +5,7 @@
 use Illuminate\Database\Connectors\ConnectionFactory;
 use Illuminate\Database\Events\ConnectionEstablished;
 use Illuminate\Support\Arr;
+use Illuminate\Support\Collection;
 use Illuminate\Support\ConfigurationUrlParser;
 use Illuminate\Support\Str;
 use Illuminate\Support\Traits\Macroable;
@@ -42,6 +43,13 @@ class DatabaseManager implements ConnectionResolverInterface
      */
     protected $connections = [];
 
+    /**
+     * The dynamically configured (DB::build) connection configurations.
+     *
+     * @var array<string, array>
+     */
+    protected $dynamicConnectionConfigurations = [];
+
     /**
      * The custom connection resolvers.
      *
@@ -109,11 +117,26 @@ public function connection($name = null)
      */
     public function build(array $config)
     {
-        return $this->connectUsing(
-            $config['name'] ?? 'ondemand',
-            $config,
-            true,
-        );
+        if (! isset($config['name'])) {
+            $config['name'] = static::calculateDynamicConnectionName($config);
+        }
+
+        $this->dynamicConnectionConfigurations[$config['name']] = $config;
+
+        return $this->connectUsing($config['name'], $config, true);
+    }
+
+    /**
+     * Calculate the dynamic connection name for an on-demand connection based on its configuration.
+     *
+     * @param  array  $config
+     * @return string
+     */
+    public static function calculateDynamicConnectionName(array $config)
+    {
+        return 'dynamic_'.md5((new Collection($config))->map(function ($value, $key) {
+            return $key.(is_string($value) || is_int($value) ? $value : '');
+        })->implode(''));
     }
 
     /**
@@ -196,12 +219,11 @@ protected function configuration($name)
     {
         $name = $name ?: $this->getDefaultConnection();
 
-        // To get the database connection configuration, we will just pull each of the
-        // connection configurations and get the configurations for the given name.
-        // If the configuration doesn't exist, we'll throw an exception and bail.
         $connections = $this->app['config']['database.connections'];
 
-        if (is_null($config = Arr::get($connections, $name))) {
+        $config = $this->dynamicConnectionConfigurations[$name] ?? Arr::get($connections, $name);
+
+        if (is_null($config)) {
             throw new InvalidArgumentException("Database connection [{$name}] not configured.");
         }
 

diff --git a/tests/Integration/Database/DatabaseConnectionsTest.php b/tests/Integration/Database/DatabaseConnectionsTest.php
@@ -9,6 +9,7 @@
 use Illuminate\Database\SQLiteConnection;
 use Illuminate\Events\Dispatcher;
 use Illuminate\Support\Facades\DB;
+use InvalidArgumentException;
 use RuntimeException;
 
 class DatabaseConnectionsTest extends DatabaseTestCase
@@ -134,4 +135,41 @@ public function testTablePrefix()
         DB::setTablePrefix('');
         $this->assertSame('', DB::getTablePrefix());
     }
+
+    public function testDynamicConnectionDoesntFailOnReconnect()
+    {
+        $connection = DB::build([
+            'name' => 'projects',
+            'driver' => 'sqlite',
+            'database' => ':memory:',
+        ]);
+
+        $this->expectNotToPerformAssertions();
+
+        try {
+            $connection->reconnect();
+        } catch (InvalidArgumentException $e) {
+            if ($e->getMessage() === 'Database connection [projects] not configured.') {
+                $this->fail('Dynamic connection should not throw an exception on reconnect.');
+            }
+        }
+    }
+
+    public function testDynamicConnectionWithNoNameDoesntFailOnReconnect()
+    {
+        $connection = DB::build([
+            'driver' => 'sqlite',
+            'database' => ':memory:',
+        ]);
+
+        $this->expectNotToPerformAssertions();
+
+        try {
+            $connection->reconnect();
+        } catch (InvalidArgumentException $e) {
+            if ($e->getMessage() === 'Database connection [projects] not configured.') {
+                $this->fail('Dynamic connection should not throw an exception on reconnect.');
+            }
+        }
+    }
 }