@agoric/swingset-liveslots 0.10.3-u18.0 → 0.10.3-u18.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/swingset-liveslots",
-  "version": "0.10.3-u18.0",
+  "version": "0.10.3-u18.1",
   "description": "SwingSet ocap support layer",
   "type": "module",
   "main": "src/index.js",
@@ -17,22 +17,22 @@
     "lint:eslint": "eslint ."
   },
   "dependencies": {
-    "@agoric/internal": "^0.4.0-u18.0",
-    "@agoric/store": "^0.9.3-u18.0",
-    "@endo/env-options": "^1.1.7",
-    "@endo/errors": "^1.2.7",
-    "@endo/eventual-send": "^1.2.7",
-    "@endo/exo": "^1.5.6",
-    "@endo/far": "^1.1.8",
-    "@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"
+    "@agoric/internal": "^0.4.0-u18.1",
+    "@agoric/store": "^0.9.3-u18.1",
+    "@endo/env-options": "^1.1.8",
+    "@endo/errors": "^1.2.8",
+    "@endo/eventual-send": "^1.2.8",
+    "@endo/exo": "^1.5.7",
+    "@endo/far": "^1.1.9",
+    "@endo/init": "^1.1.7",
+    "@endo/marshal": "^1.6.2",
+    "@endo/nat": "^5.0.13",
+    "@endo/pass-style": "^1.4.7",
+    "@endo/patterns": "^1.4.7",
+    "@endo/promise-kit": "^1.1.8"
   },
   "devDependencies": {
-    "@agoric/kmarshal": "^0.1.1-u18.0",
+    "@agoric/kmarshal": "^0.1.1-u18.1",
     "ava": "^5.3.0"
   },
   "files": [
@@ -68,5 +68,5 @@
   "typeCoverage": {
     "atLeast": 75.24
   },
-  "gitHead": "c22e7250188bbdb07bc021dffdb88af0309a7aa8"
+  "gitHead": "f8c45b8a2e29a51522a81a6692af25b2d7f6b50f"
 }

package/src/collectionManager.js

@@ -146,56 +146,48 @@ export function makeCollectionManager(
     scalarMapStore: {
       hasWeakKeys: false,
       kindID: 0,
-      // eslint-disable-next-line no-use-before-define
       reanimator: reanimateMapStore,
       durable: false,
     },
     scalarWeakMapStore: {
       hasWeakKeys: true,
       kindID: 0,
-      // eslint-disable-next-line no-use-before-define
       reanimator: reanimateWeakMapStore,
       durable: false,
     },
     scalarSetStore: {
       hasWeakKeys: false,
       kindID: 0,
-      // eslint-disable-next-line no-use-before-define
       reanimator: reanimateSetStore,
       durable: false,
     },
     scalarWeakSetStore: {
       hasWeakKeys: true,
       kindID: 0,
-      // eslint-disable-next-line no-use-before-define
       reanimator: reanimateWeakSetStore,
       durable: false,
     },
     scalarDurableMapStore: {
       hasWeakKeys: false,
       kindID: 0,
-      // eslint-disable-next-line no-use-before-define
       reanimator: reanimateMapStore,
       durable: true,
     },
     scalarDurableWeakMapStore: {
       hasWeakKeys: true,
       kindID: 0,
-      // eslint-disable-next-line no-use-before-define
       reanimator: reanimateWeakMapStore,
       durable: true,
     },
     scalarDurableSetStore: {
       hasWeakKeys: false,
       kindID: 0,
-      // eslint-disable-next-line no-use-before-define
       reanimator: reanimateSetStore,
       durable: true,
     },
     scalarDurableWeakSetStore: {
       hasWeakKeys: true,
       kindID: 0,
-      // eslint-disable-next-line no-use-before-define
       reanimator: reanimateWeakSetStore,
       durable: true,
     },
@@ -218,7 +210,6 @@ export function makeCollectionManager(
       vrm.registerKind(
         kindID,
         storeKindInfo[kind].reanimator,
-        // eslint-disable-next-line no-use-before-define
         deleteCollection,
         storeKindInfo[kind].durable,
       );
@@ -313,7 +304,6 @@ export function makeCollectionManager(
     // * vref(o-4) -> "vc.5.r0000000001:o-4"
 
     const encodeRemotable = remotable => {
-      // eslint-disable-next-line no-use-before-define
       const ordinal = getOrdinal(remotable);
       ordinal !== undefined || Fail`no ordinal for ${remotable}`;
       const ordinalTag = zeroPad(ordinal, BIGINT_TAG_LEN);

package/src/liveslots.js

@@ -155,10 +155,8 @@ function build(
     const { type, allocatedByVat, virtual, durable } = parseVatSlot(vref);
     if (type === 'object' && allocatedByVat) {
       if (virtual || durable) {
-        // eslint-disable-next-line no-use-before-define
         vrm.setExportStatus(vref, 'reachable');
       } else {
-        // eslint-disable-next-line no-use-before-define
         const remotable = requiredValForSlot(vref);
         exportedRemotables.add(remotable);
         kernelRecognizableRemotables.add(vref);
@@ -183,7 +181,6 @@ function build(
 
     if (wr && !wr.deref()) {
       // we're in the COLLECTED state, or FINALIZED after a re-introduction
-      // eslint-disable-next-line no-use-before-define
       addToPossiblyDeadSet(baseRef);
       slotToVal.delete(baseRef);
     }
@@ -209,11 +206,9 @@ function build(
         // Support: o~.[prop](...args) remote method invocation
         lsdebug(`makeImportedPresence handler.applyMethod (${slot})`);
         if (disavowedPresences.has(o)) {
-          // eslint-disable-next-line no-use-before-define
           exitVatWithFailure(disavowalError);
           throw disavowalError;
         }
-        // eslint-disable-next-line no-use-before-define
         return queueMessage(slot, prop, args, returnedP);
       },
       applyFunction(o, args, returnedP) {
@@ -222,7 +217,6 @@ function build(
       get(o, prop) {
         lsdebug(`makeImportedPresence handler.get (${slot})`);
         if (disavowedPresences.has(o)) {
-          // eslint-disable-next-line no-use-before-define
           exitVatWithFailure(disavowalError);
           throw disavowalError;
         }
@@ -294,7 +288,6 @@ function build(
           console.error(`mIPromise handler called after resolution`);
           Fail`mIPromise handler called after resolution`;
         }
-        // eslint-disable-next-line no-use-before-define
         return queueMessage(vpid, prop, args, returnedP);
       },
       get(p, prop) {
@@ -347,17 +340,14 @@ function build(
   // use a slot from the corresponding allocateX
 
   function allocateExportID() {
-    // eslint-disable-next-line no-use-before-define
     return vrm.allocateNextID('exportID');
   }
 
   function allocateCollectionID() {
-    // eslint-disable-next-line no-use-before-define
     return vrm.allocateNextID('collectionID');
   }
 
   function allocatePromiseID() {
-    // eslint-disable-next-line no-use-before-define
     const promiseID = vrm.allocateNextID('promiseID');
     return makeVatSlot('promise', true, promiseID);
   }
@@ -385,10 +375,8 @@ function build(
       // do a syscall.resolve when it fires. The caller must finish
       // doing their syscall before this turn finishes, to ensure the
       // kernel isn't surprised by a spurious resolution.
-      // eslint-disable-next-line no-use-before-define
       const p = requiredValForSlot(vpid);
       // if (!knownResolutions.has(p)) { // TODO really?
-      // eslint-disable-next-line no-use-before-define
       followForKernel(vpid, p);
       return true;
     }
@@ -400,7 +388,6 @@ function build(
     return makeVatSlot('object', true, exportID);
   }
 
-  // eslint-disable-next-line no-use-before-define
   const m = makeMarshal(convertValToSlot, convertSlotToVal, {
     marshalName: `liveSlots:${forVatID}`,
     serializeBodyFormat: 'smallcaps',
@@ -413,7 +400,6 @@ function build(
       console.warn('Logging sent error stack', err),
   });
   const unmeteredUnserialize = meterControl.unmetered(m.unserialize);
-  // eslint-disable-next-line no-use-before-define
   const unmeteredConvertSlotToVal = meterControl.unmetered(convertSlotToVal);
 
   function getSlotForVal(val) {
@@ -458,7 +444,6 @@ function build(
     allocateExportID,
     getSlotForVal,
     requiredValForSlot,
-    // eslint-disable-next-line no-use-before-define
     registerValue,
     m.serialize,
     unmeteredUnserialize,
@@ -471,10 +456,8 @@ function build(
     vrm,
     allocateExportID,
     allocateCollectionID,
-    // eslint-disable-next-line no-use-before-define
     convertValToSlot,
     unmeteredConvertSlotToVal,
-    // eslint-disable-next-line no-use-before-define
     registerValue,
     m.serialize,
     unmeteredUnserialize,
@@ -486,7 +469,6 @@ function build(
     vrm,
     vom,
     collectionManager,
-    // eslint-disable-next-line no-use-before-define
     convertValToSlot,
     convertSlotToVal: unmeteredConvertSlotToVal,
     maybeExportPromise,
@@ -516,7 +498,6 @@ function build(
         slot = allocatePromiseID();
       } else {
         if (disavowedPresences.has(val)) {
-          // eslint-disable-next-line no-use-before-define
           exitVatWithFailure(disavowalError);
           throw disavowalError; // cannot reference a disavowed object
         }
@@ -686,7 +667,6 @@ function build(
           const priorResolution = knownResolutions.get(p);
           if (priorResolution && !doneResolutions.has(slot)) {
             const [priorRejected, priorRes] = priorResolution;
-            // eslint-disable-next-line no-use-before-define
             collect(slot, priorRejected, priorRes);
           }
         }
@@ -972,7 +952,6 @@ function build(
       }
       // in both cases, we are now the decider, so treat it like an
       // exported promise
-      // eslint-disable-next-line no-use-before-define
       followForKernel(resultVPID, p);
     }
   }
@@ -1249,7 +1228,6 @@ function build(
     possiblyRetiredSet,
     slotToVal,
     valToSlot,
-    // eslint-disable-next-line no-use-before-define
     afterDispatchActions,
   });
 
@@ -1341,7 +1319,7 @@ function build(
 
   /**
    * @param {import('./types.js').VatDeliveryObject} delivery
-   * @returns {void | Promise<void>}
+   * @returns {undefined | ReturnType<startVat>}
    */
   function dispatchToUserspace(delivery) {
     let result;

package/src/virtualObjectManager.js

@@ -1,5 +1,5 @@
 /* global globalThis */
-/* eslint-disable no-use-before-define, jsdoc/require-returns-type */
+/* eslint-disable jsdoc/require-returns-type */
 
 import { environmentOptionsListHas } from '@endo/env-options';
 import { assert, Fail, q, b } from '@endo/errors';

package/src/virtualReferences.js

@@ -1,4 +1,4 @@
-/* eslint-disable no-use-before-define, jsdoc/require-returns-type */
+/* eslint-disable jsdoc/require-returns-type */
 
 import { assert, Fail } from '@endo/errors';
 import { Nat } from '@endo/nat';

package/src/watchedPromises.js

@@ -235,13 +235,23 @@ export function makeWatchedPromiseManager({
       } else {
         watchedPromiseTable.init(vpid, harden([[watcher, ...args]]));
 
+        promiseRegistrations.init(vpid, p);
+
+        // pseudoThen registers a settlement callback that will remove
+        // this promise from promiseRegistrations and
+        // watchedPromiseTable. To avoid triggering
+        // https://github.com/Agoric/agoric-sdk/issues/10757 and
+        // preventing slotToVal cleanup, the `pseudoThen()` should
+        // precede `maybeExportPromise()`. This isn't foolproof, but
+        // does mitigate in advance of a proper fix. See #10756 for
+        // details of this particular mitigation, and #10757 for the
+        // deeper bug.
+        pseudoThen(p, vpid);
+
         // Ensure that this vat's promises are rejected at termination.
         if (maybeExportPromise(vpid)) {
           syscall.subscribe(vpid);
         }
-
-        promiseRegistrations.init(vpid, p);
-        pseudoThen(p, vpid);
       }
     });
   }

package/test/watch-promise.test.js

@@ -0,0 +1,42 @@
+import test from 'ava';
+
+import { Far } from '@endo/marshal';
+import { makePromiseKit } from '@endo/promise-kit';
+import { setupTestLiveslots } from './liveslots-helpers.js';
+
+const build = vatPowers => {
+  const { VatData } = vatPowers;
+  const { makeKindHandle, defineDurableKind, watchPromise } = VatData;
+
+  const kh = makeKindHandle('handler');
+  const init = () => ({});
+  const behavior = {
+    onFulfilled: _value => 0,
+    onRejected: _reason => 0,
+  };
+  const makeHandler = defineDurableKind(kh, init, behavior);
+
+  return Far('root', {
+    async run() {
+      const pr = makePromiseKit();
+      const handler = makeHandler();
+      watchPromise(pr.promise, handler);
+      pr.resolve('ignored');
+    },
+  });
+};
+
+test('watched local promises should not leak slotToVal entries', async t => {
+  const { dispatchMessage, testHooks } = await setupTestLiveslots(
+    t,
+    build,
+    'vatA',
+  );
+  const { slotToVal } = testHooks;
+  const initial = slotToVal.size;
+
+  await dispatchMessage('run');
+  t.is(slotToVal.size, initial);
+  await dispatchMessage('run');
+  t.is(slotToVal.size, initial);
+});

package/tools/fakeVirtualSupport.js

@@ -234,7 +234,6 @@ export function makeFakeLiveSlotsStuff(options = {}) {
         assert.fail('fake liveSlots stuff configured without vrm');
       }
     }
-    // eslint-disable-next-line no-use-before-define
     registerEntry(baseRef, val, facet !== undefined);
     if (!result) {
       result = val;