feat(stepfunctions): add comment ability for when condition

[msambol]

Currently you can comment on a Choice state.
This adds the ability to comment on a when condition.

Closes #27005.

---

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

[kaizencc]

Thanks for contributing this @msambol. Just a minor nit on how the function looks

[kaizencc]

Ideally this function would be

protected addChoice(choice: ChoiceTransition) {
  this.choices.push(choice);
}

but I guess we can't change the function signature now

[kaizencc]

I wonder if we can do this to help make this function signature stable if we ever add more props to ChoiceTransition:

interface ChoiceTransition extends ChoiceTransitionOptions {
  condition;
  next;
}

interface ChoiceTransitionOptions {
  comment?;
}

protected addChoice(condition: Condition, next: State, options: ChoiceTransitionOptions) {}

This has 2 benefits:

• using the function would look like

choice.when(sfn.Condition.stringEquals('$.color', 'BLUE'), handleBlueItem, {
  comment: 'blue item comment',
});

which imo makes it clear that we're providing a comment.

• if we add an additional prop to ChoiceTransition in the future, like default or something, we can easily add it to ChoiceTransitionOptions

Pull request has been modified.

[msambol]

@kaizencc I updated per your feedback—thanks!

[kaizencc]

@msambol what was the reason for naming this IChoiceTransitionOptions? I assume you ran into some linter rule that yelled at you? Want to find out because I don't think it makes sense here, and we should exempt this from that rule if thats the case

[msambol]

@kaizencc Yep, I got:

aws-cdk-lib:     The declaring class is introduced here
aws-cdk-lib: aws-stepfunctions/lib/states/state.ts:503:3 - error JSII3008: The "comment" property of struct "aws-cdk-lib.aws_stepfunctions.ChoiceTransitionOptions" must be "readonly". Rename "aws-cdk-lib.aws_stepfunctions.ChoiceTransitionOptions" to "IChoiceTransitionOptions" if it is meant to be a behavioral interface.

[msambol]

@kaizencc From what I'm reading there isn't a way to silence JSII errors? Hmm..

[jogold]

does this fix the JSII error maybe?

Suggested change

	comment?: string;
	readonly comment?: string;

[msambol]

@jogold It did. Good shout, Jonathan. I was following the pattern of state and condition but there is no reason this can't be readonly.

[msambol]

@kaizencc Mind taking another look here?

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: feb3c0a
• Result: SUCCEEDED
• Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).