Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

MathieuGilbert
Copy link
Contributor

@MathieuGilbert MathieuGilbert commented Nov 14, 2024

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.
  • An integration test was added using fromJsonPathAt for the endpoint.
  • A test stack was deployed with an API Gateway endpoint with basic auth Connection and was successfully invoked with dynamic payload:
    const httpInvokeTask = new HttpInvoke(this, 'HttpInvoke', {
      apiRoot: api.url,
      apiEndpoint: TaskInput.fromJsonPathAt('$.endpointName'),
      method: TaskInput.fromText('GET'),
      connection,
      outputPath: '$.ResponseBody',
    })

Checklist


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

@github-actions github-actions bot added the beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK label Nov 14, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team November 14, 2024 20:49
@github-actions github-actions bot added bug This issue is a bug. effort/small Small work item – less than a day of effort p2 labels Nov 14, 2024
Copy link

codecov bot commented Nov 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.32%. Comparing base (512cf95) to head (bd13e87).

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #32139      +/-   ##
==========================================
- Coverage   78.34%   78.32%   -0.02%     
==========================================
  Files         105      105              
  Lines        7170     7170              
  Branches     1315     1315              
==========================================
- Hits         5617     5616       -1     
- Misses       1365     1366       +1     
  Partials      188      188              
Flag Coverage Δ
suite.unit 78.32% <ø> (-0.02%) ⬇️

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

Components Coverage Δ
packages/aws-cdk 78.32% <ø> (-0.02%) ⬇️

@MathieuGilbert MathieuGilbert force-pushed the awsstepfunctions-httpinvoke-format-apiendpoint-integ branch from de76858 to b278145 Compare November 15, 2024 00:19
@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Nov 15, 2024
@MathieuGilbert
Copy link
Contributor Author

Thanks for your help in getting these changes to green @ePak. I think it was the npm test after running the old tests that got it to pass. Unfortunately I don't get much time to work on this, so it's been dragging on.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK bug This issue is a bug. effort/small Small work item – less than a day of effort p2 pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member.
Projects
None yet
2 participants