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 ed3278d

Browse filesBrowse files
ctavancodebytere
ctavan
authored and
codebytere
committed
module: fix crash on multiline named cjs imports
The node process crashes when trying to parse a multiline import statement for named exports of a CommonJS module: TypeError: Cannot read property '0' of null at ModuleJob._instantiate (internal/modules/esm/module_job.js:112:77) at async ModuleJob.run (internal/modules/esm/module_job.js:137:5) at async Loader.import (internal/modules/esm/loader.js:165:24) at async rejects.name (file:///***/node/test/es-module/test-esm-cjs-named-error.mjs:56:3) at async waitForActual (assert.js:721:5) at async rejects (assert.js:830:25), The reason is that the regexp that is currently used to decorate the original error fails for multi line import statements. Unfortunately the undecorated error stack only contains the single line which causes the import to fail: file:///***/node/test/fixtures/es-modules/package-cjs-named-error/multi-line.mjs:2 comeOn, ^^^^^^ SyntaxError: The requested module './fail.cjs' does not provide an export named 'comeOn' at ModuleJob._instantiate (internal/modules/esm/module_job.js:98:21) at async ModuleJob.run (internal/modules/esm/module_job.js:141:5) at async Loader.import (internal/modules/esm/loader.js:165:24) at async rejects.name (file:///***/node/test/es-module/test-esm-cjs-named-error.mjs:56:3) at async waitForActual (assert.js:721:5) at async rejects (assert.js:830:25) Hence, for multiline import statements we cannot create an equivalent piece of code that uses default import followed by an object destructuring assignment. In any case the node process should definitely not crash. So until we have a more sophisticated way of extracting the entire problematic multiline import statement, show the code example only for single-line imports where the current regexp approach works well. Refs: #35259 PR-URL: #35275 Backport-PR-URL: #35385 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
1 parent 89a58f6 commit ed3278d
Copy full SHA for ed3278d

File tree

Expand file treeCollapse file tree

4 files changed

+31
-8
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

4 files changed

+31
-8
lines changed
Open diff view settings
Collapse file

‎lib/internal/modules/esm/module_job.js‎

Copy file name to clipboardExpand all lines: lib/internal/modules/esm/module_job.js
+14-7Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -107,16 +107,23 @@ class ModuleJob {
107107
await this.loader.resolve(childSpecifier, parentFileUrl);
108108
const format = await this.loader.getFormat(childFileURL);
109109
if (format === 'commonjs') {
110-
const importStatement = splitStack[1];
111-
const namedImports = StringPrototypeMatch(importStatement, /{.*}/)[0];
112-
const destructuringAssignment = StringPrototypeReplace(namedImports, /\s+as\s+/g, ': ');
113110
e.message = `The requested module '${childSpecifier}' is expected ` +
114111
'to be of type CommonJS, which does not support named exports. ' +
115112
'CommonJS modules can be imported by importing the default ' +
116-
'export.\n' +
117-
'For example:\n' +
118-
`import pkg from '${childSpecifier}';\n` +
119-
`const ${destructuringAssignment} = pkg;`;
113+
'export.';
114+
// TODO(@ctavan): The original error stack only provides the single
115+
// line which causes the error. For multi-line import statements we
116+
// cannot generate an equivalent object descructuring assignment by
117+
// just parsing the error stack.
118+
const importStatement = splitStack[1];
119+
const oneLineNamedImports = StringPrototypeMatch(importStatement, /{.*}/);
120+
if (oneLineNamedImports) {
121+
const destructuringAssignment =
122+
StringPrototypeReplace(oneLineNamedImports[0], /\s+as\s+/g, ': ');
123+
e.message += '\nFor example:\n' +
124+
`import pkg from '${childSpecifier}';\n` +
125+
`const ${destructuringAssignment} = pkg;`;
126+
}
120127
const newStack = StringPrototypeSplit(e.stack, '\n');
121128
newStack[3] = `SyntaxError: ${e.message}`;
122129
e.stack = ArrayPrototypeJoin(newStack, '\n');
Collapse file

‎test/es-module/test-esm-cjs-named-error.mjs‎

Copy file name to clipboardExpand all lines: test/es-module/test-esm-cjs-named-error.mjs
+11Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ const expectedRelative = 'The requested module \'./fail.cjs\' is expected to ' +
1010
'import pkg from \'./fail.cjs\';\n' +
1111
'const { comeOn } = pkg;';
1212

13+
const expectedWithoutExample = 'The requested module \'./fail.cjs\' is ' +
14+
'expected to be of type CommonJS, which does not support named exports. ' +
15+
'CommonJS modules can be imported by importing the default export.';
16+
1317
const expectedRenamed = 'The requested module \'./fail.cjs\' is expected to ' +
1418
'be of type CommonJS, which does not support named exports. CommonJS ' +
1519
'modules can be imported by importing the default export.\n' +
@@ -52,6 +56,13 @@ rejects(async () => {
5256
message: expectedRenamed
5357
}, 'should correctly format named imports with renames');
5458

59+
rejects(async () => {
60+
await import(`${fixtureBase}/multi-line.mjs`);
61+
}, {
62+
name: 'SyntaxError',
63+
message: expectedWithoutExample,
64+
}, 'should correctly format named imports across multiple lines');
65+
5566
rejects(async () => {
5667
await import(`${fixtureBase}/json-hack.mjs`);
5768
}, {
Collapse file

‎test/fixtures/es-modules/package-cjs-named-error/fail.cjs‎

Copy file name to clipboard
+2-1Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
module.exports = {
2-
comeOn: 'fhqwhgads'
2+
comeOn: 'fhqwhgads',
3+
everybody: 'to the limit',
34
};
Collapse file

‎test/fixtures/es-modules/package-cjs-named-error/multi-line.mjs‎

Copy file name to clipboard
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
import {
2+
comeOn,
3+
everybody,
4+
} from './fail.cjs';

0 commit comments

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