fix(stepfunctions-tasks): `CallAwsServiceCrossRegion` doesn't work with WAIT_FOR_TASK_TOKEN #32807

tmokmss · 2025-01-09T05:53:42Z

Issue # (if applicable)

Reason for this change

The Step Functions task CallAwsServiceCrossRegion did not work with integrationPattern.WAIT_FOR_TASK_TOKEN. This PR fixes the problem.

Description of changes

The root cause of this problem is that we used an alterntive form of calling Lambda Invoke, which does not support waitForTaskToken integration pattern.

Alternatively, you can invoke a Lambda function by specifying a function ARN directly in the "Resource" field. When you invoke a Lambda function in this way, you can't specify .waitForTaskToken, and the task result contains only the function output.

https://docs.aws.amazon.com/step-functions/latest/dg/connect-lambda.html#connect-lambda-api-examples

This PR fixes the code to align with the implementation in LambdaInvoke task, which supports both integration pattern.

aws-cdk/packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/lambda/invoke.ts

Lines 146 to 165 in bbdd42c

    
             protected _renderTask(): any { 
        
               if (this.props.payloadResponseOnly) { 
        
                 return { 
        
                   Resource: this.props.lambdaFunction.functionArn, 
        
                   ...this.props.payload && { Parameters: sfn.FieldUtils.renderObject(this.props.payload.value) }, 
        
                 }; 
        
               } else { 
        
                 return { 
        
                   Resource: integrationResourceArn('lambda', 'invoke', this.integrationPattern), 
        
                   Parameters: sfn.FieldUtils.renderObject({ 
        
                     FunctionName: this.props.lambdaFunction.functionArn, 
        
                     Payload: this.props.payload ? this.props.payload.value : sfn.TaskInput.fromJsonPathAt('$').value, 
        
                     InvocationType: this.props.invocationType, 
        
                     ClientContext: this.props.clientContext, 
        
                     Qualifier: this.props.qualifier, 
        
                   }), 
        
                 }; 
        
               } 
        
             } 
        
           }

To fix this without breaking changes, we introduce payloadResponseOnly property (true by default), and fix the _renderTask method as above. Users who need other integration patterns can set payloadResponseOnly: false.

Additionally we throw an error if payloadResponseOnly == true && integrationPattern != REQUEST_RESPONSE to prevent misconfiguration. This is not a breaking change because the construct previously did not work at all when integrationPattern != REQUEST_RESPONSE.

Describe any new or updated permissions being added

No.

Description of how you validated changes

Added 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

… WAIT_FOR_TASK_TOKEN

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

codecov · 2025-01-09T06:12:44Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.92%. Comparing base (f1d9a7d) to head (b3251d0).
Report is 12 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #32807   +/-   ##
=======================================
  Coverage   80.92%   80.92%           
=======================================
  Files         236      236           
  Lines       14253    14253           
  Branches     2490     2490           
=======================================
  Hits        11534    11534           
  Misses       2434     2434           
  Partials      285      285

Flag	Coverage Δ
suite.unit	`80.92% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
packages/aws-cdk	`79.73% <ø> (ø)`
packages/aws-cdk-lib/core	`82.20% <ø> (ø)`

packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/lambda/call-aws-service-cross-region.ts

QuantumNeuralCoder

See comment on default value set for payloadResponseOnly

aws-cdk-automation · 2025-02-02T00:13:35Z

This PR has been in the MERGE CONFLICTS state for 3 weeks, and looks abandoned. To keep this PR from being closed, please continue work on it. If not, it will automatically be closed in a week.

Pull request has been modified.

QuantumNeuralCoder

Please see the proposed change.

packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/lambda/call-aws-service-cross-region.ts

Pull request has been modified.

QuantumNeuralCoder · 2025-02-06T17:59:46Z

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

@@ -265,6 +265,8 @@ const getObject = new tasks.CallAwsServiceCrossRegion(this, 'GetObject', {

 Other properties such as `additionalIamStatements` can be used in the same way as the `CallAwsService` task.

+Note that when you use `integrationPattern.WAIT_FOR_TASK_TOKEN`, the output path changes under `Payload` property.


Nice. Thanks for adding.

mergify · 2025-02-06T18:44:02Z

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 · 2025-02-06T18:48:46Z

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

mrgrain · 2025-02-06T19:34:21Z

@Mergifyio dequeue

mergify · 2025-02-06T19:34:50Z

This pull request has been removed from the queue for the following reason: pull request dequeued.

Pull request #32807 has been dequeued by a dequeue command

You should look at the reason for the failure and decide if the pull request needs to be fixed or if you want to requeue it.

If you want to requeue this pull request, you need to post a comment with the text: @mergifyio requeue

mergify · 2025-02-06T19:34:51Z

dequeue

✅ The pull request has been removed from the queue `default-squash`

mrgrain · 2025-02-06T19:53:11Z

@Mergifyio requeue

mergify · 2025-02-06T19:53:17Z

requeue

✅ The queue state of this pull request has been cleaned. It can be re-embarked automatically

mergify · 2025-02-06T20:25:14Z

This pull request has been removed from the queue for the following reason: pull request manually updated.

The pull request #32807 has been manually updated

You should look at the reason for the failure and decide if the pull request needs to be fixed or if you want to requeue it.

If you want to requeue this pull request, you need to post a comment with the text: @mergifyio requeue

Pull request has been modified.

QuantumNeuralCoder · 2025-02-07T23:59:13Z

@Mergifyio requeue

mergify · 2025-02-07T23:59:38Z

requeue

❌ This pull request head commit has not been previously disembarked from queue.

aws-cdk-automation · 2025-02-08T00:30:07Z

AWS CodeBuild CI Report

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

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

mergify · 2025-02-08T00:30:23Z

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 · 2025-02-08T00:35:18Z

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

github-actions · 2025-02-08T00:36:44Z

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(stepfunctions-tasks): CallAwsServiceCrossRegion doesn't work with…

cbd8ecf

… WAIT_FOR_TASK_TOKEN

aws-cdk-automation requested a review from a team January 9, 2025 05:53

github-actions bot added bug This issue is a bug. effort/small Small work item – less than a day of effort p2 star-contributor [Pilot] contributed between 25-49 PRs to the CDK labels Jan 9, 2025

aws-cdk-automation previously requested changes Jan 9, 2025

View reviewed changes

tmokmss changed the title ~~fix(stepfunctions-tasks): CallAwsServiceCrossRegion doesn't work with WAIT_FOR_TASK_TOKEN~~ fix(stepfunctions-tasks): CallAwsServiceCrossRegion doesn't work with WAIT_FOR_TASK_TOKEN Jan 9, 2025

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

mazyu36 approved these changes Jan 23, 2025

View reviewed changes

aws-cdk-automation added pr/needs-maintainer-review This PR needs a review from a Core Team Member and removed pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. labels Jan 23, 2025

QuantumNeuralCoder self-assigned this Jan 28, 2025

QuantumNeuralCoder reviewed Jan 28, 2025

View reviewed changes

packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/lambda/call-aws-service-cross-region.ts Outdated Show resolved Hide resolved

QuantumNeuralCoder previously requested changes Jan 28, 2025

View reviewed changes

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jan 28, 2025

tmokmss requested a review from QuantumNeuralCoder January 29, 2025 00:35

github-actions bot mentioned this pull request Feb 1, 2025

Monthly PR metrics report #33266

Open

tmokmss added 2 commits February 2, 2025 12:36

merge

31e10b6

Update call-aws-service-cross-region.ts

4aac990

update integ

c376ea3

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Feb 2, 2025

Merge branch 'main' into aws-sdk-cr-task-token

604bb29

QuantumNeuralCoder previously requested changes Feb 4, 2025

View reviewed changes

packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/lambda/call-aws-service-cross-region.ts Outdated Show resolved Hide resolved

remove payloadResponseOnly and switch by integrationPattern

31c4e3c

QuantumNeuralCoder reviewed Feb 6, 2025

View reviewed changes

Merge branch 'main' into aws-sdk-cr-task-token

ea92806

QuantumNeuralCoder previously approved these changes Feb 6, 2025

View reviewed changes

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Feb 6, 2025

Merge branch 'main' into aws-sdk-cr-task-token

76db746

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Feb 6, 2025

QuantumNeuralCoder added 3 commits February 6, 2025 16:42

Merge branch 'main' into aws-sdk-cr-task-token

43135b3

Merge branch 'main' into aws-sdk-cr-task-token

6d2950e

Merge branch 'main' into aws-sdk-cr-task-token

b3251d0

QuantumNeuralCoder approved these changes Feb 8, 2025

View reviewed changes

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Feb 8, 2025

QuantumNeuralCoder merged commit 800b775 into aws:main Feb 8, 2025
22 of 23 checks passed

github-actions bot locked as resolved and limited conversation to collaborators Feb 8, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(stepfunctions-tasks): `CallAwsServiceCrossRegion` doesn't work with WAIT_FOR_TASK_TOKEN #32807

fix(stepfunctions-tasks): `CallAwsServiceCrossRegion` doesn't work with WAIT_FOR_TASK_TOKEN #32807

tmokmss commented Jan 9, 2025 •

edited

Loading

aws-cdk-automation left a comment

codecov bot commented Jan 9, 2025 •

edited

Loading

QuantumNeuralCoder left a comment

aws-cdk-automation commented Feb 2, 2025

QuantumNeuralCoder left a comment

QuantumNeuralCoder Feb 6, 2025

mergify bot commented Feb 6, 2025

mergify bot commented Feb 6, 2025

mrgrain commented Feb 6, 2025

mergify bot commented Feb 6, 2025

mergify bot commented Feb 6, 2025

mrgrain commented Feb 6, 2025

mergify bot commented Feb 6, 2025

mergify bot commented Feb 6, 2025

QuantumNeuralCoder commented Feb 7, 2025

mergify bot commented Feb 7, 2025

aws-cdk-automation commented Feb 8, 2025

mergify bot commented Feb 8, 2025

mergify bot commented Feb 8, 2025

github-actions bot commented Feb 8, 2025

	protected _renderTask(): any {
	if (this.props.payloadResponseOnly) {
	return {
	Resource: this.props.lambdaFunction.functionArn,
	...this.props.payload && { Parameters: sfn.FieldUtils.renderObject(this.props.payload.value) },
	};
	} else {
	return {
	Resource: integrationResourceArn('lambda', 'invoke', this.integrationPattern),
	Parameters: sfn.FieldUtils.renderObject({
	FunctionName: this.props.lambdaFunction.functionArn,
	Payload: this.props.payload ? this.props.payload.value : sfn.TaskInput.fromJsonPathAt('$').value,
	InvocationType: this.props.invocationType,
	ClientContext: this.props.clientContext,
	Qualifier: this.props.qualifier,
	}),
	};
	}
	}
	}

		@@ -265,6 +265,8 @@ const getObject = new tasks.CallAwsServiceCrossRegion(this, 'GetObject', {

		Other properties such as `additionalIamStatements` can be used in the same way as the `CallAwsService` task.

		Note that when you use `integrationPattern.WAIT_FOR_TASK_TOKEN`, the output path changes under `Payload` property.

fix(stepfunctions-tasks): CallAwsServiceCrossRegion doesn't work with WAIT_FOR_TASK_TOKEN #32807

fix(stepfunctions-tasks): CallAwsServiceCrossRegion doesn't work with WAIT_FOR_TASK_TOKEN #32807

Conversation

tmokmss commented Jan 9, 2025 • edited Loading

Issue # (if applicable)

Reason for this change

Description of changes

Describe any new or updated permissions being added

Description of how you validated changes

Checklist

aws-cdk-automation left a comment

Choose a reason for hiding this comment

codecov bot commented Jan 9, 2025 • edited Loading

Codecov Report

QuantumNeuralCoder left a comment

Choose a reason for hiding this comment

aws-cdk-automation commented Feb 2, 2025

QuantumNeuralCoder left a comment

Choose a reason for hiding this comment

QuantumNeuralCoder Feb 6, 2025

Choose a reason for hiding this comment

mergify bot commented Feb 6, 2025

mergify bot commented Feb 6, 2025

mrgrain commented Feb 6, 2025

mergify bot commented Feb 6, 2025

mergify bot commented Feb 6, 2025

✅ The pull request has been removed from the queue default-squash

mrgrain commented Feb 6, 2025

mergify bot commented Feb 6, 2025

✅ The queue state of this pull request has been cleaned. It can be re-embarked automatically

mergify bot commented Feb 6, 2025

QuantumNeuralCoder commented Feb 7, 2025

mergify bot commented Feb 7, 2025

❌ This pull request head commit has not been previously disembarked from queue.

aws-cdk-automation commented Feb 8, 2025

AWS CodeBuild CI Report

mergify bot commented Feb 8, 2025

mergify bot commented Feb 8, 2025

github-actions bot commented Feb 8, 2025

fix(stepfunctions-tasks): `CallAwsServiceCrossRegion` doesn't work with WAIT_FOR_TASK_TOKEN #32807

fix(stepfunctions-tasks): `CallAwsServiceCrossRegion` doesn't work with WAIT_FOR_TASK_TOKEN #32807

tmokmss commented Jan 9, 2025 •

edited

Loading

codecov bot commented Jan 9, 2025 •

edited

Loading

✅ The pull request has been removed from the queue `default-squash`