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

module: do not warn when require(esm) comes from node_modules #55960

Merged

Conversation

joyeecheung
Copy link
Member

@joyeecheung joyeecheung commented Nov 22, 2024

As part of the standard experimental feature graduation policy, when we unflagged require(esm) we moved the experimental warning to be emitted when require() is actually used to load ESM, which previously was an error. However, some packages in the ecosystem have already being using try-catch to load require(esm) to e.g. resolve optional dependency, and emitting warning from there instead of throwing directly could break the CLI output.

To reduce the disruption for releases, as a compromise, this patch skips the warning if require(esm) comes from node_modules, where users typically don't have much control over the code. This warning will be eventually removed when require(esm) becomes stable.

This patch was originally intended for the LTS releases (originally in #55217), though it seems there's appetite for it on v23.x as well so it's re-targeted to the main branch.

Refs: #55217
Refs: #52697

As part of the standard experimental feature graduation
policy, when we unflagged require(esm) we moved the
experimental warning to be emitted when require() is
actually used to load ESM, which previously was an error.
However, some packages in the ecosystem have already
being using try-catch to load require(esm) to e.g.
resolve optional dependency, and emitting warning from
there instead of throwing directly could break the CLI
output.

To reduce the disruption for releases, as a compromise, this
patch skips the warning if require(esm) comes from
node_modules, where users typically don't have much control
over the code. This warning will be eventually removed
when require(esm) becomes stable.

This patch was originally intended for the LTS releases,
though it seems there's appetite for it on v23.x as
well so it's re-targeted to the main branch.
@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/loaders

@nodejs-github-bot nodejs-github-bot added module Issues and PRs related to the module subsystem. needs-ci PRs that need a full CI run. labels Nov 22, 2024
@joyeecheung joyeecheung added the request-ci Add this label to start a Jenkins CI on a PR. label Nov 22, 2024
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 22, 2024
@nodejs-github-bot
Copy link
Collaborator

@joyeecheung joyeecheung added request-ci Add this label to start a Jenkins CI on a PR. and removed request-ci Add this label to start a Jenkins CI on a PR. labels Nov 22, 2024
@joyeecheung
Copy link
Member Author

Not sure it needs a fast-track, though it was already reviewed and approved before in #55217

Copy link

codecov bot commented Nov 23, 2024

Codecov Report

Attention: Patch coverage is 87.50000% with 5 lines in your changes missing coverage. Please review.

Project coverage is 87.99%. Comparing base (1d01ad6) to head (8292fe3).
Report is 20 commits behind head on main.

Files with missing lines Patch % Lines
lib/internal/modules/cjs/loader.js 87.50% 4 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #55960      +/-   ##
==========================================
- Coverage   88.01%   87.99%   -0.02%     
==========================================
  Files         653      653              
  Lines      187735   187872     +137     
  Branches    35874    35888      +14     
==========================================
+ Hits       165229   165318      +89     
- Misses      15693    15723      +30     
- Partials     6813     6831      +18     
Files with missing lines Coverage Δ
lib/internal/modules/cjs/loader.js 94.30% <87.50%> (+0.06%) ⬆️

... and 31 files with indirect coverage changes

---- 🚨 Try these New Features:

@nodejs-github-bot
Copy link
Collaborator

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link
Contributor

@aduh95 aduh95 left a comment

Choose a reason for hiding this comment

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

LGTM. Is my understanding correct that the plan is to revert immediately after it has landed, and the revert won't land on release lines (or maybe only 23.x)?

@aduh95 aduh95 added fast-track PRs that do not need to wait for 48 hours to land. author ready PRs that have at least one approval, no pending requests for changes, and a CI started. labels Nov 23, 2024
Copy link
Contributor

Fast-track has been requested by @aduh95. Please 👍 to approve.

@joyeecheung joyeecheung added the commit-queue Add this label to land a pull request using GitHub Actions. label Nov 23, 2024
@joyeecheung
Copy link
Member Author

joyeecheung commented Nov 23, 2024

LGTM. Is my understanding correct that the plan is to revert immediately after it has landed, and the revert won't land on release lines (or maybe only 23.x)?

Seems unnecessary to revert (and would be introducing backport conflicts) if it's going to be on both 23 and 22, at most we still get extra warnings on nightlies if we revert which doesn't seem super...useful?

@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Nov 23, 2024
@nodejs-github-bot nodejs-github-bot merged commit 1919560 into nodejs:main Nov 23, 2024
80 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in 1919560

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. fast-track PRs that do not need to wait for 48 hours to land. module Issues and PRs related to the module subsystem. needs-ci PRs that need a full CI run.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants