Add unknown collations for MySQL 8 and MariaDB

config/ignition.php

@@ -24,6 +24,8 @@
 use Spatie\LaravelIgnition\Solutions\SolutionProviders\ViewNotFoundSolutionProvider;
 use Spatie\LaravelIgnition\Solutions\SolutionProviders\OpenAiSolutionProvider;
 use Spatie\LaravelIgnition\Solutions\SolutionProviders\SailNetworkSolutionProvider;
+use Spatie\LaravelIgnition\Solutions\SolutionProviders\UnknownMariadbCollationSolutionProvider;
+use Spatie\LaravelIgnition\Solutions\SolutionProviders\UnknownMysql8CollationSolutionProvider;
 
 return [
 
@@ -119,6 +121,8 @@
         GenericLaravelExceptionSolutionProvider::class,
         OpenAiSolutionProvider::class,
         SailNetworkSolutionProvider::class,
+        UnknownMysql8CollationSolutionProvider::class,
+        UnknownMariadbCollationSolutionProvider::class,
     ],
 
     /*

src/Solutions/SolutionProviders/UnknownMariadbCollationSolutionProvider.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Spatie\LaravelIgnition\Solutions\SolutionProviders;
+
+use Illuminate\Database\QueryException;
+use Spatie\Ignition\Contracts\HasSolutionsForThrowable;
+use Spatie\LaravelIgnition\Solutions\SuggestUsingMariadbDatabaseSolution;
+use Throwable;
+
+class UnknownMariadbCollationSolutionProvider implements HasSolutionsForThrowable
+{
+    const MYSQL_UNKNOWN_COLLATION_CODE = 1273;
+
+    public function canSolve(Throwable $throwable): bool
+    {
+        if (! $throwable instanceof QueryException) {
+            return false;
+        }
+
+        if ($throwable->getCode() !== self::MYSQL_UNKNOWN_COLLATION_CODE) {
+            return false;
+        }
+
+        return str_contains(
+            $throwable->getMessage(),
+            'Unknown collation: \'utf8mb4_uca1400_ai_ci\''
+        );
+    }
+
+    public function getSolutions(Throwable $throwable): array
+    {
+        return [new SuggestUsingMariadbDatabaseSolution()];
+    }
+}

src/Solutions/SolutionProviders/UnknownMysql8CollationSolutionProvider.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Spatie\LaravelIgnition\Solutions\SolutionProviders;
+
+use Illuminate\Database\QueryException;
+use Spatie\Ignition\Contracts\HasSolutionsForThrowable;
+use Spatie\LaravelIgnition\Solutions\SuggestUsingMysql8DatabaseSolution;
+use Throwable;
+
+class UnknownMysql8CollationSolutionProvider implements HasSolutionsForThrowable
+{
+    const MYSQL_UNKNOWN_COLLATION_CODE = 1273;
+
+    public function canSolve(Throwable $throwable): bool
+    {
+        if (! $throwable instanceof QueryException) {
+            return false;
+        }
+
+        if ($throwable->getCode() !== self::MYSQL_UNKNOWN_COLLATION_CODE) {
+            return false;
+        }
+
+        return str_contains(
+            $throwable->getMessage(),
+            'Unknown collation: \'utf8mb4_0900_ai_ci\''
+        );
+    }
+
+    public function getSolutions(Throwable $throwable): array
+    {
+        return [new SuggestUsingMysql8DatabaseSolution()];
+    }
+}

src/Solutions/SuggestUsingMariadbDatabaseSolution.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Spatie\LaravelIgnition\Solutions;
+
+use Spatie\Ignition\Contracts\Solution;
+
+class SuggestUsingMariadbDatabaseSolution implements Solution
+{
+    public function getSolutionTitle(): string
+    {
+        return 'Database is not a MariaDB database';
+    }
+
+    public function getSolutionDescription(): string
+    {
+        return "Laravel 11 changed the default collation for MySQL and MariaDB. It seems you are trying to use the MariaDB collation `utf8mb4_uca1400_ai_ci` with a MySQL database.\n\nEdit the `.env` file and use the correct database in the `DB_CONNECTION` key.";
+    }
+
+    /** @return array<string, string> */
+    public function getDocumentationLinks(): array
+    {
+        return [
+            'Database: Getting Started docs' => 'https://laravel.com/docs/master/database#configuration',
+        ];
+    }
+}

src/Solutions/SuggestUsingMysql8DatabaseSolution.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Spatie\LaravelIgnition\Solutions;
+
+use Spatie\Ignition\Contracts\Solution;
+
+class SuggestUsingMysql8DatabaseSolution implements Solution
+{
+    public function getSolutionTitle(): string
+    {
+        return 'Database is not a MySQL 8 database';
+    }
+
+    public function getSolutionDescription(): string
+    {
+        return "Laravel 11 changed the default collation for MySQL and MariaDB. It seems you are trying to use the MySQL 8 collation `utf8mb4_0900_ai_ci` with a MariaDB or MySQL 5.7 database.\n\nEdit the `.env` file and use the correct database in the `DB_CONNECTION` key.";
+    }
+
+    /** @return array<string, string> */
+    public function getDocumentationLinks(): array
+    {
+        return [
+            'Database: Getting Started docs' => 'https://laravel.com/docs/master/database#configuration',
+        ];
+    }
+}

tests/Solutions/SolutionProviders/UnknownMariadbCollationSolutionProviderTest.php

@@ -0,0 +1,21 @@
+<?php
+
+use Illuminate\Database\QueryException;
+use Spatie\LaravelIgnition\Solutions\SolutionProviders\UnknownMariadbCollationSolutionProvider;
+
+it('can solve an an unknown mariadb collation ', function () {
+    $solutionProvider = new UnknownMariadbCollationSolutionProvider();
+
+    $exception = new QueryException(
+        'mysql',
+        'select table_name as `name`, (data_length + index_length) as `size`, table_comment as `comment`, engine as `engine`, table_collation as `collation` from information_schema.tables where table_schema = \'mariadb_test\' and table_type = \'BASE TABLE\' order by table_name',
+        [],
+        new Exception('SQLSTATE[HY000]: General error: 1273 Unknown collation: \'utf8mb4_uca1400_ai_ci\'')
+    );
+
+    $solutions = $solutionProvider->getSolutions($exception);
+
+    $solution = $solutions[0];
+
+    expect($solution->getSolutionDescription())->toBe("Laravel 11 changed the default collation for MySQL and MariaDB. It seems you are trying to use the MariaDB collation `utf8mb4_uca1400_ai_ci` with a MySQL database.\n\nEdit the `.env` file and use the correct database in the `DB_CONNECTION` key.");
+});

tests/Solutions/SolutionProviders/UnknownMysql8CollationSolutionProviderTest.php

@@ -0,0 +1,21 @@
+<?php
+
+use Illuminate\Database\QueryException;
+use Spatie\LaravelIgnition\Solutions\SolutionProviders\UnknownMysql8CollationSolutionProvider;
+
+it('can solve an an unknown mysql collation ', function () {
+    $solutionProvider = new UnknownMysql8CollationSolutionProvider();
+
+    $exception = new QueryException(
+        'mariadb',
+        'select table_name as `name`, (data_length + index_length) as `size`, table_comment as `comment`, engine as `engine`, table_collation as `collation` from information_schema.tables where table_schema = \'mariadb_test\' and table_type = \'BASE TABLE\' order by table_name',
+        [],
+        new Exception('SQLSTATE[HY000]: General error: 1273 Unknown collation: \'utf8mb4_0900_ai_ci\'')
+    );
+
+    $solutions = $solutionProvider->getSolutions($exception);
+
+    $solution = $solutions[0];
+
+    expect($solution->getSolutionDescription())->toBe("Laravel 11 changed the default collation for MySQL and MariaDB. It seems you are trying to use the MySQL 8 collation `utf8mb4_0900_ai_ci` with a MariaDB or MySQL 5.7 database.\n\nEdit the `.env` file and use the correct database in the `DB_CONNECTION` key.");
+});