Deprecate introspection of incomplete SQLite schema

doctrine · Jan 11, 2025 · f07e369 · f07e369
1 parent 84f1a4a
commit f07e369
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 8 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -8,6 +8,16 @@ awareness about deprecated code.
 
 # Upgrade to 4.3
 
+## Deprecated introspection of SQLite foreign key constraints with omitted referenced column names in an incomplete schema
+
+If the referenced column names are omitted in a foreign key constraint declaration, it implies that the constraint
+references the primary key columns of the referenced table. If the referenced table is not present in the schema, the
+constraint cannot be properly introspected, and the referenced column names are introspected as an empty list.
+This behavior is deprecated.
+
+In order to mitigate this issue, either ensure that the referenced table is present in the schema when introspecting
+foreign constraints, or provide the referenced column names explicitly in the constraint declaration.
+
 ## Deprecated `UniqueConstraint` methods, property and behavior
 
 The following `UniqueConstraint` methods and property have been deprecated:

diff --git a/src/Schema/SQLiteSchemaManager.php b/src/Schema/SQLiteSchemaManager.php
@@ -11,6 +11,7 @@
 use Doctrine\DBAL\Types\StringType;
 use Doctrine\DBAL\Types\TextType;
 use Doctrine\DBAL\Types\Type;
+use Doctrine\Deprecations\Deprecation;
 
 use function array_change_key_case;
 use function array_map;
@@ -338,6 +339,13 @@ protected function _getPortableTableForeignKeysList(array $tableForeignKeys): ar
             $foreignTableIndexes = $this->_getPortableTableIndexesList([], $value['foreignTable']);
 
             if (! isset($foreignTableIndexes['primary'])) {
+                Deprecation::trigger(
+                    'doctrine/dbal',
+                    'https://github.com/doctrine/dbal/pull/6701',
+                    'Introspection of SQLite foreign key constraints with omitted referenced column names'
+                        . ' in an incomplete schema is deprecated.',
+                );
+
                 continue;
             }
 

diff --git a/tests/Functional/Schema/SQLiteSchemaManagerTest.php b/tests/Functional/Schema/SQLiteSchemaManagerTest.php
@@ -15,12 +15,15 @@
 use Doctrine\DBAL\Types\BlobType;
 use Doctrine\DBAL\Types\Type;
 use Doctrine\DBAL\Types\Types;
+use Doctrine\Deprecations\PHPUnit\VerifyDeprecations;
 
 use function array_keys;
 use function array_shift;
 
 class SQLiteSchemaManagerTest extends SchemaManagerFunctionalTestCase
 {
+    use VerifyDeprecations;
+
     protected function supportsPlatform(AbstractPlatform $platform): bool
     {
         return $platform instanceof SQLitePlatform;
@@ -51,9 +54,7 @@ public function testListForeignKeysFromExistingDatabase(): void
 CREATE TABLE user (
     id INTEGER PRIMARY KEY AUTOINCREMENT,
     page INTEGER CONSTRAINT FK_1 REFERENCES page (key) DEFERRABLE INITIALLY DEFERRED,
-    parent INTEGER REFERENCES user(id) ON DELETE CASCADE,
-    log INTEGER,
-    CONSTRAINT FK_3 FOREIGN KEY (log) REFERENCES log ON UPDATE SET NULL NOT DEFERRABLE
+    parent INTEGER REFERENCES user(id) ON DELETE CASCADE
 )
 EOS);
 
@@ -72,16 +73,37 @@ public function testListForeignKeysFromExistingDatabase(): void
                 '',
                 ['onUpdate' => 'NO ACTION', 'onDelete' => 'CASCADE', 'deferrable' => false, 'deferred' => false],
             ),
+        ];
+
+        $this->expectNoDeprecationWithIdentifier('https://github.com/doctrine/dbal/pull/6701');
+
+        self::assertEquals($expected, $this->schemaManager->listTableForeignKeys('user'));
+    }
+
+    public function testListForeignKeysWithImplicitColumnsFromIncompleteSchema(): void
+    {
+        $this->connection->executeStatement('DROP TABLE IF EXISTS t1');
+        $this->connection->executeStatement(<<<'EOS'
+CREATE TABLE t1 (
+    id INTEGER,
+    t2_id INTEGER,
+    FOREIGN KEY (t2_id) REFERENCES t2
+)
+EOS);
+
+        $this->expectDeprecationWithIdentifier('https://github.com/doctrine/dbal/pull/6701');
+
+        $expected = [
             new ForeignKeyConstraint(
-                ['log'],
-                'log',
+                ['t2_id'],
+                't2',
                 [],
-                'FK_3',
-                ['onUpdate' => 'SET NULL', 'onDelete' => 'NO ACTION', 'deferrable' => false, 'deferred' => false],
+                '',
+                ['onUpdate' => 'NO ACTION', 'onDelete' => 'NO ACTION', 'deferrable' => false, 'deferred' => false],
             ),
         ];
 
-        self::assertEquals($expected, $this->schemaManager->listTableForeignKeys('user'));
+        self::assertEquals($expected, $this->schemaManager->listTableForeignKeys('t1'));
     }
 
     public function testColumnCollation(): void