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(ec2): fix error when using Tokens in Vpc.fromLookup() #3740

Merged
merged 2 commits into from
Aug 21, 2019

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented Aug 21, 2019

fromLookup() will not support lazy values. Throw a clear
error message when that is done, and update the documentation
to make it clear what should be done instead.

Fixes #3600.


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

`fromLookup()` will not support lazy values. Throw a clear
error message when that is done, and update the documentation
to make it clear what should be done instead.

Fixes #3600.
@rix0rrr rix0rrr self-assigned this Aug 21, 2019
@mergify
Copy link
Contributor

mergify bot commented Aug 21, 2019

Pull Request Checklist

  • Testing
  • Unit test added (prefer to add a new test rather than modify existing tests)
  • CLI change? Re-run/add CLI integration tests
  • Documentation
  • Inline docs: make sure all public APIs are documented (copy & paste from official AWS docs)
  • README: update module README
  • Design: for significant features, follow the design process
  • Title uses the format type(scope): text
  • Type: fix, feat, refactor go into CHANGELOG, chore is hidden
  • Scope: name of the module without the aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
  • Style: use all lower-case, do not end with a period
  • 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>
  • Sensitive Modules (requires 2 PR approvers)
  • IAM document library (in @aws-cdk/aws-iam)
  • EC2 security groups and ACLs (in @aws-cdk/aws-ec2)
  • Grant APIs (if not based on official documentation with a reference)

*/
public static fromLookup(scope: Construct, id: string, options: VpcLookupOptions): IVpc {
if (Token.isUnresolved(options.vpcId)
Copy link
Contributor

Choose a reason for hiding this comment

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

Geez. It looks we may be missing this check in tons of places throughout our constructs.

For v2, I wonder if we should strongly type all properties to be string | IResolvableToken (hypothetical type - may or may not exist yet) to ensure that constructs deal with both cases?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes we are. For many places it doesn't matter though (makes it harder!).

This is again an ancient discussion :).

We explicitly opted to do it this way (encode "magic" values into primitive types) in order to guarantee maximum compatibility with all programming languages. Sum types are not supported in many languages, and emulating them would become unwieldy very quickly (especially if you have to have additional syntax for LITERALLY every property you pass).

@mergify
Copy link
Contributor

mergify bot commented Aug 21, 2019

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

@mergify
Copy link
Contributor

mergify bot commented Aug 21, 2019

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

@mergify mergify bot merged commit 004077f into master Aug 21, 2019
@mergify mergify bot deleted the huijbers/no-lazy-from-vpc branch August 21, 2019 15:25
@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.

Explain that Vpc.fromLookup cannot use deploy-time values
3 participants