@agoric/swingset-liveslots 0.10.3-dev-5dc325b.0 → 0.10.3-getting-started-dev-26244e8.0

package/test/virtual-objects/test-rep-tostring.js

@@ -1,4 +1,5 @@
 import test from 'ava';
+import '@endo/init/debug.js';
 // this sets process.env.DEBUG = 'label-instances'
 import './set-debug-label-instances.js';
 
@@ -15,7 +16,7 @@ const init = () => ({});
 const behavior = {};
 const facets = { foo: {}, bar: {} };
 
-test('representatives with label-instances', t => {
+test('representatives with label-instances', async t => {
   const { fakeStuff, vom } = makeFakeVirtualStuff();
   const { getSlotForVal } = fakeStuff;
   const makeThing = vom.defineKind('thing', init, behavior);
@@ -32,7 +33,7 @@ test('representatives with label-instances', t => {
   t.is(`${q(thing2)}`, `"[Alleged: thing#${thing2vref}]"`);
 });
 
-test('facets with label-instances', t => {
+test('facets with label-instances', async t => {
   const { fakeStuff, vom } = makeFakeVirtualStuff();
   const { getSlotForVal } = fakeStuff;
   const makeThings = vom.defineKindMulti('thing', init, facets);

package/test/virtual-objects/test-retain-remotable.js

@@ -1,6 +1,6 @@
-// @ts-nocheck
 /* global WeakRef */
 import test from 'ava';
+import '@endo/init/debug.js';
 
 import { Far } from '@endo/marshal';
 import { initEmpty } from '@agoric/store';

package/test/virtual-objects/test-state-shape.js

@@ -1,10 +1,10 @@
-// @ts-nocheck
 import test from 'ava';
+import '@endo/init/debug.js';
 
 import { Far } from '@endo/marshal';
-import { kser, kslot } from '@agoric/kmarshal';
 import { M } from '@agoric/store';
 import { makeLiveSlots } from '../../src/liveslots.js';
+import { kser, kslot } from '../kmarshal.js';
 import { buildSyscall } from '../liveslots-helpers.js';
 import { makeStartVat, makeMessage } from '../util.js';
 import { makeMockGC } from '../mock-gc.js';

package/test/virtual-objects/test-virtualObjectGC.js

@@ -1,12 +1,12 @@
-// @ts-nocheck
 import test from 'ava';
+import '@endo/init/debug.js';
 
 import { Far } from '@endo/marshal';
-import { krefOf, kser, kslot } from '@agoric/kmarshal';
 import {
   setupTestLiveslots,
   findSyscallsByType,
 } from '../liveslots-helpers.js';
+import { krefOf, kser, kslot } from '../kmarshal.js';
 import { parseVatSlot } from '../../src/parseVatSlots.js';
 
 // Legs:

package/test/virtual-objects/test-virtualObjectManager.js

@@ -1,12 +1,12 @@
-// @ts-nocheck
 import test from 'ava';
+import '@endo/init/debug.js';
 
-import { kser, kslot } from '@agoric/kmarshal';
 import {
   makeFakeVirtualObjectManager,
   makeFakeVirtualStuff,
 } from '../../tools/fakeVirtualSupport.js';
 
+import { kser, kslot } from '../kmarshal.js';
 import { vstr } from '../util.js';
 
 function initThing(label = 'thing', counter = 0) {
@@ -128,7 +128,6 @@ test('multifaceted virtual objects', t => {
   flushStateCache();
   t.deepEqual(log.splice(0), [
     `get kindIDID => undefined`,
-    `get idCounters => undefined`,
     `set kindIDID 1`,
     `set vom.vkind.2.descriptor {"kindID":"2","tag":"multithing"}`,
     `set vom.${kid}/1 ${multiThingVal('foo', 1)}`,
@@ -204,7 +203,6 @@ test('virtual object operations', t => {
   const thing4 = makeThing('thing-4', 300); // [t4-0* t3-0* t2-0* t1-0*]
   // t4-0: 'thing-4' 300 0
   t.is(log.shift(), `get kindIDID => undefined`);
-  t.is(log.shift(), `get idCounters => undefined`);
   t.is(log.shift(), `set kindIDID 1`);
   t.is(log.shift(), `set vom.vkind.2.descriptor {"kindID":"2","tag":"thing"}`);
   t.is(log.shift(), `set vom.vkind.3.descriptor {"kindID":"3","tag":"zot"}`);
@@ -469,7 +467,6 @@ test('symbol named methods', t => {
   const thing2 = makeThing('thing-2', 100); // [t1-0* t2-0*]
   // t2-0: 'thing-2' 100 0
   t.is(log.shift(), `get kindIDID => undefined`);
-  t.is(log.shift(), `get idCounters => undefined`);
   t.is(log.shift(), `set kindIDID 1`);
   t.is(
     log.shift(),
@@ -650,7 +647,6 @@ test('virtual object gc', t => {
   });
 
   t.is(log.shift(), `get kindIDID => undefined`);
-  t.is(log.shift(), `get idCounters => undefined`);
   t.is(log.shift(), `set kindIDID 1`);
   const skit = [
     'storeKindIDTable',

package/test/virtual-objects/test-vo-real-gc.js

@@ -1,9 +1,9 @@
-// @ts-nocheck
 /* global WeakRef */
 import test from 'ava';
+import '@endo/init/debug.js';
 
 import { Far } from '@endo/marshal';
-import { kser, kunser } from '@agoric/kmarshal';
+import { kser, kunser } from '../kmarshal.js';
 import { setupTestLiveslots } from '../liveslots-helpers.js';
 
 test('virtual object state writes', async t => {

package/test/virtual-objects/test-weakcollections-vref-handling.js

@@ -1,8 +1,9 @@
 import test from 'ava';
+import '@endo/init/debug.js';
 
 import { makeFakeVirtualObjectManager } from '../../tools/fakeVirtualSupport.js';
 
-test('weakMap vref handling', t => {
+test('weakMap vref handling', async t => {
   const log = [];
   const {
     VirtualObjectAwareWeakMap,

package/tools/fakeVirtualSupport.js

@@ -1,4 +1,4 @@
-/* global globalThis */
+/* global WeakRef */
 /* eslint-disable max-classes-per-file */
 import { makeMarshal } from '@endo/marshal';
 import { assert } from '@agoric/assert';
@@ -9,14 +9,6 @@ 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() {}
@@ -38,6 +30,8 @@ class FakeWeakRef {
   }
 }
 
+const RealWeakRef = WeakRef;
+
 export function makeFakeLiveSlotsStuff(options = {}) {
   let vrm;
   function setVrm(vrmToUse) {
@@ -51,8 +45,6 @@ export function makeFakeLiveSlotsStuff(options = {}) {
     log,
     FinalizationRegistry = FakeFinalizationRegistry,
     WeakRef = FakeWeakRef, // VRM uses this
-    WeakMap = RealWeakMap,
-    WeakSet = RealWeakSet,
     addToPossiblyDeadSet = () => {},
     addToPossiblyRetiredSet = () => {},
   } = options;
@@ -159,12 +151,18 @@ export function makeFakeLiveSlotsStuff(options = {}) {
     },
   };
 
+  let nextExportID = 1;
   function allocateExportID() {
-    return vrm.allocateNextID('exportID');
+    const exportID = nextExportID;
+    nextExportID += 1;
+    return exportID;
   }
 
+  let nextCollectionID = 1;
   function allocateCollectionID() {
-    return vrm.allocateNextID('collectionID');
+    const collectionID = nextCollectionID;
+    nextCollectionID += 1;
+    return collectionID;
   }
 
   // note: The real liveslots slotToVal() maps slots (vrefs) to a WeakRef,
@@ -214,23 +212,17 @@ export function makeFakeLiveSlotsStuff(options = {}) {
       }
       return val;
     }
-    let result;
     if (virtual || durable) {
       if (vrm) {
         val = vrm.reanimate(slot);
         if (facet !== undefined) {
-          result = vrm.getFacet(id, val, facet);
+          return vrm.getFacet(id, val, facet);
         }
       } else {
         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;
-    }
-    return result;
+    return val;
   }
 
   const marshal = makeMarshal(convertValToSlot, convertSlotToVal, {
@@ -238,15 +230,12 @@ export function makeFakeLiveSlotsStuff(options = {}) {
   });
 
   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);
-      for (const [index, name] of vrm.getFacetNames(id).entries()) {
+      vrm.getFacetNames(id).forEach((name, index) => {
         valToSlot.set(val[name], `${baseRef}:${index}`);
-      }
+      });
     } else {
       valToSlot.set(val, baseRef);
     }
@@ -281,8 +270,6 @@ export function makeFakeLiveSlotsStuff(options = {}) {
     deleteEntry,
     FinalizationRegistry,
     WeakRef,
-    WeakMap,
-    WeakSet,
     addToPossiblyDeadSet,
     addToPossiblyRetiredSet,
     dumpStore,
@@ -328,12 +315,8 @@ export function makeFakeWatchedPromiseManager(
  * Configure virtual stuff with relaxed durability rules and fake liveslots
  *
  * @param {object} [options]
- * @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]
+ * @param {number} [options.cacheSize=3]
+ * @param {boolean} [options.relaxDurabilityRules=true]
  */
 export function makeFakeVirtualStuff(options = {}) {
   const actualOptions = {
@@ -343,9 +326,9 @@ 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);
   return { fakeStuff, vrm, vom, cm, wpm };
@@ -355,9 +338,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;
 }
 
@@ -365,7 +348,6 @@ 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/src/vatDataTypes.d.ts

@@ -1,234 +0,0 @@
-/**
- * @file Types for vat-data
- *
- * Facet is a single object with methods.
- * Behavior is a description when defining a kind of what facets it will have.
- * For the non-multi defineKind, there is just one facet so it doesn't have a key.
- */
-import type { InterfaceGuard, Pattern } from '@endo/patterns';
-import type {
-  MapStore,
-  SetStore,
-  StoreOptions,
-  WeakMapStore,
-  WeakSetStore,
-} from '@agoric/store';
-import type { makeWatchedPromiseManager } from './watchedPromises.js';
-
-// TODO should be moved into @endo/patterns and eventually imported here
-// instead of this local definition.
-export type InterfaceGuardKit = Record<string, InterfaceGuard>;
-
-export type { MapStore, Pattern };
-
-// This needs `any` values.  If they were `unknown`, code that uses Baggage
-// would need explicit runtime checks or casts for every fetch, which is
-// onerous.
-export type Baggage = MapStore<string, any>;
-
-type WatchedPromisesManager = ReturnType<typeof makeWatchedPromiseManager>;
-
-type Tail<T extends any[]> = T extends [head: any, ...rest: infer Rest]
-  ? Rest
-  : [];
-
-// used to omit the 'context' parameter
-type OmitFirstArg<F> = F extends (x: any, ...args: infer P) => infer R
-  ? (...args: P) => R
-  : never;
-
-export type KindFacet<O> = {
-  [K in keyof O]: OmitFirstArg<O[K]>; // omit the 'context' parameter
-};
-
-export type KindFacets<B> = {
-  [FacetKey in keyof B]: KindFacet<B[FacetKey]>;
-};
-
-export type KindContext<S, F> = { state: S; self: KindFacet<F> };
-export type MultiKindContext<S, B> = { state: S; facets: KindFacets<B> };
-
-export type PlusContext<C, M> = (c: C, ...args: Parameters<M>) => ReturnType<M>;
-export type FunctionsPlusContext<C, O> = {
-  [K in keyof O]: PlusContext<C, O[K]>;
-};
-
-declare class DurableKindHandleClass {
-  private descriptionTag: string;
-}
-export type DurableKindHandle = DurableKindHandleClass;
-
-/**
- * Grab bag of options that can be provided to `defineDurableKind` and its
- * siblings. Not all options are meaningful in all contexts. See the
- * doc-comments on each option.
- */
-export type DefineKindOptions<C> = {
-  /**
-   * If provided, the `finish` function will be called after the instance is
-   * made and internally registered, but before it is returned. The finish
-   * function is to do any post-intantiation initialization that should be
-   * done before exposing the object to its clients.
-   */
-  finish?: (context: C) => void;
-
-  /**
-   * Meaningful to `makeScalarBigMapStore` and its siblings. These maker
-   * fuctions will make either virtual or durable stores, depending on
-   * this flag. Defaults to off, making virtual but not durable collections.
-   *
-   * Generally, durable collections are provided with `provideDurableMapStore`
-   * and its sibling, which use this flag internally. If you do not make
-   * durable collections by other means, you can consider this as
-   * intended for internal use only.
-   */
-  durable?: boolean;
-
-  /**
-   * If provided, it describes the shape of all state records of instances
-   * of this kind.
-   */
-  stateShape?: { [name: string]: Pattern };
-
-  /**
-   * Intended for internal use only.
-   * Should the raw methods receive their `context` argument as their first
-   * argument or as their `this` binding? For `defineDurableKind` and its
-   * siblings (including `prepareSingleton`), this defaults to off, meaning that
-   * their behavior methods receive `context` as their first argument.
-   * `prepareExoClass` and its siblings (including `prepareExo`) use
-   * this flag internally to indicate that their methods receive `context`
-   * as their `this` binding.
-   */
-  thisfulMethods?: boolean;
-
-  /**
-   * Intended for internal use only.
-   * Only applicable if this is a class kind. A class kit kind should use
-   * `interfaceGuardKit` instead.
-   *
-   * If an `interfaceGuard` is provided, then the raw methods passed alongside
-   * it are wrapped by a function that first checks that this method's guard
-   * pattern is satisfied before calling the raw method.
-   *
-   * In `defineDurableKind` and its siblings, this defaults to `undefined`.
-   * Exo classes use this internally to protect their raw class methods
-   * using the provided interface.
-   * In absence, an exo is protected anyway, while a bare kind is
-   * not (detected by `!thisfulMethods`),
-   */
-  interfaceGuard?: InterfaceGuard;
-
-  /**
-   * Intended for internal use only.
-   * Only applicable if this is a class kit kind. A class kind should use
-   * `interfaceGuard` instead.
-   *
-   * If an `interfaceGuardKit` is provided, then each member of the
-   * interfaceGuardKit is used to guard the corresponding facet of the
-   * class kit.
-   *
-   * In `defineDurableKindMulti` and its siblings, this defaults to `undefined`.
-   * Exo class kits use this internally to protect their facets.
-   * In absence, an exo is protected anyway, while a bare kind is
-   * not (detected by `!thisfulMethods`),
-   */
-  interfaceGuardKit?: InterfaceGuardKit;
-};
-
-export type VatData = {
-  // virtual kinds
-  /** @deprecated Use defineVirtualExoClass instead */
-  defineKind: <P, S, F>(
-    tag: string,
-    init: (...args: P) => S,
-    facet: F,
-    options?: DefineKindOptions<KindContext<S, F>>,
-  ) => (...args: P) => KindFacet<F>;
-
-  /** @deprecated Use defineVirtualExoClassKit instead */
-  defineKindMulti: <P, S, B>(
-    tag: string,
-    init: (...args: P) => S,
-    behavior: B,
-    options?: DefineKindOptions<MultiKindContext<S, B>>,
-  ) => (...args: P) => KindFacets<B>;
-
-  // durable kinds
-  makeKindHandle: (descriptionTag: string) => DurableKindHandle;
-
-  /** @deprecated Use defineDurableExoClass instead */
-  defineDurableKind: <P, S, F>(
-    kindHandle: DurableKindHandle,
-    init: (...args: P) => S,
-    facet: F,
-    options?: DefineKindOptions<KindContext<S, F>>,
-  ) => (...args: P) => KindFacet<F>;
-
-  /** @deprecated Use defineDurableExoClassKit instead */
-  defineDurableKindMulti: <P, S, B>(
-    kindHandle: DurableKindHandle,
-    init: (...args: P) => S,
-    behavior: B,
-    options?: DefineKindOptions<MultiKindContext<S, B>>,
-  ) => (...args: P) => KindFacets<B>;
-
-  providePromiseWatcher: WatchedPromisesManager['providePromiseWatcher'];
-  watchPromise: WatchedPromisesManager['watchPromise'];
-
-  makeScalarBigMapStore: <K, V>(
-    label: string,
-    options?: StoreOptions,
-  ) => MapStore<K, V>;
-  makeScalarBigWeakMapStore: <K, V>(
-    label: string,
-    options?: StoreOptions,
-  ) => WeakMapStore<K, V>;
-
-  makeScalarBigSetStore: <K>(
-    label: string,
-    options?: StoreOptions,
-  ) => SetStore<K>;
-  makeScalarBigWeakSetStore: <K>(
-    label: string,
-    options?: StoreOptions,
-  ) => WeakSetStore<K>;
-  canBeDurable: (specimen: unknown) => boolean;
-};
-
-// The JSDoc is repeated here and at the function definition so it appears
-// in IDEs where it's used, regardless of type resolution.
-export interface PickFacet {
-  /**
-   * When making a multi-facet kind, it's common to pick one facet to
-   * expose. E.g.,
-   *
-   *     const makeFoo = (a, b, c, d) => makeFooBase(a, b, c, d).self;
-   *
-   * This helper reduces the duplication:
-   *
-   *     const makeFoo = pickFacet(makeFooBase, 'self');
-   */
-  <M extends (...args: any[]) => any, F extends keyof ReturnType<M>>(
-    maker: M,
-    facetName: F,
-  ): (...args: Parameters<M>) => ReturnType<M>[F];
-}
-
-/** @deprecated Use prepareExoClass instead */
-export type PrepareKind = <P, S, F>(
-  baggage: Baggage,
-  tag: string,
-  init: (...args: P) => S,
-  facet: F,
-  options?: DefineKindOptions<KindContext<S, F>>,
-) => (...args: P) => KindFacet<F>;
-
-/** @deprecated Use prepareExoClassKit instead */
-export type PrepareKindMulti = <P, S, B>(
-  baggage: Baggage,
-  tag: string,
-  init: (...args: P) => S,
-  behavior: B,
-  options?: DefineKindOptions<MultiKindContext<S, B>>,
-) => (...args: P) => KindFacets<B>;

package/src/vatDataTypes.js

@@ -1,2 +0,0 @@
-// Empty JS file to correspond with vatDataTypes.d.ts
-export {};

package/tools/prepare-test-env.js

@@ -1,13 +0,0 @@
-/**
- * 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

@@ -1,61 +0,0 @@
-// @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) =>
-    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 };
-};