5f7fad2605This patch adds `require()` support for synchronous ESM graphs under
the flag `--experimental-require-module`
This is based on the the following design aspect of ESM:
- The resolution can be synchronous (up to the host)
- The evaluation of a synchronous graph (without top-level await) is
also synchronous, and, by the time the module graph is instantiated
(before evaluation starts), this is is already known.
If `--experimental-require-module` is enabled, and the ECMAScript
module being loaded by `require()` meets the following requirements:
- Explicitly marked as an ES module with a `"type": "module"` field in
the closest package.json or a `.mjs` extension.
- Fully synchronous (contains no top-level `await`).
`require()` will load the requested module as an ES Module, and return
the module name space object. In this case it is similar to dynamic
`import()` but is run synchronously and returns the name space object
directly.
```mjs
// point.mjs
export function distance(a, b) {
return (b.x - a.x) ** 2 + (b.y - a.y) ** 2;
}
class Point {
constructor(x, y) { this.x = x; this.y = y; }
}
export default Point;
```
```cjs
const required = require('./point.mjs');
// [Module: null prototype] {
// default: [class Point],
// distance: [Function: distance]
// }
console.log(required);
(async () => {
const imported = await import('./point.mjs');
console.log(imported === required); // true
})();
```
If the module being `require()`'d contains top-level `await`, or the
module graph it `import`s contains top-level `await`,
[`ERR_REQUIRE_ASYNC_MODULE`][] will be thrown. In this case, users
should load the asynchronous module using `import()`.
If `--experimental-print-required-tla` is enabled, instead of throwing
`ERR_REQUIRE_ASYNC_MODULE` before evaluation, Node.js will evaluate the
module, try to locate the top-level awaits, and print their location to
help users fix them.
PR-URL: https://github.com/nodejs/node/pull/51977
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com>
63 lines
1.6 KiB
JavaScript
63 lines
1.6 KiB
JavaScript
// Flags: --experimental-require-module
|
|
'use strict';
|
|
|
|
require('../common');
|
|
const assert = require('assert');
|
|
const { spawnSyncAndExit } = require('../common/child_process');
|
|
const fixtures = require('../common/fixtures');
|
|
|
|
const message = /require\(\) cannot be used on an ESM graph with top-level await/;
|
|
const code = 'ERR_REQUIRE_ASYNC_MODULE';
|
|
|
|
assert.throws(() => {
|
|
require('../fixtures/es-modules/tla/rejected.mjs');
|
|
}, { message, code });
|
|
|
|
assert.throws(() => {
|
|
require('../fixtures/es-modules/tla/unresolved.mjs');
|
|
}, { message, code });
|
|
|
|
|
|
assert.throws(() => {
|
|
require('../fixtures/es-modules/tla/resolved.mjs');
|
|
}, { message, code });
|
|
|
|
// Test TLA in inner graphs.
|
|
assert.throws(() => {
|
|
require('../fixtures/es-modules/tla/parent.mjs');
|
|
}, { message, code });
|
|
|
|
{
|
|
spawnSyncAndExit(process.execPath, [
|
|
'--experimental-require-module',
|
|
fixtures.path('es-modules/tla/require-execution.js'),
|
|
], {
|
|
signal: null,
|
|
status: 1,
|
|
stderr(output) {
|
|
assert.doesNotMatch(output, /I am executed/);
|
|
assert.match(output, message);
|
|
return true;
|
|
},
|
|
stdout: ''
|
|
});
|
|
}
|
|
|
|
{
|
|
spawnSyncAndExit(process.execPath, [
|
|
'--experimental-require-module',
|
|
'--experimental-print-required-tla',
|
|
fixtures.path('es-modules/tla/require-execution.js'),
|
|
], {
|
|
signal: null,
|
|
status: 1,
|
|
stderr(output) {
|
|
assert.match(output, /I am executed/);
|
|
assert.match(output, /Error: unexpected top-level await at.*execution\.mjs:3/);
|
|
assert.match(output, /await Promise\.resolve\('hi'\)/);
|
|
assert.match(output, message);
|
|
return true;
|
|
},
|
|
stdout: ''
|
|
});
|
|
}
|