@agoric/xsnap 0.14.3-other-dev-8f8782b.0 → 0.14.3-other-dev-fbe72e7.0.fbe72e7

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@agoric/xsnap",
-  "version": "0.14.3-other-dev-8f8782b.0+8f8782b",
-  "description": "Description forthcoming.",
+  "version": "0.14.3-other-dev-fbe72e7.0.fbe72e7",
+  "description": "Snapshotting VM worker based on Moddable's XS Javascript engine",
   "author": "Agoric",
   "license": "Apache-2.0",
   "type": "module",
@@ -12,54 +12,74 @@
   },
   "scripts": {
     "repl": "node src/xsrepl.js",
-    "build:bin": "if git status >/dev/null 2>&1; then node src/build.js; else yarn build:from-env; fi",
-    "build:env": "if git status >/dev/null 2>&1; then node src/build.js --show-env > build.env; fi",
+    "build:bin": "/bin/sh -c 'if test -d ./test; then node src/build.js; else yarn build:from-env; fi'",
+    "build:env": "node src/build.js --show-env > build.env",
     "build:from-env": "{ cat build.env; echo node src/build.js; } | xargs env",
     "build": "yarn build:bin && yarn build:env",
-    "postinstall": "yarn build:from-env",
+    "check-version": "/bin/sh -c 'if test \"${npm_package_version}\" != \"$(./scripts/get_xsnap_version.sh)\"; then echo \"xsnap version mismatch; expected '${npm_package_version}'\"; exit 1; fi'",
+    "postinstall": "npm run build:from-env",
     "clean": "rm -rf xsnap-native/xsnap/build",
-    "lint": "run-s --continue-on-error lint:*",
+    "lint": "yarn run -T run-s --continue-on-error 'lint:*'",
     "lint:js": "eslint 'src/**/*.js' 'test/**/*.js' api.js",
-    "lint:types": "tsc -p jsconfig.json",
+    "lint:types": "yarn run -T tsc",
     "lint-fix": "eslint --fix 'src/**/*.js' 'test/**/*.js' api.js",
     "test": "ava",
-    "test:c8": "c8 $C8_OPTIONS ava --config=ava-nesm.config.js",
+    "test:c8": "c8 --all ${C8_OPTIONS:-} ava",
     "test:xs": "exit 0"
   },
   "dependencies": {
-    "@agoric/assert": "0.6.1-other-dev-8f8782b.0+8f8782b",
-    "@agoric/internal": "0.3.3-other-dev-8f8782b.0+8f8782b",
-    "@agoric/xsnap-lockdown": "0.14.1-other-dev-8f8782b.0+8f8782b",
-    "@endo/bundle-source": "2.5.2-upstream-rollup",
-    "@endo/eventual-send": "0.17.2",
-    "@endo/init": "0.5.56",
-    "@endo/netstring": "0.3.26",
-    "@endo/promise-kit": "0.2.56",
-    "@endo/stream": "0.3.25",
-    "@endo/stream-node": "0.2.26",
+    "@agoric/internal": "0.3.3-other-dev-fbe72e7.0.fbe72e7",
+    "@agoric/xsnap-lockdown": "0.14.1-other-dev-fbe72e7.0.fbe72e7",
+    "@endo/bundle-source": "^4.1.2",
+    "@endo/errors": "^1.2.13",
+    "@endo/eventual-send": "^1.3.4",
+    "@endo/init": "^1.1.12",
+    "@endo/netstring": "^1.0.18",
+    "@endo/promise-kit": "^1.1.13",
+    "@endo/stream": "^1.2.13",
+    "@endo/stream-node": "^1.1.13",
     "glob": "^7.1.6",
     "tmp": "^0.2.1"
   },
   "devDependencies": {
-    "@endo/base64": "0.2.31",
-    "ava": "^5.2.0",
-    "c8": "^7.13.0"
+    "@endo/base64": "^1.0.12",
+    "@endo/nat": "^5.1.3",
+    "ava": "^5.3.0",
+    "c8": "^10.1.3",
+    "execa": "^9.5.2"
   },
   "files": [
     "LICENSE*",
     "api.js",
     "build.env",
-    "src"
+    "moddable/modules/data/**",
+    "moddable/xs/includes/**",
+    "moddable/xs/makefiles/**",
+    "moddable/xs/sources/**",
+    "moddable/xs/platforms/*.h",
+    "scripts/**",
+    "src/**",
+    "xsnap-native/xsnap/makefiles/**",
+    "xsnap-native/xsnap/sources/**"
   ],
   "publishConfig": {
     "access": "public"
   },
   "ava": {
     "files": [
-      "test/**/test-*.js"
+      "test/**/*.test.*"
+    ],
+    "require": [
+      "@endo/init/debug.js"
     ],
     "timeout": "2m",
     "workerThreads": false
   },
-  "gitHead": "8f8782bc52393e9d4fc82523ecf31cab429b11b3"
+  "typeCoverage": {
+    "atLeast": 93.57
+  },
+  "engines": {
+    "node": "^20.9 || ^22.11"
+  },
+  "gitHead": "fbe72e72107f9997f788674e668c660d92ec4492"
 }

package/scripts/get_xsnap_version.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+set -ueo pipefail
+
+# the xsnap binary lives in a platform-specific directory
+unameOut="$(uname -s)"
+case "${unameOut}" in
+  Linux*) platform=lin ;;
+  Darwin*) platform=mac ;;
+  *) platform=win ;;
+esac
+
+# extract the xsnap package version from the long version printed by xsnap-worker
+"./xsnap-native/xsnap/build/bin/${platform}/release/xsnap-worker" -v | sed -e 's/^xsnap \([^ ]*\) (XS [^)]*)$/\1/g'

package/scripts/test-package.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+# Verifies that files in package.json covers everything xsnap needs to compile
+# from sources out of an npm package.
+set -xueo pipefail
+
+TEMP=$(mktemp -d)
+# function cleanup() {
+#   rm -rf "$TEMP"
+# }
+# trap cleanup EXIT
+
+yarn pack -f "$TEMP/package.tar"
+(
+  cd "$TEMP"
+  tar xvf package.tar
+  cd package
+  time yarn
+  time yarn
+  time yarn
+  time yarn
+)

package/src/avaAssertXS.js

@@ -1,5 +1,4 @@
 /* global globalThis */
-/* eslint-disable no-await-in-loop, @jessie.js/no-nested-await -- test code */
 /** global print */
 
 const { assign, freeze, keys } = Object;
@@ -67,7 +66,7 @@ function deepDifference(x, y) {
  * @param {(msg: TapMessage) => void} send
  *
  * @typedef { ReturnType<typeof tapFormat> } TapFormat
- * @typedef {import('./avaXS').TapMessage} TapMessage
+ * @import {TapMessage} from './avaXS.js'
  */
 function tapFormat(send) {
   return freeze({
@@ -229,6 +228,8 @@ function makeTester(htest, out) {
     fail(message) {
       assert(false, message);
     },
+    // Not the SES or @endo/errors `assert`
+    // See https://github.com/Agoric/agoric-sdk/issues/9515
     assert,
     truthy,
     /**
@@ -300,6 +301,7 @@ function makeTester(htest, out) {
       expectation,
       message = `should reject like ${expectation}`,
     ) {
+      await null;
       try {
         await (typeof thrower === 'function' ? thrower() : thrower);
         assert(false, message);
@@ -310,6 +312,7 @@ function makeTester(htest, out) {
     },
     /** @type {(thrower: () => Promise<unknown>, message?: string) => Promise<void> } */
     async notThrowsAsync(nonThrower, message) {
+      await null;
       try {
         await (typeof nonThrower === 'function' ? nonThrower() : nonThrower);
       } catch (ex) {
@@ -335,6 +338,7 @@ const test = (label, run, htestOpt) => {
   htest.queue(label, async () => {
     const out = tapFormat(htest.send);
     const t = makeTester(htest, out);
+    await null;
     try {
       // out.diagnostic('start', label);
       await run(t);

package/src/avaHandler.cjs

@@ -12,7 +12,6 @@ HandledPromise is defined by eventual send shim.
 /// <reference types="ses" />
 /// <reference types="@endo/eventual-send" />
 
-// @ts-expect-error cannot redeclare encoder
 const encoder = new TextEncoder();
 const decoder = new TextDecoder();
 
@@ -20,7 +19,7 @@ const decoder = new TextDecoder();
  * @param {{ testNames: string[]} |
  *          { bundleSource: [string, ...unknown[]] } |
  *          TapMessage | Summary } item
- * @typedef {import('./avaXS').Summary} Summary
+ * @import {Summary} from './avaXS'
  */
 function send(item) {
   const msg = encoder.encode(JSON.stringify(item)).buffer;
@@ -33,7 +32,6 @@ function send(item) {
  */
 const bundleSource = async (startFilename, ...args) => {
   const msg = await send({ bundleSource: [startFilename, ...args] });
-  // @ts-expect-error send() returns void
   return JSON.parse(decoder.decode(msg));
 };
 
@@ -79,7 +77,7 @@ function handler(rawMessage) {
       const { source } = msg;
       const virtualObjectGlobals =
         // @ts-expect-error
-        // eslint-disable-next-line no-undef
+
         typeof VatData !== 'undefined' ? { VatData } : {};
       const c = new Compartment({
         require: testRequire,
@@ -87,7 +85,6 @@ function handler(rawMessage) {
         __filename,
         console,
         assert,
-        // @ts-expect-error
         HandledPromise,
         URL: class URLStub {
           constructor(url, base) {

package/src/avaXS.js

@@ -2,17 +2,17 @@
 
 Usage:
 
-  node avaXS.js [--debug] test-*.js
+  node avaXS.js [--debug] *.test.js
 
 */
 
-/* eslint-disable no-await-in-loop, @jessie.js/no-nested-await -- test code */
 import '@endo/init';
 
 import fs from 'fs';
+import { fileURLToPath } from 'url';
 import { tmpName } from 'tmp';
 
-import { assert, q, Fail } from '@agoric/assert';
+import { assert, q, Fail } from '@endo/errors';
 import { getDebugLockdownBundle } from '@agoric/xsnap-lockdown';
 import { xsnap } from './xsnap.js';
 
@@ -22,7 +22,7 @@ const avaHandler = `./avaHandler.cjs`;
 
 /** @type { (ref: string, readFile: typeof import('fs').promises.readFile ) => Promise<string> } */
 const asset = (ref, readFile) =>
-  readFile(new URL(ref, import.meta.url).pathname, 'utf8');
+  readFile(fileURLToPath(new URL(ref, import.meta.url)), 'utf8');
 
 /**
  * When we bundle test scripts, we leave these externals
@@ -69,8 +69,6 @@ function isMatch(specimen, pattern) {
  *
  * It also calls back if a test calls `bundleSource`.
  *
- * @typedef {{ moduleFormat: string, source: string }} Bundle
- *
  * And finally it reports back a summary of assertion results.
  *
  * @typedef {{
@@ -84,7 +82,7 @@ function isMatch(specimen, pattern) {
  * @param {{ verbose?: boolean, titleMatch?: string }} options
  * @param {{
  *   spawnXSnap: (opts: object) => XSnap,
- *   bundleSource: (...args: [string, ...unknown[]]) => Promise<Bundle>,
+ *   bundleSource: import('@endo/bundle-source').BundleSource,
  *   resolve: ResolveFn,
  *   dirname: typeof import('path').dirname,
  *   basename: typeof import('path').basename,
@@ -93,7 +91,7 @@ function isMatch(specimen, pattern) {
  *
  * @typedef {{ total: number, pass: number, fail: { filename: string, name: string }[] }} TestResults
  * @typedef { 'ok' | 'not ok' | 'SKIP' } Status
- * @typedef {ReturnType<typeof import('./xsnap').xsnap>} XSnap
+ * @typedef {ReturnType<typeof import('./xsnap.js').xsnap>} XSnap
  */
 async function runTestScript(
   filename,
@@ -114,13 +112,13 @@ async function runTestScript(
   /**
    * Handle callback "command" from xsnap subprocess.
    *
-   * @type { (msg: ArrayBuffer) => Promise<ArrayBuffer> }
+   * @type { (msg: ArrayBuffer) => Promise<Uint8Array<ArrayBufferLike>> }
    */
   async function handleCommand(message) {
     /**
      * See also send() in avaHandler.cjs
      *
-     * @type { TapMessage | { testNames: string[] } | { bundleSource: [string, ...unknown[]] } | Summary }
+     * @type { TapMessage | { testNames: string[] } | { bundleSource: Parameters<import('@endo/bundle-source').BundleSource> } | Summary }
      */
     const msg = JSON.parse(decoder.decode(message));
     // console.log(input, msg, qty, byStatus);
@@ -129,6 +127,7 @@ async function runTestScript(
       testNames = msg.testNames;
     }
 
+    await null;
     if ('bundleSource' in msg) {
       const [startFilename, ...rest] = msg.bundleSource;
       // see also makeBundleResolve() below
@@ -244,6 +243,7 @@ async function avaConfig(args, options, { glob, readFile }) {
   let debug = false;
   let verbose = false;
   let titleMatch;
+  await null;
   while (args.length > 0) {
     const arg = args.shift();
     assert.typeof(arg, 'string');
@@ -301,7 +301,7 @@ async function avaConfig(args, options, { glob, readFile }) {
 /**
  * @param {string[]} args - CLI args (excluding node interpreter, script name)
  * @param {{
- *   bundleSource: typeof import('@endo/bundle-source').default,
+ *   bundleSource: import('@endo/bundle-source').BundleSource,
  *   spawn: typeof import('child_process')['spawn'],
  *   osType: typeof import('os')['type'],
  *   readFile: typeof import('fs')['promises']['readFile'],
@@ -385,7 +385,9 @@ export async function main(
 
     stats.total += results.total;
     stats.pass += results.pass;
-    results.fail.forEach(info => stats.fail.push(info));
+    for (const info of results.fail) {
+      stats.fail.push(info);
+    }
   }
 
   console.log(stats.pass, 'tests passed');