@agoric/internal 0.3.3-dev-dc89345.0.dc89345 → 0.3.3-dev-32665e4.0.32665e4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/internal",
-  "version": "0.3.3-dev-dc89345.0.dc89345",
+  "version": "0.3.3-dev-32665e4.0.32665e4",
   "description": "Externally unsupported utilities internal to agoric-sdk",
   "type": "module",
   "main": "src/index.js",
@@ -20,7 +20,7 @@
     "lint:types": "yarn run -T tsc"
   },
   "dependencies": {
-    "@agoric/base-zone": "0.1.1-dev-dc89345.0.dc89345",
+    "@agoric/base-zone": "0.1.1-dev-32665e4.0.32665e4",
     "@endo/cache-map": "^1.1.0",
     "@endo/common": "^1.2.13",
     "@endo/compartment-mapper": "^1.6.3",
@@ -38,7 +38,7 @@
     "jessie.js": "^0.3.4"
   },
   "devDependencies": {
-    "@agoric/cosmic-proto": "0.4.1-dev-dc89345.0.dc89345",
+    "@agoric/cosmic-proto": "0.4.1-dev-32665e4.0.32665e4",
     "@endo/exo": "^1.5.12",
     "@endo/init": "^1.1.12",
     "@endo/ses-ava": "^1.3.2",
@@ -66,5 +66,5 @@
   "typeCoverage": {
     "atLeast": 92.89
   },
-  "gitHead": "dc8934527d1c83584ed723aad48c7eaace489578"
+  "gitHead": "32665e40a7d223b050640771695ac47bb2a450f5"
 }

package/src/testing-utils.d.ts

@@ -1,4 +1,8 @@
 export function eventLoopIteration(): Promise<any>;
 export function inspectMapStore(store: MapStore): object;
+export function testInterruptedSteps<Context = unknown>(t: AvaT<Context>, allSteps: readonly TestStep[], doInterrupt: (t: AvaT<Context>) => ERef<void>): Promise<void>;
+export type TestStep = readonly [stepName: string, fn: (input: any, label: string) => unknown];
 import type { MapStore } from '@agoric/store';
+import type { ExecutionContext as AvaT } from 'ava';
+import type { ERef } from '@endo/eventual-send';
 //# sourceMappingURL=testing-utils.d.ts.map

package/src/testing-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"testing-utils.d.ts","sourceRoot":"","sources":["testing-utils.js"],"names":[],"mappings":"AAeO,mDACwC;AAgBxC,uCAHI,QAAQ,GACN,MAAM,CAsBlB;8BA9C2B,eAAe"}
+{"version":3,"file":"testing-utils.d.ts","sourceRoot":"","sources":["testing-utils.js"],"names":[],"mappings":"AAmBO,mDACwC;AAgBxC,uCAHI,QAAQ,GACN,MAAM,CAsBlB;AAmBM,qCALO,OAAO,eACV,KAAK,OAAO,CAAC,YACb,SAAS,QAAQ,EAAE,eACnB,CAAC,CAAC,EAAE,KAAK,OAAO,CAAC,KAAK,KAAK,IAAI,CAAC,iBA2D1C;uBAxEY,SAAS,CACjB,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAC3C;8BAxDuB,eAAe;8CACC,KAAK;0BACzB,qBAAqB"}

package/src/testing-utils.js

@@ -4,7 +4,11 @@
  *   https://github.com/Agoric/agoric-sdk/issues/7503
  */
 /* global setImmediate */
-/** @import {MapStore} from '@agoric/store'; */
+/**
+ * @import {MapStore} from '@agoric/store';
+ * @import {ExecutionContext as AvaT} from 'ava';
+ * @import {ERef} from '@endo/eventual-send';
+ */
 
 /**
  * A workaround for some issues with fake time in tests.
@@ -52,3 +56,79 @@ export const inspectMapStore = store => {
   return obj;
 };
 harden(inspectMapStore);
+
+/**
+ * @typedef {readonly [
+ *   stepName: string,
+ *   fn: (input: any, label: string) => unknown,
+ * ]} TestStep
+ */
+
+/**
+ * For each step, run to just before that point and pause for continuation after
+ * interrupt.
+ *
+ * @template [Context=unknown]
+ * @param {AvaT<Context>} t
+ * @param {readonly TestStep[]} allSteps
+ * @param {(t: AvaT<Context>) => ERef<void>} doInterrupt
+ */
+export const testInterruptedSteps = async (t, allSteps, doInterrupt) => {
+  /**
+   * @typedef {{
+   *   label: string;
+   *   accum?: unknown;
+   * }} RunState
+   */
+
+  /**
+   * @param {string} label
+   * @param {readonly TestStep[]} steps
+   * @param {RunState} [runState]
+   * @returns {Promise<RunState>}
+   */
+  const runSteps = async (label, steps, runState = { label }) => {
+    await null;
+    let accum = runState.accum;
+    const runLabel = runState.label;
+    for (const [stepName, fn] of steps) {
+      await t.notThrowsAsync(async () => {
+        accum = await fn(accum, runLabel);
+      }, `${label} ${stepName} must complete successfully`);
+    }
+    return { label: runLabel, accum };
+  };
+
+  // Sanity check
+  await runSteps('pre-interrupt', allSteps);
+
+  /**
+   * @type {{
+   *   runState: RunState;
+   *   remainingSteps: readonly TestStep[];
+   * }[]}
+   */
+  const pausedRuns = [];
+  for (let i = 0; i < allSteps.length; i += 1) {
+    const [beforeStepName] = allSteps[i];
+    const runState = await runSteps(
+      `pre-${beforeStepName}`,
+      allSteps.slice(0, i),
+      { label: `pause-before-${beforeStepName}` },
+    );
+    pausedRuns.push({ runState, remainingSteps: allSteps.slice(i) });
+  }
+
+  // Run the user code that interrupts the steps.
+  await doInterrupt(t);
+
+  // Verify a complete run post-interrupt.
+  await runSteps('post-interrupt', allSteps);
+
+  // Verify completion of each paused step.
+  for (const { runState, remainingSteps } of pausedRuns) {
+    const [beforeStepName] = remainingSteps[0];
+    await runSteps(`resumed-${beforeStepName}`, remainingSteps, runState);
+  }
+};
+harden(testInterruptedSteps);