Remove configuration for reporting modified indexes

Author: morozov

UPGRADE.md

@@ -8,6 +8,8 @@ awareness about deprecated code.
 
 # Upgrade to 5.0
 
+## Deprecated `ComparatorConfig::withReportModifiedIndexes()`
+
 ## BC BREAK: Changes in features related to primary key constraints
 
 1. The `Index` class can no longer represent a primary key constraint. As a result:
@@ -38,6 +40,10 @@ The following auto-increment column definitions are no longer supported on SQLit
 
 The `TableDiff::getModifiedForeignKeys()` and `TableDiff::getModifiedIndexes()` methods have been removed.
 
+The comparator can be no longer configured to report modified indexes. The
+`ComparatorConfig::withReportModifiedIndexes()` only accepts `false` as the argument and has been deprecated. The
+`ComparatorConfig::getReportModifiedIndexes()` method has been removed.
+
 ## BC BREAK: changes in `AbstractPlatform` constructor
 
 The `AbstractPlatform` class constructor is now `protected` and requires an `UnquotedIdentifierFolding` instance as its

src/Schema/ComparatorConfig.php

@@ -4,12 +4,14 @@
 
 namespace Doctrine\DBAL\Schema;
 
+use Doctrine\DBAL\Exception\InvalidArgumentException;
+use Doctrine\Deprecations\Deprecation;
+
 final class ComparatorConfig
 {
     public function __construct(
         private readonly bool $detectRenamedColumns = true,
         private readonly bool $detectRenamedIndexes = true,
-        private readonly bool $reportModifiedIndexes = true,
     ) {
     }
 
@@ -18,7 +20,6 @@ public function withDetectRenamedColumns(bool $detectRenamedColumns): self
         return new self(
             $detectRenamedColumns,
             $this->detectRenamedIndexes,
-            $this->reportModifiedIndexes,
         );
     }
 
@@ -32,7 +33,6 @@ public function withDetectRenamedIndexes(bool $detectRenamedIndexes): self
         return new self(
             $this->detectRenamedColumns,
             $detectRenamedIndexes,
-            $this->reportModifiedIndexes,
         );
     }
 
@@ -41,17 +41,20 @@ public function getDetectRenamedIndexes(): bool
         return $this->detectRenamedIndexes;
     }
 
+    /** @deprecated Reporting of modified indexes cannot be enabled anymore. */
     public function withReportModifiedIndexes(bool $reportModifiedIndexes): self
     {
-        return new self(
-            $this->detectRenamedColumns,
-            $this->detectRenamedIndexes,
-            $reportModifiedIndexes,
+        if ($reportModifiedIndexes) {
+            throw new InvalidArgumentException('Reporting of modified indexes cannot be enabled anymore.');
+        }
+
+        Deprecation::trigger(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/XXXX',
+            '%s is deprecated and has no effect on the comparator behavior.',
+            __METHOD__,
         );
-    }
 
-    public function getReportModifiedIndexes(): bool
-    {
-        return $this->reportModifiedIndexes;
+        return $this;
     }
 }

tests/Functional/Schema/AlterTableTest.php

@@ -159,7 +159,7 @@ public function testDropNonAutoincrementColumnFromCompositePrimaryKeyWithAutoinc
                     )
                     ->create(),
             );
-        }, (new ComparatorConfig())->withReportModifiedIndexes(false));
+        });
     }
 
     public function testAddNonAutoincrementColumnToPrimaryKeyWithAutoincrementColumn(): void
@@ -193,7 +193,7 @@ public function testAddNonAutoincrementColumnToPrimaryKeyWithAutoincrementColumn
                     )
                     ->create(),
             );
-        }, (new ComparatorConfig())->withReportModifiedIndexes(false));
+        });
     }
 
     public function testAddNewColumnToPrimaryKey(): void
@@ -270,7 +270,7 @@ public function testReplaceForeignKeyConstraint(): void
         });
     }
 
-    private function testMigration(Table $oldTable, callable $migration, ?ComparatorConfig $config = null): void
+    private function testMigration(Table $oldTable, callable $migration): void
     {
         $this->dropAndCreateTable($oldTable);
 
@@ -281,7 +281,7 @@ private function testMigration(Table $oldTable, callable $migration, ?Comparator
 
         $migration($newTable);
 
-        $diff = $schemaManager->createComparator($config ?? new ComparatorConfig())
+        $diff = $schemaManager->createComparator()
             ->compareTables($oldTable, $newTable);
 
         self::assertFalse($diff->isEmpty());

tests/Schema/ComparatorConfigTest.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\DBAL\Tests\Schema;
+
+use Doctrine\DBAL\Schema\ComparatorConfig;
+use Doctrine\Deprecations\PHPUnit\VerifyDeprecations;
+use InvalidArgumentException;
+use PHPUnit\Framework\TestCase;
+
+class ComparatorConfigTest extends TestCase
+{
+    use VerifyDeprecations;
+
+    public function testEnableReportingOfModifiedIndexes(): void
+    {
+        $this->expectException(InvalidArgumentException::class);
+        (new ComparatorConfig())->withReportModifiedIndexes(true);
+    }
+
+    public function testDisableReportingOfModifiedIndexes(): void
+    {
+        $this->expectDeprecationWithIdentifier('https://github.com/doctrine/dbal/pull/XXXX');
+        (new ComparatorConfig())->withReportModifiedIndexes(false);
+    }
+}