feat(core): the "constructs" module by eladb · Pull Request #6623 · aws/aws-cdk

eladb · 2020-03-08T12:44:33Z

Core review pointers:

Important: core/lib/construct-compat.ts - the compatibility layer in core
constructs/lib/construct.ts - this is the main file that was moved from "core" into "constructs" with some modifications.
monocdk-experiment/build.sh - changes to how monocdk is built

TODO:

Commit Message

feat(core): the "constructs" module (#6623)

This commit extracts the constructs programming model into an independent library called constructs (npm, Maven, PyPI, NuGet). This library includes the Construct base class (and satellites) as well as the token system. The main motivation is to enable projects like CDK for Kubernetes to reuse these building blocks and allow interoperability between the frameworks (hence they have to use the same base types).

To ensure backwards compatibility until we release v2.0 of the AWS CDK, the construct-compat.ts file implements shadow and wrapper types for types that are now in "constructs" so the AWS CDK code remains unchanged and fully passes API compatibility tests.

The token system and a bunch of types related to dependencies has been duplicated since the effort of shadowing was too great and there is no major value (it would still be possible to interoperate even if we have two token systems).

Added an additional dependency on constructs to all AWS CDK modules.

MONOCDK: has been modified to take a peerDependency on this new module as this will be the final setup (users will have to depend on both monocdk and constructs), so we are not going to take shortcuts here.

TESTING: All relevant unit tests were duplicated from @aws-cdk/core to constructs, and intentionally maintained unchanged in core to ensure backwards compatibility.

End Commit Message

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

This commit extracts the constructs programming model into an independent library called `constructs`. This library includes the Construct base class (and satellites) as well as the token system. The main motivation is to enable projects like [CDK for Kubernetes] to reuse these building blocks and allow interoperability between the frameworks (hence they have to use the same base types). To ensure backwards compatibility until we release v2.0 of the AWS CDK, the `constructs-compat.ts` file implements shadow and wrapper types for types that are now in "constructs" so the AWS CDK code remains unchanged and fully passes API compatibility tests. The token system and a bunch of types related to dependencies has been _duplicated_ since the effort of shadowing was too great and there is no major value (it would still be possible to interoperate even if we have two token systems). [CDK for Kubernetes]: https://github.com/awslabs/cdk8s

aws-cdk-automation · 2020-03-08T12:47:20Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 1f012d9
Result: FAILED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2020-03-08T12:50:22Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 2ef9f19
Result: FAILED
Build Logs (available for 30 days)

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

otherwise, we will have to change all import statements and I want to avoid unnecessary diffs.

aws-cdk-automation · 2020-03-08T13:03:05Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: dc19216
Result: FAILED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2020-03-08T13:06:59Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 7c6559a
Result: FAILED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2020-03-08T13:16:40Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 971faa3
Result: FAILED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2020-03-08T13:35:53Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: e4b2349
Result: FAILED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2020-03-08T13:43:02Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 1c5b490
Result: FAILED
Build Logs (available for 30 days)

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

Since we rely on peer dependencies it's not needed any longer and also conflicts with the one we already have in @aws-cdk/core, so it's a good opportunity to get rid of it.

aws-cdk-automation · 2020-03-08T15:56:49Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: f7ae5ac
Result: FAILED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2020-03-08T16:23:38Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: ceebff2
Result: FAILED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2020-03-08T17:02:31Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: c2123a4
Result: FAILED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2020-03-08T17:50:03Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 197a8d0
Result: SUCCEEDED
Build Logs (available for 30 days)

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

rix0rrr

Okay this thing is cray-cray to review :)

I imagine synthesis is part of the constructs library as well; what about the cx-api protocol and all the CloudFormation-specific artifacts in there?

packages/constructs/test/evaluate-cfn.ts

packages/@aws-cdk/core/test/test.construct.ts

aws-cdk-automation · 2020-03-16T12:29:49Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 64119d7
Result: FAILED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2020-03-16T16:06:33Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 89ba351
Result: FAILED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2020-03-16T16:11:51Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 5c02843
Result: FAILED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2020-03-16T18:35:33Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: fbc36fd
Result: SUCCEEDED
Build Logs (available for 30 days)

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

eladb · 2020-03-16T18:59:43Z

tools/awslint/lib/rules/cloudwatch-events.ts

  eval: e => {
    for (const method of e.ctx.directEventMethods.concat(e.ctx.cloudTrailEventMethods)) {
-      e.assert(!e.ctx.interfaceType || e.ctx.interfaceType.allMethods.some(m => m.name === method.name), `${e.ctx.fqn}.${method.name}`);
+      e.assert(!e.ctx.interfaceType || e.ctx.interfaceType.allMethods.filter(m => !m.protected).some(m => m.name === method.name), `${e.ctx.fqn}.${method.name}`);


@rix0rrr This is needed because the protected lifecycle methods in constructs.Construct are named onSynthesize, onValidate and onPrepare.

Not forcing protected methods to be part of a public interface would always have been the right thing to do anyway, regardless of the change you just made.

aws-cdk-automation · 2020-03-16T19:34:50Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: aa3bd84
Result: SUCCEEDED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2020-03-16T19:35:49Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: b0a75ed
Result: SUCCEEDED
Build Logs (available for 30 days)

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

rix0rrr · 2020-03-17T09:58:11Z

packages/monocdk-experiment/build.sh

 cd $(mktemp -d)
 npm init -y
-npm install ${tarball}
+npm install ${tarball} constructs@${constructs_version}


Doesn't this run into bootstrapping problems? Is the construct library already published to NPM at the right version here? What IS the versioning strategy for that even?

Already published.

The versioning strategy is that it has it's own semantic version line. Current version is 1.1.2

rix0rrr · 2020-03-17T10:00:50Z

constructs/lib/construct.ts - this is the main file that was moved from "core" into "constructs" with some modifications.

Wait, the proposed new "constructs" library is not in this PR anymore, is it?

rix0rrr

I'm okay with this.

rix0rrr · 2020-03-17T10:06:40Z

Oh one more thing: how does the Assembly fit into this? I guess CXAPI is not a dependency of constructs, right? Do we have a generalized constructs.IAssemblyBuilder that cxapi.AssemblyBuilder derives from?

eladb · 2020-03-17T13:51:38Z

Oh one more thing: how does the Assembly fit into this? I guess CXAPI is not a dependency of constructs, right? Do we have a generalized constructs.IAssemblyBuilder that cxapi.AssemblyBuilder derives from?

@rix0rrr I changed the interface of ISynthesisSession in constructs to only include an outdir, and the App construct is actually not included in that library. This makes cloud assemblies an "AWS CDK thing" if that makes sense.

eladb

LGTM

aws-cdk-automation · 2020-03-17T14:28:26Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 97403c1
Result: SUCCEEDED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2020-03-17T14:31:41Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 628ae39
Result: SUCCEEDED
Build Logs (available for 30 days)

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

mergify · 2020-03-17T14:32:04Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

eladb changed the title ~~feat(core): constructs library~~ feat(core): the "constructs" library Mar 8, 2020

mergify bot added the contribution/core This is a PR that came from AWS. label Mar 8, 2020

eladb requested a review from a team March 8, 2020 12:45

update index file

2ef9f19

Elad Ben-Israel added 3 commits March 8, 2020 14:50

do not export "Intrinsic"

73bd289

rename back "constructs-comet" to "construct"

dc19216

otherwise, we will have to change all import statements and I want to avoid unnecessary diffs.

okay rename back to construct-compat so that diff will identify the move

7c6559a

fix pkglint issues

971faa3

Elad Ben-Israel added 2 commits March 8, 2020 15:32

fix awslint issues

e4b2349

ignore rules related to "constructs" naming

1c5b490

Elad Ben-Israel added 2 commits March 8, 2020 17:41

Remove Construct.isConstruct from "constructs"

af1c652

Since we rely on peer dependencies it's not needed any longer and also conflicts with the one we already have in @aws-cdk/core, so it's a good opportunity to get rid of it.

add "constructs: 0.0.0" as dep + peer dep to all modules.

f7ae5ac

fix extermnous import

ceebff2

add "constructs" as a peer dependency of "monocdk"

c2123a4

eladb changed the title ~~feat(core): the "constructs" library~~ feat(core): the "constructs" module Mar 8, 2020

Merge branch 'master' into benisrae/extract-constructs

197a8d0

eladb added the pr/do-not-merge This PR should not be merged at this time. label Mar 8, 2020

rix0rrr reviewed Mar 9, 2020

View reviewed changes

packages/constructs/test/evaluate-cfn.ts Outdated Show resolved Hide resolved

packages/@aws-cdk/core/test/test.construct.ts Show resolved Hide resolved

Use new names for lifecycle event methods

64119d7

Elad Ben-Israel added 2 commits March 16, 2020 17:44

use caret version

89ba351

Merge branch 'master' into benisrae/extract-constructs

5c02843

eladb added the pr-linter/exempt-readme The PR linter will not require README changes label Mar 16, 2020

fix mono-cdk

fbc36fd

Elad Ben-Israel added 2 commits March 16, 2020 20:48

Update gen.js

b0a75ed

Update gen.js

aa3bd84

eladb commented Mar 16, 2020

View reviewed changes

rix0rrr reviewed Mar 17, 2020

View reviewed changes

rix0rrr approved these changes Mar 17, 2020

View reviewed changes

Elad Ben-Israel added 2 commits March 17, 2020 15:43

Merge branch 'master' into benisrae/extract-constructs

97403c1

Merge branch 'master' into benisrae/extract-constructs

628ae39

eladb added the pr-linter/exempt-test The PR linter will not require test changes label Mar 17, 2020

eladb removed the pr/do-not-merge This PR should not be merged at this time. label Mar 17, 2020

eladb commented Mar 17, 2020

View reviewed changes

mergify bot merged commit eded95b into master Mar 17, 2020

mergify bot deleted the benisrae/extract-constructs branch March 17, 2020 14:32

snyk-bot mentioned this pull request Apr 10, 2020

[Snyk] Upgrade aws-cdk from 1.28.0 to 1.30.0 ammobinDOTca/ammobin-cdk#2

Closed

Conversation

eladb commented Mar 8, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Commit Message

End Commit Message

Uh oh!

aws-cdk-automation commented Mar 8, 2020

AWS CodeBuild CI Report

Uh oh!

aws-cdk-automation commented Mar 8, 2020

AWS CodeBuild CI Report

Uh oh!

aws-cdk-automation commented Mar 8, 2020

AWS CodeBuild CI Report

Uh oh!

aws-cdk-automation commented Mar 8, 2020

AWS CodeBuild CI Report

Uh oh!

aws-cdk-automation commented Mar 8, 2020

AWS CodeBuild CI Report

Uh oh!

aws-cdk-automation commented Mar 8, 2020

AWS CodeBuild CI Report

Uh oh!

aws-cdk-automation commented Mar 8, 2020

AWS CodeBuild CI Report

Uh oh!

aws-cdk-automation commented Mar 8, 2020

AWS CodeBuild CI Report

Uh oh!

aws-cdk-automation commented Mar 8, 2020

AWS CodeBuild CI Report

Uh oh!

aws-cdk-automation commented Mar 8, 2020

AWS CodeBuild CI Report

Uh oh!

aws-cdk-automation commented Mar 8, 2020

AWS CodeBuild CI Report

Uh oh!

rix0rrr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

aws-cdk-automation commented Mar 16, 2020

AWS CodeBuild CI Report

Uh oh!

aws-cdk-automation commented Mar 16, 2020

AWS CodeBuild CI Report

Uh oh!

aws-cdk-automation commented Mar 16, 2020

AWS CodeBuild CI Report

Uh oh!

aws-cdk-automation commented Mar 16, 2020

AWS CodeBuild CI Report

Uh oh!

eladb Mar 16, 2020

Choose a reason for hiding this comment

Uh oh!

rix0rrr Mar 17, 2020

Choose a reason for hiding this comment

Uh oh!

aws-cdk-automation commented Mar 16, 2020

AWS CodeBuild CI Report

Uh oh!

aws-cdk-automation commented Mar 16, 2020

AWS CodeBuild CI Report

Uh oh!

rix0rrr Mar 17, 2020

Choose a reason for hiding this comment

Uh oh!

eladb Mar 17, 2020

Choose a reason for hiding this comment

Uh oh!

eladb Mar 17, 2020

Choose a reason for hiding this comment

Uh oh!

rix0rrr commented Mar 17, 2020

Uh oh!

rix0rrr left a comment

eladb commented Mar 8, 2020 •

edited

Loading