@agoric/swingset-liveslots 0.10.3-u13.0 → 0.10.3-u16.0

package/tools/fakeVirtualSupport.js

@@ -1,14 +1,23 @@
-/* global WeakRef */
+/* global globalThis */
 /* eslint-disable max-classes-per-file */
 import { makeMarshal } from '@endo/marshal';
 import { assert } from '@agoric/assert';
-import { parseVatSlot } from '../src/parseVatSlots.js';
+import { isPromise } from '@endo/promise-kit';
 
+import { parseVatSlot } from '../src/parseVatSlots.js';
 import { makeVirtualReferenceManager } from '../src/virtualReferences.js';
 import { makeWatchedPromiseManager } from '../src/watchedPromises.js';
 import { makeFakeVirtualObjectManager } from './fakeVirtualObjectManager.js';
 import { makeFakeCollectionManager } from './fakeCollectionManager.js';
 
+const { Fail } = assert;
+
+const {
+  WeakRef: RealWeakRef,
+  WeakMap: RealWeakMap,
+  WeakSet: RealWeakSet,
+} = globalThis;
+
 class FakeFinalizationRegistry {
   // eslint-disable-next-line no-useless-constructor, no-empty-function
   constructor() {}
@@ -30,8 +39,6 @@ class FakeWeakRef {
   }
 }
 
-const RealWeakRef = WeakRef;
-
 export function makeFakeLiveSlotsStuff(options = {}) {
   let vrm;
   function setVrm(vrmToUse) {
@@ -45,6 +52,8 @@ export function makeFakeLiveSlotsStuff(options = {}) {
     log,
     FinalizationRegistry = FakeFinalizationRegistry,
     WeakRef = FakeWeakRef, // VRM uses this
+    WeakMap = RealWeakMap,
+    WeakSet = RealWeakSet,
     addToPossiblyDeadSet = () => {},
     addToPossiblyRetiredSet = () => {},
   } = options;
@@ -151,18 +160,16 @@ export function makeFakeLiveSlotsStuff(options = {}) {
     },
   };
 
-  let nextExportID = 1;
   function allocateExportID() {
-    const exportID = nextExportID;
-    nextExportID += 1;
-    return exportID;
+    return vrm.allocateNextID('exportID');
+  }
+
+  function allocatePromiseID() {
+    return vrm.allocateNextID('promiseID');
   }
 
-  let nextCollectionID = 1;
   function allocateCollectionID() {
-    const collectionID = nextCollectionID;
-    nextCollectionID += 1;
-    return collectionID;
+    return vrm.allocateNextID('collectionID');
   }
 
   // note: The real liveslots slotToVal() maps slots (vrefs) to a WeakRef,
@@ -193,7 +200,9 @@ export function makeFakeLiveSlotsStuff(options = {}) {
 
   function convertValToSlot(val) {
     if (!valToSlot.has(val)) {
-      const slot = `o+${allocateExportID()}`;
+      const slot = isPromise(val)
+        ? `p+${allocatePromiseID()}`
+        : `o+${allocateExportID()}`;
       valToSlot.set(val, slot);
       setValForSlot(slot, val);
     }
@@ -212,30 +221,42 @@ export function makeFakeLiveSlotsStuff(options = {}) {
       }
       return val;
     }
+    let result;
     if (virtual || durable) {
       if (vrm) {
         val = vrm.reanimate(slot);
         if (facet !== undefined) {
-          return vrm.getFacet(id, val, facet);
+          result = vrm.getFacet(id, val, facet);
         }
       } else {
         assert.fail('fake liveSlots stuff configured without vrm');
       }
     }
-    return val;
+    // eslint-disable-next-line no-use-before-define
+    registerEntry(baseRef, val, facet !== undefined);
+    if (!result) {
+      result = val;
+    }
+    return result;
   }
 
   const marshal = makeMarshal(convertValToSlot, convertSlotToVal, {
     serializeBodyFormat: 'smallcaps',
+    marshalName: 'fakeLiveSlots',
+    errorIdNum: 80_000,
+    marshalSaveError: _err => {},
   });
 
   function registerEntry(baseRef, val, valIsCohort) {
+    const { facet } = parseVatSlot(baseRef);
+    !facet ||
+      Fail`registerEntry(${baseRef} should not receive individual facets`;
     setValForSlot(baseRef, val);
     if (valIsCohort) {
       const { id } = parseVatSlot(baseRef);
-      vrm.getFacetNames(id).forEach((name, index) => {
+      for (const [index, name] of vrm.getFacetNames(id).entries()) {
         valToSlot.set(val[name], `${baseRef}:${index}`);
-      });
+      }
     } else {
       valToSlot.set(val, baseRef);
     }
@@ -270,6 +291,8 @@ export function makeFakeLiveSlotsStuff(options = {}) {
     deleteEntry,
     FinalizationRegistry,
     WeakRef,
+    WeakMap,
+    WeakSet,
     addToPossiblyDeadSet,
     addToPossiblyRetiredSet,
     dumpStore,
@@ -311,12 +334,17 @@ export function makeFakeWatchedPromiseManager(
     maybeExportPromise: fakeStuff.maybeExportPromise,
   });
 }
+
 /**
  * Configure virtual stuff with relaxed durability rules and fake liveslots
  *
  * @param {object} [options]
- * @param {number} [options.cacheSize=3]
- * @param {boolean} [options.relaxDurabilityRules=true]
+ * @param {number} [options.cacheSize]
+ * @param {boolean} [options.relaxDurabilityRules]
+ * @param {Map<any, any>} [options.fakeStore]
+ * @param {WeakMapConstructor} [options.WeakMap]
+ * @param {WeakSetConstructor} [options.WeakSet]
+ * @param {boolean} [options.weak]
  */
 export function makeFakeVirtualStuff(options = {}) {
   const actualOptions = {
@@ -326,11 +354,12 @@ export function makeFakeVirtualStuff(options = {}) {
   const { relaxDurabilityRules } = actualOptions;
   const fakeStuff = makeFakeLiveSlotsStuff(actualOptions);
   const vrm = makeFakeVirtualReferenceManager(fakeStuff, relaxDurabilityRules);
+  fakeStuff.setVrm(vrm);
   const vom = makeFakeVirtualObjectManager(vrm, fakeStuff);
   vom.initializeKindHandleKind();
-  fakeStuff.setVrm(vrm);
   const cm = makeFakeCollectionManager(vrm, fakeStuff, actualOptions);
   const wpm = makeFakeWatchedPromiseManager(vrm, vom, cm, fakeStuff);
+  wpm.preparePromiseWatcherTables();
   return { fakeStuff, vrm, vom, cm, wpm };
 }
 
@@ -338,9 +367,9 @@ export function makeStandaloneFakeVirtualObjectManager(options = {}) {
   const fakeStuff = makeFakeLiveSlotsStuff(options);
   const { relaxDurabilityRules = true } = options;
   const vrm = makeFakeVirtualReferenceManager(fakeStuff, relaxDurabilityRules);
+  fakeStuff.setVrm(vrm);
   const vom = makeFakeVirtualObjectManager(vrm, fakeStuff);
   vom.initializeKindHandleKind();
-  fakeStuff.setVrm(vrm);
   return vom;
 }
 
@@ -348,6 +377,7 @@ export function makeStandaloneFakeCollectionManager(options = {}) {
   const fakeStuff = makeFakeLiveSlotsStuff(options);
   const { relaxDurabilityRules = true } = options;
   const vrm = makeFakeVirtualReferenceManager(fakeStuff, relaxDurabilityRules);
+  fakeStuff.setVrm(vrm);
   return makeFakeCollectionManager(vrm, fakeStuff, options);
 }
 

package/tools/prepare-test-env.js

@@ -0,0 +1,13 @@
+/**
+ * Prepare Agoric SwingSet vat global environment for testing.
+ *
+ * Installs Hardened JS (and does lockdown), plus adds mocks for virtual objects
+ * and stores.
+ */
+
+import '@agoric/internal/src/install-ses-debug.js';
+
+import { reincarnate } from './setup-vat-data.js';
+
+// Install the VatData globals.
+reincarnate();

package/tools/setup-vat-data.js

@@ -0,0 +1,62 @@
+// @ts-check
+/* global globalThis */
+// This file produces the globalThis.VatData property outside of a running
+// SwingSet so that it can be used by '@agoric/vat-data' (which only *consumes*
+// `globalThis.VatData`) in code under test.
+import { makeFakeVirtualStuff } from './fakeVirtualSupport.js';
+
+const { WeakMap, WeakSet } = globalThis;
+
+/** @type {ReturnType<makeFakeVirtualStuff>} */
+let fakeVomKit;
+
+globalThis.VatData = harden({
+  // @ts-expect-error spread argument for non-rest parameter
+  defineKind: (...args) => fakeVomKit.vom.defineKind(...args),
+  // @ts-expect-error spread argument for non-rest parameter
+  defineKindMulti: (...args) => fakeVomKit.vom.defineKindMulti(...args),
+  // @ts-expect-error spread argument for non-rest parameter
+  defineDurableKind: (...args) => fakeVomKit.vom.defineDurableKind(...args),
+  defineDurableKindMulti: (...args) =>
+    // @ts-expect-error spread argument for non-rest parameter
+    fakeVomKit.vom.defineDurableKindMulti(...args),
+  makeKindHandle: tag => fakeVomKit.vom.makeKindHandle(tag),
+  canBeDurable: (...args) => fakeVomKit.vom.canBeDurable(...args),
+  providePromiseWatcher: (...args) =>
+    // @ts-expect-error spread argument for non-rest parameter
+    fakeVomKit.wpm.providePromiseWatcher(...args),
+  watchPromise: (p, watcher, ...args) =>
+    fakeVomKit.wpm.watchPromise(p, watcher, ...args),
+  makeScalarBigMapStore: (...args) =>
+    fakeVomKit.cm.makeScalarBigMapStore(...args),
+  makeScalarBigWeakMapStore: (...args) =>
+    fakeVomKit.cm.makeScalarBigWeakMapStore(...args),
+  makeScalarBigSetStore: (...args) =>
+    fakeVomKit.cm.makeScalarBigSetStore(...args),
+  makeScalarBigWeakSetStore: (...args) =>
+    fakeVomKit.cm.makeScalarBigWeakSetStore(...args),
+});
+
+export const reincarnate = (options = {}) => {
+  const { fakeStore = new Map(), fakeVomKit: fvk } = options;
+
+  if (options.fakeVomKit) {
+    fvk.vom.flushStateCache();
+    fvk.cm.flushSchemaCache();
+    fvk.vrm.flushIDCounters();
+  }
+
+  fakeVomKit = makeFakeVirtualStuff({
+    ...options,
+    fakeStore,
+    WeakMap,
+    WeakSet,
+  });
+
+  // @ts-expect-error toStringTag set imperatively so it doesn't show up in the type
+  globalThis.WeakMap = fakeVomKit.vom.VirtualObjectAwareWeakMap;
+  // @ts-expect-error ditto
+  globalThis.WeakSet = fakeVomKit.vom.VirtualObjectAwareWeakSet;
+
+  return { ...options, fakeStore, fakeVomKit };
+};

package/CHANGELOG.md

@@ -1,85 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-### [0.10.3-u13.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/swingset-liveslots@0.10.3-u12.0...@agoric/swingset-liveslots@0.10.3-u13.0) (2023-12-07)
-
-**Note:** Version bump only for package @agoric/swingset-liveslots
-
-
-
-
-
-### [0.10.3-u12.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/swingset-liveslots@0.10.3-u11wf.0...@agoric/swingset-liveslots@0.10.3-u12.0) (2023-11-10)
-
-**Note:** Version bump only for package @agoric/swingset-liveslots
-
-
-
-
-
-### [0.10.3-u11wf.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/swingset-liveslots@0.10.3-u11.0...@agoric/swingset-liveslots@0.10.3-u11wf.0) (2023-09-23)
-
-**Note:** Version bump only for package @agoric/swingset-liveslots
-
-
-
-
-
-### [0.10.3-u11.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/swingset-liveslots@0.10.2...@agoric/swingset-liveslots@0.10.3-u11.0) (2023-08-24)
-
-**Note:** Version bump only for package @agoric/swingset-liveslots
-
-
-
-
-
-### [0.10.2](https://github.com/Agoric/agoric-sdk/compare/@agoric/swingset-liveslots@0.10.1...@agoric/swingset-liveslots@0.10.2) (2023-06-02)
-
-**Note:** Version bump only for package @agoric/swingset-liveslots
-
-
-
-
-
-### [0.10.1](https://github.com/Agoric/agoric-sdk/compare/@agoric/swingset-liveslots@0.10.0...@agoric/swingset-liveslots@0.10.1) (2023-05-24)
-
-**Note:** Version bump only for package @agoric/swingset-liveslots
-
-
-
-
-
-## 0.10.0 (2023-05-19)
-
-
-### Features
-
-* better diagnostic for failed reanimate ([c0c9c94](https://github.com/Agoric/agoric-sdk/commit/c0c9c9433648d520aa2bcdbadbbfe877831567c7)), closes [Error#1](https://github.com/Agoric/Error/issues/1)
-* **swingset-liveslots:** label virtual instances ([4191eb6](https://github.com/Agoric/agoric-sdk/commit/4191eb62d0e64048c3c715e5f71a53a747267350))
-* add APIs for tracking/debugging undesired object retention (aka "leaks") ([0a7221b](https://github.com/Agoric/agoric-sdk/commit/0a7221b3c04f3b2894c30346fa2ea6fb0130c046)), closes [#7318](https://github.com/Agoric/agoric-sdk/issues/7318)
-* move liveslots and specific tests to a new package ([0921a89](https://github.com/Agoric/agoric-sdk/commit/0921a8903b72cfefdf05a5906bcfb826cac1cc2f)), closes [#6596](https://github.com/Agoric/agoric-sdk/issues/6596)
-
-
-### Bug Fixes
-
-* **liveslots:** allow new Kind upgrade to add new facets ([6bc6694](https://github.com/Agoric/agoric-sdk/commit/6bc6694968e6d2f529e7c91ec1efb11fdff2e2d3)), closes [#7437](https://github.com/Agoric/agoric-sdk/issues/7437)
-* **liveslots:** retain WeakRefs to voAware collections ([3935723](https://github.com/Agoric/agoric-sdk/commit/393572396781afd17691e1366abeba696228a24e)), closes [#7371](https://github.com/Agoric/agoric-sdk/issues/7371)
-* **swingset-liveslots:** prevent VOM infinite loop if `globalThis.WeakSet` etc are replaced ([d7b35e2](https://github.com/Agoric/agoric-sdk/commit/d7b35e28715a715ef510f2717e0040fa017caab4))
-* adding dup entries to virtual sets is OK ([c81d367](https://github.com/Agoric/agoric-sdk/commit/c81d3677d8085eb4debe5baa416816ff94d582cf)), closes [#7234](https://github.com/Agoric/agoric-sdk/issues/7234)
-* code updates for new marshal ([292f971](https://github.com/Agoric/agoric-sdk/commit/292f971769db69e61782f96638c2f687c3f95ac2))
-* **SwingSet:** Don't send stopVat during upgrade ([5cc47d2](https://github.com/Agoric/agoric-sdk/commit/5cc47d2d8892690f8c1653630b41dd64cc42d73b)), closes [#6650](https://github.com/Agoric/agoric-sdk/issues/6650)
-* **types:** return value of deleter ([457f576](https://github.com/Agoric/agoric-sdk/commit/457f5765b9fc0a693e6eb5e6644ddf4af3b791db))
-* move many type definitions from swingset to liveslots ([727143d](https://github.com/Agoric/agoric-sdk/commit/727143d5562498e2e3013c34304f229b4dd11da5))
-* move rejectAllPromises from stopVat to kernels-side upgradeVat ([d79623f](https://github.com/Agoric/agoric-sdk/commit/d79623f3fb3b87653dba1c71eb1153711c9d962c)), closes [#6694](https://github.com/Agoric/agoric-sdk/issues/6694)
-* Move upgrade-time abandonExports responsibility into the kernel ([66ac657](https://github.com/Agoric/agoric-sdk/commit/66ac657d51d3d1be61ee4a6e9a621a664086ee57)), closes [#6696](https://github.com/Agoric/agoric-sdk/issues/6696)
-* only the exo api change ([5cf3bf1](https://github.com/Agoric/agoric-sdk/commit/5cf3bf10a71dd02094365a66e87032e5d17d004f))
-* **liveslots:** use Map for vrefStatus, not object ([1456e2a](https://github.com/Agoric/agoric-sdk/commit/1456e2ae006bb1c702383cedda5e5c407968840e))
-* **swingset:** move a bunch of types from swingset to swingset-liveslots ([14f9bb0](https://github.com/Agoric/agoric-sdk/commit/14f9bb00c82c085dc647f23b6c90b26e6a0a6dfd))
-* **swingset-liveslots:** Move promise rejection responsibility into the kernel ([dd29ff3](https://github.com/Agoric/agoric-sdk/commit/dd29ff35c5dc72efbbf7087849182aa7f04b2bb1)), closes [#6694](https://github.com/Agoric/agoric-sdk/issues/6694)
-* add 'v'/'d' virtual/durable annotations to vrefs ([b859e92](https://github.com/Agoric/agoric-sdk/commit/b859e92fe041415d6e34250f672a10ad927aa33e)), closes [#6695](https://github.com/Agoric/agoric-sdk/issues/6695)
-* update description of "FINALIZED" state ([809f366](https://github.com/Agoric/agoric-sdk/commit/809f3660c083467e76deb1487015cb24205a801d))
-* without assertKeyPattern ([#7035](https://github.com/Agoric/agoric-sdk/issues/7035)) ([c9fcd7f](https://github.com/Agoric/agoric-sdk/commit/c9fcd7f82757732435cd96f3377e4fbfb6586ce7))
-* **swingset-liveslots:** copy helper files to new liveslots package ([be7229f](https://github.com/Agoric/agoric-sdk/commit/be7229f7217c1ecc523069a57945a372f4a1e00e))
-* **swingset-liveslots:** update imports of helper files ([0b4b38a](https://github.com/Agoric/agoric-sdk/commit/0b4b38a1f9efbb3e1e860172b0b802548d18ae2e))

package/test/kmarshal.js

@@ -1,79 +0,0 @@
-import { Far, makeMarshal, passStyleOf } from '@endo/marshal';
-import { assert } from '@agoric/assert';
-
-// Simple wrapper for serializing and unserializing marshalled values inside the
-// kernel, where we don't actually want to use clists nor actually allocate real
-// objects, but instead to stay entirely within the domain of krefs.  This is
-// used to enable syntactic manipulation of serialized values while remaining
-// agnostic about the internal details of the serialization encoding.
-
-const refMap = new WeakMap();
-
-export const kslot = (kref, iface) => {
-  assert.typeof(kref, 'string');
-  if (iface && iface.startsWith('Alleged: ')) {
-    // Encoder prepends "Alleged: " to iface string, but the decoder doesn't strip it
-    // Unclear whether it's the decoder or me who is wrong
-    iface = iface.slice(9);
-  }
-  if (
-    kref.startsWith('p') ||
-    kref.startsWith('kp') ||
-    kref.startsWith('lp') ||
-    kref.startsWith('rp')
-  ) {
-    // TODO: temporary hack because smallcaps encodes promise references
-    // differently from remotable object references, and the current version of
-    // the smallcaps decoder annoyingly insists that if the encoded body string
-    // says a slot is a promise, then convertSlotToVal had better by damn return
-    // an actual Promise, even if, as in the intended use case here, we neither
-    // want nor need a promise, nor the overhead of a map to keep track of it
-    // with.  This behavior is in service of defense against a hypothesized
-    // security issue whose exact nature has largely been forgotton in the
-    // months since it was first encountered.  MarkM is currently researching
-    // what the problem was thought to have been, to see if it is real and to
-    // understand it if so.  This will eventually result in either changes to
-    // the smallcaps encoding or to the marshal setup API to support the purely
-    // manipulative use case.  In the meantime, this ugliness...
-    const p = new Promise(() => undefined);
-    refMap.set(p, kref);
-    return harden(p);
-  } else {
-    const o = Far(iface, {
-      iface: () => iface,
-      getKref: () => `${kref}`,
-    });
-    return o;
-  }
-};
-
-export const krefOf = obj => {
-  const fromMap = refMap.get(obj);
-  if (fromMap) {
-    return fromMap;
-  }
-  // When krefOf() is called as part of kmarshal.serialize, marshal
-  // will only give it things that are 'remotable' (Promises and the
-  // Far objects created by kslot()).  When krefOf() is called by
-  // kernel code (as part of extractSingleSlot() or the vat-comms
-  // equivalent), it ought to throw if 'obj' is not one of the Far
-  // objects created by our kslot().
-  assert.equal(passStyleOf(obj), 'remotable', obj);
-  const getKref = obj.getKref;
-  assert.typeof(getKref, 'function');
-  return getKref();
-};
-
-const kmarshal = makeMarshal(krefOf, kslot, {
-  serializeBodyFormat: 'smallcaps',
-  errorTagging: 'off',
-});
-
-export const kser = value => kmarshal.serialize(harden(value));
-
-export const kunser = serializedValue => kmarshal.unserialize(serializedValue);
-
-export function makeError(message) {
-  assert.typeof(message, 'string');
-  return kser(Error(message));
-}