feat(apigateway): cors preflight support #4211

eladb · 2019-09-23T21:26:51Z

Work in progress: adds support for CORS preflight (OPTIONS) requests on resources.
currently supports: origin, methods, headers, credentials, status code

Fixes #906

Implemented during a live twitch stream on sep 24, 2019

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

adds support for CORS preflight (OPTIONS) requests on resources. currently supports: origin, methods, headers, credentials, status code implemented during a live twitch stream on sep 24, 2019

mergify · 2019-09-23T21:27:28Z

Thanks so much for taking the time to contribute to the AWS CDK ❤️

We will shortly assign someone to review this pull request and help get it
merged. In the meantime, please take a minute to make sure you follow this
checklist:

PR title type(scope): text
- type: fix, feat, refactor go into CHANGELOG, chore is hidden
- scope: name of module without aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
- text: use all lower-case, do not end with a period, do not include issue refs
PR Description
- Rationale: describe rationale of change and approach taken
- Issues: indicate issues fixed via: fixes #xxx or closes #xxx
- Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
Testing
- Unit test added. Prefer to add a new test rather than modify existing tests
- CLI or init templates change? Re-run/add CLI integration tests
Documentation
- README: update module README to describe new features
- API docs: public APIs must be documented. Copy from official AWS docs when possible
- Design: for significant features, follow design process

aws-cdk-automation · 2019-09-23T21:38:15Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

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

…-cors

aws-cdk-automation · 2019-09-25T20:45:29Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2019-09-25T21:17:18Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2019-09-26T14:11:53Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2019-09-26T14:47:01Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2019-09-26T15:21:29Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2019-09-26T16:06:42Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

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

elhedran · 2019-10-16T02:03:38Z

Looks good and we could really, really use this. Anything I can do to help get the PR over the line?

eladb · 2019-10-16T14:10:53Z

@elhedran thanks for this nudge. I haven't had time to take this through the finish line. The main thing I'd like to add here (since I believe it might require an API change) is support recursive CORS configuration. Something like defaultCrossOriginOptions at the RestApi and Resource levels which will propagate to all child methods.

eladb · 2019-10-16T14:11:16Z

If you are interested to take a whack at it, it will be awesome! Otherwise, I hope I'll be able to find the time in the coming weeks.

…-cors

aws-cdk-automation · 2019-10-17T08:03:17Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2019-10-17T08:03:52Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2019-10-17T08:05:01Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

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

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

packages/@aws-cdk/aws-apigateway/lib/cors.ts

RomainMuller · 2019-10-17T08:04:18Z

packages/@aws-cdk/aws-apigateway/lib/cors.ts

+   * Access-Control-Allow-Methods and Access-Control-Allow-Headers headers)
+   * can be cached.
+   *
+   * To disable caching altogther use `disableCache: true`.


Wouldn't specifying 0 (or less) here be an effective way to signal "I don't want no caching"? I'm not too sure the extra flag is actually so useful.

The spec doesn't say anything about 0 and we can't express -1 as a Duration.

RomainMuller · 2019-10-17T08:05:32Z

packages/@aws-cdk/aws-apigateway/lib/cors.ts

+  readonly exposeHeaders?: string[];
+}
+
+export class Cors {


Can you please give this class a private constructor?

packages/@aws-cdk/aws-apigateway/lib/resource.ts

aws-cdk-automation · 2019-10-17T08:35:53Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2019-10-17T08:39:19Z

AWS CodeBuild CI Report

Result: SUCCEEDED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2019-10-17T09:03:35Z

AWS CodeBuild CI Report

Result: SUCCEEDED
Build Logs (available for 30 days)

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

mergify · 2019-10-17T09:04:04Z

Thank you for contributing! Your pull request is now being automatically merged.

aws-cdk-automation · 2019-10-17T09:42:33Z

AWS CodeBuild CI Report

Result: SUCCEEDED
Build Logs (available for 30 days)

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

feat(apigateway): cors support (wip)

136034d

adds support for CORS preflight (OPTIONS) requests on resources. currently supports: origin, methods, headers, credentials, status code implemented during a live twitch stream on sep 24, 2019

eladb self-assigned this Sep 24, 2019

Merge remote-tracking branch 'origin/master' into benisrae/apigateway…

c801a9b

…-cors

eladb changed the title ~~feat(apigateway): cors support (WIP)~~ feat(apigateway): cors support Sep 25, 2019

eladb changed the title ~~feat(apigateway): cors support~~ feat(apigateway): cors preflight support Sep 25, 2019

Elad Ben-Israel added 3 commits September 25, 2019 23:33

export types from cors.ts

c546a31

allow 'ANY' to be used in allowMethods

0933b82

add a bunch of unit tests

a4f430c

Elad Ben-Israel added 2 commits September 26, 2019 00:05

document api

f415bf9

support multiple origins

3fe3d8c

Elad Ben-Israel added 2 commits September 26, 2019 17:00

add maxAge + disableCache

0c2c384

document addCorsPreflight

30e328e

Elad Ben-Israel added 2 commits September 26, 2019 17:25

exposeHeaders

1a78d38

doc cleanups

03e9723

reorder methods

bcff001

add integ test expectation

5ce14ac

NGL321 added the contribution/core This is a PR that came from AWS. label Sep 27, 2019

Elad Ben-Israel added 2 commits October 17, 2019 09:05

Merge remote-tracking branch 'origin/master' into benisrae/apigateway…

6d20817

…-cors

defaultCorsPreflightOptions

11ef4b6

Elad Ben-Israel added 3 commits October 17, 2019 10:52

README

ea69fa1

add missing features link

85a5434

Merge remote-tracking branch 'origin/master' into benisrae/apigateway…

3fc4130

…-cors

eladb marked this pull request as ready for review October 17, 2019 07:55

eladb requested a review from nija-at as a code owner October 17, 2019 07:55

Elad Ben-Israel added 2 commits October 17, 2019 10:59

update integ test expectation

17908fb

fix compilation error

3255385

RomainMuller suggested changes Oct 17, 2019

View reviewed changes

Elad Ben-Israel added 2 commits October 17, 2019 11:24

respond with Vary if specific origin is specified

e27538a

update expectation

f80755d

RomainMuller approved these changes Oct 17, 2019

View reviewed changes

Merge branch 'master' into benisrae/apigateway-cors

aa9d8d1

mergify bot merged commit 0f06223 into master Oct 17, 2019

mergify bot deleted the benisrae/apigateway-cors branch October 17, 2019 09:42

This was referenced Jan 4, 2021

python api-cors-lambda out of date aws-samples/aws-cdk-examples#381

Closed

fix: update python api-cors-lambda aws-samples/aws-cdk-examples#382

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(apigateway): cors preflight support #4211

feat(apigateway): cors preflight support #4211

eladb commented Sep 23, 2019 •

edited

Loading

mergify bot commented Sep 23, 2019

aws-cdk-automation commented Sep 23, 2019

aws-cdk-automation commented Sep 25, 2019

aws-cdk-automation commented Sep 25, 2019

aws-cdk-automation commented Sep 26, 2019

aws-cdk-automation commented Sep 26, 2019

aws-cdk-automation commented Sep 26, 2019

aws-cdk-automation commented Sep 26, 2019

elhedran commented Oct 16, 2019

eladb commented Oct 16, 2019

eladb commented Oct 16, 2019

aws-cdk-automation commented Oct 17, 2019

aws-cdk-automation commented Oct 17, 2019

aws-cdk-automation commented Oct 17, 2019

RomainMuller Oct 17, 2019

eladb Oct 17, 2019

RomainMuller Oct 17, 2019

eladb Oct 17, 2019

aws-cdk-automation commented Oct 17, 2019

aws-cdk-automation commented Oct 17, 2019

aws-cdk-automation commented Oct 17, 2019

mergify bot commented Oct 17, 2019

aws-cdk-automation commented Oct 17, 2019

feat(apigateway): cors preflight support #4211

feat(apigateway): cors preflight support #4211

Conversation

eladb commented Sep 23, 2019 • edited Loading

mergify bot commented Sep 23, 2019

aws-cdk-automation commented Sep 23, 2019

AWS CodeBuild CI Report

aws-cdk-automation commented Sep 25, 2019

AWS CodeBuild CI Report

aws-cdk-automation commented Sep 25, 2019

AWS CodeBuild CI Report

aws-cdk-automation commented Sep 26, 2019

AWS CodeBuild CI Report

aws-cdk-automation commented Sep 26, 2019

AWS CodeBuild CI Report

aws-cdk-automation commented Sep 26, 2019

AWS CodeBuild CI Report

aws-cdk-automation commented Sep 26, 2019

AWS CodeBuild CI Report

elhedran commented Oct 16, 2019

eladb commented Oct 16, 2019

eladb commented Oct 16, 2019

aws-cdk-automation commented Oct 17, 2019

AWS CodeBuild CI Report

aws-cdk-automation commented Oct 17, 2019

AWS CodeBuild CI Report

aws-cdk-automation commented Oct 17, 2019

AWS CodeBuild CI Report

RomainMuller Oct 17, 2019

Choose a reason for hiding this comment

eladb Oct 17, 2019

Choose a reason for hiding this comment

RomainMuller Oct 17, 2019

Choose a reason for hiding this comment

eladb Oct 17, 2019

Choose a reason for hiding this comment

aws-cdk-automation commented Oct 17, 2019

AWS CodeBuild CI Report

aws-cdk-automation commented Oct 17, 2019

AWS CodeBuild CI Report

aws-cdk-automation commented Oct 17, 2019

AWS CodeBuild CI Report

mergify bot commented Oct 17, 2019

aws-cdk-automation commented Oct 17, 2019

AWS CodeBuild CI Report

eladb commented Sep 23, 2019 •

edited

Loading