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

feat(aws-cdk-lib): reduce JavaScript load time, second attempt #27362

Merged
merged 4 commits into from
Oct 3, 2023

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented Sep 30, 2023

This is a re-roll of #27217 which had to be reverted (first attempt to fix forward in #27314, then reverted in #27353).

The issue with the previous change were:

  • The mutation was accidentally switched off at the last second.
  • It did not work for ESM modules, because the code were were generating was not recognized as a CommonJS export by cjs-module-lexer.

We now generate code that passes the cjs-module-lexer, and have tests in place to prove it.


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

@aws-cdk-automation aws-cdk-automation requested a review from a team September 30, 2023 08:56
@github-actions github-actions bot added the p2 label Sep 30, 2023
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Sep 30, 2023
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

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

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

This change halves the load time of `require('aws-cdk-lib')`, from ~600ms to ~300ms on my machine. It also shaves ~8min off running all integ tests (again, on my machine).

It does this by making all loading of JavaScript modules lazy, so they are only loaded just before any symbols from them are actually accessed (instead of loading all modules at startup). This new automatic module replaces the previous manual effort to do something similar, in `lazy-index.ts`.

Note that this transformation (unfortunately) does not affect TypeScript compilation times: the TypeScript compiler is still going to read all `.d.ts` files. To improve interactive TypeScript performance, use `swc` or `ts-node` with type checking disabled. Fully type checking your application using `tsc` will take the amount of time it takes.

Turning this:

```js
const x = require("x");
module.exports.banana = function() {
  return x.hello();
}
```

Into this:

```js
var x = () => { var tmp = require("x"); x = () => tmp; return tmp; };
module.exports.banana = function () {
    return x().hello();
};
```
@rix0rrr rix0rrr added pr-linter/exempt-readme The PR linter will not require README changes pr-linter/exempt-integ-test The PR linter will not require integ test changes labels Oct 2, 2023
@rix0rrr rix0rrr changed the title feat(aws-cdk-lib): reduce load time, again feat(aws-cdk-lib): reduce JavaScript load time, second attempt Oct 2, 2023
@aws-cdk-automation aws-cdk-automation dismissed their stale review October 2, 2023 12:51

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Oct 2, 2023
@rix0rrr rix0rrr self-assigned this Oct 2, 2023
@mergify
Copy link
Contributor

mergify bot commented Oct 3, 2023

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

@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Oct 3, 2023
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 91c4bab
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@mergify mergify bot merged commit 0bb49b4 into main Oct 3, 2023
16 of 17 checks passed
@mergify mergify bot deleted the huijbers/lazify-2 branch October 3, 2023 09:59
@mergify
Copy link
Contributor

mergify bot commented Oct 3, 2023

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

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. p2 pr-linter/exempt-integ-test The PR linter will not require integ test changes pr-linter/exempt-readme The PR linter will not require README changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants