fix(database): throw QueryWasInvalid on database fetch failure (#1371)

Author: brendt

packages/database/src/Config/DatabaseDialect.php

@@ -4,7 +4,7 @@
 
 namespace Tempest\Database\Config;
 
-use PDOException;
+use Tempest\Database\Exceptions\QueryWasInvalid;
 
 enum DatabaseDialect: string
 {
@@ -21,12 +21,14 @@ public function tableNotFoundCode(): string
         };
     }
 
-    public function isTableNotFoundError(PDOException $exception): bool
+    public function isTableNotFoundError(QueryWasInvalid $queryWasInvalid): bool
     {
+        $pdoException = $queryWasInvalid->pdoException;
+
         return match ($this) {
-            self::MYSQL => $exception->getCode() === '42S02' && str_contains($exception->getMessage(), 'table'),
-            self::SQLITE => $exception->getCode() === 'HY000' && str_contains($exception->getMessage(), 'table'),
-            self::POSTGRESQL => $exception->getCode() === '42P01' && str_contains($exception->getMessage(), 'relation'),
+            self::MYSQL => $pdoException->getCode() === '42S02' && str_contains($pdoException->getMessage(), 'table'),
+            self::SQLITE => $pdoException->getCode() === 'HY000' && str_contains($pdoException->getMessage(), 'table'),
+            self::POSTGRESQL => $pdoException->getCode() === '42P01' && str_contains($pdoException->getMessage(), 'relation'),
         };
     }
 }

packages/database/src/Exceptions/QueryWasInvalid.php

@@ -11,8 +11,12 @@
 
 final class QueryWasInvalid extends Exception
 {
+    public readonly PDOException $pdoException;
+
     public function __construct(Query $query, array $bindings, PDOException $previous)
     {
+        $this->pdoException = $previous;
+
         $message = $previous->getMessage();
 
         $message .= PHP_EOL . PHP_EOL . $query->toSql() . PHP_EOL;

packages/database/src/GenericDatabase.php

@@ -82,11 +82,15 @@ public function fetch(BuildsQuery|Query $query): array
 
         $bindings = $this->resolveBindings($query);
 
-        $pdoQuery = $this->connection->prepare($query->toSql());
+        try {
+            $pdoQuery = $this->connection->prepare($query->toSql());
 
-        $pdoQuery->execute($bindings);
+            $pdoQuery->execute($bindings);
 
-        return $pdoQuery->fetchAll(PDO::FETCH_NAMED);
+            return $pdoQuery->fetchAll(PDO::FETCH_NAMED);
+        } catch (PDOException $pdoException) {
+            throw new QueryWasInvalid($query, $bindings, $pdoException);
+        }
     }
 
     public function fetchFirst(BuildsQuery|Query $query): ?array

packages/database/src/Migrations/MigrationManager.php

@@ -4,7 +4,6 @@
 
 namespace Tempest\Database\Migrations;
 
-use PDOException;
 use Tempest\Container\Container;
 use Tempest\Database\Builder\ModelDefinition;
 use Tempest\Database\Config\DatabaseDialect;
@@ -48,12 +47,12 @@ public function up(): void
     {
         try {
             $existingMigrations = Migration::select()->onDatabase($this->onDatabase)->all();
-        } catch (PDOException $pdoException) {
-            if ($this->dialect->isTableNotFoundError($pdoException)) {
+        } catch (QueryWasInvalid $queryWasInvalid) {
+            if ($this->dialect->isTableNotFoundError($queryWasInvalid)) {
                 $this->executeUp(new CreateMigrationsTable());
                 $existingMigrations = Migration::select()->onDatabase($this->onDatabase)->all();
             } else {
-                throw $pdoException;
+                throw $queryWasInvalid;
             }
         }
 
@@ -75,9 +74,9 @@ public function down(): void
     {
         try {
             $existingMigrations = Migration::select()->onDatabase($this->onDatabase)->all();
-        } catch (PDOException $pdoException) {
-            if (! $this->dialect->isTableNotFoundError($pdoException)) {
-                throw $pdoException;
+        } catch (QueryWasInvalid $queryWasInvalid) {
+            if (! $this->dialect->isTableNotFoundError($queryWasInvalid)) {
+                throw $queryWasInvalid;
             }
 
             event(new MigrationFailed(
@@ -132,7 +131,7 @@ public function rehashAll(): void
             $existingMigrations = Migration::select()
                 ->onDatabase($this->onDatabase)
                 ->all();
-        } catch (PDOException) {
+        } catch (QueryWasInvalid) {
             return;
         }
 
@@ -163,7 +162,7 @@ public function validate(): void
     {
         try {
             $existingMigrations = Migration::select()->onDatabase($this->onDatabase)->all();
-        } catch (PDOException) {
+        } catch (QueryWasInvalid) {
             return;
         }
 
@@ -231,10 +230,10 @@ public function executeUp(MigrationInterface $migration): void
                     hash: $this->getMigrationHash($migration),
                 ),
             );
-        } catch (PDOException $pdoException) {
-            event(new MigrationFailed($migration->name, $pdoException));
+        } catch (QueryWasInvalid $queryWasInvalid) {
+            event(new MigrationFailed($migration->name, $queryWasInvalid));
 
-            throw $pdoException;
+            throw $queryWasInvalid;
         }
 
         event(new MigrationMigrated($migration->name));
@@ -264,13 +263,13 @@ public function executeDown(MigrationInterface $migration): void
 
             // Disable foreign key checks
             new SetForeignKeyChecksStatement(enable: true)->execute($this->dialect, $this->onDatabase);
-        } catch (PDOException $pdoException) {
+        } catch (QueryWasInvalid $queryWasInvalid) {
             // Disable foreign key checks
             new SetForeignKeyChecksStatement(enable: true)->execute($this->dialect, $this->onDatabase);
 
-            event(new MigrationFailed($migration->name, $pdoException));
+            event(new MigrationFailed($migration->name, $queryWasInvalid));
 
-            throw $pdoException;
+            throw $queryWasInvalid;
         }
 
         try {

tests/Integration/Database/GenericDatabaseTest.php

@@ -6,6 +6,7 @@
 
 use Exception;
 use Tempest\Database\Database;
+use Tempest\Database\Exceptions\QueryWasInvalid;
 use Tempest\Database\Migrations\CreateMigrationsTable;
 use Tempest\Database\Query;
 use Tests\Tempest\Fixtures\Migrations\CreateAuthorTable;
@@ -67,4 +68,18 @@ public function test_query_with_semicolons(): void
 
         $this->assertSame(1, query(Publisher::class)->count()->execute());
     }
+
+    public function test_query_was_invalid_exception_is_thrown_on_fetch(): void
+    {
+        $this->assertException(QueryWasInvalid::class, function (): void {
+            query('books')->select()->orderBy('title DES')->first();
+        });
+    }
+
+    public function test_query_was_invalid_exception_is_thrown_on_execute(): void
+    {
+        $this->assertException(QueryWasInvalid::class, function (): void {
+            query('books')->update(title: 'Timeline Taxi')->where('title = ?')->execute();
+        });
+    }
 }

tests/Integration/Database/MultiDatabaseTest.php

@@ -9,6 +9,7 @@
 use Tempest\Database\Config\SQLiteConfig;
 use Tempest\Database\Database;
 use Tempest\Database\DatabaseInitializer;
+use Tempest\Database\Exceptions\QueryWasInvalid;
 use Tempest\Database\Id;
 use Tempest\Database\Migrations\CreateMigrationsTable;
 use Tempest\Database\Migrations\Migration;
@@ -321,7 +322,7 @@ public function test_migrate_fresh_seed_on_selected_database(): void
             query(Book::class)->select()->onDatabase('main')->first()->title,
         );
 
-        $this->assertException(PDOException::class, function (): void {
+        $this->assertException(QueryWasInvalid::class, function (): void {
             query(Book::class)->select()->onDatabase('backup')->first();
         });
 
@@ -343,7 +344,7 @@ private function assertTableExists(string $tableName, string $onDatabase): void
     private function assertTableDoesNotExist(string $tableName, string $onDatabase): void
     {
         $this->assertException(
-            PDOException::class,
+            QueryWasInvalid::class,
             fn () => query($tableName)->count()->onDatabase($onDatabase)->execute(),
         );
     }