Dispatch events for migration execution

composer.json

@@ -8,6 +8,7 @@
         "php": "^8.1",
         "doctrine/dbal": "^3.6.0 || ^4.0.0",
         "doctrine/orm": "^3.0.0",
+        "psr/event-dispatcher": "^1.0",
         "symfony/console": "^5.4.0 || ^6.0.0 || ^7.0.0"
     },
     "require-dev": {
@@ -21,7 +22,8 @@
         "psr/log": "^3",
         "shipmonk/composer-dependency-analyser": "^1.7.0",
         "shipmonk/phpstan-rules": "^4.0.0",
-        "slevomat/coding-standard": "^8.15.0"
+        "slevomat/coding-standard": "^8.15.0",
+        "symfony/event-dispatcher-contracts": "^3.5"
     },
     "autoload": {
         "psr-4": {

phpcs.xml.dist

@@ -278,7 +278,6 @@
     <rule ref="SlevomatCodingStandard.Classes.RequireSelfReference"/>
     <rule ref="SlevomatCodingStandard.Classes.TraitUseDeclaration" />
     <rule ref="SlevomatCodingStandard.Classes.TraitUseSpacing" />
-    <rule ref="SlevomatCodingStandard.Classes.DisallowConstructorPropertyPromotion" />
     <rule ref="SlevomatCodingStandard.Commenting.DocCommentSpacing">
         <properties>
             <property name="linesCountBeforeFirstContent" value="0"/>

src/Event/MigrationExecutionFailedEvent.php

@@ -0,0 +1,21 @@
+<?php declare(strict_types = 1);
+
+namespace ShipMonk\Doctrine\Migration\Event;
+
+use ShipMonk\Doctrine\Migration\Migration;
+use ShipMonk\Doctrine\Migration\MigrationPhase;
+use Throwable;
+
+class MigrationExecutionFailedEvent
+{
+
+    public function __construct(
+        public readonly Migration $migration,
+        public readonly string $version,
+        public readonly MigrationPhase $phase,
+        public readonly Throwable $exception,
+    )
+    {
+    }
+
+}

src/Event/MigrationExecutionStartedEvent.php

@@ -0,0 +1,19 @@
+<?php declare(strict_types = 1);
+
+namespace ShipMonk\Doctrine\Migration\Event;
+
+use ShipMonk\Doctrine\Migration\Migration;
+use ShipMonk\Doctrine\Migration\MigrationPhase;
+
+class MigrationExecutionStartedEvent
+{
+
+    public function __construct(
+        public readonly Migration $migration,
+        public readonly string $version,
+        public readonly MigrationPhase $phase,
+    )
+    {
+    }
+
+}

src/Event/MigrationExecutionSucceededEvent.php

@@ -0,0 +1,19 @@
+<?php declare(strict_types = 1);
+
+namespace ShipMonk\Doctrine\Migration\Event;
+
+use ShipMonk\Doctrine\Migration\Migration;
+use ShipMonk\Doctrine\Migration\MigrationPhase;
+
+class MigrationExecutionSucceededEvent
+{
+
+    public function __construct(
+        public readonly Migration $migration,
+        public readonly string $version,
+        public readonly MigrationPhase $phase,
+    )
+    {
+    }
+
+}

src/MigrationService.php

@@ -9,6 +9,10 @@
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Tools\SchemaTool;
 use LogicException;
+use Psr\EventDispatcher\EventDispatcherInterface;
+use ShipMonk\Doctrine\Migration\Event\MigrationExecutionFailedEvent;
+use ShipMonk\Doctrine\Migration\Event\MigrationExecutionStartedEvent;
+use ShipMonk\Doctrine\Migration\Event\MigrationExecutionSucceededEvent;
 use Throwable;
 use function file_get_contents;
 use function file_put_contents;
@@ -33,22 +37,26 @@ class MigrationService
 
     private MigrationVersionProvider $versionProvider;
 
-    private MigrationAnalyzer $migrationsAnalyzer;
+    private MigrationAnalyzer $migrationAnalyzer;
+
+    private ?EventDispatcherInterface $eventDispatcher;
 
     public function __construct(
         EntityManagerInterface $entityManager,
         MigrationConfig $config,
         ?MigrationExecutor $executor = null,
         ?MigrationVersionProvider $versionProvider = null,
-        ?MigrationAnalyzer $migrationsAnalyzer = null,
+        ?MigrationAnalyzer $migrationAnalyzer = null,
+        ?EventDispatcherInterface $eventDispatcher = null,
     )
     {
         $this->entityManager = $entityManager;
         $this->connection = $entityManager->getConnection();
         $this->config = $config;
         $this->executor = $executor ?? new MigrationDefaultExecutor($this->connection);
         $this->versionProvider = $versionProvider ?? new MigrationDefaultVersionProvider();
-        $this->migrationsAnalyzer = $migrationsAnalyzer ?? new MigrationDefaultAnalyzer();
+        $this->migrationAnalyzer = $migrationAnalyzer ?? new MigrationDefaultAnalyzer();
+        $this->eventDispatcher = $eventDispatcher;
     }
 
     public function getConfig(): MigrationConfig
@@ -67,17 +75,22 @@ public function executeMigration(string $version, MigrationPhase $phase): Migrat
     {
         $migration = $this->getMigration($version);
 
-        if ($migration instanceof TransactionalMigration) {
-            try {
-                $this->connection->beginTransaction();
+        $this->eventDispatcher?->dispatch(new MigrationExecutionStartedEvent($migration, $version, $phase));
+
+        try {
+            if ($migration instanceof TransactionalMigration) {
+                $run = $this->connection->transactional(function () use ($migration, $version, $phase): MigrationRun {
+                    return $this->doExecuteMigration($migration, $version, $phase);
+                });
+            } else {
                 $run = $this->doExecuteMigration($migration, $version, $phase);
-                $this->connection->commit();
-            } catch (Throwable $e) {
-                $this->connection->rollBack();
-                throw $e;
             }
-        } else {
-            $run = $this->doExecuteMigration($migration, $version, $phase);
+
+            $this->eventDispatcher?->dispatch(new MigrationExecutionSucceededEvent($migration, $version, $phase));
+
+        } catch (Throwable $e) {
+            $this->eventDispatcher?->dispatch(new MigrationExecutionFailedEvent($migration, $version, $phase, $e));
+            throw $e;
         }
 
         return $run;
@@ -231,7 +244,7 @@ private function excludeTablesFromSchema(Schema $schema): void
      */
     public function generateMigrationFile(array $sqls): MigrationFile
     {
-        $statements = $this->migrationsAnalyzer->analyze($sqls);
+        $statements = $this->migrationAnalyzer->analyze($sqls);
         $statementsBefore = $statementsAfter = [];
 
         foreach ($statements as $statement) {