feat(stepfunctions-tasks): add httpinvoke step functions task #28673

MathieuGilbert · 2024-01-11T20:15:43Z

This adds an HttpInvoke Step Functions task construct, which allows calling public APIs as described here.

Accepts an Event Bridge API Destination IConnection, setting required permissions to use its credentials.
Grants permission to invoke the root path for the endpoint (apiRoot prop). This allows passing the relative endpoint path at execution time (apiEndpoint prop).
Defines an enum for the allowed options for the URL encoding style of arrays, used when encoding the request body.

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.

Add task policies: events:RetrieveConnectionCredentials, secretsmanager:GetSecretValue, secretsmanager:DescribeSecret, states:InvokeHTTPEndpoint.

aws-cdk-automation · 2024-02-02T00:08:09Z

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.

…t. Test creates an API Gateway endpoint with basic auth Connection, then uses the connection in its task to invoke the endpoint.

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

… template for README compilation.

…o Rosetta fixture gives duplicate import errors on them. Add SecretValue as core import with others in template.

…s-httpinvoke

msambol · 2024-03-22T02:41:36Z

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

+
+/**
+ * The style used when applying URL encoding to array values.
+ *


nit: extra newline

msambol · 2024-03-22T02:42:34Z

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

+
+  /**
+   * The HTTP method to use.
+   * @example sfn.TaskInput.fromText("GET")


nit: can you add a newline before @example and remove the one below.

msambol · 2024-03-22T02:42:40Z

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

+
+  /**
+   * The API endpoint to call, relative to `apiRoot`.
+   * @example sfn.TaskInput.fromText("path/to/resource")


likewise here.

msambol · 2024-03-22T02:42:50Z

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

+
+  /**
+   * The EventBridge Connection to use for authentication.
+   *


nit: extra newline

msambol · 2024-03-22T02:43:28Z

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

+   * The headers to send to the HTTP endpoint.
+   *
+   * @default - No additional headers are added to the request.
+   * @example sfn.TaskInput.fromObject({ 'Content-Type': 'application/json' })


nit: can you put @default below @example and add a newline in between.

msambol · 2024-03-22T02:43:57Z

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

+
+/**
+ * A Step Functions Task to call a public third-party API.
+ *


nit: extra newline.

msambol · 2024-03-22T02:44:19Z

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

+  constructor(
+    scope: Construct,
+    id: string,
+    private readonly props: HttpInvokeProps,


nit: Can these be on the same line?

msambol · 2024-03-22T02:44:37Z

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

+  */
+  /**
+   * @internal
+  */


nit: this formatting looks off

Thanks for pointing these out, I obviously didn't pay enough attention to the comments (and don't normally use them). I did a sweep and they should all be consistent now.

msambol

Great stuff. Mostly nits on formatting.

TheRealAmazonKendra

Thank you for your contribution! This looks great overall but I just have one suggested change (in addition to the feedback already given).

TheRealAmazonKendra · 2024-03-22T22:04:43Z

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

+   *
+   * @default - ArrayEncodingFormat.INDICES
+   */
+  readonly arrayEncodingFormat?: ArrayEncodingFormat;


Given that this field is reliant on urlEncodeBody being set, these two fields should probably be one field. Maybe the only field here should still be called urlEncodeBody but have it take an Encoding (not sure about this name) class with a static function that has an optional input of ArrayEncodingFormat. Something along the lines of

urlEncodeBody: Encoding.set(ArrayEncodingFormat.INDICES);

to include encoding format, or

urlEncodeBody: Encoding.set();

to just include encoding with the default format.

This way, if they leave off this prop altogether, it's defaulted to false.

I'll also add the note here that set probably isn't a great function name here.

Thanks for pointing this out, I agree it's a bit awkward with the 2 params. I played around a bit, and I think a single prop can work with a couple extra enum options and renaming it to urlEncodingFormat. You can not pass it or specify URLEncodingFormat.NONE to get no encoding, pass it as URLEncodingFormat.DEFAULT to get encoding with the default array encoding (the underlying service defaults to INDICES), or specify the existing values to use those.

…. Rename enum to URLEncodingFormat and add DEFAULT and NONE options. Restructure the buildTaskParameters method for clarity with the new logic, and define an interface for it. Add specific test case for NONE.

…s-httpinvoke

Pull request has been modified.

MathieuGilbert · 2024-04-03T00:52:23Z

@msambol @TheRealAmazonKendra Thanks for reviewing, I think I've addressed all of your comments. Please let me know if there's anything else!

TheRealAmazonKendra

Thank you for all your work on this!

mergify · 2024-04-16T22:58:54Z

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

TheRealAmazonKendra · 2024-04-16T22:59:37Z

@Mergifyio update

mergify · 2024-04-16T22:59:49Z

update

❌ Mergify doesn't have permission to update

For security reasons, Mergify can't update this pull request. Try updating locally.
GitHub response: refusing to allow a GitHub App to create or update workflow .github/workflows/request-cli-integ-test.yml without workflows permission

aws-cdk-automation · 2024-04-16T23:28:06Z

AWS CodeBuild CI Report

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

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

mergify · 2024-04-16T23:28:30Z

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

Add http:invoke step functions task

bc37725

github-actions bot added beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 labels Jan 11, 2024

aws-cdk-automation requested a review from a team January 11, 2024 20:15

MathieuGilbert changed the title ~~Add http:invoke step functions task~~ feat(aws-stepfunctions-tasks): Add http:invoke step functions task Jan 11, 2024

aws-cdk-automation previously requested changes Jan 11, 2024

View reviewed changes

MathieuGilbert changed the title ~~feat(aws-stepfunctions-tasks): Add http:invoke step functions task~~ feat(aws-stepfunctions-tasks): add http:invoke step functions task Jan 11, 2024

Change connectionArn prop to IConnection, so policies can be set.

425c28f

Add task policies: events:RetrieveConnectionCredentials, secretsmanager:GetSecretValue, secretsmanager:DescribeSecret, states:InvokeHTTPEndpoint.

MathieuGilbert mentioned this pull request Jan 12, 2024

aws-stepfunctions-tasks: Support for new HTTPS Endpoint integration #28278

Closed

2 tasks

MathieuGilbert changed the title ~~feat(aws-stepfunctions-tasks): add http:invoke step functions task~~ feat(stepfunctions-tasks): add http:invoke step functions task Jan 12, 2024

MathieuGilbert and others added 5 commits January 30, 2024 16:25

Add an aws-stepfunctions-tasks README entry for HttpInvoke .

a0d5900

Merge branch 'main' into add-awsstepfunctions-httpinvoke

8821eaf

Add integration test.

75d049f

Fix tests

15f1b5a

drop trailing whitespace

83a8e1c

Add functional integration test using default params, and its snapsho…

1c5a3c2

…t. Test creates an API Gateway endpoint with basic auth Connection, then uses the connection in its task to invoke the endpoint.

MathieuGilbert added 8 commits February 2, 2024 17:06

Import order in test, tidy readme entry.

40902c6

Add events from aws-events import for aws-stepfunctions-tasks Rosetta…

5f3c9cf

… template for README compilation.

aws-events is already imported in individual examples, so adding it t…

215420b

…o Rosetta fixture gives duplicate import errors on them. Add SecretValue as core import with others in template.

Merge remote-tracking branch 'upstream/main' into add-awsstepfunction…

8d8873c

…s-httpinvoke

Update task props, make use of TaskInput.

fb6e25b

Merge remote-tracking branch 'upstream/main' into add-awsstepfunction…

f87d5f2

…s-httpinvoke

Fix (?) prop examples for TaskInputs.

e872adc

Merge remote-tracking branch 'upstream/main' into add-awsstepfunction…

ffdb124

…s-httpinvoke

MathieuGilbert marked this pull request as ready for review February 22, 2024 22:32

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

msambol reviewed Mar 22, 2024

View reviewed changes

msambol suggested changes Mar 22, 2024

View reviewed changes

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

TheRealAmazonKendra previously requested changes Mar 22, 2024

View reviewed changes

MathieuGilbert added 4 commits April 2, 2024 17:26

Fix casing in README section for Invoke HTTP API.

05962fa

Apply consistent comment formatting.

3155043

Refactor urlEncodeBody and arrayEncodingFormat into urlEncodingFormat…

bf056d9

…. Rename enum to URLEncodingFormat and add DEFAULT and NONE options. Restructure the buildTaskParameters method for clarity with the new logic, and define an interface for it. Add specific test case for NONE.

Merge remote-tracking branch 'upstream/main' into add-awsstepfunction…

45441fa

…s-httpinvoke

Merge branch 'main' into add-awsstepfunctions-httpinvoke

84079df

TheRealAmazonKendra approved these changes Apr 16, 2024

View reviewed changes

Merge branch 'main' into add-awsstepfunctions-httpinvoke

f784b79

TheRealAmazonKendra approved these changes Apr 16, 2024

View reviewed changes

mergify bot merged commit 178e481 into aws:main Apr 16, 2024
10 checks passed

MathieuGilbert deleted the add-awsstepfunctions-httpinvoke branch April 16, 2024 23:39

This was referenced May 23, 2024

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

Open

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

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(stepfunctions-tasks): add httpinvoke step functions task #28673

feat(stepfunctions-tasks): add httpinvoke step functions task #28673

MathieuGilbert commented Jan 11, 2024 •

edited

aws-cdk-automation left a comment

aws-cdk-automation commented Feb 2, 2024

msambol Mar 22, 2024

msambol Mar 22, 2024

msambol Mar 22, 2024

msambol Mar 22, 2024

msambol Mar 22, 2024

msambol Mar 22, 2024

msambol Mar 22, 2024

msambol Mar 22, 2024

MathieuGilbert Apr 2, 2024

msambol left a comment

TheRealAmazonKendra left a comment

TheRealAmazonKendra Mar 22, 2024

TheRealAmazonKendra Mar 22, 2024

MathieuGilbert Apr 2, 2024

MathieuGilbert commented Apr 3, 2024

TheRealAmazonKendra left a comment

mergify bot commented Apr 16, 2024

TheRealAmazonKendra commented Apr 16, 2024

mergify bot commented Apr 16, 2024

aws-cdk-automation commented Apr 16, 2024

mergify bot commented Apr 16, 2024

feat(stepfunctions-tasks): add httpinvoke step functions task #28673

feat(stepfunctions-tasks): add httpinvoke step functions task #28673

Conversation

MathieuGilbert commented Jan 11, 2024 • edited

aws-cdk-automation left a comment

Choose a reason for hiding this comment

aws-cdk-automation commented Feb 2, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

msambol left a comment

Choose a reason for hiding this comment

TheRealAmazonKendra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MathieuGilbert commented Apr 3, 2024

TheRealAmazonKendra left a comment

Choose a reason for hiding this comment

mergify bot commented Apr 16, 2024

TheRealAmazonKendra commented Apr 16, 2024

mergify bot commented Apr 16, 2024

❌ Mergify doesn't have permission to update

aws-cdk-automation commented Apr 16, 2024

AWS CodeBuild CI Report

mergify bot commented Apr 16, 2024

MathieuGilbert commented Jan 11, 2024 •

edited