feat(jsii): introduce submodules feature #1297

RomainMuller · 2020-02-27T14:18:05Z

Commit Message

feat(jsii): introduce submodules feature (#1297)

Introduces a jsii Submodule feature. Submodules are introduced
by declaring a namespace:

// Using a namespaced export statement
export * as ns from './subfolder';

// Using a namespace declaration
export ns {
  // ...
}

Submodules can be nested in other submodules, but the
dependency graph between submodules (and the top-level module)
must not result in a cycle (jsii` does currently not check for this
particular issue, although it probably will in the future).

Although this is out-of-scope for this change, they could be
enhanced so a specific README.md is attached to them, and so
that dedicated code-generating configuration can be specified.

Fixes #1286

End Commit Message

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

aws-cdk-automation · 2020-02-27T14:32:55Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-Blkkw9bQFn8A
Commit ID: 6e08662
Result: SUCCEEDED
Build Logs (available for 30 days)

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

eladb

Is this already magically supported by all code generators?

packages/jsii/lib/assembler.ts

eladb · 2020-03-01T08:09:07Z

packages/jsii/lib/assembler.ts

+      this._namespaceMap.set(symbol, ns);
+
+      const decl = symbol.declarations?.[0];
+      if (decl != null


add a comment such as "if this is a supported jsii type"...

Also, do we want a warning if it's not?

I don't think the warning is useful (exports that cannot be modeled by jsii are logged somewhere else as part of the next pass).

packages/jsii/lib/assembler.ts

aws-cdk-automation · 2020-03-10T09:12:54Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-Blkkw9bQFn8A
Commit ID: 8161f8f
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-10T09:30:16Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-Blkkw9bQFn8A
Commit ID: 18d854b
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-10T09:40:40Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-Blkkw9bQFn8A
Commit ID: bfcdc22
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-10T17:11:57Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-Blkkw9bQFn8A
Commit ID: 4cd2e17
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-11T14:32:10Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-Blkkw9bQFn8A
Commit ID: bbb7406
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-11T16:24:54Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-Blkkw9bQFn8A
Commit ID: c8bfb68
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-11T16:46:26Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-Blkkw9bQFn8A
Commit ID: eecc965
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-12T14:04:59Z

AWS CodeBuild CI Report

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

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

eladb

Can't really review this. I wish you hadn't moved around all of the compliance test types which invalidated 100% of our snapshots.

If it's reasonable to ask, I would revert all changes to jsii-calc and friends and only add a few additional tests to verify submodules. This will make it much easier to actually review how this code behaves.

docs/specifications/2-type-system.md

eladb · 2020-03-12T14:34:03Z

packages/jsii/test/negatives/neg.submodules-cannot-have-colliding-names.ts

+
+export * as ns1 from './namespaced';
+
+export class Ns1 {


Would my_module and myModule collide as well?

Yes. I guess I could add more coverage on this... Initially I only guarded against PascalCase / camelCase collisions, but figured Java & Python would use snake_case.

eladb · 2020-03-12T14:40:36Z

packages/jsii/lib/assembler.ts

+      if (colliding != null) {
+        const submoduleDecl = submodule.valueDeclaration ?? submodule.declarations[0];
+        this._diagnostic(node, ts.DiagnosticCategory.Error,
+          `Submodule "${submodule.name}" conflicts with "${jsiiType.name}". Restricted names are: ${candidates.join(', ')}`,


I guess top level types should always be pascal case (interfaces, classes, enums), so I think by definition they can't conflict with namespace names...

They can because the conflict space is PascalCase (preferred for C#), camelCase (preferred for JS), snake_case (preferred for Python & Java).

packages/jsii-reflect/test/__snapshots__/jsii-tree.test.js.snap

Co-Authored-By: Elad Ben-Israel <[email protected]>

aws-cdk-automation · 2020-03-16T13:41:01Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-Blkkw9bQFn8A
Commit ID: 2d4aa0f
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-16T15:19:56Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-Blkkw9bQFn8A
Commit ID: 318c67e
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-16T15:33:18Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-Blkkw9bQFn8A
Commit ID: c8d7514
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:01:06Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-Blkkw9bQFn8A
Commit ID: fd2d41a
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:42:12Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-Blkkw9bQFn8A
Commit ID: 72877ca
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-17T08:58:34Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-Blkkw9bQFn8A
Commit ID: 4f26cce
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-18T09:27:03Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-Blkkw9bQFn8A
Commit ID: 09b567b
Result: SUCCEEDED
Build Logs (available for 30 days)

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

eladb · 2020-03-17T14:14:42Z

packages/jsii-calc/lib/submodule/child/index.ts

+export enum Goodness {
+  /** It's pretty good */
+  PRETTY_GOOD,
+  /** It's really good */
+  REALLY_GOOD,
+  /** It's amazingly good */
+  AMAZINGLY_GOOD
+}


Optimistic today, aren't we? :-D

eladb · 2020-03-19T13:34:51Z

packages/jsii-pacmak/lib/targets/python.ts

  }

  public addMember(member: PythonBase) {
    this.members.push(member);
  }

+  public dependsOnModules(resolver: TypeResolver) {
+    resolver = this.fqn ? resolver.bind(this.fqn, this.pythonName) : resolver;


this.boundResolver?

That's not a thing on this particular type, due to peculiarities in the inheritance chain here.

mergify · 2020-03-19T13:42:40Z

Thank you for contributing! ❤️ I will now look into making sure the PR is up-to-date, then proceed to try and merge it!

mergify · 2020-03-19T13:42:41Z

Thank you for contributing! ❤️ I will now look into making sure the PR is up-to-date, then proceed to try and merge it!

mergify · 2020-03-19T13:43:16Z

Merging (with squash)...

aws-cdk-automation · 2020-03-19T15:17:35Z

AWS CodeBuild CI Report

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

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

feat(jsii): introduce submodules feature

6e08662

RomainMuller added feature-request A feature should be added or improved. module/compiler Issues affecting the JSII compiler labels Feb 27, 2020

RomainMuller requested review from eladb and MrArnoldPalmer February 27, 2020 14:18

eladb reviewed Mar 1, 2020

View reviewed changes

eladb mentioned this pull request Mar 1, 2020

RFC: 0006 monocdk aws/aws-cdk-rfcs#122

Merged

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

Merge branch 'master' into rmuller/submodules

8161f8f

address PR feedback

bfcdc22

RomainMuller force-pushed the rmuller/submodules branch from 18d854b to bfcdc22 Compare March 10, 2020 09:30

RomainMuller added 2 commits March 10, 2020 17:26

submodule some declarations in jsii-calc.

814e395

Merge remote-tracking branch 'origin/master' into rmuller/submodules

4cd2e17

Fix the python stuff

bbb7406

Merge remote-tracking branch 'origin/master' into rmuller/submodules

c8bfb68

Fixup mktemp invokation for Linux

eecc965

specification addendum

e0343da

RomainMuller marked this pull request as ready for review March 12, 2020 14:00

RomainMuller requested a review from a team as a code owner March 12, 2020 14:00

eladb suggested changes Mar 12, 2020

View reviewed changes

Update docs/specifications/2-type-system.md

bc8d3ba

Co-Authored-By: Elad Ben-Israel <[email protected]>

minor fixes

2d4aa0f

RomainMuller added 2 commits March 16, 2020 15:42

Fix bugs in compiler

eec62fb

Fixing stuff in the submodules

318c67e

RomainMuller added 2 commits March 16, 2020 16:24

Fixup test

9c7fe09

Merge remote-tracking branch 'origin/master' into rmuller/submodules

c8d7514

fix test expectations

fd2d41a

Fix path capitalization (MacOS case-insentive FS made this... tough)

72877ca

RomainMuller requested a review from eladb March 16, 2020 16:51

Merge branch 'master' into rmuller/submodules

4f26cce

Merge branch 'master' into rmuller/submodules

09b567b

RomainMuller removed the request for review from MrArnoldPalmer March 19, 2020 13:28

eladb approved these changes Mar 19, 2020

View reviewed changes

mergify bot added the pr/ready-to-merge This PR is ready to be merged. label Mar 19, 2020

Merge remote-tracking branch 'origin/master' into rmuller/submodules

b42349d

RomainMuller requested a review from MrArnoldPalmer as a code owner March 19, 2020 15:04

RomainMuller merged commit 2df5d90 into master Mar 19, 2020

RomainMuller deleted the rmuller/submodules branch March 19, 2020 15:29

mergify bot removed the pr/ready-to-merge This PR is ready to be merged. label Mar 19, 2020

eladb mentioned this pull request Apr 8, 2020

Python is broken in jsii 1.2.0 when jsii modules are installed as submodules #1501

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(jsii): introduce submodules feature #1297

feat(jsii): introduce submodules feature #1297

RomainMuller commented Feb 27, 2020 •

edited

Loading

aws-cdk-automation commented Feb 27, 2020

eladb left a comment

eladb Mar 1, 2020

RomainMuller Mar 10, 2020

aws-cdk-automation commented Mar 10, 2020

aws-cdk-automation commented Mar 10, 2020

aws-cdk-automation commented Mar 10, 2020

aws-cdk-automation commented Mar 10, 2020

aws-cdk-automation commented Mar 11, 2020

aws-cdk-automation commented Mar 11, 2020

aws-cdk-automation commented Mar 11, 2020

aws-cdk-automation commented Mar 12, 2020

eladb left a comment

eladb Mar 12, 2020

RomainMuller Mar 12, 2020

eladb Mar 12, 2020

RomainMuller Mar 12, 2020

aws-cdk-automation commented Mar 16, 2020

aws-cdk-automation commented Mar 16, 2020

aws-cdk-automation commented Mar 16, 2020

aws-cdk-automation commented Mar 16, 2020

aws-cdk-automation commented Mar 16, 2020

aws-cdk-automation commented Mar 17, 2020

aws-cdk-automation commented Mar 18, 2020

eladb Mar 17, 2020

RomainMuller Mar 19, 2020

eladb Mar 19, 2020

RomainMuller Mar 19, 2020

mergify bot commented Mar 19, 2020

mergify bot commented Mar 19, 2020

mergify bot commented Mar 19, 2020

aws-cdk-automation commented Mar 19, 2020

feat(jsii): introduce submodules feature #1297

feat(jsii): introduce submodules feature #1297

Conversation

RomainMuller commented Feb 27, 2020 • edited Loading

Commit Message

End Commit Message

aws-cdk-automation commented Feb 27, 2020

AWS CodeBuild CI Report

eladb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aws-cdk-automation commented Mar 10, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 10, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 10, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 10, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 11, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 11, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 11, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 12, 2020

AWS CodeBuild CI Report

eladb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aws-cdk-automation commented Mar 16, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 16, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 16, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 16, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 16, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 17, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 18, 2020

AWS CodeBuild CI Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mergify bot commented Mar 19, 2020

mergify bot commented Mar 19, 2020

mergify bot commented Mar 19, 2020

aws-cdk-automation commented Mar 19, 2020

AWS CodeBuild CI Report

RomainMuller commented Feb 27, 2020 •

edited

Loading