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

chore: move API compatiblity check to final build step #2911

Merged
merged 1 commit into from
Jun 19, 2019

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented Jun 18, 2019

Motivation: taking it out of the per-package 'test' step has the
following benefits:

  • the build+test cycle is quicker, because we avoid unnecessary
    downloads of old versions of the package from NPM.
  • we avoid quadratic complexity of downloads, where packages deep
    in the dependency tree get downloaded over and over again.
  • there is a clear moment and location where the check is done,
    which can be easily disabled.

There is still accidental quadratic complexity in the current
implementation which cannot be avoided without updating jsii-diff:
although all downloads are done only once, every package's JSII
assembly is still loaded individually, and all dependencies are
reloaded every time.

Loading assemblies is not as cheap as you'd think, leading many
packages to take multiple seconds to load (~4s per package) and
so the whole process still takes multiple minutes.


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
    • Design: For significant features, design document added to design folder
  • Title and Description
    • Change type: title prefixed with fix, feat and module name in parens, which 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.

Motivation: taking it out of the per-package 'test' step has the
following benefits:

- the build+test cycle is quicker, because we avoid unnecessary
  downloads of old versions of the package from NPM.
- we avoid quadratic complexity of downloads, where packages deep
  in the dependency tree get downloaded over and over again.
- there is a clear moment and location where the check is done,
  which can be easily disabled.

There is still accidental quadratic complexity in the current
implementation which cannot be avoided without updating jsii-diff:
although all downloads are done only once, every package's JSII
assembly is still loaded individually, and all dependencies are
reloaded every time.

Loading assemblies is not as cheap as you'd think, leading many
packages to take multiple seconds to load (~4s per package) and
so the whole process still takes multiple minutes.
mkdir -p $tmpdir

echo "Installing from NPM..." >&2
(cd $tmpdir && npm install --prefix $tmpdir ${package_names[@]})
Copy link
Contributor

Choose a reason for hiding this comment

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

--no-save I guess

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In a tempdir? Don't care.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Also, there is no package.json so where would it save :)

@rix0rrr rix0rrr merged commit 5b44a4d into master Jun 19, 2019
@rix0rrr rix0rrr deleted the huijbers/api-check branch June 19, 2019 06:34
@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 27, 2019
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.

3 participants