module: CJS / ESM resolver sharing and refactoring by guybedford · Pull Request #34744 · nodejs/node

guybedford · 2020-08-12T01:51:27Z

This extracts just the resolver refactoring component from #34718.

I hope that the negative diff speaks for itself at least!

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

nodejs-github-bot · 2020-08-12T01:51:32Z

Review requested:

@nodejs/modules

ljharb · 2020-08-12T05:07:01Z

Wait, so now you can map your exports to things in node_modules?? Can you help me understand why that's a good idea?

guybedford · 2020-08-12T05:32:19Z

Sure, I can add it back, it's just that the spec was actually incorrect since it was only checking the package.json target path, when we in fact need to check both the target path and the user subpath. We give separate errors for these two cases because the one is package author issue while the other is a package consumer issue. This error separation doesn't apply as easily for patterns though so those errors may need to be rethought. I refactored it out because it seems overly strict and unnecessary but I can add it back.

ljharb · 2020-08-12T05:46:50Z

I think it's very critical that "exports" only be possible to use to remap an entry specifier to "a file within the package that has exports".

guybedford · 2020-08-12T18:29:01Z

@ljharb I've added back the node_modules restriction identically to previously with a refactoring to make it part of the new segment check approach.

guybedford · 2020-08-12T22:25:34Z

I would like to land this PR soon. Any further feedback welcome.

guybedford · 2020-08-12T22:25:52Z

@nodejs/modules-active-members for any further review

nodejs-github-bot · 2020-08-12T22:34:15Z

CI: https://ci.nodejs.org/job/node-test-pull-request/32750/

nodejs-github-bot · 2020-08-12T23:37:33Z

CI: https://ci.nodejs.org/job/node-test-pull-request/32751/

PR-URL: #34744 Reviewed-By: Jan Krems <jan.krems@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

guybedford · 2020-08-13T18:05:14Z

Landed in f8976a7.

Broken locally for me since f8976a7. Refs: nodejs#34744

PR-URL: #34744 Reviewed-By: Jan Krems <jan.krems@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

PR-URL: nodejs#34744 Reviewed-By: Jan Krems <jan.krems@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

PR-URL: #34744 Backport-PR-URL: #35385 Reviewed-By: Jan Krems <jan.krems@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Previously, `requireStack` was attached only on the bottom fallback path of `Module._resolveFilename`. Errors thrown from `tryPackage`, `trySelf`, the `#imports` branch, `finalizeEsmResolution`, and from within `Module._findPath` (exports/imports resolution failures) all escaped without it, leaving the diagnostic uneven depending on which inner path failed. This change makes the diagnostic uniform across those paths via two helpers: * `buildRequireStack(parent)` walks the parent chain. It is called lazily on the error path only, so successful resolves keep their original cost and a pathological parent-chain cycle from `module.parent = module` cannot hang the hot path. * `attachRequireStack(err, parent)` applies the stack to an error when (a) the error code is in a `SafeSet` of module-resolution codes (`MODULE_NOT_FOUND`, `ERR_MODULE_NOT_FOUND`, `ERR_PACKAGE_PATH_NOT_EXPORTED`, `ERR_PACKAGE_IMPORT_NOT_DEFINED`, `ERR_INVALID_MODULE_SPECIFIER`, `ERR_INVALID_PACKAGE_TARGET`, `ERR_INVALID_PACKAGE_CONFIG`), (b) `err.requireStack` is not already an array, and (c) the error object is extensible. The last check protects against monkey-patched `Module._findPath` implementations that may throw frozen errors. The catch blocks in the `#imports`, `trySelf`, and `Module._findPath` paths delegate to `attachRequireStack`, and the bottom fallback uses `buildRequireStack` directly. Resolves two long-standing `TODO(BridgeAR): Add the requireStack as well` comments in `lib/internal/modules/cjs/loader.js`, originally deferred in nodejs#26823 (2019) and carried through nodejs#34744 (2020). Tests cover the `#imports`-to-missing-file case, the `ERR_PACKAGE_PATH_NOT_EXPORTED` case via self-require, a frozen- error monkey-patch (must not crash), and a preset non-array `requireStack` value (must be replaced). Existing assertions in `test-module-loading.js` and `test-module-loading-error.js` are extended to verify the new property on errors that previously lacked it. Signed-off-by: sangwook <rewq5991@gmail.com>

nodejs-github-bot added errors Issues and PRs related to JavaScript errors originated in Node.js core. esm Issues and PRs related to the ECMAScript Modules implementation. labels Aug 12, 2020

guybedford changed the title ~~module: exports patterns and resolver refactoring~~module: CJS / ESM resolver sharing and refactoringAug 12, 2020

guybedford mentioned this pull request Aug 12, 2020
module: exports patterns #34718
Closed
4 tasks

hybrist approved these changes Aug 12, 2020
View reviewed changes

ljharb reviewed Aug 12, 2020
View reviewed changes

Comment threadlib/internal/modules/cjs/loader.js Outdated

module: CJS/ESM resolver sharing and refactoring
fc1f44b

guybedford force-pushed the resolve-refactor branch from 734865c to fc1f44bCompare August 12, 2020 22:24

jasnell approved these changes Aug 12, 2020
View reviewed changes

windows fixes
b5622f9

guybedford added a commit that referenced this pull request Aug 13, 2020
module: share CJS/ESM resolver fns, refactoring
f8976a7
PR-URL: #34744 Reviewed-By: Jan Krems <jan.krems@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

guybedford closed this Aug 13, 2020

addaleax added a commit to addaleax/node that referenced this pull request Aug 13, 2020
test: fix message/esm_loader_not_found_cjs_hint_bare
f53b806
Broken locally for me since f8976a7. Refs: nodejs#34744

addaleax mentioned this pull request Aug 13, 2020
test: fix message/esm_loader_not_found_cjs_hint_bare #34764
Closed
3 tasks

guybedford mentioned this pull request Aug 15, 2020
module: missing path separator in ERR_PACKAGE_PATH_NOT_EXPORTED message from CJS #34778
Closed

MylesBorins pushed a commit that referenced this pull request Aug 17, 2020
module: share CJS/ESM resolver fns, refactoring
2f7cfe5
PR-URL: #34744 Reviewed-By: Jan Krems <jan.krems@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

danielleadams mentioned this pull request Aug 20, 2020
V14.9.0 proposal #34852
Merged

BethGriggs pushed a commit that referenced this pull request Aug 20, 2020
module: share CJS/ESM resolver fns, refactoring
698cae7
PR-URL: #34744 Reviewed-By: Jan Krems <jan.krems@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

guybedford added a commit to guybedford/node that referenced this pull request Sep 28, 2020
module: share CJS/ESM resolver fns, refactoring
7e20df2
PR-URL: nodejs#34744 Reviewed-By: Jan Krems <jan.krems@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

addaleax added the backport-open-v12.x label Sep 28, 2020

codebytere pushed a commit that referenced this pull request Oct 1, 2020
module: share CJS/ESM resolver fns, refactoring
cecc193
PR-URL: #34744 Backport-PR-URL: #35385 Reviewed-By: Jan Krems <jan.krems@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

codebytere mentioned this pull request Oct 4, 2020
v12.19.0 proposal #35401
Merged

cyyynthia mentioned this pull request Apr 7, 2025
esm: remove check for trailing slash during resolve #57773
Closed

Han5991 mentioned this pull request May 23, 2026
module: add requireStack to all error paths #62059
Open

Navigation Menu

Uh oh!

Uh oh!

module: CJS / ESM resolver sharing and refactoring - #34744

module: CJS / ESM resolver sharing and refactoring#34744
guybedford wants to merge 2 commits into
nodejs:masterfrom
guybedford:resolve-refactor

guybedford commented Aug 12, 2020•
edited
Loading

Uh oh!

nodejs-github-bot commented Aug 12, 2020•
edited by DerekNonGeneric
Loading

Uh oh!

ljharb commented Aug 12, 2020

Uh oh!

guybedford commented Aug 12, 2020

Uh oh!

ljharb commented Aug 12, 2020

Uh oh!

guybedford commented Aug 12, 2020

Uh oh!

Uh oh!

guybedford commented Aug 12, 2020

Uh oh!

guybedford commented Aug 12, 2020

Uh oh!

nodejs-github-bot commented Aug 12, 2020

Uh oh!

nodejs-github-bot commented Aug 12, 2020

Uh oh!

guybedford commented Aug 13, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Uh oh!

Uh oh!

Conversation

guybedford commented Aug 12, 2020• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

nodejs-github-bot commented Aug 12, 2020• edited by DerekNonGeneric Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ljharb commented Aug 12, 2020

Uh oh!

guybedford commented Aug 12, 2020

Uh oh!

ljharb commented Aug 12, 2020

Uh oh!

guybedford commented Aug 12, 2020

Uh oh!

Uh oh!

guybedford commented Aug 12, 2020

Uh oh!

guybedford commented Aug 12, 2020

Uh oh!

nodejs-github-bot commented Aug 12, 2020

Uh oh!

nodejs-github-bot commented Aug 12, 2020

Uh oh!

guybedford commented Aug 13, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

guybedford commented Aug 12, 2020•
edited
Loading

nodejs-github-bot commented Aug 12, 2020•
edited by DerekNonGeneric
Loading