Add comparison of foreign key names with option to opt-out of this (f…

…ixes #6518).
doctrine · Sep 6, 2024 · d7c47bf · d7c47bf
1 parent 0e81fa2
commit d7c47bf
Show file tree

Hide file tree

Showing 20 changed files with 97 additions and 22 deletions.
diff --git a/src/Configuration.php b/src/Configuration.php
@@ -36,6 +36,15 @@ class Configuration
 
     private ?SchemaManagerFactory $schemaManagerFactory = null;
 
+    /**
+     * Whether changes in the foreign key names should be compared.
+     * If you opt-out of this, you need to handle name changes of foreign keys yourself.
+     * Databases created based on the current schema might have different foreign key names
+     * than those migrated from older schemas if you turn this off.
+     * This could lead to incompatible migrations that try to drop non-existent foreign keys.
+     */
+    private bool $compareForeignKeyNames = false;
+
     public function __construct()
     {
         $this->schemaAssetsFilter = static function (): bool {
@@ -153,4 +162,14 @@ public function setDisableTypeComments(bool $disableTypeComments): self
 
         return $this;
     }
+
+    public function getCompareForeignKeyNames(): bool
+    {
+        return $this->compareForeignKeyNames;
+    }
+
+    public function setCompareForeignKeyNames(bool $compareForeignKeyNames): void
+    {
+        $this->compareForeignKeyNames = $compareForeignKeyNames;
+    }
 }
diff --git a/src/Platforms/MySQL/Comparator.php b/src/Platforms/MySQL/Comparator.php
@@ -4,6 +4,7 @@
 
 namespace Doctrine\DBAL\Platforms\MySQL;
 
+use Doctrine\DBAL\Configuration;
 use Doctrine\DBAL\Platforms\AbstractMySQLPlatform;
 use Doctrine\DBAL\Schema\Comparator as BaseComparator;
 use Doctrine\DBAL\Schema\Table;
@@ -23,11 +24,12 @@ class Comparator extends BaseComparator
     /** @internal The comparator can be only instantiated by a schema manager. */
     public function __construct(
         AbstractMySQLPlatform $platform,
+        Configuration $configuration,
         private readonly CharsetMetadataProvider $charsetMetadataProvider,
         private readonly CollationMetadataProvider $collationMetadataProvider,
         private readonly DefaultTableOptions $defaultTableOptions,
     ) {
-        parent::__construct($platform);
+        parent::__construct($platform, $configuration);
     }
 
     public function compareTables(Table $oldTable, Table $newTable): TableDiff

diff --git a/src/Platforms/SQLServer/Comparator.php b/src/Platforms/SQLServer/Comparator.php
@@ -4,6 +4,7 @@
 
 namespace Doctrine\DBAL\Platforms\SQLServer;
 
+use Doctrine\DBAL\Configuration;
 use Doctrine\DBAL\Platforms\SQLServerPlatform;
 use Doctrine\DBAL\Schema\Comparator as BaseComparator;
 use Doctrine\DBAL\Schema\Table;
@@ -17,9 +18,12 @@
 class Comparator extends BaseComparator
 {
     /** @internal The comparator can be only instantiated by a schema manager. */
-    public function __construct(SQLServerPlatform $platform, private readonly string $databaseCollation)
-    {
-        parent::__construct($platform);
+    public function __construct(
+        SQLServerPlatform $platform,
+        Configuration $configuration,
+        private readonly string $databaseCollation,
+    ) {
+        parent::__construct($platform, $configuration);
     }
 
     public function compareTables(Table $oldTable, Table $newTable): TableDiff

diff --git a/src/Platforms/SQLite/Comparator.php b/src/Platforms/SQLite/Comparator.php
@@ -4,6 +4,7 @@
 
 namespace Doctrine\DBAL\Platforms\SQLite;
 
+use Doctrine\DBAL\Configuration;
 use Doctrine\DBAL\Platforms\SQLitePlatform;
 use Doctrine\DBAL\Schema\Comparator as BaseComparator;
 use Doctrine\DBAL\Schema\Table;
@@ -19,9 +20,9 @@
 class Comparator extends BaseComparator
 {
     /** @internal The comparator can be only instantiated by a schema manager. */
-    public function __construct(SQLitePlatform $platform)
+    public function __construct(SQLitePlatform $platform, Configuration $configuration)
     {
-        parent::__construct($platform);
+        parent::__construct($platform, $configuration);
     }
 
     public function compareTables(Table $oldTable, Table $newTable): TableDiff

diff --git a/src/Schema/AbstractSchemaManager.php b/src/Schema/AbstractSchemaManager.php
@@ -842,7 +842,7 @@ private function getDatabase(string $methodName): string
 
     public function createComparator(): Comparator
     {
-        return new Comparator($this->platform);
+        return new Comparator($this->platform, $this->connection->getConfiguration());
     }
 
     /**

diff --git a/src/Schema/Comparator.php b/src/Schema/Comparator.php
@@ -4,6 +4,7 @@
 
 namespace Doctrine\DBAL\Schema;
 
+use Doctrine\DBAL\Configuration;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 
 use function array_map;
@@ -17,8 +18,10 @@
 class Comparator
 {
     /** @internal The comparator can be only instantiated by a schema manager. */
-    public function __construct(private readonly AbstractPlatform $platform)
-    {
+    public function __construct(
+        private readonly AbstractPlatform $platform,
+        private readonly Configuration $configuration,
+    ) {
     }
 
     /**
@@ -389,6 +392,13 @@ private function detectRenamedIndexes(array &$addedIndexes, array &$removedIndex
 
     protected function diffForeignKey(ForeignKeyConstraint $key1, ForeignKeyConstraint $key2): bool
     {
+        if (
+            $this->configuration->getCompareForeignKeyNames()
+            && strtolower($key1->getName()) !== strtolower($key2->getName())
+        ) {
+            return true;
+        }
+
         if (
             array_map('strtolower', $key1->getUnquotedLocalColumns())
             !== array_map('strtolower', $key2->getUnquotedLocalColumns())

diff --git a/src/Schema/MySQLSchemaManager.php b/src/Schema/MySQLSchemaManager.php
@@ -318,6 +318,7 @@ public function createComparator(): Comparator
     {
         return new MySQL\Comparator(
             $this->platform,
+            $this->connection->getConfiguration(),
             new CachingCharsetMetadataProvider(
                 new ConnectionCharsetMetadataProvider($this->connection),
             ),

diff --git a/src/Schema/SQLServerSchemaManager.php b/src/Schema/SQLServerSchemaManager.php
@@ -4,6 +4,7 @@
 
 namespace Doctrine\DBAL\Schema;
 
+use Doctrine\DBAL\Configuration;
 use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Platforms\SQLServer;
 use Doctrine\DBAL\Platforms\SQLServerPlatform;
@@ -264,7 +265,7 @@ protected function _getPortableViewDefinition(array $view): View
     /** @throws Exception */
     public function createComparator(): Comparator
     {
-        return new SQLServer\Comparator($this->platform, $this->getDatabaseCollation());
+        return new SQLServer\Comparator($this->platform, new Configuration(), $this->getDatabaseCollation());
     }
 
     /** @throws Exception */

diff --git a/src/Schema/SQLiteSchemaManager.php b/src/Schema/SQLiteSchemaManager.php
@@ -4,6 +4,7 @@
 
 namespace Doctrine\DBAL\Schema;
 
+use Doctrine\DBAL\Configuration;
 use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Platforms\SQLite;
 use Doctrine\DBAL\Platforms\SQLitePlatform;
@@ -498,7 +499,7 @@ private function getForeignKeyDetails(string $table): array
 
     public function createComparator(): Comparator
     {
-        return new SQLite\Comparator($this->platform);
+        return new SQLite\Comparator($this->platform, new Configuration());
     }
 
     protected function selectTableNames(string $databaseName): Result

diff --git a/tests/Functional/Schema/ComparatorTest.php b/tests/Functional/Schema/ComparatorTest.php
@@ -4,6 +4,7 @@
 
 namespace Doctrine\DBAL\Tests\Functional\Schema;
 
+use Doctrine\DBAL\Configuration;
 use Doctrine\DBAL\Platforms\AbstractMySQLPlatform;
 use Doctrine\DBAL\Platforms\MariaDBPlatform;
 use Doctrine\DBAL\Schema\AbstractSchemaManager;
@@ -53,7 +54,7 @@ public function testDefaultValueComparison(string $type, mixed $value): void
     public function testRenameColumnComparison(): void
     {
         $platform   = $this->connection->getDatabasePlatform();
-        $comparator = new Comparator($platform);
+        $comparator = new Comparator($platform, new Configuration());
 
         $table = new Table('rename_table');
         $table->addColumn('test', Types::STRING, ['default' => 'baz', 'length' => 20]);

diff --git a/tests/Platforms/AbstractMySQLPlatformTestCase.php b/tests/Platforms/AbstractMySQLPlatformTestCase.php
@@ -4,6 +4,7 @@
 
 namespace Doctrine\DBAL\Tests\Platforms;
 
+use Doctrine\DBAL\Configuration;
 use Doctrine\DBAL\Exception\InvalidColumnDeclaration;
 use Doctrine\DBAL\Platforms\AbstractMySQLPlatform;
 use Doctrine\DBAL\Platforms\MySQL;
@@ -689,6 +690,7 @@ protected function createComparator(): Comparator
     {
         return new MySQL\Comparator(
             $this->platform,
+            new Configuration(),
             self::createStub(CharsetMetadataProvider::class),
             self::createStub(CollationMetadataProvider::class),
             new DefaultTableOptions('utf8mb4', 'utf8mb4_general_ci'),

diff --git a/tests/Platforms/AbstractPlatformTestCase.php b/tests/Platforms/AbstractPlatformTestCase.php
@@ -4,6 +4,7 @@
 
 namespace Doctrine\DBAL\Tests\Platforms;
 
+use Doctrine\DBAL\Configuration;
 use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Exception\InvalidColumnDeclaration;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
@@ -40,7 +41,7 @@ protected function setUp(): void
 
     protected function createComparator(): Comparator
     {
-        return new Comparator($this->platform);
+        return new Comparator($this->platform, new Configuration());
     }
 
     public function testQuoteIdentifier(): void

diff --git a/tests/Platforms/MySQL/ComparatorTest.php b/tests/Platforms/MySQL/ComparatorTest.php
@@ -4,6 +4,7 @@
 
 namespace Doctrine\DBAL\Tests\Platforms\MySQL;
 
+use Doctrine\DBAL\Configuration;
 use Doctrine\DBAL\Platforms\MySQL\CharsetMetadataProvider;
 use Doctrine\DBAL\Platforms\MySQL\CollationMetadataProvider;
 use Doctrine\DBAL\Platforms\MySQL\Comparator;
@@ -13,10 +14,11 @@
 
 class ComparatorTest extends AbstractComparatorTestCase
 {
-    protected function setUp(): void
+    protected function createComparator(?Configuration $configuration = null): Comparator
     {
-        $this->comparator = new Comparator(
+        return new Comparator(
             new MySQLPlatform(),
+            $configuration ?? new Configuration(),
             self::createStub(CharsetMetadataProvider::class),
             self::createStub(CollationMetadataProvider::class),
             new DefaultTableOptions('utf8mb4', 'utf8mb4_general_ci'),

diff --git a/tests/Platforms/MySQL/MariaDBJsonComparatorTest.php b/tests/Platforms/MySQL/MariaDBJsonComparatorTest.php
@@ -4,6 +4,7 @@
 
 namespace Doctrine\DBAL\Tests\Platforms\MySQL;
 
+use Doctrine\DBAL\Configuration;
 use Doctrine\DBAL\Platforms\MariaDBPlatform;
 use Doctrine\DBAL\Platforms\MySQL\CharsetMetadataProvider;
 use Doctrine\DBAL\Platforms\MySQL\CollationMetadataProvider;
@@ -27,6 +28,7 @@ protected function setUp(): void
     {
         $this->comparator = new Comparator(
             new MariaDBPlatform(),
+            new Configuration(),
             new class implements CharsetMetadataProvider {
                 public function getDefaultCharsetCollation(string $charset): ?string
                 {

diff --git a/tests/Platforms/SQLServer/ComparatorTest.php b/tests/Platforms/SQLServer/ComparatorTest.php
@@ -4,14 +4,15 @@
 
 namespace Doctrine\DBAL\Tests\Platforms\SQLServer;
 
+use Doctrine\DBAL\Configuration;
 use Doctrine\DBAL\Platforms\SQLServer\Comparator;
 use Doctrine\DBAL\Platforms\SQLServerPlatform;
 use Doctrine\DBAL\Tests\Schema\AbstractComparatorTestCase;
 
 class ComparatorTest extends AbstractComparatorTestCase
 {
-    protected function setUp(): void
+    protected function createComparator(?Configuration $configuration = null): Comparator
     {
-        $this->comparator = new Comparator(new SQLServerPlatform(), '');
+        return new Comparator(new SQLServerPlatform(), $configuration ?? new Configuration(), '');
     }
 }
diff --git a/tests/Platforms/SQLServerPlatformTest.php b/tests/Platforms/SQLServerPlatformTest.php
@@ -4,6 +4,7 @@
 
 namespace Doctrine\DBAL\Tests\Platforms;
 
+use Doctrine\DBAL\Configuration;
 use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Exception\InvalidColumnDeclaration;
 use Doctrine\DBAL\LockMode;
@@ -32,7 +33,7 @@ public function createPlatform(): AbstractPlatform
 
     protected function createComparator(): Comparator
     {
-        return new SQLServer\Comparator($this->platform, '');
+        return new SQLServer\Comparator($this->platform, new Configuration(), '');
     }
 
     public function getGenerateTableSql(): string

diff --git a/tests/Platforms/SQLite/ComparatorTest.php b/tests/Platforms/SQLite/ComparatorTest.php
@@ -4,15 +4,16 @@
 
 namespace Doctrine\DBAL\Tests\Platforms\SQLite;
 
+use Doctrine\DBAL\Configuration;
 use Doctrine\DBAL\Platforms\SQLite\Comparator;
 use Doctrine\DBAL\Platforms\SQLitePlatform;
 use Doctrine\DBAL\Tests\Schema\AbstractComparatorTestCase;
 
 class ComparatorTest extends AbstractComparatorTestCase
 {
-    protected function setUp(): void
+    protected function createComparator(?Configuration $configuration = null): Comparator
     {
-        $this->comparator = new Comparator(new SQLitePlatform());
+        return new Comparator(new SQLitePlatform(), $configuration ?? new Configuration());
     }
 
     public function testCompareChangedBinaryColumn(): void

diff --git a/tests/Platforms/SQLitePlatformTest.php b/tests/Platforms/SQLitePlatformTest.php
@@ -4,6 +4,7 @@
 
 namespace Doctrine\DBAL\Tests\Platforms;
 
+use Doctrine\DBAL\Configuration;
 use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Platforms\SQLite;
@@ -30,7 +31,7 @@ public function createPlatform(): AbstractPlatform
 
     protected function createComparator(): Comparator
     {
-        return new SQLite\Comparator($this->platform);
+        return new SQLite\Comparator($this->platform, new Configuration());
     }
 
     public function getGenerateTableSql(): string

diff --git a/tests/Schema/AbstractComparatorTestCase.php b/tests/Schema/AbstractComparatorTestCase.php
@@ -4,6 +4,7 @@
 
 namespace Doctrine\DBAL\Tests\Schema;
 
+use Doctrine\DBAL\Configuration;
 use Doctrine\DBAL\Schema\AbstractAsset;
 use Doctrine\DBAL\Schema\Column;
 use Doctrine\DBAL\Schema\ColumnDiff;
@@ -29,6 +30,13 @@ abstract class AbstractComparatorTestCase extends TestCase
 {
     protected Comparator $comparator;
 
+    protected function setUp(): void
+    {
+        $this->comparator = $this->createComparator();
+    }
+
+    abstract protected function createComparator(?Configuration $configuration = null): Comparator;
+
     public function testCompareSame1(): void
     {
         $schema1 = new Schema([
@@ -365,7 +373,7 @@ public function testCompareIndexBasedOnPropertiesNotName(): void
         );
     }
 
-    public function testCompareForeignKeyBasedOnPropertiesNotName(): void
+    public function testDetectForeignKeyNameChange(): void
     {
         $tableA = new Table('foo');
         $tableA->addColumn('id', Types::INTEGER);
@@ -379,6 +387,20 @@ public function testCompareForeignKeyBasedOnPropertiesNotName(): void
             new TableDiff($tableA),
             $this->comparator->compareTables($tableA, $tableB),
         );
+
+        // With enabled name comparison:
+        $configWithEnabledFkNames = new Configuration();
+        $configWithEnabledFkNames->setCompareForeignKeyNames(true);
+        $comparatorEnabledNameComparison = $this->createComparator($configWithEnabledFkNames);
+
+        self::assertEquals(
+            new TableDiff(
+                oldTable: $tableA,
+                addedForeignKeys: [new ForeignKeyConstraint(['id'], 'bar', ['id'], 'bar_constraint')],
+                droppedForeignKeys: [new ForeignKeyConstraint(['id'], 'bar', ['id'], 'foo_constraint')],
+            ),
+            $comparatorEnabledNameComparison->compareTables($tableA, $tableB),
+        );
     }
 
     public function testDetectRenameColumn(): void
-Original file line number
+Diff line change
@@ Expand Up / @@ -842,7 +842,7 @@ private function getDatabase(string $methodName): string @@
         public function createComparator(): Comparator
         {
-            return new Comparator($this->platform);
+            return new Comparator($this->platform, $this->connection->getConfiguration());
         }
         /**
@@ Expand Down @@