Merge pull request #786 from QoboLtd/nativeuuid

Added nativeuuid type for databases with a native uuid type

.github/workflows/ci.yml

@@ -20,7 +20,7 @@ jobs:
       fail-fast: false
       matrix:
         php-version: ['8.1', '8.2', '8.3', '8.4']
-        db-type: [mysql, pgsql, sqlite]
+        db-type: [mariadb, mysql, pgsql, sqlite]
         prefer-lowest: ['']
         cake_version: ['']
         include:
@@ -52,6 +52,19 @@ jobs:
         with:
           persist-credentials: false
 
+      - name: Setup MariaDB
+        uses: getong/[email protected]
+        if: matrix.db-type == 'mariadb'
+        with:
+          mariadb version: '10.11.10'
+          mysql database: 'cakephp_test'
+          mysql root password: 'root'
+      - name: Setup MariaDB (part 2)
+        if: matrix.db-type == 'mariadb'
+        run: |
+          mysql -h 127.0.0.1 -u root -proot -e 'CREATE DATABASE cakephp_comparisons;'
+          mysql -h 127.0.0.1 -u root -proot -e 'CREATE DATABASE cakephp_snapshot;'
+
       - name: Setup MySQL
         if: matrix.db-type == 'mysql'
         run: |
@@ -108,6 +121,12 @@ jobs:
           if [[ ${{ matrix.db-type }} == 'sqlite' ]]; then
             export DB='sqlite'
           fi
+          if [[ ${{ matrix.db-type }} == 'mariadb' ]]; then
+            export DB='mysql'
+            export DB_URL='mysql://root:[email protected]/cakephp_test'
+            export DB_URL_COMPARE='mysql://root:[email protected]/cakephp_comparisons'
+            export DB_URL_SNAPSHOT='mysql://root:[email protected]/cakephp_snapshot'
+          fi
           if [[ ${{ matrix.db-type }} == 'mysql' ]]; then
             export DB='mysql'
             export DB_URL='mysql://root:[email protected]/cakephp_test'

src/Db/Adapter/AdapterInterface.php

@@ -51,6 +51,7 @@ interface AdapterInterface
     public const PHINX_TYPE_JSON = 'json';
     public const PHINX_TYPE_JSONB = 'jsonb';
     public const PHINX_TYPE_UUID = 'uuid';
+    public const PHINX_TYPE_NATIVEUUID = 'nativeuuid';
     public const PHINX_TYPE_FILESTREAM = 'filestream';
 
     // Geospatial database types

src/Db/Adapter/MysqlAdapter.php

@@ -424,8 +424,9 @@ public function getColumns(string $tableName): array
 
             if ($columnInfo['Extra'] === 'auto_increment') {
                 $column->setIdentity(true);
-            }
-            if ($columnInfo['Extra'] === 'on update CURRENT_TIMESTAMP') {
+            } elseif ($columnInfo['Extra'] === 'on update CURRENT_TIMESTAMP') {
+                $column->setUpdate('CURRENT_TIMESTAMP');
+            } elseif ($columnInfo['Extra'] === 'on update current_timestamp()') {
                 $column->setUpdate('CURRENT_TIMESTAMP');
             }
 
@@ -1071,6 +1072,14 @@ public function getSqlType(Literal|string $type, ?int $limit = null): array
                 return ['name' => 'tinyint', 'limit' => 1];
             case static::PHINX_TYPE_UUID:
                 return ['name' => 'char', 'limit' => 36];
+            case static::PHINX_TYPE_NATIVEUUID:
+                if (!$this->hasNativeUuid()) {
+                    throw new UnsupportedColumnTypeException(
+                        'Column type "' . $type . '" is not supported by this version of MySQL.'
+                    );
+                }
+
+                return ['name' => 'uuid'];
             case static::PHINX_TYPE_YEAR:
                 if (!$limit || in_array($limit, [2, 4])) {
                     $limit = 4;
@@ -1189,6 +1198,10 @@ public function getPhinxType(string $sqlTypeDef): array
                     $type = static::PHINX_TYPE_BINARYUUID;
                 }
                 break;
+            case 'uuid':
+                $type = static::PHINX_TYPE_NATIVEUUID;
+                $limit = null;
+                break;
         }
 
         try {
@@ -1496,6 +1509,26 @@ public function describeTable(string $tableName): array
      */
     public function getColumnTypes(): array
     {
-        return array_merge(parent::getColumnTypes(), static::$specificColumnTypes);
+        $types = array_merge(parent::getColumnTypes(), static::$specificColumnTypes);
+
+        if ($this->hasNativeUuid()) {
+            $types[] = self::PHINX_TYPE_NATIVEUUID;
+        }
+
+        return $types;
+    }
+
+    /**
+     * Whether the server has a native uuid type.
+     * (MariaDB 10.7.0+)
+     *
+     * @return bool
+     */
+    protected function hasNativeUuid(): bool
+    {
+        $connection = $this->getConnection();
+        $version = $connection->getDriver()->version();
+
+        return version_compare($version, '10.7', '>=');
     }
 }

src/Db/Adapter/PostgresAdapter.php

@@ -39,6 +39,7 @@ class PostgresAdapter extends PdoAdapter
         self::PHINX_TYPE_MACADDR,
         self::PHINX_TYPE_INTERVAL,
         self::PHINX_TYPE_BINARYUUID,
+        self::PHINX_TYPE_NATIVEUUID,
     ];
 
     private const GIN_INDEX_TYPE = 'gin';
@@ -547,7 +548,7 @@ protected function getChangeColumnInstructions(
                 $quotedColumnName
             );
         }
-        if ($newColumn->getType() === 'uuid') {
+        if (in_array($newColumn->getType(), ['uuid', 'nativeuuid', 'binaryuuid'])) {
             $sql .= sprintf(
                 ' USING (%s::uuid)',
                 $quotedColumnName
@@ -1028,6 +1029,7 @@ public function getSqlType(Literal|string $type, ?int $limit = null): array
             case static::PHINX_TYPE_DATETIME:
                 return ['name' => 'timestamp'];
             case static::PHINX_TYPE_BINARYUUID:
+            case static::PHINX_TYPE_NATIVEUUID:
                 return ['name' => 'uuid'];
             case static::PHINX_TYPE_BLOB:
             case static::PHINX_TYPE_BINARY:

src/Db/Adapter/SqlserverAdapter.php

@@ -29,6 +29,7 @@ class SqlserverAdapter extends PdoAdapter
     protected static array $specificColumnTypes = [
         self::PHINX_TYPE_FILESTREAM,
         self::PHINX_TYPE_BINARYUUID,
+        self::PHINX_TYPE_NATIVEUUID,
     ];
 
     /**
@@ -997,6 +998,7 @@ public function getSqlType(Literal|string $type, ?int $limit = null): array
                 return ['name' => 'bit'];
             case static::PHINX_TYPE_BINARYUUID:
             case static::PHINX_TYPE_UUID:
+            case static::PHINX_TYPE_NATIVEUUID:
                 return ['name' => 'uniqueidentifier'];
             case static::PHINX_TYPE_FILESTREAM:
                 return ['name' => 'varbinary', 'limit' => 'max'];

src/Db/Table/Column.php

@@ -36,6 +36,7 @@ class Column
     public const TIMESTAMP = AdapterInterface::PHINX_TYPE_TIMESTAMP;
     public const UUID = AdapterInterface::PHINX_TYPE_UUID;
     public const BINARYUUID = AdapterInterface::PHINX_TYPE_BINARYUUID;
+    public const NATIVEUUID = AdapterInterface::PHINX_TYPE_NATIVEUUID;
     /** MySQL-only column type */
     public const MEDIUMINTEGER = AdapterInterface::PHINX_TYPE_MEDIUM_INTEGER;
     /** MySQL-only column type */

tests/TestCase/Db/Adapter/MysqlAdapterTest.php

@@ -12,6 +12,7 @@
 use InvalidArgumentException;
 use Migrations\Db\Adapter\AdapterInterface;
 use Migrations\Db\Adapter\MysqlAdapter;
+use Migrations\Db\Adapter\UnsupportedColumnTypeException;
 use Migrations\Db\Literal;
 use Migrations\Db\Table;
 use Migrations\Db\Table\Column;
@@ -75,11 +76,26 @@ protected function tearDown(): void
         unset($this->adapter, $this->out, $this->io);
     }
 
+    private function getDefaultCollation(): string
+    {
+        return $this->usingMariaDbWithUuid() ?
+            'utf8mb4_general_ci' :
+            'utf8mb4_0900_ai_ci';
+    }
+
     private function usingMysql8(): bool
     {
         $version = $this->adapter->getConnection()->getDriver()->version();
 
-        return version_compare($version, '8.0.0', '>=');
+        return version_compare($version, '8.0.0', '>=')
+            && version_compare($version, '10.0.0', '<');
+    }
+
+    private function usingMariaDbWithUuid(): bool
+    {
+        $version = $this->adapter->getConnection()->getDriver()->version();
+
+        return version_compare($version, '10.7.0', '>=');
     }
 
     public function testConnection()
@@ -329,6 +345,27 @@ public function testCreateTableWithPrimaryKeyAsBinaryUuid()
         $this->assertTrue($this->adapter->hasColumn('ztable', 'user_id'));
     }
 
+    /**
+     * @return void
+     */
+    public function testCreateTableWithPrimaryKeyAsNativeUuid()
+    {
+        if (!$this->usingMariaDbWithUuid()) {
+            $this->markTestSkipped('Database does not have a native uuid type');
+        }
+
+        $options = [
+            'id' => false,
+            'primary_key' => 'id',
+        ];
+        $table = new Table('ztable', $options, $this->adapter);
+        $table->addColumn('id', 'nativeuuid', ['null' => false])->save();
+        $table->addColumn('user_id', 'integer')->save();
+        $this->assertTrue($this->adapter->hasColumn('ztable', 'id'));
+        $this->assertTrue($this->adapter->hasIndex('ztable', 'id'));
+        $this->assertTrue($this->adapter->hasColumn('ztable', 'user_id'));
+    }
+
     public function testCreateTableWithMultipleIndexes()
     {
         $table = new Table('table1', [], $this->adapter);
@@ -397,7 +434,7 @@ public function testCreateTableAndInheritDefaultCollation()
               ->save();
         $this->assertTrue($adapter->hasTable('table_with_default_collation'));
         $row = $adapter->fetchRow(sprintf("SHOW TABLE STATUS WHERE Name = '%s'", 'table_with_default_collation'));
-        $this->assertEquals('utf8mb4_0900_ai_ci', $row['Collation']);
+        $this->assertEquals($row['Collation'], $this->getDefaultCollation());
     }
 
     public function testCreateTableWithLatin1Collate()
@@ -502,11 +539,11 @@ public function testAddTimestampsFeatureFlag()
         $this->assertEquals('datetime', $columns[1]->getType());
         $this->assertEquals('', $columns[1]->getUpdate());
         $this->assertFalse($columns[1]->isNull());
-        $this->assertEquals('CURRENT_TIMESTAMP', $columns[1]->getDefault());
+        $this->assertContains($columns[1]->getDefault(), ['CURRENT_TIMESTAMP', 'current_timestamp()']);
 
         $this->assertEquals('updated', $columns[2]->getName());
         $this->assertEquals('datetime', $columns[2]->getType());
-        $this->assertEquals('CURRENT_TIMESTAMP', $columns[2]->getUpdate());
+        $this->assertContains($columns[2]->getUpdate(), ['CURRENT_TIMESTAMP', 'current_timestamp()']);
         $this->assertTrue($columns[2]->isNull());
         $this->assertNull($columns[2]->getDefault());
     }
@@ -2152,8 +2189,10 @@ public function testDumpCreateTable()
             ->addColumn('column3', 'string', ['default' => 'test', 'null' => false])
             ->save();
 
-        $expectedOutput = <<<'OUTPUT'
-CREATE TABLE `table1` (`id` INT(11) unsigned NOT NULL AUTO_INCREMENT, `column1` VARCHAR(255) NOT NULL, `column2` INT(11) NULL, `column3` VARCHAR(255) NOT NULL DEFAULT 'test', PRIMARY KEY (`id`)) ENGINE = InnoDB CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci;
+        $collation = $this->getDefaultCollation();
+
+        $expectedOutput = <<<OUTPUT
+CREATE TABLE `table1` (`id` INT(11) unsigned NOT NULL AUTO_INCREMENT, `column1` VARCHAR(255) NOT NULL, `column2` INT(11) NULL, `column3` VARCHAR(255) NOT NULL DEFAULT 'test', PRIMARY KEY (`id`)) ENGINE = InnoDB CHARACTER SET utf8mb4 COLLATE {$collation};
 OUTPUT;
         $actualOutput = join("\n", $this->out->messages());
         $this->assertStringContainsString($expectedOutput, $actualOutput, 'Passing the --dry-run option does not dump create table query to the output');
@@ -2257,8 +2296,10 @@ public function testDumpCreateTableAndThenInsert()
             'column2' => 1,
         ])->save();
 
-        $expectedOutput = <<<'OUTPUT'
-CREATE TABLE `table1` (`column1` VARCHAR(255) NOT NULL, `column2` INT(11) NULL, PRIMARY KEY (`column1`)) ENGINE = InnoDB CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci;
+        $collation = $this->getDefaultCollation();
+
+        $expectedOutput = <<<OUTPUT
+CREATE TABLE `table1` (`column1` VARCHAR(255) NOT NULL, `column2` INT(11) NULL, PRIMARY KEY (`column1`)) ENGINE = InnoDB CHARACTER SET utf8mb4 COLLATE {$collation};
 INSERT INTO `table1` (`column1`, `column2`) VALUES ('id1', 1);
 OUTPUT;
         $actualOutput = join("\n", $this->out->messages());
@@ -2451,10 +2492,21 @@ public static function defaultsCastAsExpressions()
     #[DataProvider('defaultsCastAsExpressions')]
     public function testDefaultsCastAsExpressionsForCertainTypes(string $type, string $default): void
     {
+        if (
+            $this->usingMariaDbWithUuid() && in_array($type, [
+            MysqlAdapter::PHINX_TYPE_GEOMETRY,
+            MysqlAdapter::PHINX_TYPE_POINT,
+            MysqlAdapter::PHINX_TYPE_LINESTRING,
+            MysqlAdapter::PHINX_TYPE_POLYGON,
+            ])
+        ) {
+            $this->markTestSkipped('GIS is broken with MariaDB');
+        }
+
         $this->adapter->connect();
 
         $table = new Table('table1', ['id' => false], $this->adapter);
-        if (!$this->usingMysql8()) {
+        if (!$this->usingMysql8() && !$this->usingMariaDbWithUuid()) {
             $this->expectException(PDOException::class);
         }
         $table
@@ -2464,7 +2516,12 @@ public function testDefaultsCastAsExpressionsForCertainTypes(string $type, strin
         $columns = $this->adapter->getColumns('table1');
         $this->assertCount(1, $columns);
         $this->assertSame('col_1', $columns[0]->getName());
-        $this->assertSame($default, $columns[0]->getDefault());
+
+        if ($this->usingMariaDbWithUuid()) {
+            $this->assertSame("'{$default}'", $columns[0]->getDefault());
+        } else {
+            $this->assertSame($default, $columns[0]->getDefault());
+        }
     }
 
     public function testCreateTableWithPrecisionCurrentTimestamp()
@@ -2522,4 +2579,12 @@ public function testGetPhinxTypeFromSQLDefinition(string $sqlDefinition, array $
         $this->assertSame($expectedResponse['name'], $result['name'], "Type mismatch - got '{$result['name']}' when expecting '{$expectedResponse['name']}'");
         $this->assertSame($expectedResponse['limit'], $result['limit'], "Field upper boundary mismatch - got '{$result['limit']}' when expecting '{$expectedResponse['limit']}'");
     }
+
+    public function testGetSqlType()
+    {
+        if (!$this->usingMariaDbWithUuid()) {
+            $this->expectException(UnsupportedColumnTypeException::class);
+        }
+        $this->assertSame(['name' => 'uuid'], $this->adapter->getSqlType('nativeuuid'));
+    }
 }

tests/TestCase/Db/Adapter/PostgresAdapterTest.php

@@ -343,6 +343,23 @@ public function testCreateTableWithPrimaryKeyAsBinaryUuid()
         $this->assertTrue($this->adapter->hasColumn('ztable', 'user_id'));
     }
 
+    /**
+     * @return void
+     */
+    public function testCreateTableWithPrimaryKeyAsNativeUuid()
+    {
+        $options = [
+            'id' => false,
+            'primary_key' => 'id',
+        ];
+        $table = new Table('ztable', $options, $this->adapter);
+        $table->addColumn('id', 'nativeuuid')->save();
+        $table->addColumn('user_id', 'integer')->save();
+        $this->assertTrue($this->adapter->hasColumn('ztable', 'id'));
+        $this->assertTrue($this->adapter->hasIndex('ztable', 'id'));
+        $this->assertTrue($this->adapter->hasColumn('ztable', 'user_id'));
+    }
+
     public function testCreateTableWithMultipleIndexes()
     {
         $table = new Table('table1', [], $this->adapter);
@@ -1066,6 +1083,24 @@ public function testChangeColumnCharToUuid()
         }
     }
 
+    public function testChangeColumnCharToNativeUuid()
+    {
+        $table = new Table('t', [], $this->adapter);
+        $table->addColumn('column1', 'char', ['default' => null, 'limit' => 36])
+              ->save();
+        $table->changeColumn('column1', 'nativeuuid', ['default' => null, 'null' => true])
+        ->save();
+        $columns = $this->adapter->getColumns('t');
+        foreach ($columns as $column) {
+            if ($column->getName() === 'column1') {
+                $this->assertTrue($column->isNull());
+                $this->assertNull($column->getDefault());
+                $columnType = $table->getColumn('column1')->getType();
+                $this->assertSame($columnType, 'uuid');
+            }
+        }
+    }
+
     public function testChangeColumnWithDefault()
     {
         $table = new Table('t', [], $this->adapter);

tests/TestCase/MigrationsTest.php

@@ -15,6 +15,7 @@
 
 use Cake\Core\Configure;
 use Cake\Core\Plugin;
+use Cake\Database\Driver\Mysql;
 use Cake\Database\Driver\Sqlserver;
 use Cake\Datasource\ConnectionManager;
 use Cake\TestSuite\TestCase;
@@ -232,7 +233,10 @@ public function testMigrateAndRollback($backend)
         $this->assertEquals($expected, $columns);
         $createdColumn = $storesTable->getSchema()->getColumn('created');
         $expected = 'CURRENT_TIMESTAMP';
-        if ($this->Connection->getDriver() instanceof Sqlserver) {
+        $driver = $this->Connection->getDriver();
+        if ($driver instanceof Mysql && $driver->isMariadb()) {
+            $expected = 'current_timestamp()';
+        } elseif ($driver instanceof Sqlserver) {
             $expected = 'getdate()';
         }
         $this->assertEquals($expected, $createdColumn['default']);