FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

module: enable existing machinery for deferred import of static modules · nodejs/node@b97c7be · GitHub

/ node Public

Commit b97c7be

Browse files
MayaLekova
authored and
aduh95
committed
module: enable existing machinery for deferred import of static modules
This commit enables deferred import for statically imported modules, by using the corresponding functionality in V8. It adds two tests: - smoke test exercising the basic syntax - test for deferred import of module with its own imports More test coverage should be added for mixing ESM and CJS modules, as well as TypeScript modules. Refs: https://github.com/tc39/proposal-defer-import-eval Signed-off-by: Maya Lekova <maya@igalia.com> PR-URL: #63712 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: Guy Bedford <guybedford@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Gürgün Dayıoğlu <hey@gurgun.day>
1 parent 2bce35b commit b97c7be

10 files changed

Lines changed: 85 additions & 9 deletions

File tree

‎eslint.config.mjs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ const { globalIgnores } = await importEslintTool('eslint/config');
1919
const { default: js } = await importEslintTool('@eslint/js');
2020
const { default: babelEslintParser } = await importEslintTool('@babel/eslint-parser');
2121
const babelPluginSyntaxImportSource = resolveEslintTool('@babel/plugin-syntax-import-source');
22+
const babelPluginImportDefer = resolveEslintTool('@babel/plugin-syntax-import-defer');
2223
const { default: jsdoc } = await importEslintTool('eslint-plugin-jsdoc');
2324
const { default: regexpPlugin } = await importEslintTool('eslint-plugin-regexp');
2425
const { default: markdown } = await importEslintTool('@eslint/markdown');
@@ -105,6 +106,7 @@ export default [
105106
babelOptions: {
106107
plugins: [
107108
babelPluginSyntaxImportSource,
109+
babelPluginImportDefer,
108110
],
109111
},
110112
requireConfigFile: false,

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

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ const {
2828
kErrored,
2929
kEvaluated,
3030
kEvaluating,
31+
kDeferPhase,
3132
kEvaluationPhase,
3233
kInstantiated,
3334
kUninstantiated,
@@ -164,7 +165,7 @@ class ModuleJobBase {
164165
debug(`ModuleJobBase.syncLink() ${this.url} -> ${request.specifier}`, job);
165166
assert(!isPromise(job));
166167
assert(job.module instanceof ModuleWrap);
167-
if (request.phase === kEvaluationPhase) {
168+
if (this.shouldRunModule(request.phase)) {
168169
ArrayPrototypePush(evaluationDepJobs, job);
169170
}
170171
modules[idx] = job.module;
@@ -199,6 +200,13 @@ class ModuleJobBase {
199200
}
200201
}
201202
}
203+
204+
shouldLinkModule(phase) {
205+
return phase >= kDeferPhase;
206+
}
207+
shouldRunModule(phase) {
208+
return phase === kEvaluationPhase;
209+
}
202210
}
203211

204212
/* A ModuleJob tracks the loading of a single Module, and the ModuleJobs of
@@ -227,7 +235,7 @@ class ModuleJob extends ModuleJobBase {
227235
this.modulePromise = PromiseResolve(moduleOrModulePromise);
228236
}
229237

230-
if (this.phase === kEvaluationPhase) {
238+
if (this.shouldLinkModule(this.phase)) {
231239
// Promise for the list of all dependencyJobs.
232240
this.linked = this.link(requestType);
233241
// This promise is awaited later anyway, so silence
@@ -279,7 +287,7 @@ class ModuleJob extends ModuleJobBase {
279287
const dependencyJobPromise = this.loader.getOrCreateModuleJob(this.url, request, requestType);
280288
const modulePromise = PromisePrototypeThen(dependencyJobPromise, (job) => {
281289
debug(`ModuleJob.asyncLink() ${this.url} -> ${request.specifier}`, job);
282-
if (request.phase === kEvaluationPhase) {
290+
if (this.shouldRunModule(request.phase)) {
283291
ArrayPrototypePush(evaluationDepJobs, job);
284292
}
285293
return job.modulePromise;
@@ -380,7 +388,7 @@ class ModuleJob extends ModuleJobBase {
380388
}
381389

382390
runSync(parent) {
383-
assert(this.phase === kEvaluationPhase);
391+
assert(this.shouldRunModule(this.phase));
384392
assert(this.module instanceof ModuleWrap);
385393
let status = this.module.getStatus();
386394

@@ -427,7 +435,7 @@ class ModuleJob extends ModuleJobBase {
427435

428436
async run(isEntryPoint = false) {
429437
debug('ModuleJob.run()', this.module);
430-
assert(this.phase === kEvaluationPhase);
438+
assert(this.shouldRunModule(this.phase));
431439
await this.#instantiate();
432440
if (isEntryPoint) {
433441
globalThis[entry_point_module_private_symbol] = this.module;
@@ -475,7 +483,7 @@ class ModuleJobSync extends ModuleJobBase {
475483
assert(this.module instanceof ModuleWrap);
476484
this.linked = undefined;
477485
this.type = importAttributes.type;
478-
if (phase === kEvaluationPhase) {
486+
if (this.shouldLinkModule(phase)) {
479487
this.linked = this.link(requestType);
480488
}
481489
}
@@ -494,7 +502,7 @@ class ModuleJobSync extends ModuleJobBase {
494502
}
495503

496504
async run() {
497-
assert(this.phase === kEvaluationPhase);
505+
assert(this.shouldRunModule(this.phase));
498506
// This path is hit by a require'd module that is imported again.
499507
const status = this.module.getStatus();
500508
debug('ModuleJobSync.run()', status, this.module);
@@ -523,7 +531,7 @@ class ModuleJobSync extends ModuleJobBase {
523531

524532
runSync(parent) {
525533
debug('ModuleJobSync.runSync()', this.module);
526-
assert(this.phase === kEvaluationPhase);
534+
assert(this.shouldRunModule(this.phase));
527535
// TODO(joyeecheung): add the error decoration logic from the async instantiate.
528536
this.module.instantiate();
529537
// If --experimental-print-required-tla is true, proceeds to evaluation even

‎src/module_wrap.cc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -555,6 +555,8 @@ ModulePhase to_phase_constant(ModuleImportPhase phase) {
555555
switch (phase) {
556556
case ModuleImportPhase::kEvaluation:
557557
return kEvaluationPhase;
558+
case ModuleImportPhase::kDefer:
559+
return kDeferPhase;
558560
case ModuleImportPhase::kSource:
559561
return kSourcePhase;
560562
default:
@@ -1682,6 +1684,7 @@ void ModuleWrap::CreatePerContextProperties(Local<Object> target,
16821684
V(Module::Status, kErrored);
16831685

16841686
V(ModulePhase, kEvaluationPhase);
1687+
V(ModulePhase, kDeferPhase);
16851688
V(ModulePhase, kSourcePhase);
16861689
#undef V
16871690
}

‎src/module_wrap.h‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@ enum HostDefinedOptions : int {
3535

3636
enum ModulePhase : int {
3737
kSourcePhase = 1,
38-
kEvaluationPhase = 2,
38+
kDeferPhase = 2,
39+
kEvaluationPhase = 3,
3940
};
4041

4142
/**

‎test/es-module/test-defer-import-eval.mjs‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
// Flags: --js-defer-import-eval
2+
3+
// Tests that defer import actually evaluates the imported module
4+
// only when properties that it exports are accessed.
5+
6+
import '../common/index.mjs';
7+
import * as assert from 'assert';
8+
9+
globalThis.eval_list = [];
10+
11+
import defer * as deferred from '../fixtures/es-modules/module-deferred-eval.mjs';
12+
13+
assert.strictEqual(globalThis.eval_list.length, 0);
14+
15+
// Attempts to define a property on the deferred module. This should
16+
// trigger its execution, similar to accessing the `foo` property.
17+
assert.throws(() => Object.defineProperty(deferred.prop, 'newProp', { value: 15 }), TypeError);
18+
19+
assert.strictEqual(deferred.foo, 42);
20+
21+
// Check that the module has been evaluated at this point.
22+
assert.partialDeepStrictEqual(['defer-1'], globalThis.eval_list);
23+
24+
// Clean-up
25+
delete globalThis.eval_list;

‎test/es-module/test-defer-import-with-module-tree.mjs‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
// Flags: --js-defer-import-eval
2+
3+
import '../common/index.mjs';
4+
5+
import defer * as deferred from '../fixtures/es-modules/module-with-module-tree.mjs';
6+
7+
console.log(deferred.bar);
8+
9+
delete globalThis.eval_list;

‎test/fixtures/es-modules/module-deferred-eval.mjs‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
if (!globalThis.eval_list) {
2+
globalThis.eval_list = [];
3+
}
4+
globalThis.eval_list.push('defer-1');
5+
6+
export const foo = 42;
7+
8+
console.log('executed');

‎test/fixtures/es-modules/module-with-module-tree.mjs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import './module-deferred-eval.mjs';
2+
3+
export const bar = 64;

‎tools/eslint/package-lock.json‎

Lines changed: 16 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎tools/eslint/package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
"dependencies": {
66
"@babel/core": "^8.0.0-rc.6",
77
"@babel/eslint-parser": "^8.0.0-rc.6",
8+
"@babel/plugin-syntax-import-defer": "^8.0.0-rc.6",
89
"@babel/plugin-syntax-import-source": "^8.0.0-rc.6",
910
"@eslint/js": "^10.0.1",
1011
"@eslint/markdown": "^8.0.2",

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL