-
Notifications
You must be signed in to change notification settings - Fork 29.1k
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
module: unflag --experimental-require-module #55085
base: main
Are you sure you want to change the base?
Conversation
Review requested:
|
This comment was marked as outdated.
This comment was marked as outdated.
This unflags --experimental-require-module so require(esm) can be used without the flag. For now, when require() actually encounters an ESM, it will still emit an experimental warning. To opt out of the feature, --no-experimental-require-module can be used. There are some tests specifically testing ERR_REQUIRE_ESM. Some of them are repurposed to test --no-experimental-require-module. Some of them are modified to just expect loading require(esm) to work, when it's appropriate.
8c00119
to
7af5b5d
Compare
Did some testing with https://github.com/joyeecheung/test-require-esm using the high-impact npm packages labeled as esm/dual/faux by https://github.com/wooorm/npm-esm-vs-cjs (I took the top 5000 as the sample), output is in https://gist.github.com/joyeecheung/f691e98e0994186f14417237ccb51f53 (note: I excluded a few packages that are not meant to be loaded in Node.js/not meant to be loaded as a module/cannot be installed properly due to conflicts with other packages out of the 5000 sample, see https://github.com/joyeecheung/test-require-esm/blob/a29118dbd1f868eddc64514c93a4b02c6c157013/try2.cjs#L7) Summary:Impact on dual packagesBefore unflagging, on v22.9.0, 363 out of 379 dual packages could be Impact on esm-only packagesBefore unflagging, on v22.9.0, 103 out of 662 esm packages could be
The conclusion is, most (>95%) high-impact esm-only npm packages can now be loaded with Impact on faux-esm packagesOn both v22 and in this PR, 526 faux packages out of the 5000 high impact npm packages can be loaded. Only The conclusion is that this does not incur additional regression compared to v22, but there is likely a regression if backported as-is to v20. I don't think this prevents us from unflagging Impact on cjs packagesGiven that the majority of the high-impact npm packages are CommonJS so the number of them is the biggest, I didn't have the time to test them all yet, but some preliminary testing and the tests covered by the core test suites at least shows that they are unlikely to be affected by this change. |
I think this is ready for review - at least, for being landed in v23, PTAL @nodejs/tsc @nodejs/loaders |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
The
notable-change
Please suggest a text for the release notes if you'd like to include a more detailed summary, then proceed to update the PR description with the text or a link to the notable change suggested text comment. Otherwise, the commit will be placed in the Other Notable Changes section. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #55085 +/- ##
==========================================
- Coverage 88.24% 88.24% -0.01%
==========================================
Files 651 651
Lines 183877 183868 -9
Branches 35858 35852 -6
==========================================
- Hits 162266 162258 -8
+ Misses 14901 14894 -7
- Partials 6710 6716 +6
|
This unflags --experimental-require-module so require(esm) can be used without the flag. For now, when require() actually encounters an ESM for the first time in a process, it will still emit an experimental warning. To opt out of the feature, --no-experimental-require-module can be used.
There are some tests specifically testing ERR_REQUIRE_ESM. Some of them are repurposed to test --no-experimental-require-module. Some of them are modified to just expect loading require(esm) to work, when it's appropriate.
This is expected to go out in 23 and get some testing before being backported to older LTS.
See #55085 (comment) for a summary of the impact of this on loading the high-impact npm packages.
Refs: #52697