Merge pull request #2054 from greg0ire/remove-disable-type-comments

Remove `disable_type_comments`

Author: greg0ire

UPGRADE-3.0.md

@@ -69,6 +69,11 @@ There is no replacement for this option.
 The `commented` option for custom types is no longer supported and has been
 removed.
 
+### The `doctrine.dbal.connection.some_connection.disable_type_comments` option is removed
+
+The `disable_type_comments` option for connections is no longer supported and has
+been removed.
+
 ### The `doctrine.dbal.connection.some_connection.platform_service` option is removed
 
 The `platform_service` option for connections is no longer supported and has

config/schema/doctrine-1.0.xsd

@@ -39,7 +39,6 @@
         <xsd:attribute name="schema-manager-factory" type="xsd:string" />
         <xsd:attribute name="result-cache" type="xsd:string" />
         <xsd:attribute name="use-savepoints" type="xsd:boolean" />
-        <xsd:attribute name="disable-type-comments" type="xsd:boolean" />
         <xsd:attributeGroup ref="driver-config" />
     </xsd:attributeGroup>
 

docs/en/configuration.rst

@@ -110,10 +110,6 @@ Configuration Reference
                         # When true, profiling also collects schema errors for each query
                         profiling_collect_schema_errors: true
 
-                        # When true, type comments are skipped in the database schema, matching the behavior of DBAL 4.
-                        # This requires using the non-deprecated schema comparison APIs of DBAL.
-                        disable_type_comments: false
-
                         server_version:       ~
                         driver_class:         ~
                         # Allows to specify a custom wrapper implementation to use.
@@ -423,7 +419,6 @@ Configuration Reference
                         profiling="%kernel.debug%"
                         profiling-collect-backtrace="false"
                         profiling-collect-schema-errors="true"
-                        disable-type-comments="false"
                         server-version=""
                         driver-class=""
                         wrapper-class=""

src/DependencyInjection/Configuration.php

@@ -4,8 +4,6 @@
 
 namespace Doctrine\Bundle\DoctrineBundle\DependencyInjection;
 
-use Doctrine\DBAL\Connection;
-use Doctrine\Deprecations\Deprecation;
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\EntityRepository;
 use Doctrine\ORM\Mapping\ClassMetadata;
@@ -31,7 +29,6 @@
 use function is_array;
 use function is_string;
 use function key;
-use function method_exists;
 use function reset;
 use function sprintf;
 use function strtoupper;
@@ -188,20 +185,6 @@ private function getDbalConnectionsNode(): ArrayNodeDefinition
                     ->defaultValue(true)
                     ->info('Enables collecting schema errors when profiling is enabled')
                 ->end()
-                ->booleanNode('disable_type_comments')
-                    ->beforeNormalization()
-                        ->ifTrue(static fn ($v): bool => isset($v) && ! method_exists(Connection::class, 'getEventManager'))
-                        ->then(static function ($v) {
-                            Deprecation::trigger(
-                                'doctrine/doctrine-bundle',
-                                'https://github.com/doctrine/DoctrineBundle/pull/2048',
-                                'The "disable_type_comments" configuration key is deprecated when using DBAL 4 and will be removed in DoctrineBundle 3.0.',
-                            );
-
-                            return $v;
-                        })
-                    ->end()
-                ->end()
                 ->scalarNode('server_version')->end()
                 ->integerNode('idle_connection_ttl')->defaultValue(600)->end()
                 ->scalarNode('driver_class')->end()

src/DependencyInjection/DoctrineExtension.php

@@ -262,12 +262,6 @@ protected function loadDbalConnection(string $name, array $connection, Container
 
         unset($connection['auto_commit']);
 
-        if (isset($connection['disable_type_comments'])) {
-            $configuration->addMethodCall('setDisableTypeComments', [$connection['disable_type_comments']]);
-        }
-
-        unset($connection['disable_type_comments']);
-
         if (isset($connection['schema_filter']) && $connection['schema_filter']) {
             $definition = new Definition(RegexSchemaAssetFilter::class, [$connection['schema_filter']]);
             $definition->addTag('doctrine.dbal.schema_filter', ['connection' => $name]);

tests/DependencyInjection/AbstractDoctrineExtensionTestCase.php

@@ -9,10 +9,8 @@
 use Doctrine\Bundle\DoctrineBundle\DependencyInjection\DoctrineExtension;
 use Doctrine\Bundle\DoctrineBundle\Tests\DependencyInjection\Fixtures\InvokableEntityListener;
 use Doctrine\DBAL\Configuration;
-use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Connections\PrimaryReadReplicaConnection;
 use Doctrine\DBAL\Platforms\PostgreSQLPlatform;
-use Doctrine\Deprecations\PHPUnit\VerifyDeprecations;
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Mapping\ClassMetadata;
@@ -43,7 +41,6 @@
 use function end;
 use function interface_exists;
 use function is_dir;
-use function method_exists;
 use function sprintf;
 use function sys_get_temp_dir;
 use function uniqid;
@@ -52,8 +49,6 @@
 
 abstract class AbstractDoctrineExtensionTestCase extends TestCase
 {
-    use VerifyDeprecations;
-
     abstract protected function loadFromFile(ContainerBuilder $container, string $file): void;
 
     public function testDbalLoadFromXmlMultipleConnections(): void
@@ -191,26 +186,6 @@ public function testDbalLoadSinglePrimaryReplicaConnection(): void
         $this->assertEquals(['engine' => 'InnoDB'], $param['defaultTableOptions']);
     }
 
-    public function testDbalLoadDisableTypeComments(): void
-    {
-        $container = $this->loadContainer('dbal_disable_type_comments');
-
-        $calls = $container->getDefinition('doctrine.dbal.no_comments_connection.configuration')->getMethodCalls();
-        $calls = array_values(array_filter($calls, static fn ($call) => $call[0] === 'setDisableTypeComments'));
-        $this->assertCount(1, $calls);
-        $this->assertEquals('setDisableTypeComments', $calls[0][0]);
-        $this->assertTrue($calls[0][1][0]);
-
-        $calls = $container->getDefinition('doctrine.dbal.comments_connection.configuration')->getMethodCalls();
-        $calls = array_values(array_filter($calls, static fn ($call) => $call[0] === 'setDisableTypeComments'));
-        $this->assertCount(1, $calls);
-        $this->assertFalse($calls[0][1][0]);
-
-        $calls = $container->getDefinition('doctrine.dbal.notset_connection.configuration')->getMethodCalls();
-        $calls = array_values(array_filter($calls, static fn ($call) => $call[0] === 'setDisableTypeComments'));
-        $this->assertCount(0, $calls);
-    }
-
     #[IgnoreDeprecations]
     public function testDbalSchemaManagerFactory(): void
     {
@@ -800,27 +775,6 @@ public function testAddFilter(): void
         $this->assertCount(2, $entityManager->getFilters()->getEnabledFilters());
     }
 
-    #[IgnoreDeprecations]
-    public function testSettingDisableTypeCommentsWithDbal4IsDeprecated(): void
-    {
-        if (method_exists(Connection::class, 'getEventManager')) {
-            self::markTestSkipped('This test requires DBAL 4.');
-        }
-
-        $this->expectDeprecationWithIdentifier('https://github.com/doctrine/DoctrineBundle/pull/2048');
-        $this->loadContainer('dbal_disable_type_comments');
-    }
-
-    public function testSettingDisableTypeCommentsWithDbal3IsFine(): void
-    {
-        if (! method_exists(Connection::class, 'getEventManager')) {
-            self::markTestSkipped('This test requires DBAL 3.');
-        }
-
-        $this->expectNoDeprecationWithIdentifier('https://github.com/doctrine/DoctrineBundle/pull/2048');
-        $this->loadContainer('dbal_disable_type_comments');
-    }
-
     public function testResolveTargetEntity(): void
     {
         if (! interface_exists(EntityManagerInterface::class)) {