Adding context information when requesting invalid column type

Author: mamazu

src/Schema/AbstractSchemaManager.php

@@ -11,12 +11,14 @@
 use Doctrine\DBAL\Platforms\Exception\NotSupported;
 use Doctrine\DBAL\Result;
 use Doctrine\DBAL\Schema\Exception\TableDoesNotExist;
+use Doctrine\DBAL\Types\Exception\UnknownColumnType;
 
 use function array_filter;
 use function array_intersect;
 use function array_map;
 use function array_values;
 use function count;
+use function sprintf;
 use function strtolower;
 
 /**
@@ -667,7 +669,11 @@ protected function _getPortableTableColumnList(string $table, string $database,
     {
         $list = [];
         foreach ($tableColumns as $tableColumn) {
-            $column = $this->_getPortableTableColumnDefinition($tableColumn);
+            try {
+                $column = $this->_getPortableTableColumnDefinition($tableColumn);
+            } catch (UnknownColumnType $unknownTypeException) {
+                throw UnknownColumnType::withContext($unknownTypeException->getType(), sprintf('table %s', $table));
+            }
 
             $name        = strtolower($column->getQuotedName($this->platform));
             $list[$name] = $column;

src/Types/Exception/UnknownColumnType.php

@@ -5,24 +5,45 @@
 namespace Doctrine\DBAL\Types\Exception;
 
 use Exception;
+use Throwable;
 
 use function sprintf;
 
 final class UnknownColumnType extends Exception implements TypesException
 {
-    public static function new(string $name): self
-    {
-        return new self(
-            sprintf(
-                'Unknown column type "%s" requested. Any Doctrine type that you use has '
+    private function __construct(
+        private string $requestedType,
+        ?string $context,
+        int $code = 0,
+        ?Throwable $throwable = null,
+    ) {
+        $message = sprintf(
+            'Unknown column type "%s" requested%s. Any Doctrine type that you use has '
                     . 'to be registered with \Doctrine\DBAL\Types\Type::addType(). You can get a list of all the '
                     . 'known types with \Doctrine\DBAL\Types\Type::getTypesMap(). If this error occurs during database '
                     . 'introspection then you might have forgotten to register all database types for a Doctrine Type. '
                     . 'Use AbstractPlatform#registerDoctrineTypeMapping() or have your custom types implement '
                     . 'Type#getMappedDatabaseTypes(). If the type name is empty you might '
                     . 'have a problem with the cache or forgot some mapping information.',
-                $name,
-            ),
+            $this->requestedType,
+            $context !== null ? ' for ' . $context : '',
         );
+
+        parent::__construct($message, $code, $throwable);
+    }
+
+    public function getType(): string
+    {
+        return $this->requestedType;
+    }
+
+    public static function new(string $name): self
+    {
+        return new self($name, null);
+    }
+
+    public static function withContext(string $name, string $context): self
+    {
+        return new self($name, $context);
     }
 }

tests/Types/Exception/UnknownColumnTypeTest.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\DBAL\Tests\Types\Exception;
+
+use Doctrine\DBAL\Types\Exception\UnknownColumnType;
+use PHPUnit\Framework\TestCase;
+
+class UnknownColumnTypeTest extends TestCase
+{
+    public function testNew(): void
+    {
+        $exception = UnknownColumnType::new('custom_type');
+
+        self::assertSame('custom_type', $exception->getType());
+        self::assertStringContainsString(
+            'Unknown column type "custom_type" requested.',
+            $exception->getMessage(),
+        );
+    }
+
+    public function testWithContext(): void
+    {
+        $exception = UnknownColumnType::withContext('custom_type', 'table "some_table"');
+
+        self::assertSame('custom_type', $exception->getType());
+        self::assertStringContainsString(
+            'Unknown column type "custom_type" requested for table "some_table".',
+            $exception->getMessage(),
+        );
+    }
+}