feat(database): add migration hash checking (#1054)

Co-authored-by: Brent Roose <[email protected]>

Author: erikaraujo

src/Tempest/Console/src/Input/MemoryInputBuffer.php

@@ -52,4 +52,11 @@ private function consumeBuffer(): string
 
         return $next ?? '';
     }
+
+    public function clear(): self
+    {
+        $this->buffer = [];
+
+        return $this;
+    }
 }

src/Tempest/Console/src/Testing/ConsoleTester.php

@@ -35,6 +35,8 @@ final class ConsoleTester
 
     private bool $withPrompting = true;
 
+    private (Console&GenericConsole)|null $console = null;
+
     public function __construct(
         private readonly Container $container,
     ) {}
@@ -43,20 +45,26 @@ public function call(string|Closure|array $command, string|array $arguments = []
     {
         $clone = clone $this;
 
-        $memoryOutputBuffer = new MemoryOutputBuffer();
+        $this->output ??= new MemoryOutputBuffer();
+        $this->output->clear();
+        $memoryOutputBuffer = $this->output;
         $clone->container->singleton(OutputBuffer::class, $memoryOutputBuffer);
 
-        $memoryInputBuffer = new MemoryInputBuffer();
+        $this->input ??= new MemoryInputBuffer();
+        $this->input->clear();
+        $memoryInputBuffer = $this->input;
         $clone->container->singleton(InputBuffer::class, $memoryInputBuffer);
 
-        $console = new GenericConsole(
+        $this->console ??= new GenericConsole(
             output: $memoryOutputBuffer,
             input: $memoryInputBuffer,
             highlighter: $clone->container->get(Highlighter::class, 'console'),
             executeConsoleCommand: $clone->container->get(ExecuteConsoleCommand::class),
             argumentBag: $clone->container->get(ConsoleArgumentBag::class),
         );
 
+        $console = $this->console;
+
         if ($this->withPrompting === false) {
             $console->disablePrompting();
         }

src/Tempest/Database/src/Migrations/CreateMigrationsTable.php

@@ -17,7 +17,8 @@ public function up(): QueryStatement
     {
         return CreateTableStatement::forModel(Migration::class)
             ->primary()
-            ->text('name');
+            ->text('name')
+            ->varchar('hash', 32);
     }
 
     public function down(): QueryStatement

src/Tempest/Database/src/Migrations/Migration.php

@@ -11,4 +11,6 @@ final class Migration
     use IsDatabaseModel;
 
     public string $name;
+
+    public string $hash;
 }

src/Tempest/Database/src/Migrations/MigrationException.php

@@ -6,10 +6,6 @@
 
 use Exception;
 
-final class MigrationException extends Exception
+interface MigrationException
 {
-    public static function noTable(): self
-    {
-        return new self('Migrations table does not exist. Nothing to roll back.');
-    }
 }

src/Tempest/Database/src/Migrations/MigrationHashMismatchException.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Database\Migrations;
+
+use Exception;
+
+final class MigrationHashMismatchException extends Exception implements MigrationException
+{
+    public function __construct(
+        string $message = 'Migration file has been tampered with.',
+    ) {
+        parent::__construct($message);
+    }
+}

src/Tempest/Database/src/Migrations/MigrationManager.php

@@ -10,8 +10,10 @@
 use Tempest\Database\Config\DatabaseDialect;
 use Tempest\Database\Database;
 use Tempest\Database\DatabaseMigration as MigrationInterface;
+use Tempest\Database\DatabaseMigration;
 use Tempest\Database\Exceptions\QueryException;
 use Tempest\Database\Query;
+use Tempest\Database\QueryStatement;
 use Tempest\Database\QueryStatements\DropTableStatement;
 use Tempest\Database\QueryStatements\SetForeignKeyChecksStatement;
 use Tempest\Database\QueryStatements\ShowTablesStatement;
@@ -60,7 +62,7 @@ public function down(): void
             /** @throw UnhandledMatchError */
             match ((string) $pdoException->getCode()) {
                 $this->databaseConfig->dialect->tableNotFoundCode() => event(
-                    event: new MigrationFailed(name: new ModelDefinition(Migration::class)->getTableDefinition()->name, exception: MigrationException::noTable()),
+                    event: new MigrationFailed(name: new ModelDefinition(Migration::class)->getTableDefinition()->name, exception: new TableNotFoundException()),
                 ),
                 default => throw new UnhandledMatchError($pdoException->getMessage()),
             };
@@ -108,6 +110,65 @@ public function dropAll(): void
         }
     }
 
+    public function rehashAll(): void
+    {
+        try {
+            $existingMigrations = Migration::all();
+        } catch (PDOException) {
+            return;
+        }
+
+        foreach ($existingMigrations as $existingMigration) {
+            /**
+             * We need to find and delete migration DB records that no longer have a corresponding migration file.
+             * This can happen if a migration file was deleted or renamed.
+             * If we don't do it, `:validate` will continue failing due to the missing migration file.
+             */
+            $databaseMigration = array_find(
+                iterator_to_array($this->migrations),
+                static fn (DatabaseMigration $migration) => $migration->name === $existingMigration->name,
+            );
+
+            if ($databaseMigration === null) {
+                $existingMigration->delete();
+
+                continue;
+            }
+
+            $existingMigration->update(
+                hash: $this->getMigrationHash($databaseMigration),
+            );
+        }
+    }
+
+    public function validate(): void
+    {
+        try {
+            $existingMigrations = Migration::all();
+        } catch (PDOException) {
+            return;
+        }
+
+        foreach ($existingMigrations as $existingMigration) {
+            $databaseMigration = array_find(
+                iterator_to_array($this->migrations),
+                static fn (DatabaseMigration $migration) => $migration->name === $existingMigration->name,
+            );
+
+            if ($databaseMigration === null) {
+                event(new MigrationValidationFailed($existingMigration->name, new MissingMigrationFileException()));
+
+                continue;
+            }
+
+            if ($this->getMigrationHash($databaseMigration) !== $existingMigration->hash) {
+                event(new MigrationValidationFailed($existingMigration->name, new MigrationHashMismatchException()));
+
+                continue;
+            }
+        }
+    }
+
     public function executeUp(MigrationInterface $migration): void
     {
         $statement = $migration->up();
@@ -125,6 +186,7 @@ public function executeUp(MigrationInterface $migration): void
 
             Migration::create(
                 name: $migration->name,
+                hash: $this->getMigrationHash($migration),
             );
         } catch (PDOException $pdoException) {
             event(new MigrationFailed($migration->name, $pdoException));
@@ -198,4 +260,30 @@ private function getTableDefinitions(DatabaseDialect $dialect): array
             new ShowTablesStatement()->fetch($dialect),
         );
     }
+
+    private function getMigrationHash(DatabaseMigration $migration): string
+    {
+        $minifiedDownSql = $this->getMinifiedSqlFromStatement($migration->down());
+        $minifiedUpSql = $this->getMinifiedSqlFromStatement($migration->up());
+
+        return hash('xxh128', $minifiedDownSql . $minifiedUpSql);
+    }
+
+    private function getMinifiedSqlFromStatement(?QueryStatement $statement): string
+    {
+        if ($statement === null) {
+            return '';
+        }
+
+        $query = new Query($statement->compile($this->databaseConfig->dialect));
+
+        // Remove comments
+        $sql = preg_replace('/--.*$/m', '', $query->getSql()); // Remove SQL single-line comments
+        $sql = preg_replace('/\/\*[\s\S]*?\*\//', '', $sql); // Remove block comments
+
+        // Remove blank lines and excessive spaces
+        $sql = preg_replace('/\s+/', ' ', trim($sql));
+
+        return $sql;
+    }
 }

src/Tempest/Database/src/Migrations/MigrationValidationFailed.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Database\Migrations;
+
+use Throwable;
+
+final readonly class MigrationValidationFailed
+{
+    public function __construct(
+        public string $name,
+        public Throwable $exception,
+    ) {}
+}

src/Tempest/Database/src/Migrations/MissingMigrationFileException.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Database\Migrations;
+
+use Exception;
+
+final class MissingMigrationFileException extends Exception implements MigrationException
+{
+    public function __construct(
+        string $message = 'Migration file is missing.',
+    ) {
+        parent::__construct($message);
+    }
+}

src/Tempest/Database/src/Migrations/TableNotFoundException.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Database\Migrations;
+
+use Exception;
+
+final class TableNotFoundException extends Exception implements MigrationException
+{
+    public function __construct(
+        string $message = 'Migrations table does not exist. Nothing to roll back.',
+    ) {
+        parent::__construct($message);
+    }
+}