Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 545c069

Browse filesBrowse files
guybedfordruyadorno
guybedford
authored and
ruyadorno
committed
module: support 'module.exports' interop export in require(esm)
PR-URL: #54563 Backport-PR-URL: #55217 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Refs: #52697
1 parent 58d6871 commit 545c069
Copy full SHA for 545c069

54 files changed

+308-6Lines changed: 308 additions & 6 deletions

File tree

Expand file treeCollapse file tree
Open diff view settings
Filter options

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Dismiss banner
Expand file treeCollapse file tree
Open diff view settings
Expand file

‎doc/api/modules.md‎

Copy file name to clipboardExpand all lines: doc/api/modules.md
+64-2Lines changed: 64 additions & 2 deletions
  • Display the source diff
  • Display the rich diff
Collapse file

‎lib/internal/modules/cjs/loader.js‎

Copy file name to clipboardExpand all lines: lib/internal/modules/cjs/loader.js
+7-4Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1416,10 +1416,13 @@ function loadESMFromCJS(mod, filename) {
14161416
// createRequiredModuleFacade() to `wrap` which is a ModuleWrap wrapping
14171417
// over the original module.
14181418

1419-
// We don't do this to modules that don't have default exports to avoid
1420-
// the unnecessary overhead. If __esModule is already defined, we will
1421-
// also skip the extension to allow users to override it.
1422-
if (!ObjectHasOwn(namespace, 'default') || ObjectHasOwn(namespace, '__esModule')) {
1419+
// We don't do this to modules that are marked as CJS ESM or that
1420+
// don't have default exports to avoid the unnecessary overhead.
1421+
// If __esModule is already defined, we will also skip the extension
1422+
// to allow users to override it.
1423+
if (ObjectHasOwn(namespace, 'module.exports')) {
1424+
mod.exports = namespace['module.exports'];
1425+
} else if (!ObjectHasOwn(namespace, 'default') || ObjectHasOwn(namespace, '__esModule')) {
14231426
mod.exports = namespace;
14241427
} else {
14251428
mod.exports = createRequiredModuleFacade(wrap);
Collapse file

‎test/es-module/test-require-as-esm-interop.mjs‎

Copy file name to clipboard
+51Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
// Flags: --experimental-require-module
2+
import '../common/index.mjs';
3+
import assert from 'assert';
4+
import { directRequireFixture, importFixture } from '../fixtures/pkgexports.mjs';
5+
6+
const tests = {
7+
'false': false,
8+
'string': 'cjs',
9+
'object': { a: 'cjs a', b: 'cjs b' },
10+
'fauxesmdefault': { default: 'faux esm default' },
11+
'fauxesmmixed': { default: 'faux esm default', a: 'faux esm a', b: 'faux esm b' },
12+
'fauxesmnamed': { a: 'faux esm a', b: 'faux esm b' }
13+
};
14+
15+
// This test demonstrates interop between CJS and CJS represented as ESM
16+
// under the new `export { ... as 'module.exports'}` pattern, for the above cases.
17+
for (const [test, exactShape] of Object.entries(tests)) {
18+
// Each case represents a CJS dependency, which has the expected shape in CJS:
19+
assert.deepStrictEqual(directRequireFixture(`interop-cjsdep-${test}`), exactShape);
20+
21+
// Each dependency is reexported through CJS as if it is a library being consumed,
22+
// which in CJS is fully shape-preserving:
23+
assert.deepStrictEqual(directRequireFixture(`interop-cjs/${test}`), exactShape);
24+
25+
// Now we have ESM conversions of these dependencies, using `export ... as "module.exports"`
26+
// staring with the conversion of those dependencies into ESM under require(esm):
27+
assert.deepStrictEqual(directRequireFixture(`interop-cjsdep-${test}-esm`), exactShape);
28+
29+
// When importing these ESM conversions, from require(esm), we should preserve the shape:
30+
assert.deepStrictEqual(directRequireFixture(`interop-cjs/${test}-esm`), exactShape);
31+
32+
// Now if the importer itself is converted into ESM, it should still be able to load the original
33+
// CJS and reexport it, preserving the shape:
34+
assert.deepStrictEqual(directRequireFixture(`interop-cjs-esm/${test}`), exactShape);
35+
36+
// And then if we have the converted CJS to ESM importing from converted CJS to ESM,
37+
// that should also work:
38+
assert.deepStrictEqual(directRequireFixture(`interop-cjs-esm/${test}-esm`), exactShape);
39+
40+
// Finally, the CJS ESM representation under `import()` should match all these cases equivalently,
41+
// where the CJS module is exported as the default export:
42+
const esmCjsImport = await importFixture(`interop-cjsdep-${test}`);
43+
assert.deepStrictEqual(esmCjsImport.default, exactShape);
44+
45+
assert.deepStrictEqual((await importFixture(`interop-cjsdep-${test}`)).default, exactShape);
46+
assert.deepStrictEqual((await importFixture(`interop-cjs/${test}`)).default, exactShape);
47+
assert.deepStrictEqual((await importFixture(`interop-cjsdep-${test}-esm`)).default, exactShape);
48+
assert.deepStrictEqual((await importFixture(`interop-cjs/${test}-esm`)).default, exactShape);
49+
assert.deepStrictEqual((await importFixture(`interop-cjs-esm/${test}`)).default, exactShape);
50+
assert.deepStrictEqual((await importFixture(`interop-cjs-esm/${test}-esm`)).default, exactShape);
51+
}
Collapse file

‎test/fixtures/node_modules/interop-cjs-esm/false-esm.js‎

Copy file name to clipboardExpand all lines: test/fixtures/node_modules/interop-cjs-esm/false-esm.js
+3Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Collapse file

‎test/fixtures/node_modules/interop-cjs-esm/false.js‎

Copy file name to clipboardExpand all lines: test/fixtures/node_modules/interop-cjs-esm/false.js
+3Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Collapse file

‎test/fixtures/node_modules/interop-cjs-esm/fauxesmdefault-esm.js‎

Copy file name to clipboardExpand all lines: test/fixtures/node_modules/interop-cjs-esm/fauxesmdefault-esm.js
+3Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Collapse file

‎test/fixtures/node_modules/interop-cjs-esm/fauxesmdefault.js‎

Copy file name to clipboardExpand all lines: test/fixtures/node_modules/interop-cjs-esm/fauxesmdefault.js
+3Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Collapse file

‎test/fixtures/node_modules/interop-cjs-esm/fauxesmmixed-esm.js‎

Copy file name to clipboardExpand all lines: test/fixtures/node_modules/interop-cjs-esm/fauxesmmixed-esm.js
+4Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Collapse file

‎test/fixtures/node_modules/interop-cjs-esm/fauxesmmixed.js‎

Copy file name to clipboardExpand all lines: test/fixtures/node_modules/interop-cjs-esm/fauxesmmixed.js
+3Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Collapse file

‎test/fixtures/node_modules/interop-cjs-esm/fauxesmnamed-esm.js‎

Copy file name to clipboardExpand all lines: test/fixtures/node_modules/interop-cjs-esm/fauxesmnamed-esm.js
+3Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.