aws / aws/aws-cdk

cdk.aws_stepfunctions.StateMachine: timeout does not apply to .asl.json definition

Open
#37,150 2 comments 0 reactions 0 assignees View on GitHub
@aws-cdk/aws-stepfunctions bug documentation good first issue p2
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
1d 19h
Merged PRs (30d)
74

Description

### Describe the issue

It seems that the timeout argument to `new cdk.aws_stepfunctions.StateMachine` is only applied when the definitionBody is a `ChainDefinitionBody`. The only reference I can find is here: https://github.com/aws/aws-cdk/blob/ebfaf89e6a9018d19eb29dcb42f2a1ec93e81d57/packages/aws-cdk-lib/aws-stepfunctions/lib/state-machine.ts#L486

This behavior is unclear from the documentation:
https://github.com/aws/aws-cdk/blob/ebfaf89e6a9018d19eb29dcb42f2a1ec93e81d57/packages/aws-cdk-lib/aws-stepfunctions/lib/state-machine.ts#L127

For users that provide a `.asl.json` definitionBody, this can cause unexpected behavior.

### Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.StateMachine.html#timeout

Contributor guide

Open the contributing guide

Research direction

Start in packages/aws-cdk-lib/aws-stepfunctions/lib/state-machine.ts at the timeout handling around the referenced line, and compare the behavior for ChainDefinitionBody with a .asl.json definitionBody. Check the StateMachine timeout documentation and existing related tests, then ensure the documented timeout behavior matches both definition forms.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, typescript
Domain
cloud, infrastructure
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.