[BUGFIX] Ensure table renaming works due doctrine/dbal behaviour change

doctrine/dbal is working on deprecating and changing code and
behaviour in 3.x as preparation for removal in 4.x. Starting
with doctrine/dbal v3.5.0, the table rename detection in the
TYPO3 database compare no longer works as expected. TableDiff
got an `isEmpty()` check, which is used in SchemaDiff and thus
filtering out "renamed" tables without further changes, leading
to a change of behavior. doctrine/dbal favors renaming table
no longer by setting a new name in the TableDiff, thus not having
the changed name in the `isEmpty()` check.

See: doctrine/dbal#5770

doctrine/dbal deprecations and changes require systematical
adoption to cover all the changes. This takes time and proper
testing, which is out of the scope for this change.

This change overrides the `TableDiff->isEmpty()` method in the
corresponding core fascade class, adding checks for $newName
and $tableOptions checks as a intermediate workaround. Thus
keep compatibillity between doctrine/dbal <3.5 and 3.5 for now.

Resolves: #98707
Releases: main
Change-Id: If305e4d809be29585e0b6a72c3215f5cff68762d
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/76232
Tested-by: core-ci <[email protected]>
Tested-by: Christian Kuhn <[email protected]>
Tested-by: Benni Mack <[email protected]>
Tested-by: Stefan Bürk <[email protected]>
Reviewed-by: Christian Kuhn <[email protected]>
Reviewed-by: Benni Mack <[email protected]>
Reviewed-by: Stefan Bürk <[email protected]>

Author: sbuerk

typo3/sysext/core/Classes/Database/Schema/ConnectionMigrator.php

@@ -676,7 +676,6 @@ protected function getUnusedTableUpdateSuggestions(SchemaDiff $schemaDiff): arra
             );
 
             $statements = $changedFieldDiff->toSql($this->connection->getDatabasePlatform());
-
             foreach ($statements as $statement) {
                 $updateSuggestions['change_table'][md5($statement)] = $statement;
             }

typo3/sysext/core/Classes/Database/Schema/TableDiff.php

@@ -78,4 +78,27 @@ public function getTableOption(string $optionName): string
 
         return '';
     }
+
+    /**
+     * @return bool
+     */
+    public function isEmpty(): bool
+    {
+        return count($this->addedColumns) === 0
+            && count($this->changedColumns) === 0
+            && count($this->removedColumns) === 0
+            && count($this->renamedColumns) === 0
+            && count($this->addedIndexes) === 0
+            && count($this->changedIndexes) === 0
+            && count($this->removedIndexes) === 0
+            && count($this->renamedIndexes) === 0
+            && count($this->addedForeignKeys) === 0
+            && count($this->changedForeignKeys) === 0
+            && count($this->removedForeignKeys) === 0
+            // @todo Recheck this after proper table rename strategy has been evolved. Related to doctrine/dbal 3.5 changes.
+            && $this->newName === false
+            // @todo doctrine/dbal 3.5 deprecated schema events, thus a new way to provide table option has to
+            //       be found and implemented. Recheck this afterwards.
+            && $this->tableOptions === [];
+    }
 }