@agoric/zone 0.2.3-other-dev-3eb1a1d.0 → 0.2.3-other-dev-d15096d.0.d15096d

package/package.json

@@ -1,21 +1,21 @@
 {
   "name": "@agoric/zone",
-  "version": "0.2.3-other-dev-3eb1a1d.0+3eb1a1d",
+  "version": "0.2.3-other-dev-d15096d.0.d15096d",
   "description": "Allocation zone abstraction for objects on the heap, persistent stores, etc.",
   "type": "module",
   "repository": "https://github.com/Agoric/agoric-sdk",
   "main": "./src/index.js",
   "scripts": {
     "build": "exit 0",
-    "prepack": "tsc --build tsconfig.build.json",
-    "postpack": "git clean -f '*.d.ts*' '*.tsbuildinfo'",
+    "prepack": "yarn run -T tsc --build tsconfig.build.json",
+    "postpack": "git clean -f '*.d.*ts*' '*.tsbuildinfo'",
     "test": "ava",
-    "test:c8": "c8 --all $C8_OPTIONS ava",
+    "test:c8": "c8 --all ${C8_OPTIONS:-} ava",
     "test:xs": "exit 0",
     "lint-fix": "yarn lint:eslint --fix",
-    "lint": "run-s --continue-on-error lint:*",
-    "lint:types": "tsc",
-    "lint:eslint": "eslint ."
+    "lint": "yarn run -T run-s --continue-on-error 'lint:*'",
+    "lint:types": "yarn run -T tsc",
+    "lint:eslint": "yarn run -T eslint ."
   },
   "exports": {
     ".": "./src/index.js",
@@ -27,22 +27,22 @@
   "author": "Agoric",
   "license": "Apache-2.0",
   "dependencies": {
-    "@agoric/base-zone": "0.1.1-other-dev-3eb1a1d.0+3eb1a1d",
-    "@agoric/vat-data": "0.5.3-other-dev-3eb1a1d.0+3eb1a1d",
-    "@endo/errors": "^1.2.8",
-    "@endo/far": "^1.1.9",
-    "@endo/pass-style": "^1.4.7"
+    "@agoric/base-zone": "0.1.1-other-dev-d15096d.0.d15096d",
+    "@agoric/vat-data": "0.5.3-other-dev-d15096d.0.d15096d",
+    "@endo/errors": "^1.2.13",
+    "@endo/far": "^1.1.14",
+    "@endo/pass-style": "^1.6.3"
   },
   "devDependencies": {
-    "@agoric/swingset-vat": "0.32.3-other-dev-3eb1a1d.0+3eb1a1d",
-    "@endo/patterns": "^1.4.7",
+    "@agoric/swingset-vat": "0.32.3-other-dev-d15096d.0.d15096d",
+    "@endo/patterns": "^1.7.0",
     "ava": "^5.3.0"
   },
   "publishConfig": {
     "access": "public"
   },
   "engines": {
-    "node": "^18.12 || ^20.9"
+    "node": "^20.9 || ^22.11"
   },
   "ava": {
     "files": [
@@ -55,7 +55,7 @@
     "workerThreads": false
   },
   "typeCoverage": {
-    "atLeast": 98.56
+    "atLeast": 94
   },
-  "gitHead": "3eb1a1d2d75b2b4a94807cd3bf759bc9fc531f05"
+  "gitHead": "d15096dc4ff8b96e9b6cd11954c20d3a9efbb393"
 }

package/src/durable.d.ts

@@ -1,2 +1,4 @@
-export function makeDurableZone(baggage: import("@agoric/vat-data").Baggage, baseLabel?: string | undefined): import(".").Zone;
+export function makeDurableZone(baggage: Baggage, baseLabel?: string): Zone;
+import type { Baggage } from '@agoric/swingset-liveslots';
+import type { Zone } from './index.js';
 //# sourceMappingURL=durable.d.ts.map

package/src/durable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"durable.d.ts","sourceRoot":"","sources":["durable.js"],"names":[],"mappings":"AAyEO,yCAJI,OAAO,kBAAkB,EAAE,OAAO,mCAEhC,OAAO,GAAG,EAAE,IAAI,CA+C5B"}
+{"version":3,"file":"durable.d.ts","sourceRoot":"","sources":["durable.js"],"names":[],"mappings":"AA+EO,yCAJI,OAAO,cACP,MAAM,GACJ,IAAI,CA+ChB;6BApGyB,4BAA4B;0BAF/B,YAAY"}

package/src/durable.js

@@ -19,6 +19,12 @@ import {
 
 import { agoricVatDataKeys as keys, makeOnceKit } from '@agoric/base-zone';
 
+/**
+ * @import {Zone} from './index.js';
+ * @import {Stores} from './index.js';
+ * @import {Baggage} from '@agoric/swingset-liveslots';
+ */
+
 /**
  * A variant of `canBeDurable` that returns `false` instead of ever throwing.
  *
@@ -29,26 +35,26 @@ const isStorable = specimen => isPassable(specimen) && canBeDurable(specimen);
 harden(isStorable);
 
 /**
- * @param {() => import('@agoric/vat-data').Baggage} getBaggage
+ * @param {() => Baggage} getBaggage
  */
 const attachDurableStores = getBaggage => {
-  /** @type {import('.').Zone['mapStore']} */
+  /** @type {Zone['mapStore']} */
   const mapStore = (label, options) => {
     const baggage = getBaggage();
     const ret = provideDurableMapStore(baggage, label, options);
     return ret;
   };
-  /** @type {import('.').Zone['setStore']} */
+  /** @type {Zone['setStore']} */
   const setStore = (label, options) =>
     provideDurableSetStore(getBaggage(), label, options);
-  /** @type {import('.').Zone['weakSetStore']} */
+  /** @type {Zone['weakSetStore']} */
   const weakSetStore = (label, options) =>
     provideDurableWeakSetStore(getBaggage(), label, options);
-  /** @type {import('.').Zone['weakMapStore']} */
+  /** @type {Zone['weakMapStore']} */
   const weakMapStore = (label, options) =>
     provideDurableWeakMapStore(getBaggage(), label, options);
 
-  /** @type {import('.').Stores} */
+  /** @type {Stores} */
   return Far('durableStores', {
     detached: () => detachedDurableStores,
     isStorable,
@@ -59,7 +65,7 @@ const attachDurableStores = getBaggage => {
   });
 };
 
-/** @type {import('.').Stores} */
+/** @type {Stores} */
 const detachedDurableStores = attachDurableStores(() =>
   makeScalarMapStore('detached'),
 );
@@ -67,9 +73,9 @@ const detachedDurableStores = attachDurableStores(() =>
 /**
  * Create a zone whose objects persist between Agoric vat upgrades.
  *
- * @param {import('@agoric/vat-data').Baggage} baggage
+ * @param {Baggage} baggage
  * @param {string} [baseLabel]
- * @returns {import('.').Zone}
+ * @returns {Zone}
  */
 export const makeDurableZone = (baggage, baseLabel = 'durableZone') => {
   baggage || Fail`baggage required`;
@@ -82,20 +88,20 @@ export const makeDurableZone = (baggage, baseLabel = 'durableZone') => {
     baggage,
   );
 
-  /** @type {import('.').Zone['exoClass']} */
+  /** @type {Zone['exoClass']} */
   const exoClass = (...args) => prepareExoClass(baggage, ...args);
-  /** @type {import('.').Zone['exoClassKit']} */
+  /** @type {Zone['exoClassKit']} */
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment -- happens only integrating with Endo master
   // @ts-ignore FIXME in Endo
   const exoClassKit = (...args) => prepareExoClassKit(baggage, ...args);
-  /** @type {import('.').Zone['exo']} */
+  /** @type {Zone['exo']} */
   const exo = (...args) => prepareExo(baggage, ...args);
 
   const subZoneStore = wrapProvider(attachedStores.mapStore, keys.zone);
 
-  /** @type {import('.').Zone['subZone']} */
+  /** @type {Zone['subZone']} */
   const subZone = (label, options = {}) => {
-    /** @type {import('@agoric/swingset-liveslots').Baggage} */
+    /** @type {Baggage} */
     const subBaggage = subZoneStore(label, options);
     return makeDurableZone(subBaggage, `${baseLabel}.${label}`);
   };

package/src/virtual.d.ts

@@ -1,2 +1,3 @@
-export function makeVirtualZone(baseLabel?: string | undefined): import(".").Zone;
+export function makeVirtualZone(baseLabel?: string): Zone;
+import type { Zone } from './index.js';
 //# sourceMappingURL=virtual.d.ts.map

package/src/virtual.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"virtual.d.ts","sourceRoot":"","sources":["virtual.js"],"names":[],"mappings":"AAiEO,iEAFM,OAAO,GAAG,EAAE,IAAI,CA+B5B"}
+{"version":3,"file":"virtual.d.ts","sourceRoot":"","sources":["virtual.js"],"names":[],"mappings":"AAqEO,4CAHI,MAAM,GACJ,IAAI,CA+BhB;0BA9EsB,YAAY"}

package/src/virtual.js

@@ -17,6 +17,12 @@ import {
   watchPromise,
 } from '@agoric/base-zone';
 
+/**
+ * @import {Zone} from './index.js';
+ * @import {DefineKindOptions} from '@agoric/vat-data';
+ * @import {Stores} from './index.js';
+ */
+
 const emptyRecord = harden({});
 const initEmpty = harden(() => emptyRecord);
 
@@ -24,7 +30,7 @@ const initEmpty = harden(() => emptyRecord);
  * This implementation of `defineVirtualExo` only exists to ensure there are no
  * gaps in the virtualZone API.
  *
- * @type {import('.').Zone['exo']}
+ * @type {Zone['exo']}
  */
 const makeVirtualExo = (
   label,
@@ -33,9 +39,7 @@ const makeVirtualExo = (
   options = undefined,
 ) => {
   const defineKindOptions =
-    /** @type {import('@agoric/vat-data').DefineKindOptions<{ self: typeof methods }>} */ (
-      options
-    );
+    /** @type {DefineKindOptions<{ self: typeof methods }>} */ (options);
   const makeInstance = defineVirtualExoClass(
     label,
     interfaceGuard,
@@ -46,7 +50,7 @@ const makeVirtualExo = (
   return makeInstance();
 };
 
-/** @type {import('.').Stores} */
+/** @type {Stores} */
 const detachedVirtualStores = Far('virtualStores', {
   detached: () => detachedVirtualStores,
   isStorable: isPassable,
@@ -61,7 +65,7 @@ const detachedVirtualStores = Far('virtualStores', {
  * current vat.
  *
  * @param {string} [baseLabel]
- * @returns {import('.').Zone}
+ * @returns {Zone}
  */
 export const makeVirtualZone = (baseLabel = 'virtualZone') => {
   const { makeOnce, wrapProvider } = makeOnceKit(

package/test/exos.test.js

@@ -1,3 +1,4 @@
+import { M } from '@endo/patterns';
 import {
   annihilate,
   getBaggage,
@@ -21,7 +22,11 @@ import { makeHeapZone } from '../heap.js';
 import { makeVirtualZone } from '../virtual.js';
 
 /**
- * @param {import('ava').Assertions} t
+ * @import {Assertions} from 'ava';
+ */
+
+/**
+ * @param {Assertions} t
  * @param {MapStore} baggage
  */
 const testFirstVatDataIncarnation = (t, baggage) => {
@@ -123,3 +128,80 @@ test.serial('vatData migrate to durableZone', t => {
   const baggage2 = getBaggage();
   testSecondZoneIncarnation(t, makeDurableZone(baggage2));
 });
+
+test.serial('exoClass stateShape expansion', t => {
+  annihilate();
+
+  // See ../../swingset-liveslots/test/virtual-objects/state-shape.test.js
+  const stateShapeMismatch = { message: /stateShape mismatch/ };
+  const HolderI = M.interface('Holder', {
+    get: M.call().rest(M.arrayOf(M.string())).returns(M.record()),
+    set: M.call(M.record()).returns(),
+  });
+  const initHolder = fields => ({ ...fields });
+  const holderMethods = {
+    get(...fields) {
+      const { state } = this;
+      // We require fields to be explicit because they are currently defined on
+      // the state *prototype*.
+      return Object.fromEntries(
+        fields.flatMap(key => (key in state ? [[key, state[key]]] : [])),
+      );
+    },
+    set(fields) {
+      Object.assign(this.state, fields);
+    },
+  };
+  const prepareHolder = (zone, stateShape) =>
+    zone.exoClass('Holder', HolderI, initHolder, holderMethods, { stateShape });
+
+  const fields = ['foo', 'bar', 'baz']; // but "baz" is not initially present
+  const baggage1 = getBaggage();
+  const zone1 = makeDurableZone(baggage1);
+  const makeHolder1 = prepareHolder(zone1, {
+    foo: M.number(),
+    bar: M.number(),
+  });
+  const holder1 = makeHolder1({ foo: 0, bar: 1 });
+  t.deepEqual(holder1.get(...fields), { foo: 0, bar: 1 });
+  holder1.set({ foo: 2, bar: 2 });
+  t.deepEqual(holder1.get(...fields), { foo: 2, bar: 2 });
+  t.throws(() => makeHolder1({ foo: 0, bar: 1, baz: 2 }));
+  t.throws(() => makeHolder1({ foo: 0, bar: 'string' }));
+
+  nextLife();
+  t.throws(
+    () =>
+      prepareHolder(makeDurableZone(getBaggage()), {
+        foo: M.string(),
+        bar: M.number(),
+      }),
+    stateShapeMismatch,
+    'backwards-incompatible stateShape change',
+  );
+
+  nextLife();
+  t.throws(
+    () =>
+      prepareHolder(makeDurableZone(getBaggage()), {
+        foo: M.or(M.number(), M.string()),
+        bar: M.number(),
+        baz: M.or(undefined, M.number()),
+      }),
+    stateShapeMismatch,
+    'stateShape field value expansion (needs #7407)',
+  );
+
+  nextLife();
+  const baggage2 = getBaggage();
+  const zone2 = makeDurableZone(baggage2);
+  const makeHolder2 = prepareHolder(zone2, {
+    foo: M.number(),
+    bar: M.number(),
+    baz: M.or(undefined, M.number()),
+  });
+  const holder2 = makeHolder2({ foo: 0, bar: 1, baz: 2 });
+  t.deepEqual(holder2.get(...fields), { foo: 0, bar: 1, baz: 2 });
+  holder2.set({ foo: 2, bar: 2, baz: undefined });
+  t.deepEqual(holder2.get(...fields), { foo: 2, bar: 2, baz: undefined });
+});

package/test/make-once.test.js

@@ -9,10 +9,13 @@ import { makeDurableZone } from '../durable.js';
 import { makeHeapZone } from '../heap.js';
 import { makeVirtualZone } from '../virtual.js';
 
-/** @import {Zone} from '../src/index.js' */
+/**
+ * @import {Zone} from '../src/index.js'
+ * @import {Assertions} from 'ava';
+ */
 
 /**
- * @param {import('ava').Assertions} t
+ * @param {Assertions} t
  * @param {Zone} rootZone
  */
 const testOnce = (t, rootZone) => {

package/tsconfig.build.tsbuildinfo

@@ -1 +1 @@
-{"root":["./durable.js","./heap.js","./virtual.js","./src/durable.js","./src/index.js","./src/virtual.js"],"version":"5.6.3"}
+{"root":["./durable.js","./heap.js","./virtual.js","./src/durable.js","./src/index.js","./src/virtual.js"],"version":"5.9.3"}