fix(stepfunctions-tasks): allow passing apiEndpoint as intrinsic function

[MathieuGilbert]

Issue #29925

Closes #29925, #30749.

Reason for this change

The apiEndpoint prop currently only works when it's a string (ie. TaskInput.fromText('some/text')), with the task failing when passed as a reference (ie. TaskInput.fromText(JsonPath.format('some/text/{}', '123')). This is needed to allow for dynamic parts in the path.

Description of changes

• Change the ApiEndpoint task parameter to use the JsonPath.format intrinsic function to combine the apiRoot and apiEndpoint props, instead of basic string concatenation.
• Update README entry with more complex example.

Description of how you validated changes

• A unit test was added to cover passing formatted input.
• A test stack was deployed with an API Gateway endpoint at GET /testing with basic auth Connection and was successfully invoked with task and payload { "endpointName: "testing" }:

    const httpInvokeTask = new HttpInvoke(this, 'HttpInvoke', {
      apiRoot: api.url,
      apiEndpoint: TaskInput.fromJsonPathAt('$.endpointName'),
      method: TaskInput.fromText('GET'),
      connection,
      outputPath: '$.ResponseBody',
    })

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

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

[MathieuGilbert]

Clarification Request

What is the process for updating integration tests? My previous attempts failed in CI due to snapshots not matching, which they shouldn't when the test changes.

[aws-cdk-automation]

This PR has been in the CHANGES REQUESTED 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.

[ePak]

Clarification Request

What is the process for updating integration tests? My previous attempts failed in CI due to snapshots not matching, which they shouldn't when the test changes.

Hi @MathieuGilbert,

The instruction to create/update the integration tests is in here.
I was trying to write the tests and put up a PR for your branch but the setup of the integration tests are in the us-east-1 AWS region which has been restricted in my employer's AWS account unfortunately.

I think we can just use integ.invoke.ts as the starting point and update line 68 to use TaskInput.fromJsonPathAt().

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: 19a8a75
• Result: FAILED
• Build Logs (available for 30 days)

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

[ePak]

Hi @MathieuGilbert, maybe I wasn't very clear before but this was what I meant. Although, like I have said, I am not able to run the test due to account restriction.
We should be adding a new test rather than modifying the existing one because there should be separate tests for using plain text and from json path.

And then I believe you need to run yarn integ --update-on-failed integ.lambda.js and npm test (documented here) afterward to deal with the integration snapshots that the aws-cdk-automation bot has been complaining about.

[aws-cdk-automation]

This PR has been deemed to be abandoned, and will be automatically closed. Please create a new PR for these changes if you think this decision has been made in error.

[github-actions]

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.

[aws-cdk-automation]

The pull request linter fails with the following errors:

❌ Fixes must contain a change to an integration test file and the resulting snapshot.

PRs must pass status checks before we can provide a meaningful review.

If you would like to request an exemption from the status checks or clarification on feedback, please leave a comment on this PR containing Exemption Request and/or Clarification Request.