[10.x] Fix: select maximum supported timestamp precision (#44223)

* fix: select maximum supported timestamp precision

Simplified code, upgraded from deprecations

* added test

* removed further deprecations

* added back depracations

Until DBAL reaches v4

* styleci fixes

Author: nandi95

src/Illuminate/Database/DBAL/TimestampType.php

@@ -4,44 +4,60 @@
 
 use Doctrine\DBAL\Exception as DBALException;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Platforms\MariaDb1027Platform;
+use Doctrine\DBAL\Platforms\MariaDBPlatform;
+use Doctrine\DBAL\Platforms\MySQL57Platform;
+use Doctrine\DBAL\Platforms\MySQL80Platform;
+use Doctrine\DBAL\Platforms\MySQLPlatform;
+use Doctrine\DBAL\Platforms\PostgreSQL100Platform;
+use Doctrine\DBAL\Platforms\PostgreSQL94Platform;
+use Doctrine\DBAL\Platforms\PostgreSQLPlatform;
+use Doctrine\DBAL\Platforms\SqlitePlatform;
+use Doctrine\DBAL\Platforms\SQLServer2012Platform;
+use Doctrine\DBAL\Platforms\SQLServerPlatform;
 use Doctrine\DBAL\Types\PhpDateTimeMappingType;
 use Doctrine\DBAL\Types\Type;
 
 class TimestampType extends Type implements PhpDateTimeMappingType
 {
     /**
      * {@inheritdoc}
+     *
+     * @throws DBALException
      */
-    public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform)
+    public function getSQLDeclaration(array $column, AbstractPlatform $platform): string
     {
-        return match ($name = $platform->getName()) {
-            'mysql',
-            'mysql2' => $this->getMySqlPlatformSQLDeclaration($fieldDeclaration),
-            'postgresql',
-            'pgsql',
-            'postgres' => $this->getPostgresPlatformSQLDeclaration($fieldDeclaration),
-            'mssql' => $this->getSqlServerPlatformSQLDeclaration($fieldDeclaration),
-            'sqlite',
-            'sqlite3' => $this->getSQLitePlatformSQLDeclaration($fieldDeclaration),
-            default => throw new DBALException('Invalid platform: '.$name),
+        return match (get_class($platform)) {
+            MySQLPlatform::class,
+            MySQL57Platform::class,
+            MySQL80Platform::class,
+            MariaDBPlatform::class,
+            MariaDb1027Platform::class => $this->getMySqlPlatformSQLDeclaration($column),
+            PostgreSQLPlatform::class,
+            PostgreSQL94Platform::class,
+            PostgreSQL100Platform::class => $this->getPostgresPlatformSQLDeclaration($column),
+            SQLServerPlatform::class,
+            SQLServer2012Platform::class => $this->getSqlServerPlatformSQLDeclaration($column),
+            SqlitePlatform::class => 'DATETIME',
+            default => throw new DBALException('Invalid platform: '.substr(strrchr(get_class($platform), '\\'), 1)),
         };
     }
 
     /**
      * Get the SQL declaration for MySQL.
      *
-     * @param  array  $fieldDeclaration
+     * @param  array  $column
      * @return string
      */
-    protected function getMySqlPlatformSQLDeclaration(array $fieldDeclaration)
+    protected function getMySqlPlatformSQLDeclaration(array $column): string
     {
         $columnType = 'TIMESTAMP';
 
-        if ($fieldDeclaration['precision']) {
-            $columnType = 'TIMESTAMP('.$fieldDeclaration['precision'].')';
+        if ($column['precision']) {
+            $columnType = 'TIMESTAMP('.min((int) $column['precision'], 6).')';
         }
 
-        $notNull = $fieldDeclaration['notnull'] ?? false;
+        $notNull = $column['notnull'] ?? false;
 
         if (! $notNull) {
             return $columnType.' NULL';
@@ -53,36 +69,25 @@ protected function getMySqlPlatformSQLDeclaration(array $fieldDeclaration)
     /**
      * Get the SQL declaration for PostgreSQL.
      *
-     * @param  array  $fieldDeclaration
+     * @param  array  $column
      * @return string
      */
-    protected function getPostgresPlatformSQLDeclaration(array $fieldDeclaration)
+    protected function getPostgresPlatformSQLDeclaration(array $column): string
     {
-        return 'TIMESTAMP('.(int) $fieldDeclaration['precision'].')';
+        return 'TIMESTAMP('.min((int) $column['precision'], 6).')';
     }
 
     /**
      * Get the SQL declaration for SQL Server.
      *
-     * @param  array  $fieldDeclaration
-     * @return string
-     */
-    protected function getSqlServerPlatformSQLDeclaration(array $fieldDeclaration)
-    {
-        return $fieldDeclaration['precision'] ?? false
-                    ? 'DATETIME2('.$fieldDeclaration['precision'].')'
-                    : 'DATETIME';
-    }
-
-    /**
-     * Get the SQL declaration for SQLite.
-     *
-     * @param  array  $fieldDeclaration
+     * @param  array  $column
      * @return string
      */
-    protected function getSQLitePlatformSQLDeclaration(array $fieldDeclaration)
+    protected function getSqlServerPlatformSQLDeclaration(array $column): string
     {
-        return 'DATETIME';
+        return $column['precision'] ?? false
+            ? 'DATETIME2('.min((int) $column['precision'], 7).')'
+            : 'DATETIME';
     }
 
     /**

tests/Database/DatabaseSchemaBlueprintIntegrationTest.php

@@ -404,6 +404,26 @@ public function testItEnsuresRenamingAndDroppingMultipleColumnsIsAvailable()
         });
     }
 
+    public function testItDoesNotSetPrecisionHigherThanSupportedWhenRenamingTimestamps()
+    {
+        $this->db->connection()->getSchemaBuilder()->create('users', function (Blueprint $table) {
+            $table->timestamp('created_at');
+        });
+
+        try {
+            // this would only fail in mysql, postgres and sql server
+            $this->db->connection()->getSchemaBuilder()->table('users', function (Blueprint $table) {
+                $table->renameColumn('created_at', 'new_created_at');
+            });
+            $this->addToAssertionCount(1); // it did not throw
+        } catch (\Exception $e) {
+            // Expecting something similar to:
+            // Illuminate\Database\QueryException
+            //   SQLSTATE[42000]: Syntax error or access violation: 1426 Too big precision 10 specified for 'my_timestamp'. Maximum is 6....
+            $this->fail('test_it_does_not_set_precision_higher_than_supported_when_renaming_timestamps has failed. Error: '.$e->getMessage());
+        }
+    }
+
     public function testItEnsuresDroppingForeignKeyIsAvailable()
     {
         $this->expectException(BadMethodCallException::class);