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

package/README.md

@@ -0,0 +1,2 @@
+# SwingSet Liveslots
+

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@agoric/swingset-liveslots",
-  "version": "0.10.3-u14.0",
+  "version": "0.10.3-u16.0",
   "description": "SwingSet ocap support layer",
   "type": "module",
   "main": "src/index.js",
   "engines": {
-    "node": ">=14.15.0"
+    "node": "^18.12 || ^20.9"
   },
   "scripts": {
     "build": "exit 0",
@@ -13,26 +13,28 @@
     "test:xs": "exit 0",
     "lint-fix": "yarn lint:eslint --fix",
     "lint": "run-s --continue-on-error lint:*",
-    "lint:types": "tsc -p jsconfig.json",
+    "lint:types": "tsc",
     "lint:eslint": "eslint ."
   },
   "dependencies": {
-    "@agoric/assert": "^0.6.1-u11wf.0",
-    "@agoric/internal": "^0.4.0-u14.0",
-    "@agoric/store": "^0.9.3-u14.0",
-    "@agoric/vat-data": "^0.5.3-u14.0",
-    "@endo/eventual-send": "0.17.2",
-    "@endo/exo": "0.2.2",
-    "@endo/far": "0.2.18",
-    "@endo/init": "0.5.56",
-    "@endo/marshal": "0.8.5",
-    "@endo/nat": "4.1.27",
-    "@endo/pass-style": "0.1.3",
-    "@endo/patterns": "0.2.2",
-    "@endo/promise-kit": "0.2.56"
+    "@agoric/assert": "^0.6.1-u16.0",
+    "@agoric/internal": "^0.4.0-u16.0",
+    "@agoric/store": "^0.9.3-u16.0",
+    "@endo/env-options": "^1.1.4",
+    "@endo/errors": "^1.2.2",
+    "@endo/eventual-send": "^1.2.2",
+    "@endo/exo": "^1.5.0",
+    "@endo/far": "^1.1.2",
+    "@endo/init": "^1.1.2",
+    "@endo/marshal": "^1.5.0",
+    "@endo/nat": "^5.0.7",
+    "@endo/pass-style": "^1.4.0",
+    "@endo/patterns": "^1.4.0",
+    "@endo/promise-kit": "^1.1.2"
   },
   "devDependencies": {
-    "ava": "^5.2.0"
+    "@agoric/kmarshal": "^0.1.1-u16.0",
+    "ava": "^5.3.0"
   },
   "files": [
     "src/**/*.js",
@@ -53,7 +55,10 @@
   "homepage": "https://github.com/Agoric/agoric-sdk#readme",
   "ava": {
     "files": [
-      "test/**/test-*.js"
+      "test/**/*.test.*"
+    ],
+    "require": [
+      "@endo/init/debug.js"
     ],
     "timeout": "20m",
     "workerThreads": false
@@ -61,5 +66,8 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b3a6f3374cb3bddab39fc6d6f426429cae6c29c6"
+  "typeCoverage": {
+    "atLeast": 75.29
+  },
+  "gitHead": "bbdf652c3f413381cb352a8a360db1063974fafd"
 }

package/src/cache.js

@@ -4,7 +4,7 @@ import { Fail } from '@agoric/assert';
  * @template V
  * @callback CacheGet
  * @param {string} key
- * @returns {V}
+ * @returns {V | undefined}
  */
 
 /**
@@ -62,6 +62,7 @@ import { Fail } from '@agoric/assert';
 export function makeCache(readBacking, writeBacking, deleteBacking) {
   const stash = new Map();
   const dirtyKeys = new Set();
+  /** @type {Cache<V>} */
   const cache = {
     get: key => {
       assert.typeof(key, 'string');

package/src/capdata.js

@@ -1,6 +1,5 @@
 import { Fail } from '@agoric/assert';
 
-/* eslint-disable jsdoc/require-returns-check */
 /**
  * Assert function to ensure that something expected to be a capdata object
  * actually is.  A capdata object should have a .body property that's a string

package/src/collectionManager.js

@@ -15,7 +15,10 @@ import {
   makeCopySet,
   makeCopyMap,
   getRankCover,
+  getCopyMapEntries,
+  getCopySetKeys,
 } from '@endo/patterns';
+import { isCopyMap, isCopySet } from '@agoric/store';
 import { makeBaseRef, parseVatSlot } from './parseVatSlots.js';
 import {
   enumerateKeysStartEnd,
@@ -23,6 +26,10 @@ import {
 } from './vatstore-iterators.js';
 import { makeCache } from './cache.js';
 
+/**
+ * @import {ToCapData, FromCapData} from '@endo/marshal';
+ */
+
 // XXX TODO: The following key length limit was put in place due to limitations
 // in LMDB.  With the move away from LMDB, it is no longer relevant, but I'm
 // leaving it in place for the time being as a general defensive measure against
@@ -47,6 +54,14 @@ function throwNotDurable(value, slotIndex, serializedValue) {
   Fail`value is not durable: ${value} at slot ${q(slotIndex)} of ${serializedValue.body}`;
 }
 
+function failNotFound(key, label) {
+  Fail`key ${key} not found in collection ${q(label)}`;
+}
+
+function failNotIterable(value) {
+  Fail`provided data source is not iterable: ${value}`;
+}
+
 function prefixc(collectionID, dbEntryKey) {
   return `vc.${collectionID}.${dbEntryKey}`;
 }
@@ -101,8 +116,8 @@ function makeSchemaCache(syscall, unserialize) {
  * @param {(val: any) => string | undefined} convertValToSlot
  * @param {*} convertSlotToVal
  * @param {*} registerValue
- * @param {import('@endo/marshal').ToCapData<string>} serialize
- * @param {import('@endo/marshal').FromCapData<string>} unserialize
+ * @param {ToCapData<string>} serialize
+ * @param {FromCapData<string>} unserialize
  * @param {(capDatas: any) => void} assertAcceptableSyscallCapdataSize
  */
 export function makeCollectionManager(
@@ -244,7 +259,11 @@ export function makeCollectionManager(
     const kindInfo = storeKindInfo[kindName];
     kindInfo || Fail`unknown collection kind ${kindName}`;
     const { hasWeakKeys, durable } = kindInfo;
-    const getSchema = () => schemaCache.get(collectionID);
+    const getSchema = () => {
+      const result = schemaCache.get(collectionID);
+      assert(result !== undefined);
+      return result;
+    };
     const dbKeyPrefix = `vc.${collectionID}.`;
     let currentGenerationNumber = 0;
 
@@ -336,24 +355,26 @@ export function makeCollectionManager(
       const { keyShape } = getSchema();
       if (!matches(key, keyShape)) {
         return false;
-      }
-      if (passStyleOf(key) === 'remotable') {
+      } else if (passStyleOf(key) === 'remotable') {
         return getOrdinal(key) !== undefined;
       } else {
         return syscall.vatstoreGet(keyToDBKey(key)) !== undefined;
       }
     }
 
+    function mustGet(key, label) {
+      if (passStyleOf(key) === 'remotable' && getOrdinal(key) === undefined) {
+        failNotFound(key, label);
+      }
+      const dbKey = keyToDBKey(key);
+      const result = syscall.vatstoreGet(dbKey) || failNotFound(key, label);
+      return { dbKey, result };
+    }
+
     function get(key) {
       const { keyShape, label } = getSchema();
       mustMatch(key, keyShape, makeInvalidKeyTypeMsg(label));
-      if (passStyleOf(key) === 'remotable' && getOrdinal(key) === undefined) {
-        throw Fail`key ${key} not found in collection ${q(label)}`;
-      }
-      const result = syscall.vatstoreGet(keyToDBKey(key));
-      if (!result) {
-        throw Fail`key ${key} not found in collection ${q(label)}`;
-      }
+      const { result } = mustGet(key, label);
       return unserializeValue(JSON.parse(result));
     }
 
@@ -377,11 +398,11 @@ export function makeCollectionManager(
       currentGenerationNumber += 1;
       assertAcceptableSyscallCapdataSize([serializedValue]);
       if (durable) {
-        serializedValue.slots.forEach((vref, slotIndex) => {
+        for (const [slotIndex, vref] of serializedValue.slots.entries()) {
           if (!vrm.isDurable(vref)) {
             throwNotDurable(value, slotIndex, serializedValue);
           }
-        });
+        }
       }
       if (passStyleOf(key) === 'remotable') {
         /** @type {string} */
@@ -397,7 +418,9 @@ export function makeCollectionManager(
           vrm.addReachableVref(vref);
         }
       }
-      serializedValue.slots.forEach(vrm.addReachableVref);
+      for (const vref of serializedValue.slots) {
+        vrm.addReachableVref(vref);
+      }
       syscall.vatstoreSet(keyToDBKey(key), JSON.stringify(serializedValue));
       updateEntryCount(1);
     };
@@ -416,15 +439,13 @@ export function makeCollectionManager(
       const after = serializeValue(harden(value));
       assertAcceptableSyscallCapdataSize([after]);
       if (durable) {
-        after.slots.forEach((vref, i) => {
+        for (const [i, vref] of after.slots.entries()) {
           if (!vrm.isDurable(vref)) {
             throwNotDurable(value, i, after);
           }
-        });
+        }
       }
-      const dbKey = keyToDBKey(key);
-      const rawBefore = syscall.vatstoreGet(dbKey);
-      rawBefore || Fail`key ${key} not found in collection ${q(label)}`;
+      const { dbKey, result: rawBefore } = mustGet(key, label);
       const before = JSON.parse(rawBefore);
       vrm.updateReferenceCounts(before.slots, after.slots);
       syscall.vatstoreSet(dbKey, JSON.stringify(after));
@@ -433,12 +454,7 @@ export function makeCollectionManager(
     function deleteInternal(key) {
       const { keyShape, label } = getSchema();
       mustMatch(key, keyShape, makeInvalidKeyTypeMsg(label));
-      if (passStyleOf(key) === 'remotable' && getOrdinal(key) === undefined) {
-        throw Fail`key ${key} not found in collection ${q(label)}`;
-      }
-      const dbKey = keyToDBKey(key);
-      const rawValue = syscall.vatstoreGet(dbKey);
-      rawValue || Fail`key ${key} not found in collection ${q(label)}`;
+      const { dbKey, result: rawValue } = mustGet(key, label);
       const value = JSON.parse(rawValue);
       const doMoreGC1 = value.slots.map(vrm.removeReachableVref).some(b => b);
       syscall.vatstoreDelete(dbKey);
@@ -474,18 +490,15 @@ export function makeCollectionManager(
       const end = prefix(coverEnd); // exclusive
 
       const generationAtStart = currentGenerationNumber;
-      function checkGen() {
-        if (generationAtStart !== currentGenerationNumber) {
-          Fail`keys in store cannot be added to during iteration`;
-        }
-      }
+      const checkGen = () =>
+        currentGenerationNumber === generationAtStart ||
+        Fail`keys in store cannot be added to during iteration`;
 
       const needToMatchKey = !matchAny(keyPatt);
       const needToMatchValue = !matchAny(valuePatt);
 
-      // we always get the dbKey, but we might not need to unserialize it
+      // we might not need to unserialize the dbKey or get the dbValue
       const needKeys = yieldKeys || needToMatchKey;
-      // we don't always need the dbValue
       const needValues = yieldValues || needToMatchValue;
 
       /**
@@ -513,7 +526,7 @@ export function makeCollectionManager(
           yield [yieldKeys ? key : undefined, yieldValues ? value : undefined];
         }
       }
-
+      harden(iter);
       return iter();
     }
 
@@ -523,6 +536,7 @@ export function makeCollectionManager(
           yield entry[0];
         }
       }
+      harden(iter);
       return iter();
     }
 
@@ -587,6 +601,7 @@ export function makeCollectionManager(
           yield entry[1];
         }
       }
+      harden(iter);
       return iter();
     }
 
@@ -596,12 +611,13 @@ export function makeCollectionManager(
           yield entry;
         }
       }
+      harden(iter);
       return iter();
     }
 
     function countEntries(keyPatt, valuePatt) {
       let count = 0;
-      // eslint-disable-next-line no-use-before-define, no-unused-vars
+      // eslint-disable-next-line no-unused-vars
       for (const k of keys(keyPatt, valuePatt)) {
         count += 1;
       }
@@ -624,6 +640,34 @@ export function makeCollectionManager(
     const snapshotMap = (keyPatt, valuePatt) =>
       makeCopyMap(entries(keyPatt, valuePatt));
 
+    const addAllToSet = elems => {
+      if (typeof elems[Symbol.iterator] !== 'function') {
+        elems =
+          Object.isFrozen(elems) && isCopySet(elems)
+            ? getCopySetKeys(elems)
+            : failNotIterable(elems);
+      }
+      for (const elem of elems) {
+        addToSet(elem);
+      }
+    };
+
+    const addAllToMap = mapEntries => {
+      if (typeof mapEntries[Symbol.iterator] !== 'function') {
+        mapEntries =
+          Object.isFrozen(mapEntries) && isCopyMap(mapEntries)
+            ? getCopyMapEntries(mapEntries)
+            : failNotIterable(mapEntries);
+      }
+      for (const [key, value] of mapEntries) {
+        if (has(key)) {
+          set(key, value);
+        } else {
+          doInit(key, value, true);
+        }
+      }
+    };
+
     return {
       has,
       get,
@@ -635,6 +679,8 @@ export function makeCollectionManager(
       keys,
       values,
       entries,
+      addAllToSet,
+      addAllToMap,
       snapshotSet,
       snapshotMap,
       sizeInternal,
@@ -647,12 +693,23 @@ export function makeCollectionManager(
     const hasWeakKeys = storeKindInfo[kindName].hasWeakKeys;
     const raw = summonCollectionInternal(initial, collectionID, kindName);
 
-    const { has, get, init, addToSet, set, delete: del } = raw;
+    const {
+      has,
+      get,
+      init,
+      addToSet,
+      addAllToMap,
+      addAllToSet,
+      set,
+      delete: del,
+    } = raw;
     const weakMethods = {
       has,
       get,
       init,
       addToSet,
+      addAllToSet,
+      addAllToMap,
       set,
       delete: del,
     };
@@ -700,7 +757,9 @@ export function makeCollectionManager(
     const collection = summonCollectionInternal(false, collectionID, kindName);
 
     let doMoreGC = collection.clearInternal(true);
-    const { schemataCapData } = schemaCache.get(collectionID);
+    const record = schemaCache.get(collectionID);
+    assert(record !== undefined);
+    const { schemataCapData } = record;
     doMoreGC =
       schemataCapData.slots.map(vrm.removeReachableVref).some(b => b) ||
       doMoreGC;
@@ -747,13 +806,15 @@ export function makeCollectionManager(
     }
     const schemataCapData = serialize(harden(schemata));
     if (isDurable) {
-      schemataCapData.slots.forEach((vref, slotIndex) => {
+      for (const [slotIndex, vref] of schemataCapData.slots.entries()) {
         if (!vrm.isDurable(vref)) {
           throwNotDurable(vref, slotIndex, schemataCapData);
         }
-      });
+      }
+    }
+    for (const vref of schemataCapData.slots) {
+      vrm.addReachableVref(vref);
     }
-    schemataCapData.slots.forEach(vrm.addReachableVref);
 
     schemaCache.set(
       collectionID,
@@ -764,12 +825,48 @@ export function makeCollectionManager(
   }
 
   function collectionToMapStore(collection) {
-    const { snapshotSet: _, snapshotMap, ...rest } = collection;
-    return Far('mapStore', { snapshot: snapshotMap, ...rest });
+    const {
+      has,
+      get,
+      init,
+      set,
+      delete: del,
+      addAllToMap,
+      keys,
+      values,
+      entries,
+      snapshotMap,
+      getSize,
+      clear,
+    } = collection;
+    const mapStore = {
+      has,
+      get,
+      init,
+      set,
+      delete: del,
+      addAll: addAllToMap,
+      keys,
+      values,
+      entries,
+      snapshot: snapshotMap,
+      getSize,
+      clear,
+    };
+    return Far('mapStore', mapStore);
   }
 
   function collectionToWeakMapStore(collection) {
-    return Far('weakMapStore', collection);
+    const { has, get, init, set, delete: del, addAllToMap } = collection;
+    const weakMapStore = {
+      has,
+      get,
+      init,
+      set,
+      delete: del,
+      addAll: addAllToMap,
+    };
+    return Far('weakMapStore', weakMapStore);
   }
 
   function collectionToSetStore(collection) {
@@ -777,50 +874,35 @@ export function makeCollectionManager(
       has,
       addToSet,
       delete: del,
+      addAllToSet,
       keys,
-      getSize,
       snapshotSet,
+      getSize,
       clear,
     } = collection;
-    function* entries(patt) {
-      for (const k of keys(patt)) {
-        yield [k, k];
-      }
-    }
-    function addAll(elems) {
-      for (const elem of elems) {
-        addToSet(elem, null);
-      }
-    }
 
     const setStore = {
       has,
       add: addToSet,
-      addAll,
       delete: del,
+      addAll: addAllToSet,
       keys: patt => keys(patt),
       values: patt => keys(patt),
-      entries,
-      getSize: patt => getSize(patt),
       snapshot: snapshotSet,
+      getSize: patt => getSize(patt),
       clear,
     };
     return Far('setStore', setStore);
   }
 
   function collectionToWeakSetStore(collection) {
-    const { has, addToSet, delete: del } = collection;
-    function addAll(elems) {
-      for (const elem of elems) {
-        addToSet(elem);
-      }
-    }
+    const { has, addToSet, delete: del, addAllToSet } = collection;
 
     const weakSetStore = {
       has,
       add: addToSet,
-      addAll,
       delete: del,
+      addAll: addAllToSet,
     };
     return Far('weakSetStore', weakSetStore);
   }
@@ -829,7 +911,7 @@ export function makeCollectionManager(
    * Produce a big map.
    *
    * @template K,V
-   * @param {string} [label='map'] - diagnostic label for the store
+   * @param {string} [label] - diagnostic label for the store
    * @param {StoreOptions} [options]
    * @returns {MapStore<K,V>}
    */
@@ -873,7 +955,7 @@ export function makeCollectionManager(
    * Produce a weak big map.
    *
    * @template K,V
-   * @param {string} [label='weakMap'] - diagnostic label for the store
+   * @param {string} [label] - diagnostic label for the store
    * @param {StoreOptions} [options]
    * @returns {WeakMapStore<K,V>}
    */
@@ -902,7 +984,7 @@ export function makeCollectionManager(
    * Produce a big set.
    *
    * @template K
-   * @param {string} [label='set'] - diagnostic label for the store
+   * @param {string} [label] - diagnostic label for the store
    * @param {StoreOptions} [options]
    * @returns {SetStore<K>}
    */
@@ -929,7 +1011,7 @@ export function makeCollectionManager(
    * Produce a weak big set.
    *
    * @template K
-   * @param {string} [label='weakSet'] - diagnostic label for the store
+   * @param {string} [label] - diagnostic label for the store
    * @param {StoreOptions} [options]
    * @returns {WeakSetStore<K>}
    */
@@ -1006,7 +1088,7 @@ export function makeCollectionManager(
    * remotables.
    *
    * @template K,V
-   * @param {string} [label='map'] - diagnostic label for the store
+   * @param {string} [label] - diagnostic label for the store
    * @param {StoreOptions} [options]
    * @returns {MapStore<K,V>}
    */
@@ -1018,7 +1100,7 @@ export function makeCollectionManager(
    * primitives, or remotables.
    *
    * @template K,V
-   * @param {string} [label='weakMap'] - diagnostic label for the store
+   * @param {string} [label] - diagnostic label for the store
    * @param {StoreOptions} [options]
    * @returns {WeakMapStore<K,V>}
    */
@@ -1030,7 +1112,7 @@ export function makeCollectionManager(
    * remotables.
    *
    * @template K
-   * @param {string} [label='set'] - diagnostic label for the store
+   * @param {string} [label] - diagnostic label for the store
    * @param {StoreOptions} [options]
    * @returns {SetStore<K>}
    */
@@ -1042,7 +1124,7 @@ export function makeCollectionManager(
    * primitives, or remotables.
    *
    * @template K
-   * @param {string} [label='weakSet'] - diagnostic label for the store
+   * @param {string} [label] - diagnostic label for the store
    * @param {StoreOptions} [options]
    * @returns {WeakSetStore<K>}
    */

package/src/index.js

@@ -1,3 +1,6 @@
+/// <reference types="@agoric/store/exported.js" />
+
+/* eslint-disable import/export -- types files have no named runtime exports */
 export { makeLiveSlots, makeMarshaller } from './liveslots.js';
 
 export {
@@ -8,5 +11,5 @@ export {
   insistVatSyscallResult,
 } from './message.js';
 
-// eslint-disable-next-line import/export -- no named exports
 export * from './types.js';
+export * from './vatDataTypes.js';