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

refactor: readonly struct properties and hide internals #2106

Merged
merged 59 commits into from
Mar 28, 2019

Conversation

eladb
Copy link
Contributor

@eladb eladb commented Mar 27, 2019

This change upgrades the repo to jsii 0.8.0 which requires that all struct types (data interfaces like our "Props" interfaces) will be marked readonly in order to ensure they can be passed by-value.

The new jsii version also hides all members marked as @internal which means that those APIs will not be available from outside the framework.

Fixes awslabs/cdk-ops#321

BREAKING CHANGE: stack._toCloudFormation method is now unavailable and is replaced by @aws-cdk/assert.SynthUtils.toCloudFormation(stack).


Pull Request Checklist

  • Testing
    • Unit test added (prefer not to modify an existing test, otherwise, it's probably a breaking change)
    • 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.

@eladb eladb requested review from RomainMuller, skinny85, SoManyHs and a team as code owners March 27, 2019 19:11
@skinny85 skinny85 merged commit 66dd228 into master Mar 28, 2019
@hoegertn
Copy link
Contributor

What is the new/correct way to modify Props after creating the object?

I use this currently to set fields conditionally after creating the object with my shared config:
e.g. https://github.com/taimos/cdk-constructs/blob/master/lib/alexa/skill.ts#L57

@eladb eladb deleted the benisrae/jsii0-0.8.0 branch March 31, 2019 07:34
@eladb
Copy link
Contributor Author

eladb commented Mar 31, 2019

@hoegertn not sure what this line points at :-)

@hoegertn
Copy link
Contributor

Sorry, I changed it already. Here is the link to the revision: https://github.com/taimos/cdk-constructs/blob/e2279f2bcc004374dcbba5c14be61dd78ab30158/lib/alexa/skill.ts#L56

I changed it in master, but I am not really happy with the code.

@yueyingcui
Copy link

@eladb since the attributes are readonly now, could you share a recommended way to modify/dynamically create Props objects?

@eladb
Copy link
Contributor Author

eladb commented Jun 17, 2019

See #2372

@yueyingcui
Copy link

Thanks!

@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 23, 2019
@mergify
Copy link
Contributor

mergify bot commented Sep 23, 2019

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

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.

6 participants