feat(stepfunctions): adding custom state name prop (#27306)

Closes #23532

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

Author: SankyRed

packages/aws-cdk-lib/aws-stepfunctions/README.md

@@ -124,6 +124,7 @@ becomes new the new Data object. This behavior can be modified by supplying valu
 
 These properties impact how each individual step interacts with the state machine data:
 
+* `stateName`: the name of the state in the state machine definition. If not supplied, defaults to the construct id.
 * `inputPath`: the part of the data object that gets passed to the step (`itemsPath` for `Map` states)
 * `resultSelector`: the part of the step result that should be added to the state machine data
 * `resultPath`: where in the state machine data the step result should be inserted
@@ -285,6 +286,7 @@ and also injects a field called `otherData`.
 
 ```ts
 const pass = new sfn.Pass(this, 'Filter input and inject data', {
+  stateName: 'my-pass-state', // the custom state name for the Pass state, defaults to 'Filter input and inject data' as the state name
   parameters: { // input to the pass state
     input: sfn.JsonPath.stringAt('$.input.greeting'),
     otherData: 'some-extra-stuff',

packages/aws-cdk-lib/aws-stepfunctions/lib/state-machine.ts

@@ -101,7 +101,7 @@ export interface StateMachineProps {
   readonly definitionBody?: DefinitionBody;
 
   /**
-   * substitutions for the definition body aas a key-value map
+   * substitutions for the definition body as a key-value map
    */
   readonly definitionSubstitutions?: { [key: string]: string };
 

packages/aws-cdk-lib/aws-stepfunctions/lib/states/choice.ts

@@ -9,6 +9,13 @@ import { IChainable, INextable } from '../types';
  * Properties for defining a Choice state
  */
 export interface ChoiceProps {
+  /**
+   * Optional name for this state
+   *
+   * @default - The construct ID will be used as state name
+   */
+  readonly stateName?: string;
+
   /**
    * An optional description for this state
    *

packages/aws-cdk-lib/aws-stepfunctions/lib/states/fail.ts

@@ -7,6 +7,13 @@ import { INextable } from '../types';
  * Properties for defining a Fail state
  */
 export interface FailProps {
+  /**
+   * Optional name for this state
+   *
+   * @default - The construct ID will be used as state name
+   */
+  readonly stateName?: string;
+
   /**
    * An optional description for this state
    *

packages/aws-cdk-lib/aws-stepfunctions/lib/states/map.ts

@@ -11,6 +11,13 @@ import { CatchProps, IChainable, INextable, RetryProps } from '../types';
  * Properties for defining a Map state
  */
 export interface MapProps {
+  /**
+   * Optional name for this state
+   *
+   * @default - The construct ID will be used as state name
+   */
+  readonly stateName?: string;
+
   /**
    * An optional description for this state
    *

packages/aws-cdk-lib/aws-stepfunctions/lib/states/parallel.ts

@@ -9,6 +9,13 @@ import { CatchProps, IChainable, INextable, RetryProps } from '../types';
  * Properties for defining a Parallel state
  */
 export interface ParallelProps {
+  /**
+   * Optional name for this state
+   *
+   * @default - The construct ID will be used as state name
+   */
+  readonly stateName?: string;
+
   /**
    * An optional description for this state
    *

packages/aws-cdk-lib/aws-stepfunctions/lib/states/pass.ts

@@ -56,6 +56,13 @@ export class Result {
  * Properties for defining a Pass state
  */
 export interface PassProps {
+  /**
+   * Optional name for this state
+   *
+   * @default - The construct ID will be used as state name
+   */
+  readonly stateName?: string;
+
   /**
    * An optional description for this state
    *

packages/aws-cdk-lib/aws-stepfunctions/lib/states/state.ts

@@ -9,6 +9,13 @@ import { CatchProps, Errors, IChainable, INextable, RetryProps } from '../types'
  * Properties shared by all states
  */
 export interface StateProps {
+  /**
+   * Optional name for this state
+   *
+   * @default - The construct ID will be used as state name
+   */
+  readonly stateName?: string;
+
   /**
    * A comment describing this state
    *
@@ -155,6 +162,7 @@ export abstract class State extends Construct implements IChainable {
   // features are shared by a couple of states, and it becomes cumbersome to
   // slice it out across all states. This is not great design, but it is
   // pragmatic!
+  protected readonly stateName?: string;
   protected readonly comment?: string;
   protected readonly inputPath?: string;
   protected readonly parameters?: object;
@@ -194,6 +202,7 @@ export abstract class State extends Construct implements IChainable {
 
     this.startState = this;
 
+    this.stateName = props.stateName;
     this.comment = props.comment;
     this.inputPath = props.inputPath;
     this.parameters = props.parameters;
@@ -219,7 +228,7 @@ export abstract class State extends Construct implements IChainable {
    * Tokenized string that evaluates to the state's ID
    */
   public get stateId(): string {
-    return this.prefixes.concat(this.id).join('');
+    return this.prefixes.concat(this.stateName? this.stateName: this.id).join('');
   }
 
   /**

packages/aws-cdk-lib/aws-stepfunctions/lib/states/succeed.ts

@@ -7,6 +7,13 @@ import { INextable } from '../types';
  * Properties for defining a Succeed state
  */
 export interface SucceedProps {
+  /**
+   * Optional name for this state
+   *
+   * @default - The construct ID will be used as state name
+   */
+  readonly stateName?: string;
+
   /**
    * An optional description for this state
    *

packages/aws-cdk-lib/aws-stepfunctions/lib/states/task-base.ts

@@ -13,6 +13,13 @@ import { CatchProps, IChainable, INextable, RetryProps } from '../types';
  * Props that are common to all tasks
  */
 export interface TaskStateBaseProps {
+  /**
+   * Optional name for this state
+   *
+   * @default - The construct ID will be used as state name
+   */
+  readonly stateName?: string;
+
   /**
    * An optional description for this state
    *

packages/aws-cdk-lib/aws-stepfunctions/lib/states/task.ts

@@ -21,6 +21,13 @@ export interface TaskProps {
    */
   readonly task: IStepFunctionsTask;
 
+  /**
+   * Optional name for this state
+   *
+   * @default - The construct ID will be used as state name
+   */
+  readonly stateName?: string;
+
   /**
    * An optional description for this state
    *

packages/aws-cdk-lib/aws-stepfunctions/lib/states/wait.ts

@@ -50,6 +50,13 @@ export class WaitTime {
  * Properties for defining a Wait state
  */
 export interface WaitProps {
+  /**
+   * Optional name for this state
+   *
+   * @default - The construct ID will be used as state name
+   */
+  readonly stateName?: string;
+
   /**
    * An optional description for this state
    *

packages/aws-cdk-lib/aws-stepfunctions/test/custom-state.test.ts

@@ -41,15 +41,17 @@ describe('Custom State', () => {
     // WHEN
     const definition = new sfn.CustomState(stack, 'Custom', {
       stateJson,
-    }).next(new sfn.Pass(stack, 'MyPass'));
+    }).next(new sfn.Pass(stack, 'MyPass', {
+      stateName: 'my-pass-state',
+    }));
 
     // THEN
     expect(render(stack, definition)).toStrictEqual(
       {
         StartAt: 'Custom',
         States: {
-          Custom: {
-            Next: 'MyPass',
+          'Custom': {
+            Next: 'my-pass-state',
             Type: 'Task',
             Resource: 'arn:aws:states:::dynamodb:putItem',
             Parameters: {
@@ -62,7 +64,7 @@ describe('Custom State', () => {
             },
             ResultPath: null,
           },
-          MyPass: {
+          'my-pass-state': {
             Type: 'Pass',
             End: true,
           },

packages/aws-cdk-lib/aws-stepfunctions/test/fail.test.ts

@@ -1,10 +1,67 @@
+import { render } from './private/render-util';
 import * as cdk from '../../core';
 import * as stepfunctions from '../lib';
 
 describe('Fail State', () => {
-  test('Props are optional', () => {
-    const stack = new cdk.Stack();
+  let stack: cdk.Stack;
+  let stateJson: any;
+
+  beforeEach(() => {
+    // GIVEN
+    stack = new cdk.Stack();
+    stateJson = {
+      Type: 'Task',
+      Resource: 'arn:aws:states:::dynamodb:putItem',
+      Parameters: {
+        TableName: 'MyTable',
+        Item: {
+          id: {
+            S: 'MyEntry',
+          },
+        },
+      },
+      ResultPath: null,
+    };
+  });
 
+  test('Props are optional', () => {
     new stepfunctions.Fail(stack, 'Fail');
   });
+
+  test('can add a fail state to the chain with custom state name', () => {
+  // WHEN
+    const definition = new stepfunctions.CustomState(stack, 'Custom1', {
+      stateJson,
+    }).next(new stepfunctions.Pass(stack, 'MyPass'))
+      .next(new stepfunctions.Fail(stack, 'Fail', {
+        stateName: 'my-fail-state',
+        comment: 'failing state',
+        errorPath: stepfunctions.JsonPath.stringAt('$.error'),
+        causePath: stepfunctions.JsonPath.stringAt('$.cause'),
+      }));
+
+    // THEN
+    expect(render(stack, definition)).toStrictEqual(
+      {
+        StartAt: 'Custom1',
+        States: {
+          'Custom1': {
+            Next: 'MyPass',
+            Type: 'Task',
+            ...stateJson,
+          },
+          'MyPass': {
+            Type: 'Pass',
+            Next: 'my-fail-state',
+          },
+          'my-fail-state': {
+            Comment: 'failing state',
+            Type: 'Fail',
+            CausePath: '$.cause',
+            ErrorPath: '$.error',
+          },
+        },
+      },
+    );
+  });
 });

packages/aws-cdk-lib/aws-stepfunctions/test/map.test.ts

@@ -8,6 +8,7 @@ describe('Map State', () => {
 
     // WHEN
     const map = new stepfunctions.Map(stack, 'Map State', {
+      stateName: 'My-Map-State',
       maxConcurrency: 1,
       itemsPath: stepfunctions.JsonPath.stringAt('$.inputForMap'),
       parameters: {
@@ -19,9 +20,9 @@ describe('Map State', () => {
 
     // THEN
     expect(render(map)).toStrictEqual({
-      StartAt: 'Map State',
+      StartAt: 'My-Map-State',
       States: {
-        'Map State': {
+        'My-Map-State': {
           Type: 'Map',
           End: true,
           Parameters: {

packages/aws-cdk-lib/aws-stepfunctions/test/parallel.test.ts

@@ -8,7 +8,7 @@ describe('Parallel State', () => {
 
     // WHEN
     const parallel = new stepfunctions.Parallel(stack, 'Parallel State');
-    parallel.branch(new stepfunctions.Pass(stack, 'Branch 1'));
+    parallel.branch(new stepfunctions.Pass(stack, 'Branch 1', { stateName: 'first-pass-state' }));
     parallel.branch(new stepfunctions.Pass(stack, 'Branch 2'));
 
     // THEN
@@ -19,7 +19,7 @@ describe('Parallel State', () => {
           Type: 'Parallel',
           End: true,
           Branches: [
-            { StartAt: 'Branch 1', States: { 'Branch 1': { Type: 'Pass', End: true } } },
+            { StartAt: 'first-pass-state', States: { 'first-pass-state': { Type: 'Pass', End: true } } },
             { StartAt: 'Branch 2', States: { 'Branch 2': { Type: 'Pass', End: true } } },
           ],
         },

packages/aws-cdk-lib/aws-stepfunctions/test/state-machine-resources.test.ts

@@ -642,6 +642,7 @@ describe('State Machine Resources', () => {
     // GIVEN
     const stack = new cdk.Stack();
     const task = new stepfunctions.Pass(stack, 'Pass', {
+      stateName: 'my-pass-state',
       inputPath: '$',
       outputPath: '$.state',
       parameters: {

packages/aws-cdk-lib/aws-stepfunctions/test/wait.test.ts

@@ -75,4 +75,25 @@ describe('Wait State', () => {
     });
   });
 
+  test('supports adding a custom state name', () => {
+    // GIVEN
+    const stack = new cdk.Stack();
+    const waitTime = new Wait(stack, 'myWaitState', {
+      stateName: 'wait-state-custom-name',
+      time: WaitTime.duration(cdk.Duration.seconds(30)),
+    });
+
+    // THEN
+    expect(render(stack, waitTime)).toEqual({
+      StartAt: 'wait-state-custom-name',
+      States: {
+        'wait-state-custom-name': {
+          Seconds: 30,
+          Type: 'Wait',
+          End: true,
+        },
+      },
+    });
+  });
+
 });