@agoric/swingset-liveslots 0.10.3-dev-7244c71.0 → 0.10.3-getting-started-dev-26244e8.0

package/CHANGELOG.md

@@ -0,0 +1,77 @@
+# 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-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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/swingset-liveslots",
-  "version": "0.10.3-dev-7244c71.0+7244c71",
+  "version": "0.10.3-getting-started-dev-26244e8.0+26244e8",
   "description": "SwingSet ocap support layer",
   "type": "module",
   "main": "src/index.js",
@@ -13,26 +13,26 @@
     "test:xs": "exit 0",
     "lint-fix": "yarn lint:eslint --fix",
     "lint": "run-s --continue-on-error lint:*",
-    "lint:types": "tsc",
+    "lint:types": "tsc -p jsconfig.json",
     "lint:eslint": "eslint ."
   },
   "dependencies": {
-    "@agoric/assert": "0.6.1-dev-7244c71.0+7244c71",
-    "@agoric/internal": "0.3.3-dev-7244c71.0+7244c71",
-    "@agoric/store": "0.9.3-dev-7244c71.0+7244c71",
-    "@endo/eventual-send": "^0.17.5",
-    "@endo/exo": "^0.2.5",
-    "@endo/far": "^0.2.21",
-    "@endo/init": "^0.5.59",
-    "@endo/marshal": "^0.8.8",
-    "@endo/nat": "^4.1.30",
-    "@endo/pass-style": "^0.1.6",
-    "@endo/patterns": "^0.2.5",
-    "@endo/promise-kit": "^0.2.59"
+    "@agoric/assert": "0.6.1-getting-started-dev-26244e8.0+26244e8",
+    "@agoric/internal": "0.4.0-getting-started-dev-26244e8.0+26244e8",
+    "@agoric/store": "0.9.3-getting-started-dev-26244e8.0+26244e8",
+    "@agoric/vat-data": "0.5.3-getting-started-dev-26244e8.0+26244e8",
+    "@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"
   },
   "devDependencies": {
-    "@agoric/kmarshal": "0.1.1-dev-7244c71.0+7244c71",
-    "ava": "^5.3.0"
+    "ava": "^5.2.0"
   },
   "files": [
     "src/**/*.js",
@@ -55,17 +55,11 @@
     "files": [
       "test/**/test-*.js"
     ],
-    "require": [
-      "@endo/init/debug.js"
-    ],
     "timeout": "20m",
     "workerThreads": false
   },
   "publishConfig": {
     "access": "public"
   },
-  "typeCoverage": {
-    "atLeast": 71.48
-  },
-  "gitHead": "7244c710962174a886903cf039c0fbe18874287f"
+  "gitHead": "26244e821f1a83cd5868f0c7d54aa480c8c17e5e"
 }

package/src/collectionManager.js

@@ -15,10 +15,7 @@ import {
   makeCopySet,
   makeCopyMap,
   getRankCover,
-  getCopyMapEntries,
-  getCopySetKeys,
 } from '@endo/patterns';
-import { isCopyMap, isCopySet } from '@agoric/store';
 import { makeBaseRef, parseVatSlot } from './parseVatSlots.js';
 import {
   enumerateKeysStartEnd,
@@ -50,14 +47,6 @@ 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}`;
 }
@@ -347,26 +336,24 @@ export function makeCollectionManager(
       const { keyShape } = getSchema();
       if (!matches(key, keyShape)) {
         return false;
-      } else if (passStyleOf(key) === 'remotable') {
+      }
+      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));
-      const { result } = mustGet(key, 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)}`;
+      }
       return unserializeValue(JSON.parse(result));
     }
 
@@ -390,11 +377,11 @@ export function makeCollectionManager(
       currentGenerationNumber += 1;
       assertAcceptableSyscallCapdataSize([serializedValue]);
       if (durable) {
-        for (const [slotIndex, vref] of serializedValue.slots.entries()) {
+        serializedValue.slots.forEach((vref, slotIndex) => {
           if (!vrm.isDurable(vref)) {
             throwNotDurable(value, slotIndex, serializedValue);
           }
-        }
+        });
       }
       if (passStyleOf(key) === 'remotable') {
         /** @type {string} */
@@ -410,9 +397,7 @@ export function makeCollectionManager(
           vrm.addReachableVref(vref);
         }
       }
-      for (const vref of serializedValue.slots) {
-        vrm.addReachableVref(vref);
-      }
+      serializedValue.slots.forEach(vrm.addReachableVref);
       syscall.vatstoreSet(keyToDBKey(key), JSON.stringify(serializedValue));
       updateEntryCount(1);
     };
@@ -431,13 +416,15 @@ export function makeCollectionManager(
       const after = serializeValue(harden(value));
       assertAcceptableSyscallCapdataSize([after]);
       if (durable) {
-        for (const [i, vref] of after.slots.entries()) {
+        after.slots.forEach((vref, i) => {
           if (!vrm.isDurable(vref)) {
             throwNotDurable(value, i, after);
           }
-        }
+        });
       }
-      const { dbKey, result: rawBefore } = mustGet(key, label);
+      const dbKey = keyToDBKey(key);
+      const rawBefore = syscall.vatstoreGet(dbKey);
+      rawBefore || Fail`key ${key} not found in collection ${q(label)}`;
       const before = JSON.parse(rawBefore);
       vrm.updateReferenceCounts(before.slots, after.slots);
       syscall.vatstoreSet(dbKey, JSON.stringify(after));
@@ -446,7 +433,12 @@ export function makeCollectionManager(
     function deleteInternal(key) {
       const { keyShape, label } = getSchema();
       mustMatch(key, keyShape, makeInvalidKeyTypeMsg(label));
-      const { dbKey, result: rawValue } = mustGet(key, 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 value = JSON.parse(rawValue);
       const doMoreGC1 = value.slots.map(vrm.removeReachableVref).some(b => b);
       syscall.vatstoreDelete(dbKey);
@@ -482,15 +474,18 @@ export function makeCollectionManager(
       const end = prefix(coverEnd); // exclusive
 
       const generationAtStart = currentGenerationNumber;
-      const checkGen = () =>
-        currentGenerationNumber === generationAtStart ||
-        Fail`keys in store cannot be added to during iteration`;
+      function checkGen() {
+        if (generationAtStart !== currentGenerationNumber) {
+          Fail`keys in store cannot be added to during iteration`;
+        }
+      }
 
       const needToMatchKey = !matchAny(keyPatt);
       const needToMatchValue = !matchAny(valuePatt);
 
-      // we might not need to unserialize the dbKey or get the dbValue
+      // we always get the dbKey, but we might not need to unserialize it
       const needKeys = yieldKeys || needToMatchKey;
+      // we don't always need the dbValue
       const needValues = yieldValues || needToMatchValue;
 
       /**
@@ -629,34 +624,6 @@ 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,
@@ -668,8 +635,6 @@ export function makeCollectionManager(
       keys,
       values,
       entries,
-      addAllToSet,
-      addAllToMap,
       snapshotSet,
       snapshotMap,
       sizeInternal,
@@ -682,23 +647,12 @@ export function makeCollectionManager(
     const hasWeakKeys = storeKindInfo[kindName].hasWeakKeys;
     const raw = summonCollectionInternal(initial, collectionID, kindName);
 
-    const {
-      has,
-      get,
-      init,
-      addToSet,
-      addAllToMap,
-      addAllToSet,
-      set,
-      delete: del,
-    } = raw;
+    const { has, get, init, addToSet, set, delete: del } = raw;
     const weakMethods = {
       has,
       get,
       init,
       addToSet,
-      addAllToSet,
-      addAllToMap,
       set,
       delete: del,
     };
@@ -793,15 +747,13 @@ export function makeCollectionManager(
     }
     const schemataCapData = serialize(harden(schemata));
     if (isDurable) {
-      for (const [slotIndex, vref] of schemataCapData.slots.entries()) {
+      schemataCapData.slots.forEach((vref, slotIndex) => {
         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,
@@ -812,48 +764,12 @@ export function makeCollectionManager(
   }
 
   function collectionToMapStore(collection) {
-    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);
+    const { snapshotSet: _, snapshotMap, ...rest } = collection;
+    return Far('mapStore', { snapshot: snapshotMap, ...rest });
   }
 
   function collectionToWeakMapStore(collection) {
-    const { has, get, init, set, delete: del, addAllToMap } = collection;
-    const weakMapStore = {
-      has,
-      get,
-      init,
-      set,
-      delete: del,
-      addAll: addAllToMap,
-    };
-    return Far('weakMapStore', weakMapStore);
+    return Far('weakMapStore', collection);
   }
 
   function collectionToSetStore(collection) {
@@ -861,35 +777,50 @@ export function makeCollectionManager(
       has,
       addToSet,
       delete: del,
-      addAllToSet,
       keys,
-      snapshotSet,
       getSize,
+      snapshotSet,
       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),
-      snapshot: snapshotSet,
+      entries,
       getSize: patt => getSize(patt),
+      snapshot: snapshotSet,
       clear,
     };
     return Far('setStore', setStore);
   }
 
   function collectionToWeakSetStore(collection) {
-    const { has, addToSet, delete: del, addAllToSet } = collection;
+    const { has, addToSet, delete: del } = collection;
+    function addAll(elems) {
+      for (const elem of elems) {
+        addToSet(elem);
+      }
+    }
 
     const weakSetStore = {
       has,
       add: addToSet,
+      addAll,
       delete: del,
-      addAll: addAllToSet,
     };
     return Far('weakSetStore', weakSetStore);
   }
@@ -898,7 +829,7 @@ export function makeCollectionManager(
    * Produce a big map.
    *
    * @template K,V
-   * @param {string} [label] - diagnostic label for the store
+   * @param {string} [label='map'] - diagnostic label for the store
    * @param {StoreOptions} [options]
    * @returns {MapStore<K,V>}
    */
@@ -942,7 +873,7 @@ export function makeCollectionManager(
    * Produce a weak big map.
    *
    * @template K,V
-   * @param {string} [label] - diagnostic label for the store
+   * @param {string} [label='weakMap'] - diagnostic label for the store
    * @param {StoreOptions} [options]
    * @returns {WeakMapStore<K,V>}
    */
@@ -971,7 +902,7 @@ export function makeCollectionManager(
    * Produce a big set.
    *
    * @template K
-   * @param {string} [label] - diagnostic label for the store
+   * @param {string} [label='set'] - diagnostic label for the store
    * @param {StoreOptions} [options]
    * @returns {SetStore<K>}
    */
@@ -998,7 +929,7 @@ export function makeCollectionManager(
    * Produce a weak big set.
    *
    * @template K
-   * @param {string} [label] - diagnostic label for the store
+   * @param {string} [label='weakSet'] - diagnostic label for the store
    * @param {StoreOptions} [options]
    * @returns {WeakSetStore<K>}
    */
@@ -1075,7 +1006,7 @@ export function makeCollectionManager(
    * remotables.
    *
    * @template K,V
-   * @param {string} [label] - diagnostic label for the store
+   * @param {string} [label='map'] - diagnostic label for the store
    * @param {StoreOptions} [options]
    * @returns {MapStore<K,V>}
    */
@@ -1087,7 +1018,7 @@ export function makeCollectionManager(
    * primitives, or remotables.
    *
    * @template K,V
-   * @param {string} [label] - diagnostic label for the store
+   * @param {string} [label='weakMap'] - diagnostic label for the store
    * @param {StoreOptions} [options]
    * @returns {WeakMapStore<K,V>}
    */
@@ -1099,7 +1030,7 @@ export function makeCollectionManager(
    * remotables.
    *
    * @template K
-   * @param {string} [label] - diagnostic label for the store
+   * @param {string} [label='set'] - diagnostic label for the store
    * @param {StoreOptions} [options]
    * @returns {SetStore<K>}
    */
@@ -1111,7 +1042,7 @@ export function makeCollectionManager(
    * primitives, or remotables.
    *
    * @template K
-   * @param {string} [label] - diagnostic label for the store
+   * @param {string} [label='weakSet'] - diagnostic label for the store
    * @param {StoreOptions} [options]
    * @returns {WeakSetStore<K>}
    */

package/src/index.js

@@ -1,4 +1,3 @@
-/* eslint-disable import/export -- types files have no named runtime exports */
 export { makeLiveSlots, makeMarshaller } from './liveslots.js';
 
 export {
@@ -9,5 +8,5 @@ export {
   insistVatSyscallResult,
 } from './message.js';
 
+// eslint-disable-next-line import/export -- no named exports
 export * from './types.js';
-export * from './vatDataTypes.js';