add ability to override url

jrushlow · jrushlow · commit 265e8e9e20ea · 2021-02-26T16:39:52.000-05:00
diff --git a/ConnectionFactory.php b/ConnectionFactory.php
@@ -45,8 +45,16 @@ public function createConnection(array $params, Configuration $config = null, Ev
             $this->initializeTypes();
         }
 
-        if (! isset($params['pdo']) && ! isset($params['charset'])) {
+        $connectionOverrideOptions = [];
+
+        if (isset($params['connection_override_options'])) {
+            $connectionOverrideOptions = $params['connection_override_options'];
+            unset($params['connection_override_options']);
+        }
+
+        if (! isset($params['pdo']) && (! isset($params['charset']) || (! empty($connectionOverrideOptions) && isset($params['url'])))) {
             $wrapperClass = null;
+
             if (isset($params['wrapperClass'])) {
                 if (! is_subclass_of($params['wrapperClass'], Connection::class)) {
                     if (class_exists(DBALException::class)) {
@@ -64,6 +72,24 @@ public function createConnection(array $params, Configuration $config = null, Ev
             $params     = $connection->getParams();
             $driver     = $connection->getDriver();
 
+            if (! empty($connectionOverrideOptions)) {
+                $supportedOverrideParams = [
+                    'dbname',
+                    'host',
+                    'port',
+                    'user',
+                    'password',
+                ];
+
+                foreach ($supportedOverrideParams as $paramKey) {
+                    if (! array_key_exists($paramKey, $connectionOverrideOptions)) {
+                        continue;
+                    }
+
+                    $params[$paramKey] = $connectionOverrideOptions[$paramKey];
+                }
+            }
+
             if ($driver instanceof AbstractMySQLDriver) {
                 $params['charset'] = 'utf8mb4';
 
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -217,10 +217,11 @@ private function configureDbalDriverNode(ArrayNodeDefinition $node): void
             ->children()
                 ->scalarNode('url')->info('A URL with connection information; any parameter value parsed from this string will override explicitly set parameters')->end()
                 ->scalarNode('dbname')->end()
-                ->scalarNode('host')->defaultValue('localhost')->end()
-                ->scalarNode('port')->defaultNull()->end()
-                ->scalarNode('user')->defaultValue('root')->end()
-                ->scalarNode('password')->defaultNull()->end()
+                ->scalarNode('host')->info('Defaults to "localhost" at runtime.')->end()
+                ->scalarNode('port')->info('Default to null at runtime.')->end()
+                ->scalarNode('user')->info('Default to "root" at runtime.')->end()
+                ->scalarNode('password')->info('Default to null at runtime.')->end()
+                ->booleanNode('override_url')->info('Allows overriding URL parameters with dbname, host, port, user, and/or password parameters.')->end()
                 ->scalarNode('application_name')->end()
                 ->scalarNode('charset')->end()
                 ->scalarNode('path')->end()
diff --git a/DependencyInjection/DoctrineExtension.php b/DependencyInjection/DoctrineExtension.php
@@ -15,6 +15,7 @@
 use Doctrine\DBAL\SQLParserUtils;
 use Doctrine\DBAL\Tools\Console\Command\ImportCommand;
 use Doctrine\DBAL\Tools\Console\ConnectionProvider;
+use Doctrine\Deprecations\Deprecation;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Id\AbstractIdGenerator;
 use Doctrine\ORM\Proxy\Autoloader;
@@ -254,6 +255,54 @@ protected function getConnectionOptions($connection)
     {
         $options = $connection;
 
+        $options['connection_override_options'] = [];
+
+        $connectionDefaults = [
+            'dbname' => null,
+            'host' => 'localhost',
+            'port' => null,
+            'user' => 'root',
+            'password' => null,
+        ];
+
+        $allowOverrideUrl = $options['override_url'] ?? false;
+
+        if (! $allowOverrideUrl && isset($options['url'])) {
+            Deprecation::trigger(
+                'doctrine/doctrineBundle',
+                'https://github.com/doctrine/DoctrineBundle/pull/1290',
+                'Not setting doctrine.dbal.override_url to true is deprecated. True is the only value that will be supported in doctrine-bundle 3.0.'
+            );
+        }
+
+        if ($allowOverrideUrl) {
+            foreach (array_keys($connectionDefaults) as $paramName) {
+                if (! array_key_exists($paramName, $options)) {
+                    continue;
+                }
+
+                $options['connection_override_options'][$paramName] = $options[$paramName];
+            }
+        }
+
+        unset($options['override_url'], $connectionDefaults['dbname']);
+
+        $nestedConnections = ['shards', 'replicas', 'slaves'];
+
+        foreach ($connectionDefaults as $defaultKey => $defaultValue) {
+            if (! array_key_exists($defaultKey, $options)) {
+                $options[$defaultKey] = $defaultValue;
+            }
+
+            foreach ($nestedConnections as $connectionKey) {
+                if (! array_key_exists($connectionKey, $options)) {
+                    continue;
+                }
+
+                $options[$connectionKey] = $this->setDefaultOnNestedConnectionOption($options[$connectionKey], $defaultKey, $defaultValue);
+            }
+        }
+
         if (isset($options['platform_service'])) {
             $options['platform'] = new Reference($options['platform_service']);
             unset($options['platform_service']);
@@ -975,4 +1024,20 @@ private function createArrayAdapterCachePool(ContainerBuilder $container, string
 
         return $id;
     }
+
+    /**
+     * @return array<string|int, array<string|int, mixed>>
+     */
+    private function setDefaultOnNestedConnectionOption(array $connectionOptions, string $paramName, $defaultValue): array
+    {
+        foreach ($connectionOptions as $connectionKey => $connection) {
+            if (array_key_exists($paramName, $connection)) {
+                continue;
+            }
+
+            $connectionOptions[$connectionKey][$paramName] = $defaultValue;
+        }
+
+        return $connectionOptions;
+    }
 }
diff --git a/Resources/config/schema/doctrine-1.0.xsd b/Resources/config/schema/doctrine-1.0.xsd
@@ -51,6 +51,7 @@
         <xsd:attribute name="port" type="xsd:string" />
         <xsd:attribute name="user" type="xsd:string" />
         <xsd:attribute name="password" type="xsd:string" />
+        <xsd:attribute name="override-url" type="xsd:boolean" />
         <xsd:attribute name="application-name" type="xsd:string" />
         <xsd:attribute name="path" type="xsd:string" />
         <xsd:attribute name="unix-socket" type="xsd:string" />
diff --git a/Resources/doc/configuration.rst b/Resources/doc/configuration.rst
@@ -22,6 +22,9 @@ Configuration Reference
                 connections:
                     # A collection of different named connections (e.g. default, conn2, etc)
                     default:
+                        # If true, allows overriding url parameters with explicitly set parameters.
+                        # "dbname", "host", "port", "user", and/or "password" can be overridden.
+                        override_url:         ~
                         dbname:               ~
                         host:                 localhost
                         port:                 ~
@@ -914,10 +917,11 @@ Doctrine DBAL Configuration
 .. note::
 
     When specifying a ``url`` parameter, any information extracted from that
-    URL will override explicitly set parameters. An example database URL
-    would be ``mysql://snoopy:redbaron@localhost/baseball``, and any explicitly
-    set driver, user, password and dbname parameter would be overridden by
-    this URL. See the Doctrine `DBAL documentation`_ for more information.
+    URL will override explicitly set parameters unless ``override_url`` is set
+    to ``true``. An example database URL would be
+    ``mysql://snoopy:redbaron@localhost/baseball``, and any explicitly set driver,
+    user, password and dbname parameter would be overridden by this URL.
+    See the Doctrine `DBAL documentation`_ for more information.
 
 Besides default Doctrine options, there are some Symfony-related ones that you
 can configure. The following block shows all possible configuration keys:
@@ -928,6 +932,7 @@ can configure. The following block shows all possible configuration keys:
 
         doctrine:
             dbal:
+                override_url:             true
                 url:                      mysql://user:secret@localhost:1234/otherdatabase # this would override the values below
                 dbname:                   database
                 host:                     localhost
diff --git a/Tests/ConnectionFactoryTest.php b/Tests/ConnectionFactoryTest.php
@@ -71,6 +71,31 @@ public function testDefaultCharsetMySql(): void
 
         $this->assertSame('utf8mb4', $connection->getParams()['charset']);
     }
+
+    public function testUrlOverride(): void
+    {
+        $factory = new ConnectionFactory([]);
+        $url     = 'mysql://root:password@database:3306/main?serverVersion=mariadb-10.5.8';
+
+        $params = [
+            'dbname' => 'main_test',
+            'host' => 'db_test',
+            'port' => 5432,
+            'user' => 'tester',
+            'password' => 'wordpass',
+        ];
+
+        $connection = $factory->createConnection([
+            'url' => $url,
+            'connection_override_options' => $params,
+        ]);
+
+        $result = $connection->getParams();
+
+        foreach ($params as $paramKey => $expectedValue) {
+            self::assertSame($expectedValue, $result[$paramKey]);
+        }
+    }
 }
 
 /**
diff --git a/Tests/DependencyInjection/AbstractDoctrineExtensionTest.php b/Tests/DependencyInjection/AbstractDoctrineExtensionTest.php
@@ -113,6 +113,31 @@ public function testDbalLoadFromXmlSingleConnections(): void
         $this->assertEquals('5.6.20', $config['serverVersion']);
     }
 
+    public function testDbalLoadUrlOverride(): void
+    {
+        $container = $this->loadContainer('dbal_allow_url_override');
+
+        // doctrine.dbal.mysql_connection
+        $config = $container->getDefinition('doctrine.dbal.default_connection')->getArgument(0);
+
+        $this->assertSame('mysql://root:password@database:3306/main?serverVersion=mariadb-10.5.8', $config['url']);
+
+        $expectedOverrides = [
+            'dbname' => 'main_test',
+            'host' => 'docker',
+            'port' => 4321,
+            'user' => 'tester',
+            'password' => 'wordpass',
+        ];
+
+        foreach ($expectedOverrides as $param => $value) {
+            $this->assertSame($value, $config[$param]);
+        }
+
+        $this->assertSame($expectedOverrides, $config['connection_override_options']);
+        $this->assertFalse(isset($config['override_url']));
+    }
+
     public function testDbalLoadSingleMasterSlaveConnection(): void
     {
         $container = $this->loadContainer('dbal_service_single_master_slave_connection');
@@ -135,6 +160,7 @@ class_exists(PrimaryReadReplicaConnection::class) ?
                 'dbname' => 'mysql_db',
                 'host' => 'localhost',
                 'unix_socket' => '/path/to/mysqld.sock',
+                'connection_override_options' => [],
             ],
             $param['primary'] ?? $param['master'] // TODO: Remove 'master' support here when we require dbal >= 2.11
         );
@@ -169,6 +195,7 @@ public function testDbalLoadPoolShardingConnection(): void
                 'dbname' => 'mysql_db',
                 'host' => 'localhost',
                 'unix_socket' => '/path/to/mysqld.sock',
+                'connection_override_options' => [],
             ],
             $param['global']
         );
@@ -223,6 +250,7 @@ public function testLoadSimpleSingleConnection(): void
                 'driver' => 'pdo_mysql',
                 'driverOptions' => [],
                 'defaultTableOptions' => [],
+                'connection_override_options' => [],
             ],
             new Reference('doctrine.dbal.default_connection.configuration'),
             new Reference('doctrine.dbal.default_connection.event_manager'),
@@ -262,6 +290,7 @@ public function testLoadSimpleSingleConnectionWithoutDbName(): void
                 'driver' => 'pdo_mysql',
                 'driverOptions' => [],
                 'defaultTableOptions' => [],
+                'connection_override_options' => [],
             ],
             new Reference('doctrine.dbal.default_connection.configuration'),
             new Reference('doctrine.dbal.default_connection.event_manager'),
@@ -302,6 +331,7 @@ public function testLoadSingleConnection(): void
                 'dbname' => 'sqlite_db',
                 'memory' => true,
                 'defaultTableOptions' => [],
+                'connection_override_options' => [],
             ],
             new Reference('doctrine.dbal.default_connection.configuration'),
             new Reference('doctrine.dbal.default_connection.event_manager'),
diff --git a/Tests/DependencyInjection/Fixtures/config/xml/dbal_allow_url_override.xml b/Tests/DependencyInjection/Fixtures/config/xml/dbal_allow_url_override.xml
@@ -0,0 +1,12 @@
+<?xml version="1.0" ?>
+
+<srv:container xmlns="http://symfony.com/schema/dic/doctrine"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:srv="http://symfony.com/schema/dic/services"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
+                        http://symfony.com/schema/dic/doctrine http://symfony.com/schema/dic/doctrine/doctrine-1.0.xsd">
+
+    <config>
+        <dbal override-url="true" dbname="main_test" user="tester" password="wordpass" host="docker" port="4321" url="mysql://root:password@database:3306/main?serverVersion=mariadb-10.5.8" />
+    </config>
+</srv:container>
diff --git a/Tests/DependencyInjection/Fixtures/config/yml/dbal_allow_url_override.yml b/Tests/DependencyInjection/Fixtures/config/yml/dbal_allow_url_override.yml
@@ -0,0 +1,9 @@
+doctrine:
+    dbal:
+        override_url: true
+        url: 'mysql://root:password@database:3306/main?serverVersion=mariadb-10.5.8'
+        dbname: main_test
+        user: tester
+        password: wordpass
+        host: docker
+        port: 4321
diff --git a/UPGRADE-2.3.md b/UPGRADE-2.3.md
@@ -1,6 +1,10 @@
 UPGRADE FROM 2.2 to 2.3
 =======================
 
+Configuration
+--------
+* Not setting `doctrine.dbal.override_url` to `true` when using a `url` parameter in a connection is deprecated.
+
 DependencyInjection
 --------
 
