Introduce SagaStoreRelation schema

jerowork · jerowork · commit 4bbec530dd5b · 2025-10-16T19:33:24.000+02:00
As a Saga can be linked to multiple SagaIds, a relation table is required
(similar as with EventStore).
diff --git a/resources/migrations/doctrine/Version20251002195234.php b/resources/migrations/doctrine/Version20251002195234.php
@@ -12,12 +12,23 @@ public function up(Schema $schema): void
         $this->addSql(
             <<<'SQL'
             CREATE TABLE `saga_store` (
-              `saga_id` varchar(50) COLLATE utf8mb4_unicode_ci NOT NULL,
+              `id` varchar(50) COLLATE utf8mb4_unicode_ci NOT NULL,
               `saga_name` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL,
               `payload` json NOT NULL,
               `created_at` timestamp(6) NOT NULL,
               `updated_at` timestamp(6) NULL DEFAULT NULL,
-              PRIMARY KEY (`saga_id`, `saga_name`)
+              PRIMARY KEY (`id`)
+            ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
+            SQL
+        );
+
+        $this->addSql(
+            <<<'SQL'
+            CREATE TABLE `saga_store_relation` (
+              `id` varchar(50) COLLATE utf8mb4_unicode_ci NOT NULL,
+              `saga_id` varchar(50) COLLATE utf8mb4_unicode_ci NOT NULL,
+              PRIMARY KEY (`id`,`saga_id`),
+              CONSTRAINT `saga_store_relation_ibfk_1` FOREIGN KEY (`id`) REFERENCES `saga_store` (`id`)
             ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
             SQL
         );
diff --git a/resources/migrations/phinx/20251002194212.php b/resources/migrations/phinx/20251002194212.php
@@ -8,8 +8,8 @@ final class V20251002194212 extends AbstractMigration
 {
     public function change(): void
     {
-        $this->table('saga_store', ['id' => false, 'primary_key' => ['saga_id', 'saga_name']])
-            ->addColumn('saga_id', 'string', ['limit' => 50, 'null' => false])
+        $this->table('saga_store', ['id' => false, 'primary_key' => 'id'])
+            ->addColumn('id', 'string', ['limit' => 50, 'null' => false])
             ->addColumn('saga_name', 'string', ['null' => false])
             ->addColumn('payload', 'json', ['null' => false])
             ->addColumn('created_at', 'timestamp', ['limit' => 6, 'null' => false])
diff --git a/resources/migrations/phinx/20251015202332.php b/resources/migrations/phinx/20251015202332.php
@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+use Phinx\Migration\AbstractMigration;
+
+final class V20251015202332 extends AbstractMigration
+{
+    public function change(): void
+    {
+        $this->table('saga_store_relation', ['id' => false, 'primary_key' => ['id', 'saga_id']])
+            ->addColumn('id', 'string', ['limit' => 50, 'null' => false])
+            ->addColumn('saga_id', 'string', ['limit' => 50, 'null' => false])
+            ->addForeignKey('id', 'saga_store', 'id')
+            ->create();
+    }
+}
diff --git a/resources/schema.sql b/resources/schema.sql
@@ -16,10 +16,17 @@ CREATE TABLE `event_store_relation` (
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
 
 CREATE TABLE `saga_store` (
-  `saga_id` varchar(50) COLLATE utf8mb4_unicode_ci NOT NULL,
+  `id` varchar(50) COLLATE utf8mb4_unicode_ci NOT NULL,
   `saga_name` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL,
   `payload` json NOT NULL,
   `created_at` timestamp(6) NOT NULL,
   `updated_at` timestamp(6) NULL DEFAULT NULL,
-  PRIMARY KEY (`saga_id`, `saga_name`)
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
+
+CREATE TABLE `saga_store_relation` (
+  `id` varchar(50) COLLATE utf8mb4_unicode_ci NOT NULL,
+  `saga_id` varchar(50) COLLATE utf8mb4_unicode_ci NOT NULL,
+  PRIMARY KEY (`id`,`saga_id`),
+  CONSTRAINT `saga_store_relation_ibfk_1` FOREIGN KEY (`id`) REFERENCES `saga_store` (`id`)
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
diff --git a/src/Saga/TableSchema/SagaStoreRelationTableSchema.php b/src/Saga/TableSchema/SagaStoreRelationTableSchema.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Gember\RdbmsEventStoreDoctrineDbal\Saga\TableSchema;
+
+final readonly class SagaStoreRelationTableSchema
+{
+    public function __construct(
+        public string $tableName,
+        public string $idFieldName,
+        public string $sagaIdFieldName,
+    ) {}
+}
diff --git a/src/Saga/TableSchema/SagaStoreTableSchema.php b/src/Saga/TableSchema/SagaStoreTableSchema.php
@@ -8,7 +8,7 @@
 {
     public function __construct(
         public string $tableName,
-        public string $sagaIdFieldName,
+        public string $idFieldName,
         public string $sagaNameFieldName,
         public string $payloadFieldName,
         public string $createdAtFieldName,
diff --git a/src/Saga/TableSchema/SagaTableSchemaFactory.php b/src/Saga/TableSchema/SagaTableSchemaFactory.php
@@ -8,7 +8,7 @@
 {
     public static function createDefaultSagaStore(
         string $tableName = 'saga_store',
-        string $sagaIdFieldName = 'saga_id',
+        string $idFieldName = 'id',
         string $sagaNameFieldName = 'saga_name',
         string $payloadFieldName = 'payload',
         string $createdAtFieldName = 'created_at',
@@ -18,7 +18,7 @@ public static function createDefaultSagaStore(
     ): SagaStoreTableSchema {
         return new SagaStoreTableSchema(
             $tableName,
-            $sagaIdFieldName,
+            $idFieldName,
             $sagaNameFieldName,
             $payloadFieldName,
             $createdAtFieldName,
@@ -27,4 +27,16 @@ public static function createDefaultSagaStore(
             $updatedAtFieldFormat,
         );
     }
+
+    public static function createDefaultSagaStoreRelation(
+        string $tableName = 'saga_store_relation',
+        string $idFieldName = 'id',
+        string $sagaIdFieldName = 'saga_id',
+    ): SagaStoreRelationTableSchema {
+        return new SagaStoreRelationTableSchema(
+            $tableName,
+            $idFieldName,
+            $sagaIdFieldName,
+        );
+    }
 }
diff --git a/tests/Saga/TableSchema/SagaTableSchemaFactoryTest.php b/tests/Saga/TableSchema/SagaTableSchemaFactoryTest.php
@@ -14,12 +14,12 @@
 final class SagaTableSchemaFactoryTest extends TestCase
 {
     #[Test]
-    public function itShouldCreateDefaultEventStoreTableSchema(): void
+    public function itShouldCreateDefaultSagaStoreTableSchema(): void
     {
         $schema = SagaTableSchemaFactory::createDefaultSagaStore();
 
         self::assertSame('saga_store', $schema->tableName);
-        self::assertSame('saga_id', $schema->sagaIdFieldName);
+        self::assertSame('id', $schema->idFieldName);
         self::assertSame('saga_name', $schema->sagaNameFieldName);
         self::assertSame('payload', $schema->payloadFieldName);
         self::assertSame('created_at', $schema->createdAtFieldName);
@@ -29,11 +29,11 @@ public function itShouldCreateDefaultEventStoreTableSchema(): void
     }
 
     #[Test]
-    public function itShouldCreateCustomEventStoreTableSchema(): void
+    public function itShouldCreateCustomSagaStoreTableSchema(): void
     {
         $schema = SagaTableSchemaFactory::createDefaultSagaStore(
             'custom_saga_store',
-            'custom_saga_id',
+            'custom_id',
             'custom_saga_name',
             'custom_payload',
             'custom_created_at',
@@ -43,12 +43,36 @@ public function itShouldCreateCustomEventStoreTableSchema(): void
         );
 
         self::assertSame('custom_saga_store', $schema->tableName);
-        self::assertSame('custom_saga_id', $schema->sagaIdFieldName);
+        self::assertSame('custom_id', $schema->idFieldName);
         self::assertSame('custom_saga_name', $schema->sagaNameFieldName);
         self::assertSame('custom_payload', $schema->payloadFieldName);
         self::assertSame('custom_created_at', $schema->createdAtFieldName);
         self::assertSame('custom_created_at_format', $schema->createdAtFieldFormat);
         self::assertSame('custom_updated_at', $schema->updatedAtFieldName);
         self::assertSame('custom_updated_at_format', $schema->updatedAtFieldFormat);
     }
+
+    #[Test]
+    public function itShouldCreateDefaultSagaStoreRelationTableSchema(): void
+    {
+        $schema = SagaTableSchemaFactory::createDefaultSagaStoreRelation();
+
+        self::assertSame('saga_store_relation', $schema->tableName);
+        self::assertSame('id', $schema->idFieldName);
+        self::assertSame('saga_id', $schema->sagaIdFieldName);
+    }
+
+    #[Test]
+    public function itShouldCreateCustomSagaStoreRelationTableSchema(): void
+    {
+        $schema = SagaTableSchemaFactory::createDefaultSagaStoreRelation(
+            'custom_saga_store',
+            'custom_id',
+            'custom_saga_id',
+        );
+
+        self::assertSame('custom_saga_store', $schema->tableName);
+        self::assertSame('custom_id', $schema->idFieldName);
+        self::assertSame('custom_saga_id', $schema->sagaIdFieldName);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -8,8 +8,8 @@ final class V20251002194212 extends AbstractMigration`
`8`	`8`	`{`
`9`	`9`	`public function change(): void`
`10`	`10`	`{`
`11`		`- $this->table('saga_store', ['id' => false, 'primary_key' => ['saga_id', 'saga_name']])`
`12`		`- ->addColumn('saga_id', 'string', ['limit' => 50, 'null' => false])`
	`11`	`+ $this->table('saga_store', ['id' => false, 'primary_key' => 'id'])`
	`12`	`+ ->addColumn('id', 'string', ['limit' => 50, 'null' => false])`
`13`	`13`	`->addColumn('saga_name', 'string', ['null' => false])`
`14`	`14`	`->addColumn('payload', 'json', ['null' => false])`
`15`	`15`	`->addColumn('created_at', 'timestamp', ['limit' => 6, 'null' => false])`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`{`
`9`	`9`	`public function __construct(`
`10`	`10`	`public string $tableName,`
`11`		`- public string $sagaIdFieldName,`
	`11`	`+ public string $idFieldName,`
`12`	`12`	`public string $sagaNameFieldName,`
`13`	`13`	`public string $payloadFieldName,`
`14`	`14`	`public string $createdAtFieldName,`