feat(jsii): Further normalize assembly outputs #177

RomainMuller · 2018-08-14T10:50:02Z

Sort member arrays (properties and methods), to produce fully sorted assemblies:

static members
immutable members (only relevant for properties)
non-optional members (only relevant for properties)
lexicographically sorted

Also, stop emitting step builders for interfaces in Java (they break due to the property order change the above causes). Conveniently, this fixes #60.

…assemblies

…d isolate the `test` typescript configuration.

Use a simple builder class that has `whit`ers for all properties and perform required-validation at `build()` time. Fixes #60

eladb · 2018-08-14T11:27:32Z

...sii-calc-lib/java/src/main/java/software/amazon/jsii/tests/calculator/lib/MyFirstStruct.java

+         * Builds the configured instance.
+         * @return a new instance of {@link MyFirstStruct}
+         * @throws NullPointerException if any required attribute was not provided
+         */


eladb · 2018-08-14T11:28:13Z

...ib/java/src/main/java/software/amazon/jsii/tests/calculator/lib/StructWithOnlyOptionals.java

     */
-    public static final class Builder {
-        private Jsii$Pojo instance = new Jsii$Pojo();
+    final class Builder {


Shouldn’t it be static as well?

It's a member of an interface, so it is inherently static.

eladb · 2018-08-14T11:29:30Z

packages/codemaker/package.json

@@ -5,8 +5,8 @@
  "main": "lib/index.js",
  "types": "lib/index.d.ts",
  "scripts": {
-    "build": "tsc",
-    "watch": "tsc -w",
+    "build": "tsc -b",


What’s -b?

In full, --build. It's the new compiler mode that supports project references.

eladb · 2018-08-14T14:27:02Z

packages/jsii/tsconfig.json

+    "test"
+  ],
+  "references": [
+    { "path": "../jsii-spec" }


I don't like this one bit. Why are we referencing outside of the module tree?

Well, this particular feature has been added in typescript specifically to improve the developer experience around monorepos and composite projects... If you're not into the ../ reference, the best alternative is to reference via ./node_modules/jsii-spec instead?

./node_modules sounds much better for sure. But what happens if the reference directory doesn't have .ts files (i.e. it's not a mono-repo or we split those modules into separate repos)

If there is no tsconfig.json in the pointed to directory, typescript will not like it. When the projects are "untangled", they need those project references edited out.

eladb · 2018-08-14T14:31:04Z

packages/jsii-pacmak/tsconfig.json

+    "**/*.d.ts",
+    "node_modules"
+  ],
+  "references": [


What happens when someone needs to add a dependency? Do they have to remember to add it here?

It should work without being added in references. If it's a dependency from the same monorepo (aka you have the .ts files available, not just the .d.ts), then you'll get sub-optimal compile times.

got it... did you see any improvement?

It feels faster, but it's a small project so it's hard to tell for sure...

TBH feels like a redundant smartassness to me... More configuration, more ways for things to go wrong, harder to understand what's going on... If you are keen on this, be my guest, but in my view if there is no clear benefit, KISS!

Yeah, so I'll be generating project references for JSII assemblies' managed tsconfig.json, but I'm removing the support for the jsii monorepo packages (it doesn't work when using references in-tree, and the error message... isn't helpful).

Not sure I understand and it's worrying me. Let's talk about it tomorrow?

We can talk about this over the PR that I'll submit a bit later that'll create those automatically. No need to make a fuss now :)

I've already started crying 😢

…1 in /packages/@jsii/python-runtime (#3315) Updates the requirements on [cattrs](https://github.com/python-attrs/cattrs) to permit the latest version. <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/python-attrs/cattrs/blob/main/HISTORY.rst">cattrs's changelog</a>.</em></p> <blockquote> <h2>1.10.0 (2022-01-04)</h2> <ul> <li>Add PEP 563 (string annotations) support for dataclasses. (<code>[#195](python-attrs/cattrs#195) <https://github.com/python-attrs/cattrs/issues/195></code>_)</li> <li>Fix handling of dictionaries with string Enum keys for bson, orjson, and tomlkit.</li> <li>Rename the <code>cattr.gen.make_dict_unstructure_fn.omit_if_default</code> parameter to <code>_cattrs_omit_if_default</code>, for consistency. The <code>omit_if_default</code> parameters to <code>GenConverter</code> and <code>override</code> are unchanged.</li> <li>Following the changes in <code>attrs</code> 21.3.0, add a <code>cattrs</code> package mirroring the existing <code>cattr</code> package. Both package names may be used as desired, and the <code>cattr</code> package isn't going away.</li> </ul> <h2>1.9.0 (2021-12-06)</h2> <ul> <li>Python 3.10 support, including support for the new union syntax (<code>A | B</code> vs <code>Union[A, B]</code>).</li> <li>The <code>GenConverter</code> can now properly structure generic classes with generic collection fields. (<code>[#149](python-attrs/cattrs#149) <https://github.com/python-attrs/cattrs/issues/149></code>_)</li> <li><code>omit=True</code> now also affects generated structuring functions. (<code>[#166](python-attrs/cattrs#166) <https://github.com/python-attrs/cattrs/issues/166></code>_)</li> <li><code>cattr.gen.{make_dict_structure_fn, make_dict_unstructure_fn}</code> now resolve type annotations automatically when PEP 563 is used. (<code>[#169](python-attrs/cattrs#169) <https://github.com/python-attrs/cattrs/issues/169></code>_)</li> <li>Protocols are now unstructured as their runtime types. (<code>[#177](python-attrs/cattrs#177) <https://github.com/python-attrs/cattrs/pull/177></code>_)</li> <li>Fix an issue generating structuring functions with renaming and <code>_cattrs_forbid_extra_keys=True</code>. (<code>[#190](python-attrs/cattrs#190) <https://github.com/python-attrs/cattrs/issues/190></code>_)</li> </ul> <h2>1.8.0 (2021-08-13)</h2> <ul> <li>Fix <code>GenConverter</code> mapping structuring for unannotated dicts on Python 3.8. (<code>[#151](python-attrs/cattrs#151) <https://github.com/python-attrs/cattrs/issues/151></code>_)</li> <li>The source code for generated un/structuring functions is stored in the <code>linecache</code> cache, which enables more informative stack traces when un/structuring errors happen using the <code>GenConverter</code>. This behavior can optionally be disabled to save memory.</li> <li>Support using the attr converter callback during structure. By default, this is a method of last resort, but it can be elevated to the default by setting <code>prefer_attrib_converters=True</code> on <code>Converter</code> or <code>GenConverter</code>. (<code>[#138](python-attrs/cattrs#138) <https://github.com/python-attrs/cattrs/issues/138></code>_)</li> <li>Fix structuring recursive classes. (<code>[#159](python-attrs/cattrs#159) <https://github.com/python-attrs/cattrs/issues/159></code>_)</li> <li>Converters now support un/structuring hook factories. This is the most powerful and complex venue for customizing un/structuring. This had previously been an internal feature.</li> <li>The <code>Common Usage Examples <https://cattrs.readthedocs.io/en/latest/usage.html#using-factory-hooks></code>_ documentation page now has a section on advanced hook factory usage.</li> <li><code>cattr.override</code> now supports the <code>omit</code> parameter, which makes <code>cattrs</code> skip the atribute entirely when unstructuring.</li> <li>The <code>cattr.preconf.bson</code> module is now tested against the <code>bson</code> module bundled with the <code>pymongo</code> package, because that package is much more popular than the standalone PyPI <code>bson</code> package.</li> </ul> <h2>1.7.1 (2021-05-28)</h2> <ul> <li><code>Literal</code> s are not supported on Python 3.9.0 (supported on 3.9.1 and later), so we skip importing them there. (<code>[#150](python-attrs/cattrs#150) <https://github.com/python-attrs/cattrs/issues/150></code>_)</li> </ul> <h2>1.7.0 (2021-05-26)</h2> <ul> <li><code>cattr.global_converter</code> (which provides <code>cattr.unstructure</code>, <code>cattr.structure</code> etc.) is now an instance of <code>cattr.GenConverter</code>.</li> <li><code>Literal</code> s are now supported and validated when structuring.</li> <li>Fix dependency metadata information for <code>attrs</code>. (<code>[#147](python-attrs/cattrs#147) <https://github.com/python-attrs/cattrs/issues/147></code>_)</li> <li>Fix <code>GenConverter</code> mapping structuring for unannotated dicts. (<code>[#148](python-attrs/cattrs#148) <https://github.com/python-attrs/cattrs/issues/148></code>_)</li> </ul> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/python-attrs/cattrs/commit/7d3a6ba5e0df942391349e332cb87f6871088015"><code>7d3a6ba</code></a> Bump to 1.10.0</li> <li><a href="https://github.com/python-attrs/cattrs/commit/22b24c28fbeb2b8ca90d568dc4939bdc98ec5902"><code>22b24c2</code></a> Tin/import cattrs (<a href="https://github-redirect.dependabot.com/python-attrs/cattrs/issues/203">#203</a>)</li> <li><a href="https://github.com/python-attrs/cattrs/commit/a0e56f43f061c43814d6f938833d1c325ed61525"><code>a0e56f4</code></a> Fix test with 32-bit time_t</li> <li><a href="https://github.com/python-attrs/cattrs/commit/bc9432e606177fe10aa3d2d11e715970c92526be"><code>bc9432e</code></a> Documentation tweaks</li> <li><a href="https://github.com/python-attrs/cattrs/commit/6260c58aa185200a08c76ecc99a941a26a93eeb8"><code>6260c58</code></a> Rename gen.make_dict_unstructure_fn.omit_if_default</li> <li><a href="https://github.com/python-attrs/cattrs/commit/bb4383c2d97aae0e8a01db64f142d07350861a17"><code>bb4383c</code></a> Remove walrus</li> <li><a href="https://github.com/python-attrs/cattrs/commit/81d7756541129a73b82f076b860d61c550296666"><code>81d7756</code></a> Clean up test</li> <li><a href="https://github.com/python-attrs/cattrs/commit/de16200c3d02d259d04960ab466f49fcf8fa47a4"><code>de16200</code></a> Fix preconf string Enum keys</li> <li><a href="https://github.com/python-attrs/cattrs/commit/077c9ea8521372f706346f1f39101db716ca3089"><code>077c9ea</code></a> CI tweak</li> <li><a href="https://github.com/python-attrs/cattrs/commit/3ad74d4456c19598e7278deef62e3af85eabc99d"><code>3ad74d4</code></a> setup.cfg B gone</li> <li>Additional commits viewable in <a href="https://github.com/python-attrs/cattrs/compare/v1.8.0...v1.10.0">compare view</a></li> </ul> </details> <br /> Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details>

…2 in /packages/@jsii/python-runtime (#3470) Updates the requirements on [cattrs](https://github.com/python-attrs/cattrs) to permit the latest version. <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/python-attrs/cattrs/blob/main/HISTORY.rst">cattrs's changelog</a>.</em></p> <blockquote> <h2>22.1.0 (2022-04-03)</h2> <ul> <li>cattrs now uses the CalVer versioning convention.</li> <li>cattrs now has a detailed validation mode, which is enabled by default. Learn more <code>here <https://cattrs.readthedocs.io/en/latest/validation.html></code>_. The old behavior can be restored by creating the converter with <code>detailed_validation=False</code>.</li> <li><code>attrs</code> and dataclass structuring is now ~25% faster.</li> <li>Fix an issue structuring bare <code>typing.List</code> s on Pythons lower than 3.9. (<code>[#209](python-attrs/cattrs#209) <https://github.com/python-attrs/cattrs/issues/209></code>_)</li> <li>Fix structuring of non-parametrized containers like <code>list/dict/...</code> on Pythons lower than 3.9. (<code>[#218](python-attrs/cattrs#218) <https://github.com/python-attrs/cattrs/issues/218></code>_)</li> <li>Fix structuring bare <code>typing.Tuple</code> on Pythons lower than 3.9. (<code>[#218](python-attrs/cattrs#218) <https://github.com/python-attrs/cattrs/issues/218></code>_)</li> <li>Fix a wrong <code>AttributeError</code> of an missing <code>__parameters__</code> attribute. This could happen when inheriting certain generic classes – for example <code>typing.*</code> classes are affected. (<code>[#217](python-attrs/cattrs#217) <https://github.com/python-attrs/cattrs/issues/217></code>_)</li> <li>Fix structuring of <code>enum.Enum</code> instances in <code>typing.Literal</code> types. (<code>[#231](python-attrs/cattrs#231) <https://github.com/python-attrs/cattrs/pull/231></code>_)</li> <li>Fix unstructuring all tuples - unannotated, variable-length, homogenous and heterogenous - to <code>list</code>. (<code>[#226](python-attrs/cattrs#226) <https://github.com/python-attrs/cattrs/issues/226></code>_)</li> <li>For <code>forbid_extra_keys</code> raise custom <code>ForbiddenExtraKeyError</code> instead of generic <code>Exception</code>. (<code>[#225](python-attrs/cattrs#225) <https://github.com/python-attrs/cattrs/pull/225></code>_)</li> <li>All preconf converters now support <code>loads</code> and <code>dumps</code> directly. See an example <code>here <https://cattrs.readthedocs.io/en/latest/preconf.html></code>_.</li> <li>Fix mappings with byte keys for the orjson, bson and tomlkit converters. (<code>[#241](python-attrs/cattrs#241) <https://github.com/python-attrs/cattrs/issues/241></code>_)</li> </ul> <h2>1.10.0 (2022-01-04)</h2> <ul> <li>Add PEP 563 (string annotations) support for dataclasses. (<code>[#195](python-attrs/cattrs#195) <https://github.com/python-attrs/cattrs/issues/195></code>_)</li> <li>Fix handling of dictionaries with string Enum keys for bson, orjson, and tomlkit.</li> <li>Rename the <code>cattr.gen.make_dict_unstructure_fn.omit_if_default</code> parameter to <code>_cattrs_omit_if_default</code>, for consistency. The <code>omit_if_default</code> parameters to <code>GenConverter</code> and <code>override</code> are unchanged.</li> <li>Following the changes in <code>attrs</code> 21.3.0, add a <code>cattrs</code> package mirroring the existing <code>cattr</code> package. Both package names may be used as desired, and the <code>cattr</code> package isn't going away.</li> </ul> <h2>1.9.0 (2021-12-06)</h2> <ul> <li>Python 3.10 support, including support for the new union syntax (<code>A | B</code> vs <code>Union[A, B]</code>).</li> <li>The <code>GenConverter</code> can now properly structure generic classes with generic collection fields. (<code>[#149](python-attrs/cattrs#149) <https://github.com/python-attrs/cattrs/issues/149></code>_)</li> <li><code>omit=True</code> now also affects generated structuring functions. (<code>[#166](python-attrs/cattrs#166) <https://github.com/python-attrs/cattrs/issues/166></code>_)</li> <li><code>cattr.gen.{make_dict_structure_fn, make_dict_unstructure_fn}</code> now resolve type annotations automatically when PEP 563 is used. (<code>[#169](python-attrs/cattrs#169) <https://github.com/python-attrs/cattrs/issues/169></code>_)</li> <li>Protocols are now unstructured as their runtime types. (<code>[#177](python-attrs/cattrs#177) <https://github.com/python-attrs/cattrs/pull/177></code>_)</li> <li>Fix an issue generating structuring functions with renaming and <code>_cattrs_forbid_extra_keys=True</code>. (<code>[#190](python-attrs/cattrs#190) <https://github.com/python-attrs/cattrs/issues/190></code>_)</li> </ul> <h2>1.8.0 (2021-08-13)</h2> <ul> <li>Fix <code>GenConverter</code> mapping structuring for unannotated dicts on Python 3.8.</li> </ul> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li>See full diff in <a href="https://github.com/python-attrs/cattrs/commits">compare view</a></li> </ul> </details> <br /> Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details>

RomainMuller added 3 commits August 14, 2018 09:06

Sort member arrays (properties and methods), to produce fully sorted …

343529d

…assemblies

Use project references between the jsii and jsii-spec modules, an…

45a5cdf

…d isolate the `test` typescript configuration.

Stop emitting Java step builders for data types

18ef48e

Use a simple builder class that has `whit`ers for all properties and perform required-validation at `build()` time. Fixes #60

RomainMuller requested a review from eladb August 14, 2018 10:50

eladb reviewed Aug 14, 2018

View reviewed changes

Remove project references

ba64a6d

eladb approved these changes Aug 14, 2018

View reviewed changes

RomainMuller merged commit de3f062 into master Aug 14, 2018

RomainMuller deleted the rmuller/sort-assembly branch August 14, 2018 17:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(jsii): Further normalize assembly outputs #177

feat(jsii): Further normalize assembly outputs #177

RomainMuller commented Aug 14, 2018 •

edited

Loading

eladb Aug 14, 2018

eladb Aug 14, 2018

RomainMuller Aug 14, 2018

eladb Aug 14, 2018

RomainMuller Aug 14, 2018

eladb Aug 14, 2018

RomainMuller Aug 14, 2018

eladb Aug 14, 2018

RomainMuller Aug 14, 2018

eladb Aug 14, 2018

RomainMuller Aug 14, 2018

eladb Aug 14, 2018

RomainMuller Aug 14, 2018

eladb Aug 14, 2018

RomainMuller Aug 14, 2018

eladb Aug 14, 2018

RomainMuller Aug 14, 2018

eladb Aug 14, 2018

feat(jsii): Further normalize assembly outputs #177

feat(jsii): Further normalize assembly outputs #177

Conversation

RomainMuller commented Aug 14, 2018 • edited Loading

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

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RomainMuller commented Aug 14, 2018 •

edited

Loading