feat(apigateway): step functions integration #16827

saqibdhuka · 2021-10-06T15:56:39Z

Added StepFunctionsRestApi and StepFunctionsIntegration implementation

closes #15081.

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

gitpod-io · 2021-10-06T15:56:42Z

mergify · 2021-10-06T15:56:57Z

Title does not follow the guidelines of Conventional Commits. Please adjust title before merge.

packages/@aws-cdk/aws-apigateway/lib/integrations/stepFunctions.ts

packages/@aws-cdk/aws-apigateway/lib/stepFunctions-api.ts

packages/@aws-cdk/aws-apigateway/lib/integrations/stepFunctions.ts

packages/@aws-cdk/aws-apigateway/lib/stepFunctions-api.ts

yarn.lock

packages/@aws-cdk/aws-apigateway/lib/integrations/stepFunctions.ts

packages/@aws-cdk/aws-apigateway/test/integ.stepFunctions-api.deploymentStack.ts

packages/@aws-cdk/aws-apigateway/test/stepFunctions-api.test.ts

packages/@aws-cdk/aws-apigateway/test/integrations/stepFunctions.test.ts

nija-at

Please add a section to the README with usage snippets.

Pull request has been modified.

saqibdhuka · 2021-10-14T17:03:39Z

Please add a section to the README with usage snippets.

Added

packages/@aws-cdk/aws-apigateway/lib/integrations/stepFunctions.ts

packages/@aws-cdk/aws-apigateway/lib/stepFunctions-api.ts

aidansteele · 2021-10-18T22:20:39Z

@saqibdhuka thank you for making this, it's very exciting. I tried it out yesterday and have a couple of questions/comments.

The first mistake I made was forgetting to make my Step Function an express workflow. I only realised my error after trying to invoke the API, because it successfully deployed but failed to invoke. I wonder if there is some way to warn/error if the user provides the wrong type of state machine?

Once I fixed that, it worked great. I see that it passes the request body to the sfn execution. In our environment, 99.9% of our APIs have authorization and our integrations need to know the identity of the authorized user. I don't think that is possible currently. I wonder if it preferable to change the execution input to instead more closely reflect the input format provided by API GW to "Lambda proxy integrations". This would also provide a way to receive request headers, etc.

This would be more complex for the simple unauthorized use case, but more usable for the authorized use case. I understand that there's value in the opinionated simple configuration, but it would be a shame for this construct to not get much usage due to this limitation.

aidansteele · 2021-10-18T23:59:21Z

I've been thinking it through a bit more and discussing with @diegotry. I assume this construct is modelled to be similar to apigateway.LambdaRestApi. I think it might help with adoption if the following was possible:

--- a/stack.ts
+++ b/stack.ts
@@ -1,20 +1,20 @@
declare const backend: lambda.Function;

- new apigateway.LambdaRestApi(this, 'myapi', {
-   handler: backend,
- });

+ const task = new tasks.LambdaInvoke(this, "Handle", { lambdaFunction: backend });
+ const stateMachine = new sfn.StateMachine(this, 'StateMachineX', {
+   stateMachineType: sfn.StateMachineType.EXPRESS,
+   definition: task,
+ });
+ 
+ new apigateway.StepFunctionsRestApi(this, 'mystepapi', { 
+   handler: stateMachine,
+ });

What do you think? If we change the VTL template to more closely resemble the Lambda proxy integration input then it makes migration easier for people.

packages/@aws-cdk/aws-apigateway/README.md

Pull request has been modified.

Co-authored-by: Niranjan Jayakar <nija@amazon.com>

…ns.test.ts Co-authored-by: Niranjan Jayakar <nija@amazon.com>

This reverts commit dc3b54f.

…aders)

…utionIntegration

Co-authored-by: Niranjan Jayakar <nija@amazon.com>

nija-at

Looks good. Let me know once the PR is rebased and I'll be happy to approve.

I've made some tweaks to the PR - #16827 (commits). Hope those are fine with you.

nija-at · 2021-11-25T09:25:34Z

packages/@aws-cdk/assert-internal/lib/assertions/have-resource-matchers.ts

-  const regex = new RegExp(`^${pattern.split('*').map(escapeRegex).join('.*')}$`);
+
+  // needs rebase from https://github.com/aws/aws-cdk/pull/17692/files
+  const regex = new RegExp(`^${pattern.split('*').map(escapeRegex).join('.*')}$`, 'm');


Amazing! I've approved the PR and it is now merged.

packages/@aws-cdk/aws-apigateway/lib/integrations/stepfunctions.ts

nija-at · 2021-11-25T11:49:45Z

packages/@aws-cdk/aws-apigateway/README.md

+const stateMachineDefinition = new stepfunctions.Pass(this, 'PassState');
+
+const stateMachine: stepfunctions.IStateMachine = new stepfunctions.StateMachine(this, 'StateMachine', {
+    definition: stateMachineDefinition,
+    stateMachineType: stepfunctions.StateMachineType.EXPRESS,
+});
+


I've pushed a commit that fixes this up.

Pull request has been modified.

nija-at

Thanks for being patient with me and working through this! 🙏

mergify · 2021-11-25T15:20:40Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

aws-cdk-automation · 2021-11-25T15:20:48Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
Commit ID: 57763b8
Result: SUCCEEDED
Build Logs (available for 30 days)

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

- Added StepFunctionsRestApi and StepFunctionsIntegration implementation closes aws#15081. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

saqibdhuka changed the title ~~StepFunctionsRestApi~~ feat(apigateway): add REST API Integration -- Step Functions Oct 6, 2021

saqibdhuka force-pushed the StepFunctionsRestApi-branch-issue#15081 branch from f740690 to c300c8e Compare October 6, 2021 17:46

diegotry reviewed Oct 6, 2021

View reviewed changes

packages/@aws-cdk/aws-apigateway/lib/integrations/stepFunctions.ts Outdated Show resolved Hide resolved

diegotry reviewed Oct 6, 2021

View reviewed changes

packages/@aws-cdk/aws-apigateway/lib/integrations/stepFunctions.ts Outdated Show resolved Hide resolved

diegotry reviewed Oct 6, 2021

View reviewed changes

packages/@aws-cdk/aws-apigateway/lib/integrations/stepFunctions.ts Outdated Show resolved Hide resolved

packages/@aws-cdk/aws-apigateway/lib/stepFunctions-api.ts Outdated Show resolved Hide resolved

packages/@aws-cdk/aws-apigateway/lib/stepFunctions-api.ts Outdated Show resolved Hide resolved

saqibdhuka force-pushed the StepFunctionsRestApi-branch-issue#15081 branch 2 times, most recently from 6352467 to f001265 Compare October 7, 2021 16:23

diegotry reviewed Oct 7, 2021

View reviewed changes

saqibdhuka force-pushed the StepFunctionsRestApi-branch-issue#15081 branch 2 times, most recently from f13f153 to ef176a9 Compare October 7, 2021 23:05

nija-at changed the title ~~feat(apigateway): add REST API Integration -- Step Functions~~ feat(apigateway): step functions integration Oct 11, 2021

diegotry suggested changes Oct 13, 2021

View reviewed changes

saqibdhuka force-pushed the StepFunctionsRestApi-branch-issue#15081 branch 2 times, most recently from 4ff8a66 to d3b6f74 Compare October 13, 2021 21:56

nija-at self-assigned this Oct 14, 2021

nija-at previously requested changes Oct 14, 2021

View reviewed changes

saqibdhuka force-pushed the StepFunctionsRestApi-branch-issue#15081 branch from d3b6f74 to 30372d3 Compare October 14, 2021 17:02

saqibdhuka force-pushed the StepFunctionsRestApi-branch-issue#15081 branch from 30372d3 to d41369b Compare October 14, 2021 17:44

aidansteele reviewed Oct 18, 2021

View reviewed changes

packages/@aws-cdk/aws-apigateway/lib/integrations/stepFunctions.ts Outdated Show resolved Hide resolved

aidansteele reviewed Oct 18, 2021

View reviewed changes

packages/@aws-cdk/aws-apigateway/lib/stepFunctions-api.ts Outdated Show resolved Hide resolved

saqibdhuka force-pushed the StepFunctionsRestApi-branch-issue#15081 branch from d41369b to 933399b Compare October 18, 2021 22:26

LeontiBrechko reviewed Oct 19, 2021

View reviewed changes

packages/@aws-cdk/aws-apigateway/README.md Outdated Show resolved Hide resolved

saqibdhuka closed this Oct 20, 2021

saqibdhuka reopened this Oct 20, 2021

change the integration class api

3bf2c8b

diegotry and others added 11 commits November 24, 2021 07:44

Doc update

7d950b1

Co-authored-by: Niranjan Jayakar <nija@amazon.com>

Doc update

2f10576

Co-authored-by: Niranjan Jayakar <nija@amazon.com>

rename interface

dc3b54f

Doc update

8ebf0c7

Co-authored-by: Niranjan Jayakar <nija@amazon.com>

Doc update

de43130

Co-authored-by: Niranjan Jayakar <nija@amazon.com>

Update packages/@aws-cdk/aws-apigateway/test/integrations/stepfunctio…

2cc14dc

…ns.test.ts Co-authored-by: Niranjan Jayakar <nija@amazon.com>

fix snippet

d2ad11d

Revert "rename interface"

1ca20ea

This reverts commit dc3b54f.

Update fields documentation (requestContext, querystring, path and he…

e4b9ff5

…aders)

Update code sample to use path as an object instead of strung

ede456f

Move functions to the end of the file

c8b1630

diegotry mentioned this pull request Nov 24, 2021

(assert-internal): stringLike function does not support multiline strings #17691

Closed

diegotry and others added 6 commits November 24, 2021 17:47

Include tests for request context fields inside the StepFunctionsExec…

8aaf67a

…utionIntegration

Update packages/@aws-cdk/aws-apigateway/test/integ.stepfunctions-api.ts

e501659

Co-authored-by: Niranjan Jayakar <nija@amazon.com>

Update integ test.exepcted.json

9a95f46

update tests

884397e

update snippets

0bf4637

code tweaks

2623b65

nija-at previously requested changes Nov 25, 2021

View reviewed changes

diegotry and others added 2 commits November 25, 2021 06:36

Remove stringLike fix as it is merged from the other PR

57763b8

Merge branch 'master' into StepFunctionsRestApi-branch-issue#15081

0ff219a

nija-at approved these changes Nov 25, 2021

View reviewed changes

mergify bot merged commit cb31547 into aws:master Nov 25, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(apigateway): step functions integration #16827

feat(apigateway): step functions integration #16827

saqibdhuka commented Oct 6, 2021

gitpod-io bot commented Oct 6, 2021

mergify bot commented Oct 6, 2021

nija-at left a comment

saqibdhuka commented Oct 14, 2021

aidansteele commented Oct 18, 2021 •

edited

aidansteele commented Oct 18, 2021

nija-at left a comment •

edited

nija-at Nov 25, 2021

nija-at Nov 25, 2021

nija-at left a comment

mergify bot commented Nov 25, 2021

aws-cdk-automation commented Nov 25, 2021

feat(apigateway): step functions integration #16827

feat(apigateway): step functions integration #16827

Conversation

saqibdhuka commented Oct 6, 2021

gitpod-io bot commented Oct 6, 2021

mergify bot commented Oct 6, 2021

nija-at left a comment

Choose a reason for hiding this comment

saqibdhuka commented Oct 14, 2021

aidansteele commented Oct 18, 2021 • edited

aidansteele commented Oct 18, 2021

nija-at left a comment • edited

Choose a reason for hiding this comment

nija-at Nov 25, 2021

Choose a reason for hiding this comment

nija-at Nov 25, 2021

Choose a reason for hiding this comment

nija-at left a comment

Choose a reason for hiding this comment

mergify bot commented Nov 25, 2021

aws-cdk-automation commented Nov 25, 2021

AWS CodeBuild CI Report

aidansteele commented Oct 18, 2021 •

edited

nija-at left a comment •

edited