Skip to content

Commit

Permalink
bootstrap: support namespaced builtins in snapshot scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
joyeecheung committed Apr 7, 2023
1 parent 33d5125 commit 0113e81
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 5 deletions.
18 changes: 13 additions & 5 deletions lib/internal/main/mksnapshot.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ const {
ObjectSetPrototypeOf,
SafeArrayIterator,
SafeSet,
StringPrototypeStartsWith,
StringPrototypeSlice,
} = primordials;

const binding = internalBinding('mksnapshot');
Expand Down Expand Up @@ -96,23 +98,29 @@ function supportedInUserSnapshot(id) {
}

function requireForUserSnapshot(id) {
if (!BuiltinModule.canBeRequiredByUsers(id)) {
let normalizedId = id;
if (StringPrototypeStartsWith(id, 'node:')) {
normalizedId = StringPrototypeSlice(id, 5);
}
if (!BuiltinModule.canBeRequiredByUsers(normalizedId) ||
(id !== normalizedId &&
!BuiltinModule.canBeRequiredWithoutScheme(normalizedId))) {
// eslint-disable-next-line no-restricted-syntax
const err = new Error(
`Cannot find module '${id}'. `,
);
err.code = 'MODULE_NOT_FOUND';
throw err;
}
if (!supportedInUserSnapshot(id)) {
if (!warnedModules.has(id)) {
if (!supportedInUserSnapshot(normalizedId)) {
if (!warnedModules.has(normalizedId)) {
process.emitWarning(
`built-in module ${id} is not yet supported in user snapshots`);
warnedModules.add(id);
warnedModules.add(normalizedId);
}
}

return require(id);
return require(normalizedId);
}

function main() {
Expand Down
42 changes: 42 additions & 0 deletions test/parallel/test-snapshot-namespaced-builtin.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
'use strict';

// This tests snapshot JS API using the example in the docs.

require('../common');
const assert = require('assert');
const { spawnSync } = require('child_process');
const tmpdir = require('../common/tmpdir');
const path = require('path');
const fs = require('fs');

tmpdir.refresh();
const blobPath = path.join(tmpdir.path, 'snapshot.blob');
{
// The list of modules supported in the snapshot is unstable, so just check
// a few that are known to work.
const code = `
require("node:v8");
require("node:fs");
require("node:fs/promises");
`;
fs.writeFileSync(
path.join(tmpdir.path, 'entry.js'),
code,
'utf8'
);
const child = spawnSync(process.execPath, [
'--snapshot-blob',
blobPath,
'--build-snapshot',
'entry.js',
], {
cwd: tmpdir.path
});
if (child.status !== 0) {
console.log(child.stderr.toString());
console.log(child.stdout.toString());
assert.strictEqual(child.status, 0);
}
const stats = fs.statSync(path.join(tmpdir.path, 'snapshot.blob'));
assert(stats.isFile());
}

0 comments on commit 0113e81

Please sign in to comment.