fix(stepfunctions): add docs and warning DistributedMap Class ignores executionType in the ProcessorConfig #30301

mazyu36 · 2024-05-22T04:10:02Z

Issue # (if applicable)

Reason for this change

In #27913, the ItemProcessor was introduced for use with the Map Class. With the executionType in the ProcessorConfig, it was possible to specify the executionType for the Map.
On the other hand, in #28821, the DistributedMap Class was introduced. The mapExecutionType of the DistributedMap class always overwrites the executionType of the ProcessorConfig.
Therefore, when using the DistributedMap class, the implementation ignores the executionType of the ProcessorConfig. However, this behavior cannot be inferred from the documentation.

Description of changes

Added to the docs that when using the DistributedMap Class, the executionType in the ProcessorConfig is ignored.
Also added a warning.

Description of how you validated changes

Add unit tests and integ tests

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

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

mazyu36 · 2024-05-22T04:12:05Z

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

@@ -234,9 +235,10 @@ export class DistributedMap extends MapBase implements INextable {
   */
  public toStateJson(): object {
    let rendered: any = super.toStateJson();
-    if (this.mapExecutionType) {


Removed this conditional statement as it is meaningless, because in the following code, mapExecutionType is always set, making the condition always evaluate to true.

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

Line 129 in a37bc72

this.mapExecutionType = props.mapExecutionType ?? StateMachineType.STANDARD;

gracelu0

Hi @mazyu36 , thanks for working on this! Could you add a note in the docstring for the mapExecutionType property and update the README file as well so users know they should use that property to set the execution type for ItemProcessor. Thanks!

packages/aws-cdk-lib/aws-stepfunctions/lib/types.ts

Co-authored-by: Grace Luo <[email protected]>

Pull request has been modified.

mazyu36 · 2024-06-01T06:40:46Z

@gracelu0
Thank you for the review!
I have updated the documentation and README.

gracelu0 · 2024-06-03T17:17:07Z

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

@@ -595,6 +595,21 @@ const distributedMap = new sfn.DistributedMap(this, 'Distributed Map State', {
 distributedMap.itemProcessor(new sfn.Pass(this, 'Pass State'));
 ```

+If you want to specify the execution type for the DistributedMap, you must set the `mapExecutionType` property in the `DistributedMap` class. When using the `DistributedMap` class, the `ProcessorConfig.executionType` property is ignored.


Do we mean 'execution type for ItemProcessor'? I don't see a mapExecutionType property in the docs

Thank you for the review.
As you correctly understood, I have revised the expression to 'ItemProcessor in the DistributedMap' for more accurate phrasing.

gracelu0 · 2024-06-03T17:18:04Z

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

@@ -595,6 +595,21 @@ const distributedMap = new sfn.DistributedMap(this, 'Distributed Map State', {
 distributedMap.itemProcessor(new sfn.Pass(this, 'Pass State'));
 ```

+If you want to specify the execution type for the DistributedMap, you must set the `mapExecutionType` property in the `DistributedMap` class. When using the `DistributedMap` class, the `ProcessorConfig.executionType` property is ignored.
+
+In the following example, the execution type for the DistributedMap is set to `EXPRESS` based on the value specified for `mapExecutionType`.


Same as above, itemProcessor instead of DistributedMap?

I have made the same revision as the one above.

gracelu0 · 2024-06-13T16:57:18Z

@Mergifyio update

mergify · 2024-06-13T16:57:35Z

update

✅ Branch has been successfully updated

gracelu0

Thank you for contributing!

aws-cdk-automation · 2024-06-13T17:45:39Z

AWS CodeBuild CI Report

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

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

mergify · 2024-06-13T17:45:55Z

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).

… executionType in the ProcessorConfig (aws#30301) ### Issue # (if applicable) Closes aws#30194 ### Reason for this change In aws#27913, the ItemProcessor was introduced for use with the Map Class. With the executionType in the ProcessorConfig, it was possible to specify the executionType for the Map. On the other hand, in aws#28821, the DistributedMap Class was introduced. The mapExecutionType of the DistributedMap class always overwrites the executionType of the ProcessorConfig. Therefore, when using the DistributedMap class, the implementation ignores the executionType of the ProcessorConfig. However, this behavior cannot be inferred from the documentation. ### Description of changes * Added to the docs that when using the DistributedMap Class, the executionType in the ProcessorConfig is ignored. * Also added a warning. ### Description of how you validated changes Add unit tests and integ tests ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

aws-cdk-automation · 2024-07-25T21:06:34Z

Comments on closed issues and PRs are hard for our team to see. If you need help, please open a new issue that references this one.

fix: executionType setting in the DestributedMap Construct

a37bc72

github-actions bot added bug This issue is a bug. valued-contributor [Pilot] contributed between 6-12 PRs to the CDK effort/small Small work item – less than a day of effort p2 labels May 22, 2024

aws-cdk-automation requested a review from a team May 22, 2024 04:10

mazyu36 commented May 22, 2024

View reviewed changes

chore: import fixed

bec3d36

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label May 22, 2024

github-actions bot mentioned this pull request May 27, 2024

Weekly PR metrics report #30348

Closed

gracelu0 previously requested changes May 31, 2024

View reviewed changes

packages/aws-cdk-lib/aws-stepfunctions/lib/types.ts Outdated Show resolved Hide resolved

aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label May 31, 2024

github-actions bot mentioned this pull request Jun 1, 2024

Monthly PR metrics report #30414

Closed

Update packages/aws-cdk-lib/aws-stepfunctions/lib/types.ts

180f0f9

Co-authored-by: Grace Luo <[email protected]>

docs: update tsdocs and README

931dfce

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jun 1, 2024

docs: update README

7bb3d86

gracelu0 reviewed Jun 3, 2024

View reviewed changes

chore: docs update

c5b8b0c

mazyu36 force-pushed the sfn-distributed-map-execution-type-30194 branch from d631069 to c5b8b0c Compare June 4, 2024 01:49

Merge branch 'main' into sfn-distributed-map-execution-type-30194

b9896ea

Merge branch 'main' into sfn-distributed-map-execution-type-30194

5f27336

gracelu0 approved these changes Jun 13, 2024

View reviewed changes

mergify bot merged commit 0499adf into aws:main Jun 13, 2024
10 checks passed

mazyu36 deleted the sfn-distributed-map-execution-type-30194 branch June 18, 2024 14:37

This was referenced Jul 12, 2024

[Snyk] Upgrade: , aws-cdk NOUIY/aws-solutions-constructs#108

Open

[Snyk] Upgrade: , aws-cdk NOUIY/aws-solutions-constructs#109

Open

This was referenced Jul 19, 2024

[Snyk] Upgrade: , aws-cdk NOUIY/aws-solutions-constructs#110

Open

[Snyk] Upgrade: , aws-cdk NOUIY/aws-solutions-constructs#111

Open

aws locked as resolved and limited conversation to collaborators Jul 25, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(stepfunctions): add docs and warning DistributedMap Class ignores executionType in the ProcessorConfig #30301

fix(stepfunctions): add docs and warning DistributedMap Class ignores executionType in the ProcessorConfig #30301

mazyu36 commented May 22, 2024

mazyu36 May 22, 2024

gracelu0 left a comment

mazyu36 commented Jun 1, 2024

gracelu0 Jun 3, 2024

mazyu36 Jun 4, 2024

gracelu0 Jun 3, 2024

mazyu36 Jun 4, 2024

gracelu0 commented Jun 13, 2024

mergify bot commented Jun 13, 2024

gracelu0 left a comment

aws-cdk-automation commented Jun 13, 2024

mergify bot commented Jun 13, 2024

aws-cdk-automation commented Jul 25, 2024

fix(stepfunctions): add docs and warning DistributedMap Class ignores executionType in the ProcessorConfig #30301

fix(stepfunctions): add docs and warning DistributedMap Class ignores executionType in the ProcessorConfig #30301

Conversation

mazyu36 commented May 22, 2024

Issue # (if applicable)

Reason for this change

Description of changes

Description of how you validated changes

Checklist

mazyu36 May 22, 2024

Choose a reason for hiding this comment

gracelu0 left a comment

Choose a reason for hiding this comment

mazyu36 commented Jun 1, 2024

gracelu0 Jun 3, 2024

Choose a reason for hiding this comment

mazyu36 Jun 4, 2024

Choose a reason for hiding this comment

gracelu0 Jun 3, 2024

Choose a reason for hiding this comment

mazyu36 Jun 4, 2024

Choose a reason for hiding this comment

gracelu0 commented Jun 13, 2024

mergify bot commented Jun 13, 2024

✅ Branch has been successfully updated

gracelu0 left a comment

Choose a reason for hiding this comment

aws-cdk-automation commented Jun 13, 2024

AWS CodeBuild CI Report

mergify bot commented Jun 13, 2024

aws-cdk-automation commented Jul 25, 2024