mirror of
https://github.com/nodejs/node.git
synced 2024-11-21 10:59:27 +00:00
5f7fad2605
This 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>
119 lines
4.3 KiB
JavaScript
119 lines
4.3 KiB
JavaScript
'use strict';
|
|
// Flags: --expose-internals
|
|
|
|
require('../common');
|
|
|
|
const { strictEqual, throws } = require('assert');
|
|
const { createModuleLoader } = require('internal/modules/esm/loader');
|
|
const { LoadCache, ResolveCache } = require('internal/modules/esm/module_map');
|
|
const { ModuleJob } = require('internal/modules/esm/module_job');
|
|
const createDynamicModule = require(
|
|
'internal/modules/esm/create_dynamic_module');
|
|
|
|
const jsModuleDataUrl = 'data:text/javascript,export{}';
|
|
const jsonModuleDataUrl = 'data:application/json,""';
|
|
|
|
const stubJsModule = createDynamicModule([], ['default'], jsModuleDataUrl);
|
|
const stubJsonModule = createDynamicModule([], ['default'], jsonModuleDataUrl);
|
|
|
|
const loader = createModuleLoader(false);
|
|
const jsModuleJob = new ModuleJob(loader, stubJsModule.module, undefined,
|
|
() => new Promise(() => {}));
|
|
const jsonModuleJob = new ModuleJob(loader, stubJsonModule.module,
|
|
{ type: 'json' },
|
|
() => new Promise(() => {}));
|
|
|
|
|
|
// LoadCache.set and LoadCache.get store and retrieve module jobs for a
|
|
// specified url/type tuple; LoadCache.has correctly reports whether such jobs
|
|
// are stored in the map.
|
|
{
|
|
const moduleMap = new LoadCache();
|
|
|
|
moduleMap.set(jsModuleDataUrl, undefined, jsModuleJob);
|
|
moduleMap.set(jsonModuleDataUrl, 'json', jsonModuleJob);
|
|
|
|
strictEqual(moduleMap.get(jsModuleDataUrl), jsModuleJob);
|
|
strictEqual(moduleMap.get(jsonModuleDataUrl, 'json'), jsonModuleJob);
|
|
|
|
strictEqual(moduleMap.has(jsModuleDataUrl), true);
|
|
strictEqual(moduleMap.has(jsModuleDataUrl, 'javascript'), true);
|
|
strictEqual(moduleMap.has(jsonModuleDataUrl, 'json'), true);
|
|
|
|
strictEqual(moduleMap.has('unknown'), false);
|
|
|
|
// The types must match
|
|
strictEqual(moduleMap.has(jsModuleDataUrl, 'json'), false);
|
|
strictEqual(moduleMap.has(jsonModuleDataUrl, 'javascript'), false);
|
|
strictEqual(moduleMap.has(jsonModuleDataUrl), false);
|
|
strictEqual(moduleMap.has(jsModuleDataUrl, 'unknown'), false);
|
|
strictEqual(moduleMap.has(jsonModuleDataUrl, 'unknown'), false);
|
|
}
|
|
|
|
// LoadCache.get, LoadCache.has and LoadCache.set should only accept string
|
|
// values as url argument.
|
|
{
|
|
const moduleMap = new LoadCache();
|
|
|
|
const errorObj = {
|
|
code: 'ERR_INVALID_ARG_TYPE',
|
|
name: 'TypeError',
|
|
message: /^The "url" argument must be of type string/
|
|
};
|
|
|
|
[{}, [], true, 1].forEach((value) => {
|
|
throws(() => moduleMap.get(value), errorObj);
|
|
throws(() => moduleMap.has(value), errorObj);
|
|
throws(() => moduleMap.set(value, undefined, jsModuleJob), errorObj);
|
|
});
|
|
}
|
|
|
|
// LoadCache.get, LoadCache.has and LoadCache.set should only accept string
|
|
// values (or the kAssertType symbol) as type argument.
|
|
{
|
|
const moduleMap = new LoadCache();
|
|
|
|
const errorObj = {
|
|
code: 'ERR_INVALID_ARG_TYPE',
|
|
name: 'TypeError',
|
|
message: /^The "type" argument must be of type string/
|
|
};
|
|
|
|
[{}, [], true, 1].forEach((value) => {
|
|
throws(() => moduleMap.get(jsModuleDataUrl, value), errorObj);
|
|
throws(() => moduleMap.has(jsModuleDataUrl, value), errorObj);
|
|
throws(() => moduleMap.set(jsModuleDataUrl, value, jsModuleJob), errorObj);
|
|
});
|
|
}
|
|
|
|
// LoadCache.set should only accept ModuleJob values as job argument.
|
|
{
|
|
const moduleMap = new LoadCache();
|
|
|
|
[{}, [], true, 1].forEach((value) => {
|
|
throws(() => moduleMap.set('', undefined, value), {
|
|
code: 'ERR_INVALID_ARG_TYPE',
|
|
name: 'TypeError',
|
|
message: /^The "job" argument must be an instance of ModuleJob/
|
|
});
|
|
});
|
|
}
|
|
|
|
{
|
|
const resolveMap = new ResolveCache();
|
|
|
|
strictEqual(resolveMap.serializeKey('./file', { __proto__: null }), './file::');
|
|
strictEqual(resolveMap.serializeKey('./file', { __proto__: null, type: 'json' }), './file::"type""json"');
|
|
strictEqual(resolveMap.serializeKey('./file::"type""json"', { __proto__: null }), './file::"type""json"::');
|
|
strictEqual(resolveMap.serializeKey('./file', { __proto__: null, c: 'd', a: 'b' }), './file::"a""b","c""d"');
|
|
strictEqual(resolveMap.serializeKey('./s', { __proto__: null, c: 'd', a: 'b', b: 'c' }), './s::"a""b","b""c","c""d"');
|
|
|
|
resolveMap.set('key1', 'parent1', 1);
|
|
resolveMap.set('key2', 'parent1', 2);
|
|
resolveMap.set('key2', 'parent2', 3);
|
|
|
|
strictEqual(resolveMap.get('key1', 'parent1'), 1);
|
|
strictEqual(resolveMap.get('key2', 'parent1'), 2);
|
|
strictEqual(resolveMap.get('key2', 'parent2'), 3);
|
|
}
|