GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — module: bootstrap module loaders in shadow realm · nodejs/node@c7a7493

File tree

Expand file treeCollapse file tree
Open diff view settings
Filter options
  • lib/internal
    • bootstrap
      • realm.js
      • shadow_realm.js
    • main
      • worker_thread.js
    • modules/esm
      • loader.js
      • utils.js
    • process
      • pre_execution.js
  • src
    • async_wrap.cc
    • env.cc
    • module_wrap.cc
    • module_wrap.h
    • node_binding.h
    • node_errors.h
    • node_shadow_realm.cc
  • test
    • fixtures/es-module-shadow-realm
      • custom-loaders.js
      • preload-main.js
      • preload.js
      • re-export-state-counter.mjs
      • state-counter.mjs
    • parallel
      • test-shadow-realm-allowed-builtin-modules.js
      • test-shadow-realm-custom-loaders.js
      • test-shadow-realm-gc-module.js
      • test-shadow-realm-import-value-resolve.js
      • test-shadow-realm-module.js
      • test-shadow-realm-preload-module.js
Expand file treeCollapse file tree
Open diff view settings
Collapse file

‎lib/internal/bootstrap/realm.js‎

Copy file name to clipboardExpand all lines: lib/internal/bootstrap/realm.js
+11-2Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@
5050

5151
const {
5252
ArrayFrom,
53+
ArrayPrototypeFilter,
54+
ArrayPrototypeIncludes,
5355
ArrayPrototypeMap,
5456
ArrayPrototypePush,
5557
ArrayPrototypeSlice,
@@ -215,8 +217,8 @@ const internalBuiltinIds = builtinIds
215217
.filter((id) => StringPrototypeStartsWith(id, 'internal/') && id !== selfId);
216218

217219
// When --expose-internals is on we'll add the internal builtin ids to these.
218-
const canBeRequiredByUsersList = new SafeSet(publicBuiltinIds);
219-
const canBeRequiredByUsersWithoutSchemeList =
220+
let canBeRequiredByUsersList = new SafeSet(publicBuiltinIds);
221+
let canBeRequiredByUsersWithoutSchemeList =
220222
new SafeSet(publicBuiltinIds.filter((id) => !schemelessBlockList.has(id)));
221223

222224
/**
@@ -269,6 +271,13 @@ class BuiltinModule {
269271
}
270272
}
271273

274+
static setRealmAllowRequireByUsers(ids) {
275+
canBeRequiredByUsersList =
276+
new SafeSet(ArrayPrototypeFilter(ids, (id) => ArrayPrototypeIncludes(publicBuiltinIds, id)));
277+
canBeRequiredByUsersWithoutSchemeList =
278+
new SafeSet(ArrayPrototypeFilter(ids, (id) => !schemelessBlockList.has(id)));
279+
}
280+
272281
// To be called during pre-execution when --expose-internals is on.
273282
// Enables the user-land module loader to access internal modules.
274283
static exposeInternals() {
Collapse file

‎lib/internal/bootstrap/shadow_realm.js‎

Copy file name to clipboard
+21Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
'use strict';
2+
3+
// This script sets up the context for shadow realms.
4+
5+
const {
6+
prepareShadowRealmExecution,
7+
} = require('internal/process/pre_execution');
8+
const {
9+
BuiltinModule,
10+
} = require('internal/bootstrap/realm');
11+
12+
BuiltinModule.setRealmAllowRequireByUsers([
13+
/**
14+
* The built-in modules exposed in the ShadowRealm must each be providing
15+
* platform capabilities with no authority to cause side effects such as
16+
* I/O or mutation of values that are shared across different realms within
17+
* the same Node.js environment.
18+
*/
19+
]);
20+
21+
prepareShadowRealmExecution();
Collapse file

‎lib/internal/main/worker_thread.js‎

Copy file name to clipboardExpand all lines: lib/internal/main/worker_thread.js
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,7 @@ port.on('message', (message) => {
136136
const isLoaderWorker =
137137
doEval === 'internal' &&
138138
filename === require('internal/modules/esm/utils').loaderWorkerId;
139+
// Disable custom loaders in loader worker.
139140
setupUserModules(isLoaderWorker);
140141

141142
if (!hasStdin)
Collapse file

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

Copy file name to clipboardExpand all lines: lib/internal/modules/esm/loader.js
+4-3Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -528,9 +528,10 @@ let emittedLoaderFlagWarning = false;
528528
*/
529529
function createModuleLoader() {
530530
let customizations = null;
531-
// Don't spawn a new worker if we're already in a worker thread created by instantiating CustomizedModuleLoader;
532-
// doing so would cause an infinite loop.
533-
if (!require('internal/modules/esm/utils').isLoaderWorker()) {
531+
// Don't spawn a new worker if custom loaders are disabled. For instance, if
532+
// we're already in a worker thread created by instantiating
533+
// CustomizedModuleLoader; doing so would cause an infinite loop.
534+
if (!require('internal/modules/esm/utils').forceDefaultLoader()) {
534535
const userLoaderPaths = getOptionValue('--experimental-loader');
535536
if (userLoaderPaths.length > 0) {
536537
if (!emittedLoaderFlagWarning) {
Collapse file

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

Copy file name to clipboardExpand all lines: lib/internal/modules/esm/utils.js
+33-10Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ const {
44
ArrayIsArray,
55
SafeSet,
66
SafeWeakMap,
7+
Symbol,
78
ObjectFreeze,
89
} = primordials;
910

@@ -157,6 +158,26 @@ function registerModule(referrer, registry) {
157158
moduleRegistries.set(idSymbol, registry);
158159
}
159160

161+
/**
162+
* Registers the ModuleRegistry for dynamic import() calls with a realm
163+
* as the referrer. Similar to {@link registerModule}, but this function
164+
* generates a new id symbol instead of using the one from the referrer
165+
* object.
166+
* @param {globalThis} globalThis The globalThis object of the realm.
167+
* @param {ModuleRegistry} registry
168+
*/
169+
function registerRealm(globalThis, registry) {
170+
let idSymbol = globalThis[host_defined_option_symbol];
171+
// If the per-realm host-defined options is already registered, do nothing.
172+
if (idSymbol) {
173+
return;
174+
}
175+
// Otherwise, register the per-realm host-defined options.
176+
idSymbol = Symbol('Realm globalThis');
177+
globalThis[host_defined_option_symbol] = idSymbol;
178+
moduleRegistries.set(idSymbol, registry);
179+
}
180+
160181
/**
161182
* Defines the `import.meta` object for a given module.
162183
* @param {symbol} symbol - Reference to the module.
@@ -192,28 +213,29 @@ async function importModuleDynamicallyCallback(referrerSymbol, specifier, attrib
192213
throw new ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING();
193214
}
194215

195-
let _isLoaderWorker = false;
216+
let _forceDefaultLoader = false;
196217
/**
197218
* Initializes handling of ES modules.
198219
* This is configured during pre-execution. Specifically it's set to true for
199220
* the loader worker in internal/main/worker_thread.js.
200-
* @param {boolean} [isLoaderWorker=false] - A boolean indicating whether the loader is a worker or not.
221+
* @param {boolean} [forceDefaultLoader=false] - A boolean indicating disabling custom loaders.
201222
*/
202-
function initializeESM(isLoaderWorker = false) {
203-
_isLoaderWorker = isLoaderWorker;
223+
function initializeESM(forceDefaultLoader = false) {
224+
_forceDefaultLoader = forceDefaultLoader;
204225
initializeDefaultConditions();
205-
// Setup per-isolate callbacks that locate data or callbacks that we keep
226+
// Setup per-realm callbacks that locate data or callbacks that we keep
206227
// track of for different ESM modules.
207228
setInitializeImportMetaObjectCallback(initializeImportMetaObject);
208229
setImportModuleDynamicallyCallback(importModuleDynamicallyCallback);
209230
}
210231

211232
/**
212-
* Determine whether the current process is a loader worker.
213-
* @returns {boolean} Whether the current process is a loader worker.
233+
* Determine whether custom loaders are disabled and it is forced to use the
234+
* default loader.
235+
* @returns {boolean}
214236
*/
215-
function isLoaderWorker() {
216-
return _isLoaderWorker;
237+
function forceDefaultLoader() {
238+
return _forceDefaultLoader;
217239
}
218240

219241
/**
@@ -251,10 +273,11 @@ async function initializeHooks() {
251273

252274
module.exports = {
253275
registerModule,
276+
registerRealm,
254277
initializeESM,
255278
initializeHooks,
256279
getDefaultConditions,
257280
getConditionsSet,
258281
loaderWorkerId: 'internal/modules/esm/worker',
259-
isLoaderWorker,
282+
forceDefaultLoader,
260283
};
Collapse file

‎lib/internal/process/pre_execution.js‎

Copy file name to clipboardExpand all lines: lib/internal/process/pre_execution.js
+30-8Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,26 @@ function prepareWorkerThreadExecution() {
6767
});
6868
}
6969

70+
function prepareShadowRealmExecution() {
71+
const { registerRealm } = require('internal/modules/esm/utils');
72+
// Patch the process object with legacy properties and normalizations.
73+
// Do not expand argv1 as it is not available in ShadowRealm.
74+
patchProcessObject(false);
75+
setupDebugEnv();
76+
77+
// Disable custom loaders in ShadowRealm.
78+
setupUserModules(true);
79+
registerRealm(globalThis, {
80+
__proto__: null,
81+
importModuleDynamically: (specifier, _referrer, attributes) => {
82+
// The handler for `ShadowRealm.prototype.importValue`.
83+
const { esmLoader } = require('internal/process/esm_loader');
84+
// `parentURL` is not set in the case of a ShadowRealm top-level import.
85+
return esmLoader.import(specifier, undefined, attributes);
86+
},
87+
});
88+
}
89+
7090
function prepareExecution(options) {
7191
const { expandArgv1, initializeModules, isMainThread } = options;
7292

@@ -161,16 +181,17 @@ function setupSymbolDisposePolyfill() {
161181
}
162182
}
163183

164-
function setupUserModules(isLoaderWorker = false) {
184+
function setupUserModules(forceDefaultLoader = false) {
165185
initializeCJSLoader();
166-
initializeESMLoader(isLoaderWorker);
186+
initializeESMLoader(forceDefaultLoader);
167187
const CJSLoader = require('internal/modules/cjs/loader');
168188
assert(!CJSLoader.hasLoadedAnyUserCJSModule);
169-
// Loader workers are responsible for doing this themselves.
170-
if (isLoaderWorker) {
171-
return;
189+
// Do not enable preload modules if custom loaders are disabled.
190+
// For example, loader workers are responsible for doing this themselves.
191+
// And preload modules are not supported in ShadowRealm as well.
192+
if (!forceDefaultLoader) {
193+
loadPreloadModules();
172194
}
173-
loadPreloadModules();
174195
// Need to be done after --require setup.
175196
initializeFrozenIntrinsics();
176197
}
@@ -701,9 +722,9 @@ function initializeCJSLoader() {
701722
initializeCJS();
702723
}
703724

704-
function initializeESMLoader(isLoaderWorker) {
725+
function initializeESMLoader(forceDefaultLoader) {
705726
const { initializeESM } = require('internal/modules/esm/utils');
706-
initializeESM(isLoaderWorker);
727+
initializeESM(forceDefaultLoader);
707728

708729
// Patch the vm module when --experimental-vm-modules is on.
709730
// Please update the comments in vm.js when this block changes.
@@ -779,6 +800,7 @@ module.exports = {
779800
setupUserModules,
780801
prepareMainThreadExecution,
781802
prepareWorkerThreadExecution,
803+
prepareShadowRealmExecution,
782804
markBootstrapComplete,
783805
loadPreloadModules,
784806
initializeFrozenIntrinsics,
Collapse file

‎src/async_wrap.cc‎

Copy file name to clipboardExpand all lines: src/async_wrap.cc
+13-9Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -372,8 +372,9 @@ void AsyncWrap::CreatePerContextProperties(Local<Object> target,
372372
Local<Value> unused,
373373
Local<Context> context,
374374
void* priv) {
375-
Environment* env = Environment::GetCurrent(context);
376-
Isolate* isolate = env->isolate();
375+
Realm* realm = Realm::GetCurrent(context);
376+
Environment* env = realm->env();
377+
Isolate* isolate = realm->isolate();
377378
HandleScope scope(isolate);
378379

379380
PropertyAttribute ReadOnlyDontDelete =
@@ -446,13 +447,16 @@ void AsyncWrap::CreatePerContextProperties(Local<Object> target,
446447

447448
#undef FORCE_SET_TARGET_FIELD
448449

449-
env->set_async_hooks_init_function(Local<Function>());
450-
env->set_async_hooks_before_function(Local<Function>());
451-
env->set_async_hooks_after_function(Local<Function>());
452-
env->set_async_hooks_destroy_function(Local<Function>());
453-
env->set_async_hooks_promise_resolve_function(Local<Function>());
454-
env->set_async_hooks_callback_trampoline(Local<Function>());
455-
env->set_async_hooks_binding(target);
450+
// TODO(legendecas): async hook functions are not realm-aware yet.
451+
// This simply avoid overriding principal realm's functions when a
452+
// ShadowRealm initializes the binding.
453+
realm->set_async_hooks_init_function(Local<Function>());
454+
realm->set_async_hooks_before_function(Local<Function>());
455+
realm->set_async_hooks_after_function(Local<Function>());
456+
realm->set_async_hooks_destroy_function(Local<Function>());
457+
realm->set_async_hooks_promise_resolve_function(Local<Function>());
458+
realm->set_async_hooks_callback_trampoline(Local<Function>());
459+
realm->set_async_hooks_binding(target);
456460
}
457461

458462
void AsyncWrap::RegisterExternalReferences(
Collapse file

‎src/env.cc‎

Copy file name to clipboardExpand all lines: src/env.cc
+7-4Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1651,10 +1651,13 @@ void AsyncHooks::MemoryInfo(MemoryTracker* tracker) const {
16511651
void AsyncHooks::grow_async_ids_stack() {
16521652
async_ids_stack_.reserve(async_ids_stack_.Length() * 3);
16531653

1654-
env()->async_hooks_binding()->Set(
1655-
env()->context(),
1656-
env()->async_ids_stack_string(),
1657-
async_ids_stack_.GetJSArray()).Check();
1654+
env()
1655+
->principal_realm()
1656+
->async_hooks_binding()
1657+
->Set(env()->context(),
1658+
env()->async_ids_stack_string(),
1659+
async_ids_stack_.GetJSArray())
1660+
.Check();
16581661
}
16591662

16601663
void AsyncHooks::FailWithCorruptedAsyncStack(double expected_async_id) {

0 commit comments

Comments
0 (0)
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.