Merge pull request #1432 from VincentLanglet/freezeMigrations

Throw an exception if addSql is used in post methods

src/AbstractMigration.php

@@ -10,6 +10,7 @@
 use Doctrine\DBAL\Schema\AbstractSchemaManager;
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\Migrations\Exception\AbortMigration;
+use Doctrine\Migrations\Exception\FrozenMigration;
 use Doctrine\Migrations\Exception\IrreversibleMigration;
 use Doctrine\Migrations\Exception\MigrationException;
 use Doctrine\Migrations\Exception\SkipMigration;
@@ -36,6 +37,8 @@ abstract class AbstractMigration
     /** @var Query[] */
     private array $plannedSql = [];
 
+    private bool $frozen = false;
+
     public function __construct(Connection $connection, private readonly LoggerInterface $logger)
     {
         $this->connection = $connection;
@@ -125,6 +128,10 @@ protected function addSql(
         array $params = [],
         array $types = [],
     ): void {
+        if ($this->frozen) {
+            throw FrozenMigration::new();
+        }
+
         $this->plannedSql[] = new Query($sql, $params, $types);
     }
 
@@ -134,6 +141,11 @@ public function getSql(): array
         return $this->plannedSql;
     }
 
+    public function freeze(): void
+    {
+        $this->frozen = true;
+    }
+
     protected function write(string $message): void
     {
         $this->logger->notice($message, ['migration' => $this]);

src/Exception/FrozenMigration.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Migrations\Exception;
+
+use LogicException;
+
+final class FrozenMigration extends LogicException implements MigrationException
+{
+    public static function new(): self
+    {
+        return new self('The migration is frozen and cannot be edited anymore.');
+    }
+}

src/Version/DbalExecutor.php

@@ -145,6 +145,8 @@ private function executeMigration(
             $this->addSql(new Query($sql));
         }
 
+        $migration->freeze();
+
         if (count($this->sql) !== 0) {
             if (! $configuration->isDryRun()) {
                 $this->executeResult($configuration);

tests/AbstractMigrationTest.php

@@ -6,6 +6,7 @@
 
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\Migrations\Exception\AbortMigration;
+use Doctrine\Migrations\Exception\FrozenMigration;
 use Doctrine\Migrations\Exception\IrreversibleMigration;
 use Doctrine\Migrations\Exception\SkipMigration;
 use Doctrine\Migrations\Query\Query;
@@ -47,6 +48,15 @@ public function testAddSql(): void
         self::assertEquals([new Query('SELECT 1', [1], [2])], $this->migration->getSql());
     }
 
+    public function testThrowFrozenMigrationException(): void
+    {
+        $this->expectException(FrozenMigration::class);
+        $this->expectExceptionMessage('The migration is frozen and cannot be edited anymore.');
+
+        $this->migration->freeze();
+        $this->migration->exposedAddSql('SELECT 1', [1], [2]);
+    }
+
     public function testWarnIfOutputMessage(): void
     {
         $this->migration->warnIf(true, 'Warning was thrown');