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.

Sign up for GitHub

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

Jump to bottom

feat: construct base class changes (breaking) #1444

Merged
merged 29 commits into from
Jan 3, 2019
Merged

feat: construct base class changes (breaking) #1444

merged 29 commits into from
Jan 3, 2019

Conversation

eladb
Copy link
Contributor

@eladb eladb commented Dec 27, 2018 •
edited
Loading

BREAKING CHANGE: Multiple breaking changes:

Pull Request Checklist

  • Testing
    • Unit test added
    • CLI change?: manually run integration tests and paste output as a PR comment
    • 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.

Elad Ben-Israel added 8 commits December 26, 2018 19:46
doc: RFC for code asset metadata
c0d2d6a 
Initial RFC for design of #1432
Close backticks
9eeb8de
feat(assets): enable local tooling scenarios such as lambda debugging
ad1a902 
Adds CloudFormation resource metadata which enables tools such as SAM
CLI to find local assets used by resources in the template.

See design document under [design/code-asset-metadata.md](./design/code-asset-metadata.md)

Fixes #1432
revert unwanted change in function
a081639
Support disabling asset metadata (and disable in integ tests)
416b6ba
Fix test
0f83270
[WIP] construct refactors
304e062 
- Move all construct members (besides protected "validate") under "node"
- Rename "parent" to "scope"
- Rename "id" or "name" to "scid" (not sure about this one)
Merge remote-tracking branch 'origin/master' into benisrae/construct-…
d9b2e41 
…refactors
@eladb eladb requested review from RomainMuller, skinny85, SoManyHs and a team as code owners December 27, 2018 21:49
rix0rrr
rix0rrr approved these changes Dec 28, 2018
View reviewed changes
packages/@aws-cdk/cdk/lib/core/construct.ts Outdated
* When a construct is created, it is always added as a child
*/
export class Construct {
export class Node {
Copy link
Contributor

Choose a reason for hiding this comment

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

Can't help but feel that Node is overly generic. ConstructNode maybe, or even ConstructTree?

Other than that, muy bien!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You mean for the class name, sure. Are you with Construct#node as the accessor?

Copy link
Contributor

Choose a reason for hiding this comment

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

I would support both treeNode and node.

@eladb
Copy link
Contributor Author

eladb commented Dec 30, 2018

@rix0rrr @RomainMuller I am loving "scope", but not 100% comfortable with renaming "id" to "scid". How do you feel about it?

@eladb
Copy link
Contributor Author

eladb commented Dec 30, 2018

The reason it feels wrong is because we are starting to see a pattern where this ID is used as a double for some other lower-level name/ID. For example, the name of a CodePipeline stage, the name of the Stack, ID of the Step Functions action, etc.

On the other hand, due to the fact that these IDs cannot include deploy-time tokens, I am worried that people are going to abuse them and constantly fall into this error, so perhaps we should give them a wacky name so they will less likely be abused.

@rix0rrr
Copy link
Contributor

rix0rrr commented Dec 31, 2018

I'm fine with leaving id, as well as scid.

@eladb eladb mentioned this pull request Jan 2, 2019
Merged
6 tasks
skinny85
skinny85 approved these changes Jan 2, 2019
View reviewed changes
Copy link
Contributor

@skinny85 skinny85 left a comment

Choose a reason for hiding this comment

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

I focused mainly on the Code* and general Construct changes. Everything looks good to me. I like the scope naming, and especially the node property - I think it will make the Sphinx docs a lot more helpful, without cluttering every single class with the Construct API.

@eladb eladb changed the title [WIP] Construct base class refactoring feat: construct base class refactoring Jan 3, 2019
@eladb eladb changed the title feat: construct base class refactoring feat: major construct base class refactoring Jan 3, 2019
@eladb eladb changed the title feat: major construct base class refactoring feat: construct base class changes (breaking) Jan 3, 2019
@eladb eladb merged commit fb22a32 into master Jan 3, 2019
eladb pushed a commit to eladb/aws-cdk-user-guide that referenced this pull request Jan 8, 2019
feat(concepts): "scope" instead of "parent"
e827083 
Shift the conceptual mental model to talk about the scope
hierarchy instead of a tree with parents and children.

See aws/aws-cdk#1444
@eladb eladb mentioned this pull request Jan 8, 2019
Closed
@rix0rrr rix0rrr deleted the benisrae/construct-refactors branch April 23, 2019 07:11
@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
Reviewers

@rix0rrr rix0rrr rix0rrr approved these changes

@skinny85 skinny85 skinny85 approved these changes

@RomainMuller RomainMuller Awaiting requested review from RomainMuller

@SoManyHs SoManyHs Awaiting requested review from SoManyHs

Assignees
No one assigned
Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

constructs: reduce API clutter from base class construct: consider renaming "parent" to "scope"
4 participants
@eladb @rix0rrr @skinny85 @NGL321