@agoric/swingset-vat 0.32.3-upgrade-18-dev-6ddbef0.0 → 0.32.3-upgrade-19-dev-c605745.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/swingset-vat",
-  "version": "0.32.3-upgrade-18-dev-6ddbef0.0+6ddbef0",
+  "version": "0.32.3-upgrade-19-dev-c605745.0+c605745",
   "description": "Vat/Container Launcher",
   "type": "module",
   "main": "src/index.js",
@@ -27,44 +27,44 @@
     "@types/yargs-parser": "^21.0.0"
   },
   "dependencies": {
-    "@agoric/internal": "0.3.3-upgrade-18-dev-6ddbef0.0+6ddbef0",
-    "@agoric/kmarshal": "0.1.1-upgrade-18-dev-6ddbef0.0+6ddbef0",
-    "@agoric/store": "0.9.3-upgrade-18-dev-6ddbef0.0+6ddbef0",
-    "@agoric/swing-store": "0.9.2-upgrade-18-dev-6ddbef0.0+6ddbef0",
-    "@agoric/swingset-liveslots": "0.10.3-upgrade-18-dev-6ddbef0.0+6ddbef0",
-    "@agoric/swingset-xsnap-supervisor": "0.10.3-upgrade-18-dev-6ddbef0.0+6ddbef0",
-    "@agoric/time": "0.3.3-upgrade-18-dev-6ddbef0.0+6ddbef0",
-    "@agoric/vat-data": "0.5.3-upgrade-18-dev-6ddbef0.0+6ddbef0",
-    "@agoric/xsnap": "0.14.3-upgrade-18-dev-6ddbef0.0+6ddbef0",
-    "@agoric/xsnap-lockdown": "0.14.1-upgrade-18-dev-6ddbef0.0+6ddbef0",
-    "@endo/base64": "^1.0.8",
-    "@endo/bundle-source": "^3.4.2",
-    "@endo/captp": "^4.4.2",
-    "@endo/check-bundle": "^1.0.11",
-    "@endo/compartment-mapper": "^1.3.1",
-    "@endo/errors": "^1.2.7",
-    "@endo/eventual-send": "^1.2.7",
-    "@endo/far": "^1.1.8",
-    "@endo/import-bundle": "^1.3.1",
-    "@endo/init": "^1.1.6",
-    "@endo/marshal": "^1.6.1",
-    "@endo/nat": "^5.0.12",
-    "@endo/pass-style": "^1.4.6",
-    "@endo/patterns": "^1.4.6",
-    "@endo/promise-kit": "^1.1.7",
-    "@endo/ses-ava": "^1.2.7",
-    "@endo/stream": "^1.2.7",
-    "@endo/zip": "^1.0.8",
+    "@agoric/internal": "0.3.3-upgrade-19-dev-c605745.0+c605745",
+    "@agoric/kmarshal": "0.1.1-upgrade-19-dev-c605745.0+c605745",
+    "@agoric/store": "0.9.3-upgrade-19-dev-c605745.0+c605745",
+    "@agoric/swing-store": "0.9.2-upgrade-19-dev-c605745.0+c605745",
+    "@agoric/swingset-liveslots": "0.10.3-upgrade-19-dev-c605745.0+c605745",
+    "@agoric/swingset-xsnap-supervisor": "0.10.3-upgrade-19-dev-c605745.0+c605745",
+    "@agoric/time": "0.3.3-upgrade-19-dev-c605745.0+c605745",
+    "@agoric/vat-data": "0.5.3-upgrade-19-dev-c605745.0+c605745",
+    "@agoric/xsnap-lockdown": "0.14.1-upgrade-19-dev-c605745.0+c605745",
+    "@endo/base64": "^1.0.9",
+    "@endo/bundle-source": "^3.5.1",
+    "@endo/captp": "^4.4.4",
+    "@endo/check-bundle": "^1.0.13",
+    "@endo/compartment-mapper": "^1.5.0",
+    "@endo/errors": "^1.2.9",
+    "@endo/eventual-send": "^1.3.0",
+    "@endo/far": "^1.1.10",
+    "@endo/import-bundle": "^1.3.3",
+    "@endo/init": "^1.1.8",
+    "@endo/marshal": "^1.6.3",
+    "@endo/nat": "^5.0.14",
+    "@endo/pass-style": "^1.4.8",
+    "@endo/patterns": "^1.4.8",
+    "@endo/promise-kit": "^1.1.9",
+    "@endo/ses-ava": "^1.2.9",
+    "@endo/stream": "^1.2.9",
+    "@endo/zip": "^1.0.9",
     "ansi-styles": "^6.2.1",
     "anylogger": "^0.21.0",
     "better-sqlite3": "^9.1.1",
-    "import-meta-resolve": "^2.2.1",
+    "import-meta-resolve": "^4.1.0",
     "microtime": "^3.1.0",
     "semver": "^6.3.0",
     "tmp": "^0.2.1",
     "yargs-parser": "^21.1.1"
   },
   "peerDependencies": {
+    "@agoric/xsnap": "^0.14.2",
     "ava": "^5.3.0"
   },
   "files": [
@@ -94,14 +94,13 @@
     "require": [
       "@endo/init/debug.js"
     ],
-    "timeout": "20m",
-    "workerThreads": false
+    "timeout": "20m"
   },
   "publishConfig": {
     "access": "public"
   },
   "typeCoverage": {
-    "atLeast": 75.82
+    "atLeast": 76.28
   },
-  "gitHead": "6ddbef09f18c18f205e8d166c363ff4884115ce9"
+  "gitHead": "c605745ee6619292b51cec5fc0db0a25ff1b203c"
 }

package/src/controller/controller.js

@@ -15,6 +15,8 @@ import { initSwingStore } from '@agoric/swing-store';
 
 import { mustMatch, M } from '@endo/patterns';
 import { checkBundle } from '@endo/check-bundle/lite.js';
+import { deepCopyJsonable } from '@agoric/internal/src/js-utils.js';
+import { makeLimitedConsole } from '@agoric/internal/src/ses-utils.js';
 import engineGC from '@agoric/internal/src/lib-nodejs/engine-gc.js';
 import { startSubprocessWorker } from '@agoric/internal/src/lib-nodejs/spawnSubprocessWorker.js';
 import { waitUntilQuiescent } from '@agoric/internal/src/lib-nodejs/waitUntilQuiescent.js';
@@ -34,6 +36,10 @@ import {
 import { makeStartXSnap } from './startXSnap.js';
 import { makeStartSubprocessWorkerNode } from './startNodeSubprocess.js';
 
+/**
+ * @import {EReturn} from '@endo/far';
+ */
+
 /**
  * @typedef { import('../types-internal.js').VatID } VatID
  */
@@ -51,34 +57,32 @@ export function computeSha512(bytes) {
   return hash.digest().toString('hex');
 }
 
-/** @param {string | ((args: unknown[]) => string)} tagOrTagCreator */
-function makeConsole(tagOrTagCreator) {
-  /** @type {(level: string) => (args: unknown[]) => void} */
-  let makeLoggerForLevel;
-  if (typeof tagOrTagCreator === 'function') {
-    const tagToLogger = new Map();
-    makeLoggerForLevel =
-      level =>
-      (...args) => {
-        // Retrieve the logger from cache.
-        const tag = tagOrTagCreator(args);
-        let logger = tagToLogger.get(tag);
-        if (!logger) {
-          logger = anylogger(tag);
-          tagToLogger.set(tag, logger);
-        }
-        // Actually log the message.
-        return logger[level](...args);
-      };
-  } else {
-    const logger = anylogger(tagOrTagCreator);
-    makeLoggerForLevel = level => logger[level];
-  }
-  const cons = {};
-  for (const level of ['debug', 'log', 'info', 'warn', 'error']) {
-    cons[level] = makeLoggerForLevel(level);
+/**
+ * Make logger functions from either a prefix string or a function that receives
+ * the first argument of a log-method invocation and returns a replacement that
+ * provides more detail for source identification.
+ *
+ * @param {string | ((originalSource: unknown) => string)} prefixer
+ */
+function makeConsole(prefixer) {
+  if (typeof prefixer !== 'function') {
+    const logger = anylogger(prefixer);
+    return makeLimitedConsole(level => logger[level]);
   }
-  return harden(cons);
+
+  const prefixToLogger = new Map();
+  return makeLimitedConsole(level => {
+    return (source, ...args) => {
+      const prefix = prefixer(source);
+      let logger = prefixToLogger.get(prefix);
+      if (!logger) {
+        logger = anylogger(prefix);
+        prefixToLogger.set(prefix, logger);
+      }
+
+      return logger[level](...args);
+    };
+  });
 }
 
 /**
@@ -208,17 +212,23 @@ export async function makeSwingsetController(
     process.on('unhandledRejection', unhandledRejectionHandler);
   }
 
-  function kernelRequire(what) {
-    Fail`kernelRequire unprepared to satisfy require(${what})`;
-  }
+  const kernelConsole = makeConsole(`${debugPrefix}SwingSet:kernel`);
+  const sloggingKernelConsole = makeLimitedConsole(level => {
+    return (...args) => {
+      kernelConsole[level](...args);
+      writeSlogObject({ type: 'console', source: 'kernel', args });
+    };
+  });
   writeSlogObject({ type: 'import-kernel-start' });
   const kernelNS = await importBundle(kernelBundle, {
     filePrefix: 'kernel/...',
     endowments: {
-      console: makeConsole(`${debugPrefix}SwingSet:kernel`),
+      console: sloggingKernelConsole,
       // See https://github.com/Agoric/agoric-sdk/issues/9515
       assert: globalThis.assert,
-      require: kernelRequire,
+      require: harden(
+        what => Fail`kernelRequire unprepared to satisfy require(${what})`,
+      ),
       URL: globalThis.Base64, // Unavailable only on XSnap
       Base64: globalThis.Base64, // Available only on XSnap
     },
@@ -263,13 +273,6 @@ export async function makeSwingsetController(
 
   await kernel.start();
 
-  /**
-   * @param {T} x
-   * @returns {T}
-   * @template T
-   */
-  const defensiveCopy = x => JSON.parse(JSON.stringify(x));
-
   /**
    * Validate and install a code bundle.
    *
@@ -304,7 +307,7 @@ export async function makeSwingsetController(
     writeSlogObject,
 
     dump() {
-      return defensiveCopy(kernel.dump());
+      return deepCopyJsonable(kernel.dump());
     },
 
     verboseDebugMode(flag) {
@@ -340,11 +343,11 @@ export async function makeSwingsetController(
     },
 
     getStats() {
-      return defensiveCopy(kernel.getStats());
+      return deepCopyJsonable(kernel.getStats());
     },
 
     getStatus() {
-      return defensiveCopy(kernel.getStatus());
+      return deepCopyJsonable(kernel.getStatus());
     },
 
     getActivityhash() {
@@ -483,7 +486,7 @@ export async function makeSwingsetController(
      *
      * The first `controller.run()` after this call will delete all
      * the old vat's state at once, unless you use a
-     * [`runPolicy`](../docs/run-policy.md) to rate-limit cleanups.
+     * [`runPolicy`](../../docs/run-policy.md) to rate-limit cleanups.
      *
      * @param {VatID} vatID
      * @param {SwingSetCapData} reasonCD
@@ -500,7 +503,7 @@ export async function makeSwingsetController(
 
   return controller;
 }
-/** @typedef {Awaited<ReturnType<typeof makeSwingsetController>>} SwingsetController */
+/** @typedef {EReturn<typeof makeSwingsetController>} SwingsetController */
 
 /**
  * NB: To be used only in tests. An app with this may not survive a reboot.

package/src/controller/initializeKernel.js

@@ -1,5 +1,3 @@
-/* eslint-disable no-use-before-define */
-
 import { assert, Fail } from '@endo/errors';
 import { makeMarshal } from '@endo/marshal';
 import { Far } from '@endo/far';
@@ -102,7 +100,6 @@ export async function initializeKernel(config, kernelStorage, options = {}) {
       // the VatManager, since it isn't available until the bundle is evaluated
       assertKnownOptions(creationOptions, [
         'enablePipelining',
-        'metered',
         'managerType',
         'enableDisavow',
         'enableSetup',

package/src/controller/initializeSwingset.js

@@ -2,8 +2,8 @@
 import fs from 'fs';
 import path from 'path';
 
-import { assert, Fail } from '@endo/errors';
-import { makeTracer } from '@agoric/internal';
+import { assert, b, Fail } from '@endo/errors';
+import { deepCopyJsonable, makeTracer } from '@agoric/internal';
 import { mustMatch } from '@agoric/store';
 import bundleSource from '@endo/bundle-source';
 import { resolve as resolveModuleSpecifier } from 'import-meta-resolve';
@@ -86,16 +86,6 @@ export async function buildKernelBundles() {
   return harden({ kernel: kernelBundle, ...vdBundles });
 }
 
-function byName(a, b) {
-  if (a.name < b.name) {
-    return -1;
-  }
-  if (a.name > b.name) {
-    return 1;
-  }
-  return 0;
-}
-
 /**
  * Scan a directory for files defining the vats to bootstrap for a swingset, and
  * produce a swingset config object for what was found there.  Looks for files
@@ -126,18 +116,18 @@ export function loadBasedir(basedir, options = {}) {
   const { includeDevDependencies = false, bundleFormat = undefined } = options;
   /** @type { SwingSetConfigDescriptor } */
   const vats = {};
-  const subs = fs.readdirSync(basedir, { withFileTypes: true });
-  subs.sort(byName);
-  for (const dirent of subs) {
-    if (
-      dirent.name.startsWith('vat-') &&
-      dirent.name.endsWith('.js') &&
-      dirent.isFile()
-    ) {
-      const name = dirent.name.slice('vat-'.length, -'.js'.length);
-      const vatSourcePath = path.resolve(basedir, dirent.name);
-      vats[name] = { sourceSpec: vatSourcePath, parameters: {} };
-    }
+  const rVatName = /^vat-(.*)\.js$/s;
+  const files = fs.readdirSync(basedir, { withFileTypes: true });
+  const vatFiles = files.flatMap(dirent => {
+    const file = dirent.name;
+    const m = rVatName.exec(file);
+    return m && dirent.isFile() ? [{ file, label: m[1] }] : [];
+  });
+  // eslint-disable-next-line no-shadow,no-nested-ternary
+  vatFiles.sort((a, b) => (a.label < b.label ? -1 : a.label > b.label ? 1 : 0));
+  for (const { file, label } of vatFiles) {
+    const vatSourcePath = path.resolve(basedir, file);
+    vats[label] = { sourceSpec: vatSourcePath, parameters: {} };
   }
   /** @type {string | void} */
   let bootstrapPath = path.resolve(basedir, 'bootstrap.js');
@@ -185,37 +175,42 @@ async function resolveSpecFromConfig(referrer, specPath) {
 }
 
 /**
- * For each entry in a config descriptor (i.e, `vats`, `bundles`, etc), convert
- * it to normal form: resolve each pathname to a context-insensitive absolute
- * path and make sure it has a `parameters` property if it's supposed to.
+ * Convert each entry in a config descriptor group (`vats`/`bundles`/etc.) to
+ * normal form: resolve each pathname to a context-insensitive absolute path and
+ * run any other appropriate fixup.
  *
- * @param {SwingSetConfigDescriptor | void} desc  The config descriptor to be normalized.
- * @param {string} referrer  The pathname of the file or directory in which the
- * config file was found
- * @param {boolean} expectParameters `true` if the entries should have parameters (for
- *    example, `true` for `vats` but `false` for bundles).
+ * @param {SwingSetConfig} config
+ * @param {'vats' | 'bundles' | 'devices'} groupName
+ * @param {string | undefined} configPath of the containing config file
+ * @param {string} referrer URL
+ * @param {(entry: SwingSetConfigProperties, name?: string) => void} [fixupEntry]
+ *   A function to call on each entry to e.g. add defaults for missing fields
+ *   such as vat `parameters`.
  */
-async function normalizeConfigDescriptor(desc, referrer, expectParameters) {
-  const normalizeSpec = async (entry, key) => {
-    return resolveSpecFromConfig(referrer, entry[key]).then(spec => {
-      fs.existsSync(spec) ||
-        Fail`spec for ${entry[key]} does not exist: ${spec}`;
-      entry[key] = spec;
-    });
+async function normalizeConfigDescriptor(
+  config,
+  groupName,
+  configPath,
+  referrer,
+  fixupEntry,
+) {
+  const normalizeSpec = async (entry, specKey, name) => {
+    const sourcePath = await resolveSpecFromConfig(referrer, entry[specKey]);
+    fs.existsSync(sourcePath) ||
+      Fail`${sourcePath} for ${b(groupName)}[${name}].${b(specKey)} in ${configPath} config file does not exist`;
+    entry[specKey] = sourcePath;
   };
 
   const jobs = [];
+  const desc = config[groupName];
   if (desc) {
-    for (const name of Object.keys(desc)) {
-      const entry = desc[name];
+    for (const [name, entry] of Object.entries(desc)) {
+      fixupEntry?.(entry, name);
       if ('sourceSpec' in entry) {
-        jobs.push(normalizeSpec(entry, 'sourceSpec'));
+        jobs.push(normalizeSpec(entry, 'sourceSpec', name));
       }
       if ('bundleSpec' in entry) {
-        jobs.push(normalizeSpec(entry, 'bundleSpec'));
-      }
-      if (expectParameters && !entry.parameters) {
-        entry.parameters = {};
+        jobs.push(normalizeSpec(entry, 'bundleSpec', name));
       }
     }
   }
@@ -223,27 +218,41 @@ async function normalizeConfigDescriptor(desc, referrer, expectParameters) {
 }
 
 /**
- * Read and parse a swingset config file and return it in normalized form.
- *
- * @param {string} configPath  Path to the config file to be processed
- *
- * @returns {Promise<SwingSetConfig | null>} the contained config object, in normalized form, or null if the
- *    requested config file did not exist.
+ * @param {SwingSetConfig} config
+ * @param {string} [configPath]
+ * @returns {Promise<void>}
+ * @throws {Error} if the config is invalid
+ */
+export async function normalizeConfig(config, configPath) {
+  const base = `file://${process.cwd()}/`;
+  const referrer = configPath
+    ? new URL(configPath, base).href
+    : new URL(base).href;
+  const fixupVat = vat => (vat.parameters ||= {});
+  await Promise.all([
+    normalizeConfigDescriptor(config, 'vats', configPath, referrer, fixupVat),
+    normalizeConfigDescriptor(config, 'bundles', configPath, referrer),
+    // TODO: represent devices
+    // normalizeConfigDescriptor(config, 'devices', configPath, referrer),
+  ]);
+  config.bootstrap ||
+    Fail`no designated bootstrap vat in ${configPath} config file`;
+  (config.vats && config.vats[/** @type {string} */ (config.bootstrap)]) ||
+    Fail`bootstrap vat ${config.bootstrap} not found in ${configPath} config file`;
+}
+
+/**
+ * Read and normalize a swingset config file.
  *
- * @throws {Error} if the file existed but was inaccessible, malformed, or otherwise
- *    invalid.
+ * @param {string} configPath
+ * @returns {Promise<SwingSetConfig | null>} the normalized config,
+ *   or null if the file did not exist
  */
 export async function loadSwingsetConfigFile(configPath) {
   await null;
   try {
     const config = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
-    const referrer = new URL(configPath, `file://${process.cwd()}/`).toString();
-    await normalizeConfigDescriptor(config.vats, referrer, true);
-    await normalizeConfigDescriptor(config.bundles, referrer, false);
-    // await normalizeConfigDescriptor(config.devices, referrer, true); // TODO: represent devices
-    config.bootstrap || Fail`no designated bootstrap vat in ${configPath}`;
-    (config.vats && config.vats[config.bootstrap]) ||
-      Fail`bootstrap vat ${config.bootstrap} not found in ${configPath}`;
+    await normalizeConfig(config, configPath);
     return config;
   } catch (e) {
     console.error(`failed to load ${configPath}`);
@@ -314,7 +323,7 @@ export async function initializeSwingset(
   } = runtimeOptions;
 
   // copy config so we can safely mess with it even if it's shared or hardened
-  config = JSON.parse(JSON.stringify(config));
+  config = deepCopyJsonable(config);
   if (!config.bundles) {
     config.bundles = {};
   }
@@ -433,26 +442,24 @@ export async function initializeSwingset(
    * The host application gives us
    * config.[vats|devices].NAME.[bundle|bundleSpec|sourceSpec|bundleName] .
    * The 'bundleName' option points into
-   * config.bundles.BUNDLENAME.[bundle|bundleSpec|sourceSpec] , which can
+   * config.bundles.BUNDLENAME.[bundle|bundleSpec|sourceSpec], which can
    * also include arbitrary named bundles that will be made available to
-   * E(vatAdminService).getNamedBundleCap(bundleName) ,and temporarily as
+   * E(vatAdminService).getNamedBundleCap(bundleName), and temporarily as
    * E(vatAdminService).createVatByName(bundleName)
    *
    * The 'kconfig' we pass through to initializeKernel has
    * kconfig.[vats|devices].NAME.bundleID and
-   * kconfig.namedBundleIDs.BUNDLENAME=bundleID , which both point into
+   * kconfig.namedBundleIDs.BUNDLENAME=bundleID, which both point into
    * kconfig.idToBundle.BUNDLEID=bundle
    *
-   * @param {SwingSetConfigProperties | { bundleName: string }} desc
+   * @param {SwingSetConfigProperties} desc
    * @param {Record<string, *>} [nameToBundle]
    */
   async function getBundle(desc, nameToBundle) {
     trace(
       'getBundle',
       Object.keys(desc),
-      // @ts-expect-error optional
       desc.moduleFormat,
-      // @ts-expect-error optional
       desc.endoZipBase64Sha512 || desc.sourceSpec,
     );
 
@@ -480,8 +487,9 @@ export async function initializeSwingset(
     throw Error(`unknown mode in desc`, desc);
   }
 
-  // fires with BundleWithID: { ...bundle, id }
   /**
+   * Returns a bundle record with an "id" property from an input that might be missing it.
+   *
    * @param {EndoZipBase64Bundle & {id?: string}} bundle
    * @returns {Promise<EndoZipBase64Bundle & {id: string}>} bundle
    */
@@ -499,11 +507,9 @@ export async function initializeSwingset(
     };
   }
 
-  // fires with BundleWithID: { ...bundle, id }
-
   /**
    *
-   * @param {(SwingSetConfigProperties | { bundleName: string }) & {bundleID?: string }} desc
+   * @param {SwingSetConfigProperties & {bundleID?: string}} desc
    * @param {Record<string, EndoZipBase64Bundle>} [nameToBundle]
    */
   async function processDesc(desc, nameToBundle) {
@@ -517,14 +523,14 @@ export async function initializeSwingset(
     modes.length === 1 ||
       Fail`need =1 of bundle/bundleSpec/sourceSpec/bundleName, got ${modes}`;
     const mode = modes[0];
-    return getBundle(desc, nameToBundle)
-      .then(addBundleID)
-      .then(bundleWithID => {
-        // replace original .sourceSpec/etc with a uniform .bundleID
-        delete desc[mode];
-        desc.bundleID = bundleWithID.id;
-        return bundleWithID;
-      });
+
+    // Remove the original mode in favor of a uniform "bundleID" property.
+    const bundle = await getBundle(desc, nameToBundle);
+    const bundleWithID = await addBundleID(bundle);
+    delete desc[mode];
+    desc.bundleID = bundleWithID.id;
+
+    return bundleWithID;
   }
 
   /**