feat(construct): BREAKING CHANGE: add multiple migration configurations

guiyom-e · Oct 6, 2023 · e1bcd67 · e1bcd67
1 parent c10df04
commit e1bcd67
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 25 deletions.
diff --git a/cdk-dynamodb-migrator/bin/cdk.ts b/cdk-dynamodb-migrator/bin/cdk.ts
@@ -32,9 +32,21 @@ class UserStack extends Stack {
 const userStack = new UserStack(app, 'UserStack');
 
 new MigrationStack(app, 'MigrationStack', {
-  migrationHandling: {
-    type: 'lambda',
-    migrationLambdaFunction: userStack.runMigrationsFunction,
-  },
+  configurations: [
+    {
+      id: '0',
+      migrationHandling: {
+        type: 'lambda',
+        migrationLambdaFunction: userStack.runMigrationsFunction,
+      },
+    },
+    {
+      id: '1',
+      migrationHandling: {
+        type: 'lambda',
+        migrationLambdaFunction: userStack.runMigrationsFunction,
+      },
+    },
+  ],
   settings: {},
 });
diff --git a/cdk-dynamodb-migrator/index.ts b/cdk-dynamodb-migrator/index.ts
@@ -7,11 +7,12 @@ import {
   FAILURE_STATUS,
   SUCCESS_STATUS,
 } from './lib/constants';
+import { MigrationConstruct, MigrationConstructProps } from './lib/constructs';
 import {
-  MigrationConstruct,
-  MigrationConstructProps,
+  MigrationConfiguration,
+  MigrationHandling,
   VersioningSettings,
-} from './lib/constructs';
+} from './lib/constructs/types';
 
 export {
   DEFAULT_PARTITION_KEY_NAME,
@@ -20,9 +21,14 @@ export {
   CURRENT_STATUS_SORT_KEY,
   SUCCESS_STATUS,
   FAILURE_STATUS,
+  // Export Migration construct
   MigrationConstruct,
   MigrationConstructProps,
+  // Export Migration stack
   MigrationStack,
   MigrationStackProps,
+  // Export types
+  MigrationConfiguration,
+  MigrationHandling,
   VersioningSettings,
 };
diff --git a/cdk-dynamodb-migrator/lib/constructs/index.ts b/cdk-dynamodb-migrator/lib/constructs/index.ts
@@ -13,7 +13,10 @@ import {
 
 /** MigrationConstruct props */
 export type MigrationConstructProps = StackProps & {
-  migrationHandling: MigrationHandling;
+  configurations: {
+    id: string;
+    migrationHandling: MigrationHandling;
+  }[];
   settings?: {
     versioning?: Partial<VersioningSettings>;
   };
@@ -26,7 +29,7 @@ export class MigrationConstruct extends Construct {
 
   constructor(scope: Construct, id: string, props: MigrationConstructProps) {
     super(scope, id);
-    const { migrationHandling, settings } = props;
+    const { configurations, settings } = props;
 
     // Versioning
     const versioningPartitionKey =
@@ -58,12 +61,8 @@ export class MigrationConstruct extends Construct {
 
     // State machine
     this.migrationStateMachine = new MigrationStateMachine(this, 'MSM', {
-      configurations: [
-        {
-          migrationHandling,
-          versioning: this.versioning,
-        },
-      ],
+      configurations,
+      versioning: this.versioning,
     });
   }
 }
diff --git a/cdk-dynamodb-migrator/lib/constructs/stepFunctions/stateMachine.ts b/cdk-dynamodb-migrator/lib/constructs/stepFunctions/stateMachine.ts
@@ -8,26 +8,25 @@ import {
 import { Construct } from 'constructs';
 
 import { getMigrationStateMachineBaseDefinition } from './getStateMachineBaseDefinition';
-import { MigrationHandling, VersioningSettings } from '../types';
+import { MigrationConfiguration, VersioningSettings } from '../types';
 
 interface MigrationStateMachineProps {
-  configurations: [
-    {
-      migrationHandling: MigrationHandling;
-      versioning: VersioningSettings;
-    },
-  ];
+  configurations: MigrationConfiguration[];
+  versioning: VersioningSettings;
 }
 
 export class MigrationStateMachine extends Construct {
   constructor(scope: Construct, id: string, props: MigrationStateMachineProps) {
     super(scope, id);
 
-    const { configurations } = props;
+    const { configurations, versioning } = props;
 
     const defineDefaults = new Pass(this, 'DefineDefaults', {
       parameters: {
-        configurations: configurations.map((_, index) => ({ id: index })),
+        configurations: configurations.map((config, index) => ({
+          id: config.id,
+          index,
+        })),
       },
       resultPath: '$.inputDefaults',
     }).next(
@@ -45,7 +44,7 @@ export class MigrationStateMachine extends Construct {
     );
 
     const migrationBranches = configurations.map(
-      ({ migrationHandling, versioning }, configIndex) =>
+      ({ migrationHandling }, configIndex) =>
         getMigrationStateMachineBaseDefinition(this, {
           id: configIndex.toString(),
           index: configIndex,

diff --git a/cdk-dynamodb-migrator/lib/constructs/types.ts b/cdk-dynamodb-migrator/lib/constructs/types.ts
@@ -9,6 +9,11 @@ interface GenericMigration {
 
 export type MigrationHandling = GenericMigration;
 
+export type MigrationConfiguration = {
+  id: string;
+  migrationHandling: MigrationHandling;
+};
+
 /** Versioning settings of MigrationConstruct */
 export type VersioningSettings = {
   /** DynamoDB table to store migration state and versions */