Skip to content

module: convert schema-only core module on convertCJSFilenameToURL #58612

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions lib/internal/modules/customization_hooks.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ const {
ArrayPrototypeSplice,
ObjectAssign,
ObjectFreeze,
StringPrototypeSlice,
StringPrototypeStartsWith,
Symbol,
} = primordials;
Expand Down Expand Up @@ -126,9 +127,12 @@ function registerHooks(hooks) {
*/
function convertCJSFilenameToURL(filename) {
if (!filename) { return filename; }
const builtinId = BuiltinModule.normalizeRequirableId(filename);
if (builtinId) {
return `node:${builtinId}`;
let normalizedId = filename;
if (StringPrototypeStartsWith(filename, 'node:')) {
normalizedId = StringPrototypeSlice(filename, 5);
}
if (BuiltinModule.canBeRequiredByUsers(normalizedId)) {
return `node:${normalizedId}`;
}
// Handle the case where filename is neither a path, nor a built-in id,
// which is possible via monkey-patching.
Expand Down
48 changes: 48 additions & 0 deletions test/module-hooks/test-module-hooks-builtin-require.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
'use strict';

// This tests that when builtins that demand the `node:` prefix are
// required, the URL returned by the default resolution step is still
// prefixed and valid, and that gets passed to the load hook is still
// the one with the `node:` prefix. The one with the prefix
// stripped for internal lookups should not get passed into the hooks.

const common = require('../common');
const assert = require('assert');
const { registerHooks } = require('module');

const schemelessBlockList = new Set([
'sea',
'sqlite',
'test',
'test/reporters',
]);

const testModules = [];
for (const mod of schemelessBlockList) {
testModules.push(`node:${mod}`);
}

const hook = registerHooks({
resolve: common.mustCall((specifier, context, nextResolve) => {
const result = nextResolve(specifier, context);
assert.match(result.url, /^node:/);
assert.strictEqual(schemelessBlockList.has(result.url.slice(5, result.url.length)), true);
return result;
}, testModules.length),
load: common.mustCall(function load(url, context, nextLoad) {
assert.match(url, /^node:/);
assert.strictEqual(schemelessBlockList.has(url.slice(5, url.length)), true);
const result = nextLoad(url, context);
assert.strictEqual(result.source, null);
return {
source: 'throw new Error("I should not be thrown because the loader ignores user-supplied source for builtins")',
format: 'builtin',
};
}, testModules.length),
});

for (const mod of testModules) {
require(mod);
}

hook.deregister();
39 changes: 38 additions & 1 deletion test/module-hooks/test-module-hooks-load-builtin-require.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@ const { registerHooks } = require('module');

// Pick a builtin that's unlikely to be loaded already - like zlib.
assert(!process.moduleLoadList.includes('NativeModule zlib'));
let hook;

const hook = registerHooks({
hook = registerHooks({
load: common.mustCall(function load(url, context, nextLoad) {
assert.strictEqual(url, 'node:zlib');
const result = nextLoad(url, context);
Expand All @@ -27,3 +28,39 @@ const hook = registerHooks({
assert.strictEqual(typeof require('zlib').createGzip, 'function');

hook.deregister();

// This tests that when builtins that demand the `node:` prefix are
// required, the URL returned by the default resolution step is still
// prefixed and valid, and that gets passed to the load hook is still
// the one with the `node:` prefix. The one with the prefix
// stripped for internal lookups should not get passed into the hooks.
const schemelessBlockList = new Set([
'sea',
'sqlite',
'test',
'test/reporters',
]);

const testModules = [];
for (const mod of schemelessBlockList) {
testModules.push(`node:${mod}`);
}

hook = registerHooks({
load: common.mustCall(function load(url, context, nextLoad) {
assert.match(url, /^node:/);
assert.strictEqual(schemelessBlockList.has(url.slice(5, url.length)), true);
const result = nextLoad(url, context);
assert.strictEqual(result.source, null);
return {
source: 'throw new Error("I should not be thrown because the loader ignores user-supplied source for builtins")',
format: 'builtin',
};
}, testModules.length),
});

for (const mod of testModules) {
require(mod);
}

hook.deregister();
Loading