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(lambda): add a synth-time check for environment variables #1690

Merged
merged 2 commits into from
Feb 8, 2019

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented Feb 6, 2019

In some regions Lambda environment variables don't work. Add a check
for that so that there is quicker feedback on this missing feature.


Pull Request Checklist

  • Testing
    • Unit test added
    • CLI change?: coordinate update of integration tests with team
    • cdk-init template change?: coordinated update of integration tests with team
  • Docs
    • jsdocs: All public APIs documented
    • README: README and/or documentation topic updated
  • Title and Description
    • Change type: title prefixed with fix, feat will appear in changelog
    • Title: use lower-case and doesn't end with a period
    • Breaking?: last paragraph: "BREAKING CHANGE: <describe what changed + link for details>"
    • Issues: Indicate issues fixed via: "Fixes #xxx" or "Closes #xxx"
  • Sensitive Modules (requires 2 PR approvers)
    • IAM Policy Document (in @aws-cdk/aws-iam)
    • EC2 Security Groups and ACLs (in @aws-cdk/aws-ec2)
    • Grant APIs (only if not based on official documentation with a reference)

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

In some regions Lambda environment variables don't work. Add a check
for that so that there is quicker feedback on this missing feature.
@rix0rrr rix0rrr requested a review from a team as a code owner February 6, 2019 15:13
@@ -347,6 +347,12 @@ export class Function extends FunctionBase {
this.role.addToPolicy(statement);
}

const stack = cdk.Stack.find(this);
const isChina = stack.env.region && stack.env.region.startsWith('cn-');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe we should check if region is not a token? (cdk.unresolved)

const stack = cdk.Stack.find(this);
const isChina = stack.env.region && stack.env.region.startsWith('cn-');
if (isChina && props.environment && Object.keys(props.environment).length > 0) {
throw new Error(`Environment variables are not supported in this region (${stack.env.region}); please use tags or SSM parameters instead`);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rephrase "please use" to "you may consider using" or "you can use"

@@ -1178,6 +1178,25 @@ export = {
test.done();
},

'environment variables are prohibited in China'(test: Test) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a test for what happens when the region is undefined and when the region is a token

@rix0rrr rix0rrr merged commit 846ed9f into master Feb 8, 2019
@rix0rrr rix0rrr deleted the huijbers/lambda-feature-check branch February 8, 2019 10:18
@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants