Merge pull request #1995 from greg0ire/no-url-override

Remove URL override feature

Author: greg0ire

UPGRADE-3.0.md

@@ -60,6 +60,10 @@ have been removed:
 
 Use `doctrine.dbal.default_table_options.collation` instead.
 
+### The `doctrine.dbal.override_url` option is removed
+
+There is no replacement for this option.
+
 ### Controller resolver auto mapping can no longer be configured
 
 The `doctrine.orm.controller_resolver.auto_mapping` option now only accepts `false` as value, to disallow the usage of the controller resolver auto mapping feature by default. The configuration option will be fully removed in 4.0.

docs/en/configuration.rst

@@ -814,15 +814,6 @@ Doctrine DBAL Configuration
     accept, converted to the XML or YAML naming standards that Symfony
     enforces. See the Doctrine `DBAL documentation`_ for more information.
 
-.. note::
-
-    When specifying a ``url`` parameter, any information extracted from that
-    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:
 

src/ConnectionFactory.php

@@ -20,7 +20,6 @@
 use function array_merge;
 use function class_exists;
 use function is_subclass_of;
-use function trigger_deprecation;
 
 use const PHP_EOL;
 
@@ -69,14 +68,6 @@ public function createConnection(
             $this->initializeTypes();
         }
 
-        $overriddenOptions = [];
-        /** @phpstan-ignore isset.offset (We should adjust when https://github.com/phpstan/phpstan/issues/12414 is fixed) */
-        if (isset($params['connection_override_options'])) {
-            trigger_deprecation('doctrine/doctrine-bundle', '2.4', 'The "connection_override_options" connection parameter is deprecated');
-            $overriddenOptions = $params['connection_override_options'];
-            unset($params['connection_override_options']);
-        }
-
         $params = $this->parseDatabaseUrl($params);
 
         // URL support for PrimaryReplicaConnection
@@ -91,25 +82,22 @@ public function createConnection(
         }
 
         /** @phpstan-ignore-next-line We should adjust when https://github.com/phpstan/phpstan/issues/12414 is fixed */
-        if (! isset($params['pdo']) && (! isset($params['charset']) || $overriddenOptions || isset($params['dbname_suffix']))) {
+        if (! isset($params['pdo']) && (! isset($params['charset']) || isset($params['dbname_suffix']))) {
             $wrapperClass = null;
 
             if (isset($params['wrapperClass'])) {
                 if (! is_subclass_of($params['wrapperClass'], Connection::class)) {
                     if (class_exists(InvalidWrapperClass::class)) {
                         throw InvalidWrapperClass::new($params['wrapperClass']);
                     }
-
-                    /* @phpstan-ignore staticMethod.notFound */
-                    throw DBALException::invalidWrapperClass($params['wrapperClass']);
                 }
 
                 $wrapperClass           = $params['wrapperClass'];
                 $params['wrapperClass'] = null;
             }
 
             $connection = DriverManager::getConnection($params, $config);
-            $params     = $this->addDatabaseSuffix(array_merge($connection->getParams(), $overriddenOptions));
+            $params     = $this->addDatabaseSuffix($connection->getParams());
             $driver     = $connection->getDriver();
             $platform   = $driver->getDatabasePlatform(new StaticServerVersionProvider(
                 $params['serverVersion'] ?? $params['primary']['serverVersion'] ?? '',

src/DependencyInjection/Configuration.php

@@ -303,11 +303,6 @@ private function configureDbalDriverNode(ArrayNodeDefinition $node): void
                 ->scalarNode('port')->info('Defaults to null at runtime.')->end()
                 ->scalarNode('user')->info('Defaults to "root" at runtime.')->end()
                 ->scalarNode('password')->info('Defaults to null at runtime.')->end()
-                ->booleanNode('override_url')->setDeprecated(
-                    'doctrine/doctrine-bundle',
-                    '2.4',
-                    'The "doctrine.dbal.override_url" configuration key is deprecated.',
-                )->end()
                 ->scalarNode('dbname_suffix')->info('Adds the given suffix to the configured database name, this option has no effects for the SQLite platform')->end()
                 ->scalarNode('application_name')->end()
                 ->scalarNode('charset')->end()

src/DependencyInjection/DoctrineExtension.php

@@ -57,7 +57,6 @@
 use Symfony\Component\PropertyInfo\PropertyInfoExtractorInterface;
 use Symfony\Component\Validator\Mapping\Loader\LoaderInterface;
 
-use function array_intersect_key;
 use function array_keys;
 use function array_merge;
 use function class_exists;
@@ -338,11 +337,6 @@ protected function getConnectionOptions(array $connection): array
             'password' => null,
         ];
 
-        if ($options['override_url'] ?? false) {
-            $options['connection_override_options'] = array_intersect_key($options, ['dbname' => null] + $connectionDefaults);
-        }
-
-        unset($options['override_url']);
         unset($options['schema_manager_factory']);
 
         $options += $connectionDefaults;

tests/ConnectionFactoryTest.php

@@ -9,8 +9,6 @@
 use Doctrine\DBAL\Schema\DefaultSchemaManagerFactory;
 use Doctrine\Deprecations\PHPUnit\VerifyDeprecations;
 
-use function array_intersect_key;
-
 class ConnectionFactoryTest extends TestCase
 {
     use VerifyDeprecations;
@@ -61,29 +59,6 @@ public function testDefaultCollationMySql(): void
         );
     }
 
-    /** @group legacy */
-    public function testConnectionOverrideOptions(): void
-    {
-        $params = [
-            'dbname' => 'main_test',
-            'host' => 'db_test',
-            'port' => 5432,
-            'user' => 'tester',
-            'password' => 'wordpass',
-        ];
-
-        /** @psalm-suppress InvalidArgument We should adjust when https://github.com/vimeo/psalm/issues/8984 is fixed */
-        $connection = (new ConnectionFactory([]))->createConnection(
-            [
-                'url' => 'mysql://root:password@database:3306/main?serverVersion=mariadb-12.1.1',
-                'connection_override_options' => $params,
-            ],
-            $this->configuration,
-        );
-
-        $this->assertEquals($params, array_intersect_key($connection->getParams(), $params));
-    }
-
     public function testConnectionCharsetFromUrl(): void
     {
         /** @psalm-suppress InvalidArgument Need to be compatible with DBAL < 4, which still has `$params['url']` */

tests/DependencyInjection/AbstractDoctrineExtensionTestCase.php

@@ -32,7 +32,6 @@
 use Symfony\Component\Security\Core\User\UserInterface;
 
 use function array_filter;
-use function array_intersect_key;
 use function array_keys;
 use function array_values;
 use function assert;
@@ -130,47 +129,6 @@ public function testDbalLoadFromXmlSingleConnections(): void
         $this->assertEquals('9.4.0', $config['serverVersion']);
     }
 
-    /** @group legacy */
-    public function testDbalLoadUrlOverride(): void
-    {
-        $container = $this->loadContainer('dbal_allow_url_override');
-        $config    = $container->getDefinition('doctrine.dbal.default_connection')->getArgument(0);
-
-        $this->assertSame('mysql://root:password@database:3306/main?serverVersion=mariadb-12.1.1', $config['url']);
-
-        $expectedOverrides = [
-            'dbname' => 'main_test',
-            'user' => 'tester',
-            'password' => 'wordpass',
-            'host' => 'localhost',
-            'port' => 4321,
-        ];
-
-        $this->assertEquals($expectedOverrides, array_intersect_key($config, $expectedOverrides));
-        $this->assertSame($expectedOverrides, $config['connection_override_options']);
-        $this->assertFalse(isset($config['override_url']));
-    }
-
-    /** @group legacy */
-    public function testDbalLoadPartialUrlOverrideSetsDefaults(): void
-    {
-        $container = $this->loadContainer('dbal_allow_partial_url_override');
-        $config    = $container->getDefinition('doctrine.dbal.default_connection')->getArgument(0);
-
-        $expectedDefaults = [
-            'host' => 'localhost',
-            'user' => 'root',
-            'password' => null,
-            'port' => null,
-        ];
-
-        $this->assertEquals($expectedDefaults, array_intersect_key($config, $expectedDefaults));
-        $this->assertSame('mysql://root:password@database:3306/main?serverVersion=mariadb-12.1.1', $config['url']);
-        $this->assertCount(1, $config['connection_override_options']);
-        $this->assertSame('main_test', $config['connection_override_options']['dbname']);
-        $this->assertFalse(isset($config['override_url']));
-    }
-
     public function testDbalDbnameSuffix(): void
     {
         $container = $this->loadContainer('dbal_dbname_suffix');