Evaluate the impact of ignoring DC2Type comments

This PR drops all calls to SchemManager::extractDoctrineTypeFromComment found in src I have commented out the tests that fail in order to spot tests that fail when running more complete test suites that are available in the CI.
doctrine · Dec 11, 2021 · a89b28f · a89b28f
1 parent 2b3504f
commit a89b28f
Show file tree

Hide file tree

Showing 11 changed files with 17 additions and 52 deletions.
diff --git a/src/Platforms/AbstractPlatform.php b/src/Platforms/AbstractPlatform.php
@@ -3978,7 +3978,7 @@ private function columnToArray(Column $column): array
         $columnData = array_merge($column->toArray(), [
             'name' => $name,
             'version' => $column->hasPlatformOption('version') ? $column->getPlatformOption('version') : false,
-            'comment' => $this->getColumnComment($column),
+            'comment' => $column->getComment(),
         ]);
 
         if ($columnData['type'] instanceof Types\StringType && $columnData['length'] === null) {

diff --git a/src/Schema/DB2SchemaManager.php b/src/Schema/DB2SchemaManager.php
@@ -65,8 +65,8 @@ protected function _getPortableTableColumnDefinition($tableColumn)
         $type = $this->_platform->getDoctrineTypeMapping($tableColumn['typename']);
 
         if (isset($tableColumn['comment'])) {
-            $type                   = $this->extractDoctrineTypeFromComment($tableColumn['comment'], $type);
-            $tableColumn['comment'] = $this->removeDoctrineTypeFromComment($tableColumn['comment'], $type);
+            $typeFromComment        = $this->extractDoctrineTypeFromComment($tableColumn['comment'], $type);
+            $tableColumn['comment'] = $this->removeDoctrineTypeFromComment($tableColumn['comment'], $typeFromComment);
         }
 
         switch (strtolower($tableColumn['typename'])) {

diff --git a/src/Schema/MySQLSchemaManager.php b/src/Schema/MySQLSchemaManager.php
@@ -138,8 +138,8 @@ protected function _getPortableTableColumnDefinition($tableColumn)
 
         // In cases where not connected to a database DESCRIBE $table does not return 'Comment'
         if (isset($tableColumn['comment'])) {
-            $type                   = $this->extractDoctrineTypeFromComment($tableColumn['comment'], $type);
-            $tableColumn['comment'] = $this->removeDoctrineTypeFromComment($tableColumn['comment'], $type);
+            $typeFromComment        = $this->extractDoctrineTypeFromComment($tableColumn['comment'], $type);
+            $tableColumn['comment'] = $this->removeDoctrineTypeFromComment($tableColumn['comment'], $typeFromComment);
         }
 
         switch ($dbType) {

diff --git a/src/Schema/OracleSchemaManager.php b/src/Schema/OracleSchemaManager.php
@@ -134,8 +134,8 @@ protected function _getPortableTableColumnDefinition($tableColumn)
         }
 
         $type                    = $this->_platform->getDoctrineTypeMapping($dbType);
-        $type                    = $this->extractDoctrineTypeFromComment($tableColumn['comments'], $type);
-        $tableColumn['comments'] = $this->removeDoctrineTypeFromComment($tableColumn['comments'], $type);
+        $typeFromComment         = $this->extractDoctrineTypeFromComment($tableColumn['comments'], $type);
+        $tableColumn['comments'] = $this->removeDoctrineTypeFromComment($tableColumn['comments'], $typeFromComment);
 
         switch ($dbType) {
             case 'number':

diff --git a/src/Schema/PostgreSQLSchemaManager.php b/src/Schema/PostgreSQLSchemaManager.php
@@ -413,8 +413,8 @@ protected function _getPortableTableColumnDefinition($tableColumn)
         }
 
         $type                   = $this->_platform->getDoctrineTypeMapping($dbType);
-        $type                   = $this->extractDoctrineTypeFromComment($tableColumn['comment'], $type);
-        $tableColumn['comment'] = $this->removeDoctrineTypeFromComment($tableColumn['comment'], $type);
+        $typeFromComment        = $this->extractDoctrineTypeFromComment($tableColumn['comment'], $type);
+        $tableColumn['comment'] = $this->removeDoctrineTypeFromComment($tableColumn['comment'], $typeFromComment);
 
         switch ($dbType) {
             case 'smallint':

diff --git a/src/Schema/SQLServerSchemaManager.php b/src/Schema/SQLServerSchemaManager.php
@@ -98,8 +98,8 @@ protected function _getPortableTableColumnDefinition($tableColumn)
         }
 
         $type                   = $this->_platform->getDoctrineTypeMapping($dbType);
-        $type                   = $this->extractDoctrineTypeFromComment($tableColumn['comment'], $type);
-        $tableColumn['comment'] = $this->removeDoctrineTypeFromComment($tableColumn['comment'], $type);
+        $typeFromComment        = $this->extractDoctrineTypeFromComment($tableColumn['comment'], $type);
+        $tableColumn['comment'] = $this->removeDoctrineTypeFromComment($tableColumn['comment'], $typeFromComment);
 
         $options = [
             'unsigned'      => false,

diff --git a/src/Schema/SqliteSchemaManager.php b/src/Schema/SqliteSchemaManager.php
@@ -311,12 +311,10 @@ protected function _getPortableTableColumnList($table, $database, $tableColumns)
                 continue;
             }
 
-            $type = $this->extractDoctrineTypeFromComment($comment, '');
+            $typeFromComment = $this->extractDoctrineTypeFromComment($comment, '');
 
-            if ($type !== '') {
-                $column->setType(Type::getType($type));
-
-                $comment = $this->removeDoctrineTypeFromComment($comment, $type);
+            if ($typeFromComment !== '') {
+                $comment = $this->removeDoctrineTypeFromComment($comment, $typeFromComment);
             }
 
             $column->setComment($comment);

diff --git a/tests/Functional/Schema/MySQLSchemaManagerTest.php b/tests/Functional/Schema/MySQLSchemaManagerTest.php
@@ -406,17 +406,6 @@ public function testListFloatTypeColumns(): void
         self::assertTrue($columns['col_unsigned']->getUnsigned());
     }
 
-    public function testJsonColumnType(): void
-    {
-        $table = new Table('test_mysql_json');
-        $table->addColumn('col_json', 'json');
-        $this->dropAndCreateTable($table);
-
-        $columns = $this->schemaManager->listTableColumns('test_mysql_json');
-
-        self::assertSame(Types::JSON, $columns['col_json']->getType()->getName());
-    }
-
     public function testColumnDefaultCurrentTimestamp(): void
     {
         $platform = $this->schemaManager->getDatabasePlatform();

diff --git a/tests/Functional/Schema/SchemaManagerFunctionalTestCase.php b/tests/Functional/Schema/SchemaManagerFunctionalTestCase.php
@@ -24,14 +24,11 @@
 use Doctrine\DBAL\Schema\UniqueConstraint;
 use Doctrine\DBAL\Schema\View;
 use Doctrine\DBAL\Tests\FunctionalTestCase;
-use Doctrine\DBAL\Types\ArrayType;
 use Doctrine\DBAL\Types\BinaryType;
 use Doctrine\DBAL\Types\BlobType;
-use Doctrine\DBAL\Types\DateIntervalType;
 use Doctrine\DBAL\Types\DateTimeType;
 use Doctrine\DBAL\Types\DecimalType;
 use Doctrine\DBAL\Types\IntegerType;
-use Doctrine\DBAL\Types\ObjectType;
 use Doctrine\DBAL\Types\StringType;
 use Doctrine\DBAL\Types\TextType;
 use Doctrine\DBAL\Types\Type;
@@ -927,9 +924,9 @@ public function testAutomaticallyAppendCommentOnMarkedColumns(): void
         self::assertEquals(3, count($columns));
         self::assertEquals('This is a comment', $columns['id']->getComment());
         self::assertEquals('This is a comment', $columns['obj']->getComment());
-        self::assertInstanceOf(ObjectType::class, $columns['obj']->getType());
+        /* self::assertInstanceOf(ObjectType::class, $columns['obj']->getType()); */
         self::assertEquals('This is a comment', $columns['arr']->getComment());
-        self::assertInstanceOf(ArrayType::class, $columns['arr']->getType());
+        /* self::assertInstanceOf(ArrayType::class, $columns['arr']->getType()); */
     }
 
     public function testCommentHintOnDateIntervalTypeColumn(): void
@@ -955,7 +952,7 @@ public function testCommentHintOnDateIntervalTypeColumn(): void
         self::assertEquals(2, count($columns));
         self::assertEquals('This is a comment', $columns['id']->getComment());
         self::assertEquals('This is a comment', $columns['date_interval']->getComment());
-        self::assertInstanceOf(DateIntervalType::class, $columns['date_interval']->getType());
+        /* self::assertInstanceOf(DateIntervalType::class, $columns['date_interval']->getType()); */
     }
 
     public function testChangeColumnsTypeWithDefaultValue(): void

diff --git a/tests/Platforms/AbstractPlatformTestCase.php b/tests/Platforms/AbstractPlatformTestCase.php
@@ -508,16 +508,6 @@ public function testAlterTableColumnComments(): void
         self::assertEquals($this->getAlterTableColumnCommentsSQL(), $this->platform->getAlterTableSQL($tableDiff));
     }
 
-    public function testCreateTableColumnTypeComments(): void
-    {
-        $table = new Table('test');
-        $table->addColumn('id', 'integer');
-        $table->addColumn('data', 'array');
-        $table->setPrimaryKey(['id']);
-
-        self::assertEquals($this->getCreateTableColumnTypeCommentsSQL(), $this->platform->getCreateTableSQL($table));
-    }
-
     /**
      * @return string[]
      */

diff --git a/tests/Schema/ComparatorTest.php b/tests/Schema/ComparatorTest.php
@@ -14,7 +14,6 @@
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\Schema\TableDiff;
 use Doctrine\DBAL\Types\Type;
-use Doctrine\DBAL\Types\Types;
 use PHPUnit\Framework\TestCase;
 
 use function array_keys;
@@ -1228,14 +1227,6 @@ public static function getCompareColumnComments(): iterable
         ];
     }
 
-    public function testCompareCommentedTypes(): void
-    {
-        $column1 = new Column('foo', Type::getType(Types::ARRAY));
-        $column2 = new Column('foo', Type::getType(Types::OBJECT));
-
-        self::assertFalse($this->comparator->columnsEqual($column1, $column2));
-    }
-
     public function testForeignKeyRemovalWithRenamedLocalColumn(): void
     {
         $fromSchema = new Schema([