@agoric/async-flow 0.1.1-upgrade-16-dev-d492653.0 → 0.1.1-upgrade-17-dev-3b97a9f.0

package/test/replay-membrane-eventual.test.js

@@ -7,6 +7,7 @@ import {
 } from './prepare-test-env-ava.js';
 
 import { Fail } from '@endo/errors';
+import { eventLoopIteration } from '@agoric/internal/src/testing-utils.js';
 import { prepareVowTools } from '@agoric/vow';
 import { E } from '@endo/eventual-send';
 // import E from '@agoric/vow/src/E.js';
@@ -18,6 +19,13 @@ import { prepareLogStore } from '../src/log-store.js';
 import { prepareBijection } from '../src/bijection.js';
 import { makeReplayMembrane } from '../src/replay-membrane.js';
 
+/**
+ * @import {PromiseKit} from '@endo/promise-kit'
+ * @import {Zone} from '@agoric/base-zone'
+ * @import {LogStore} from '../src/log-store.js';
+ * @import {Bijection} from '../src/bijection.js';
+ */
+
 const watchWake = _vowish => {};
 const panic = problem => Fail`panic over ${problem}`;
 
@@ -39,15 +47,25 @@ const preparePingee = zone =>
  */
 const testFirstPlay = async (t, zone) => {
   const vowTools = prepareVowTools(zone);
+  const { makeVowKit } = vowTools;
   const makeLogStore = prepareLogStore(zone);
   const makeBijection = prepareBijection(zone);
   const makePingee = preparePingee(zone);
+  const { vow: v1, resolver: r1 } = zone.makeOnce('v1', () => makeVowKit());
+  const { vow: _v2, resolver: _r2 } = zone.makeOnce('v2', () => makeVowKit());
 
   const log = zone.makeOnce('log', () => makeLogStore());
-  const bij = zone.makeOnce('bij', makeBijection);
-
-  const mem = makeReplayMembrane(log, bij, vowTools, watchWake, panic);
+  const bijection = zone.makeOnce('bij', makeBijection);
+
+  const mem = makeReplayMembrane({
+    log,
+    bijection,
+    vowTools,
+    watchWake,
+    panic,
+  });
 
+  const p1 = mem.hostToGuest(v1);
   t.deepEqual(log.dump(), []);
 
   /** @type {Pingee} */
@@ -56,18 +74,122 @@ const testFirstPlay = async (t, zone) => {
   const guestPingee = mem.hostToGuest(pingee);
   t.deepEqual(log.dump(), []);
 
-  const pingTestSendResult = t.throwsAsync(() => E(guestPingee).ping('send'), {
-    message:
-      'panic over "[Error: guest eventual send not yet supported: \\"[Alleged: Pingee guest wrapper]\\".ping([\\"send\\"]) -> \\"[Promise]\\"]"',
+  const p = E(guestPingee).ping('send');
+  const pOnly = E.sendOnly(guestPingee).ping('sendOnly');
+  t.is(pOnly, undefined);
+
+  guestPingee.ping('call');
+
+  t.is(await p, undefined);
+  const dump = log.dump();
+  const v3 = dump[3][2];
+  t.deepEqual(dump, [
+    ['checkCall', pingee, 'ping', ['call'], 0],
+    ['doReturn', 0, undefined],
+    ['checkSend', pingee, 'ping', ['send'], 2],
+    ['doReturn', 2, v3],
+    ['checkSendOnly', pingee, 'ping', ['sendOnly'], 4],
+    ['doFulfill', v3, undefined],
+  ]);
+
+  r1.resolve('x');
+  t.is(await p1, 'x');
+
+  t.deepEqual(log.dump(), [
+    ['checkCall', pingee, 'ping', ['call'], 0],
+    ['doReturn', 0, undefined],
+    ['checkSend', pingee, 'ping', ['send'], 2],
+    ['doReturn', 2, v3],
+    ['checkSendOnly', pingee, 'ping', ['sendOnly'], 4],
+    ['doFulfill', v3, undefined],
+    ['doFulfill', v1, 'x'],
+  ]);
+};
+
+/**
+ * @param {any} t
+ * @param {Zone} zone
+ */
+const testReplay = async (t, zone) => {
+  const vowTools = prepareVowTools(zone);
+  prepareLogStore(zone);
+  prepareBijection(zone);
+  preparePingee(zone);
+  const { vow: v1 } = zone.makeOnce('v1', () => Fail`need v1`);
+  const { vow: v2, resolver: r2 } = zone.makeOnce('v2', () => Fail`need v2`);
+
+  const log = /** @type {LogStore} */ (
+    zone.makeOnce('log', () => Fail`need log`)
+  );
+  const bijection = /** @type {Bijection} */ (
+    zone.makeOnce('bij', () => Fail`need bij`)
+  );
+
+  const pingee = zone.makeOnce('pingee', () => Fail`need pingee`);
+
+  const dump = log.dump();
+  const v3 = dump[3][2];
+  t.deepEqual(dump, [
+    ['checkCall', pingee, 'ping', ['call'], 0],
+    ['doReturn', 0, undefined],
+    ['checkSend', pingee, 'ping', ['send'], 2],
+    ['doReturn', 2, v3],
+    ['checkSendOnly', pingee, 'ping', ['sendOnly'], 4],
+    ['doFulfill', v3, undefined],
+    ['doFulfill', v1, 'x'],
+  ]);
+
+  const mem = makeReplayMembrane({
+    log,
+    bijection,
+    vowTools,
+    watchWake,
+    panic,
   });
+  t.true(log.isReplaying());
+  t.is(log.getIndex(), 0);
+
+  const guestPingee = mem.hostToGuest(pingee);
+  const p2 = mem.hostToGuest(v2);
+  // @ts-expect-error TS doesn't know that r2 is a resolver
+  r2.resolve('y');
+  await eventLoopIteration();
+
+  const p1 = mem.hostToGuest(v1);
+  mem.wake();
+  t.true(log.isReplaying());
+  t.is(log.getIndex(), 0);
+  t.deepEqual(log.dump(), [
+    ['checkCall', pingee, 'ping', ['call'], 0],
+    ['doReturn', 0, undefined],
+    ['checkSend', pingee, 'ping', ['send'], 2],
+    ['doReturn', 2, v3],
+    ['checkSendOnly', pingee, 'ping', ['sendOnly'], 4],
+    ['doFulfill', v3, undefined],
+    ['doFulfill', v1, 'x'],
+  ]);
+
+  E(guestPingee).ping('send');
+  // TODO Once https://github.com/endojs/endo/issues/2336 is fixed,
+  // the following `void` should not be needed. But strangely, TS isn't
+  // telling me a `void` is needed above, which is also incorrect.
+  void E.sendOnly(guestPingee).ping('sendOnly');
 
   guestPingee.ping('call');
 
-  await pingTestSendResult;
+  t.is(await p1, 'x');
+  t.is(await p2, 'y');
+  t.false(log.isReplaying());
 
   t.deepEqual(log.dump(), [
     ['checkCall', pingee, 'ping', ['call'], 0],
     ['doReturn', 0, undefined],
+    ['checkSend', pingee, 'ping', ['send'], 2],
+    ['doReturn', 2, v3],
+    ['checkSendOnly', pingee, 'ping', ['sendOnly'], 4],
+    ['doFulfill', v3, undefined],
+    ['doFulfill', v1, 'x'],
+    ['doFulfill', v2, 'y'],
   ]);
 };
 
@@ -87,5 +209,9 @@ test.serial('test durable replay-membrane settlement', async t => {
 
   nextLife();
   const zone1 = makeDurableZone(getBaggage(), 'durableRoot');
-  return testFirstPlay(t, zone1);
+  await testFirstPlay(t, zone1);
+
+  nextLife();
+  const zone3 = makeDurableZone(getBaggage(), 'durableRoot');
+  return testReplay(t, zone3);
 });

package/test/replay-membrane-settlement.test.js

@@ -17,6 +17,13 @@ import { prepareLogStore } from '../src/log-store.js';
 import { prepareBijection } from '../src/bijection.js';
 import { makeReplayMembrane } from '../src/replay-membrane.js';
 
+/**
+ * @import {PromiseKit} from '@endo/promise-kit'
+ * @import {Zone} from '@agoric/base-zone'
+ * @import {LogStore} from '../src/log-store.js';
+ * @import {Bijection} from '../src/bijection.js';
+ */
+
 const watchWake = _vowish => {};
 const panic = problem => Fail`panic over ${problem}`;
 
@@ -42,9 +49,15 @@ const testFirstPlay = async (t, zone) => {
   const { vow: _v2, resolver: _r2 } = zone.makeOnce('v2', () => makeVowKit());
 
   const log = zone.makeOnce('log', () => makeLogStore());
-  const bij = zone.makeOnce('bij', makeBijection);
-
-  const mem = makeReplayMembrane(log, bij, vowTools, watchWake, panic);
+  const bijection = zone.makeOnce('bij', makeBijection);
+
+  const mem = makeReplayMembrane({
+    log,
+    bijection,
+    vowTools,
+    watchWake,
+    panic,
+  });
 
   const p1 = mem.hostToGuest(v1);
   t.deepEqual(log.dump(), []);
@@ -85,7 +98,7 @@ const testReplay = async (t, zone) => {
   const log = /** @type {LogStore} */ (
     zone.makeOnce('log', () => Fail`need log`)
   );
-  const bij = /** @type {Bijection} */ (
+  const bijection = /** @type {Bijection} */ (
     zone.makeOnce('bij', () => Fail`need bij`)
   );
 
@@ -97,7 +110,13 @@ const testReplay = async (t, zone) => {
     ['doFulfill', v1, 'x'],
   ]);
 
-  const mem = makeReplayMembrane(log, bij, vowTools, watchWake, panic);
+  const mem = makeReplayMembrane({
+    log,
+    bijection,
+    vowTools,
+    watchWake,
+    panic,
+  });
   t.true(log.isReplaying());
   t.is(log.getIndex(), 0);
 

package/test/replay-membrane-zombie.test.js

@@ -17,6 +17,11 @@ import { prepareLogStore } from '../src/log-store.js';
 import { prepareBijection } from '../src/bijection.js';
 import { makeReplayMembrane } from '../src/replay-membrane.js';
 
+/**
+ * @import {PromiseKit} from '@endo/promise-kit'
+ * @import {Zone} from '@agoric/base-zone'
+ */
+
 const watchWake = _vowish => {};
 const panic = problem => Fail`panic over ${problem}`;
 
@@ -31,14 +36,20 @@ const testMissingStop = async (t, zone) => {
   const makeBijection = prepareBijection(zone);
 
   const log = makeLogStore();
-  const bij = makeBijection();
+  const bijection = makeBijection();
 
-  const memA = makeReplayMembrane(log, bij, vowTools, watchWake, panic);
+  const memA = makeReplayMembrane({
+    log,
+    bijection,
+    vowTools,
+    watchWake,
+    panic,
+  });
 
   const { vow: v1, resolver: r1 } = makeVowKit();
 
   const p1A = memA.hostToGuest(v1);
-  t.true(bij.has(p1A, v1));
+  t.true(bijection.has(p1A, v1));
 
   await eventLoopIteration();
 
@@ -48,12 +59,18 @@ const testMissingStop = async (t, zone) => {
   // except stopping the old membrane,
   // to demonstate why `makeGuestForHostVow` also tests`stopped`.
   log.reset();
-  bij.reset();
-  const memB = makeReplayMembrane(log, bij, vowTools, watchWake, panic);
+  bijection.reset();
+  const memB = makeReplayMembrane({
+    log,
+    bijection,
+    vowTools,
+    watchWake,
+    panic,
+  });
 
   const p1B = memB.hostToGuest(v1);
-  t.true(bij.has(p1B, v1));
-  t.false(bij.hasGuest(p1A));
+  t.true(bijection.has(p1B, v1));
+  t.false(bijection.hasGuest(p1A));
 
   await eventLoopIteration();
 
@@ -81,14 +98,20 @@ const testProperStop = async (t, zone) => {
   const makeBijection = prepareBijection(zone);
 
   const log = makeLogStore();
-  const bij = makeBijection();
+  const bijection = makeBijection();
 
-  const memA = makeReplayMembrane(log, bij, vowTools, watchWake, panic);
+  const memA = makeReplayMembrane({
+    log,
+    bijection,
+    vowTools,
+    watchWake,
+    panic,
+  });
 
   const { vow: v1, resolver: r1 } = makeVowKit();
 
   const p1A = memA.hostToGuest(v1);
-  t.true(bij.has(p1A, v1));
+  t.true(bijection.has(p1A, v1));
 
   await eventLoopIteration();
 
@@ -98,13 +121,19 @@ const testProperStop = async (t, zone) => {
   // including stopping the old membrane,
   // to demonstate why `makeGuestForHostVow` also tests`stopped`.
   log.reset();
-  bij.reset();
+  bijection.reset();
   memA.stop(); // the point
-  const memB = makeReplayMembrane(log, bij, vowTools, watchWake, panic);
+  const memB = makeReplayMembrane({
+    log,
+    bijection,
+    vowTools,
+    watchWake,
+    panic,
+  });
 
   const p1B = memB.hostToGuest(v1);
-  t.true(bij.has(p1B, v1));
-  t.false(bij.hasGuest(p1A));
+  t.true(bijection.has(p1B, v1));
+  t.false(bijection.hasGuest(p1A));
 
   await eventLoopIteration();
 

package/test/replay-membrane.test.js

@@ -18,6 +18,14 @@ import { prepareLogStore } from '../src/log-store.js';
 import { prepareBijection } from '../src/bijection.js';
 import { makeReplayMembrane } from '../src/replay-membrane.js';
 
+/**
+ * @import {PromiseKit} from '@endo/promise-kit'
+ * @import {Zone} from '@agoric/base-zone'
+ * @import {MapStore} from '@agoric/store';
+ * @import {LogStore} from '../src/log-store.js';
+ * @import {Bijection} from '../src/bijection.js';
+ */
+
 const watchWake = _vowish => {};
 const panic = problem => Fail`panic over ${problem}`;
 
@@ -61,9 +69,15 @@ const testFirstPlay = async (t, zone, showOnConsole = false) => {
   const { vow: v2, resolver: r2 } = makeVowKit();
 
   const log = zone.makeOnce('log', () => makeLogStore());
-  const bij = zone.makeOnce('bij', makeBijection);
-
-  const mem = makeReplayMembrane(log, bij, vowTools, watchWake, panic);
+  const bijection = zone.makeOnce('bij', makeBijection);
+
+  const mem = makeReplayMembrane({
+    log,
+    bijection,
+    vowTools,
+    watchWake,
+    panic,
+  });
 
   const g1 = mem.hostToGuest(v1);
   t.true(isPromise(g1));
@@ -71,9 +85,9 @@ const testFirstPlay = async (t, zone, showOnConsole = false) => {
   t.is(await g1, 'x');
 
   const hOrch7 = makeOrchestra(7, v2, r2);
-  t.false(bij.hasHost(hOrch7));
+  t.false(bijection.hasHost(hOrch7));
   const gOrch7 = mem.hostToGuest(hOrch7);
-  t.true(bij.has(gOrch7, hOrch7));
+  t.true(bijection.has(gOrch7, hOrch7));
 
   const prod = gOrch7.scale(3);
   t.is(prod, 21);
@@ -126,7 +140,7 @@ const testBadReplay = async (t, zone) => {
   const log = /** @type {LogStore} */ (
     zone.makeOnce('log', () => Fail`need log`)
   );
-  const bij = /** @type {Bijection} */ (
+  const bijection = /** @type {Bijection} */ (
     zone.makeOnce('bij', () => Fail`need bij`)
   );
 
@@ -135,7 +149,7 @@ const testBadReplay = async (t, zone) => {
   const hOrch7 = dump[1][1];
   const hErr = dump[4][2];
 
-  t.false(bij.hasHost(hOrch7));
+  t.false(bijection.hasHost(hOrch7));
 
   t.deepEqual(dump, [
     ['doFulfill', v1, 'x'],
@@ -145,13 +159,19 @@ const testBadReplay = async (t, zone) => {
     ['doThrow', 3, hErr],
   ]);
 
-  const mem = makeReplayMembrane(log, bij, vowTools, watchWake, panic);
+  const mem = makeReplayMembrane({
+    log,
+    bijection,
+    vowTools,
+    watchWake,
+    panic,
+  });
 
   const g1 = mem.hostToGuest(v1);
   mem.wake();
   t.is(await g1, 'x');
   const gOrch7 = mem.hostToGuest(hOrch7);
-  t.true(bij.has(gOrch7, hOrch7));
+  t.true(bijection.has(gOrch7, hOrch7));
 
   // failure of guest to reproduce behavior from previous incarnations
   t.throws(() => gOrch7.scale(4), {
@@ -172,7 +192,7 @@ const testGoodReplay = async (t, zone) => {
   const log = /** @type {LogStore} */ (
     zone.makeOnce('log', () => Fail`need log`)
   );
-  const bij = /** @type {Bijection} */ (
+  const bijection = /** @type {Bijection} */ (
     zone.makeOnce('bij', () => Fail`need bij`)
   );
 
@@ -181,7 +201,7 @@ const testGoodReplay = async (t, zone) => {
   const hOrch7 = dump[1][1];
   const hErr = dump[4][2];
 
-  t.false(bij.hasHost(hOrch7));
+  t.false(bijection.hasHost(hOrch7));
 
   t.deepEqual(dump, [
     ['doFulfill', v1, 'x'],
@@ -193,13 +213,19 @@ const testGoodReplay = async (t, zone) => {
 
   const oldLogLen = dump.length;
 
-  const mem = makeReplayMembrane(log, bij, vowTools, watchWake, panic);
+  const mem = makeReplayMembrane({
+    log,
+    bijection,
+    vowTools,
+    watchWake,
+    panic,
+  });
 
   const g1 = mem.hostToGuest(v1);
   mem.wake();
   t.is(await g1, 'x');
   const gOrch7 = mem.hostToGuest(hOrch7);
-  t.true(bij.has(gOrch7, hOrch7));
+  t.true(bijection.has(gOrch7, hOrch7));
 
   // replay
   const prodA = gOrch7.scale(3);

package/test/types.test-d.ts

@@ -0,0 +1,73 @@
+import { expectType } from 'tsd';
+import type { Vow, VowTools } from '@agoric/vow';
+import type {
+  HostOf,
+  GuestOf,
+  HostInterface,
+  GuestInterface,
+} from '../src/types.js';
+
+const castable: unknown = null;
+const vt: VowTools = null as any;
+
+const sumVow = (a: number, b: number) => vt.asVow(() => a + b);
+
+const sumPromise = (a: number, b: number) => Promise.resolve(a + b);
+
+expectType<(p1: number, p2: number) => Promise<number>>(
+  castable as GuestOf<typeof sumVow>,
+);
+
+expectType<(p1: number, p2: number) => Vow<number>>(
+  castable as HostOf<typeof sumPromise>,
+);
+expectType<(p1: number, p2: number) => Vow<void>>(
+  // @ts-expect-error incompatible return type
+  castable as HostOf<typeof sumPromise>,
+);
+
+// Test HostInterface and GuestInterface with an exoClass object
+type ExoAPIBase = {
+  getValue: () => number;
+  setValue: (value: number) => void;
+  getCopyData: () => Record<string, number>[];
+  // TODO include `getRemote() => Guarded<...>`, since durable exos are passable
+};
+type ExoGuestAPI = ExoAPIBase & {
+  getValueAsync: () => Promise<number>;
+};
+
+type ExoHostAPI = ExoAPIBase & {
+  getValueAsync: () => Vow<number>;
+};
+
+expectType<
+  ExoAPIBase & {
+    getValueAsync: () => Vow<number>;
+  }
+>(castable as HostInterface<ExoGuestAPI>);
+expectType<
+  ExoAPIBase & {
+    getValueAsync: () => Promise<number>;
+  }
+>(castable as GuestInterface<ExoHostAPI>);
+
+// Test HostInterface and GuestInterface with classKit (nested) objects
+expectType<{
+  facet: ExoAPIBase & {
+    getValueAsync: () => Vow<number>;
+  };
+}>(
+  castable as HostInterface<{
+    facet: ExoGuestAPI;
+  }>,
+);
+expectType<{
+  facet: ExoAPIBase & {
+    getValueAsync: () => Promise<number>;
+  };
+}>(
+  castable as GuestInterface<{
+    facet: ExoHostAPI;
+  }>,
+);

package/tsconfig.json

@@ -9,5 +9,7 @@
     "scripts",
     "src/**/*.js",
     "test/**/*.js",
+    "src/**/*.ts",
+    "test/**/*.ts",
   ],
 }

package/src/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.js"],"names":[],"mappings":"iBAWa,SAAS,GACrB,UAAsB,GACtB,WAAuB,GACvB,QAAoB,GACpB,MAAkB;WAMN,CAAC,gCAAD,CAAC;UAKD,CAAC,gCAAD,CAAC;;;;;aAQQ,CAAC;;;sBAIV,CAAC,GAAG,cAAc,EAAE,KAAK,EAAE,KAAK,KAAK,cAAS;4BAI9C,CAAC,GAAG,cAAc,EAAE,IAAI,EAAE,KAAK,OAAO;;;2FA7BlC,CAAC;;;wBAyBN,SAAQ;;;;;;;;;;;;;;;;;;;;;;;;mBAeP,QAAQ,GAAC,OAAO;eAIhB;IAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,GAAG,CAAA;CAAC,GAC7B;IAAC,IAAI,EAAE,OAAO,CAAC;IAAE,OAAO,EAAE,GAAG,CAAA;CAAC;cAStB,CAAC,4BADK,CAAC;SAAd,CAAC,IAAI,EACE,CAAC,AADA,KAAK,CAAC;cACd,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI;;;;;;;gBAQlB,CAAE,iEAAiE;AAC/E,EAAQ,EAAE,WAAW,EACrB,GAAS,EAAE,OAAO,EAClB,WAAiB,EAAE,IAAI,CAClB,GAAG,CACR,EAAQ,EAAE,UAAU,EACpB,GAAS,EAAE,OAAO,EAClB,MAAY,EAAE,IAAI,CACb,GAAG,CACR,EAAQ,EAAE,UAAU,EACpB,SAAe,EAAE,MAAM,EACvB,MAAY,EAAE,IAAI,CACb,GAAG,CACR,EAAQ,EAAE,SAAS,EACnB,SAAe,EAAE,MAAM,EACvB,OAAa,EAAE,IAAI,CACd,GAAG,CAAE,qEAAqE;AAC/E,EAAQ,EAAE,WAAW,EACrB,MAAY,EAAE,IAAI,EAClB,OAAa,EAAE,WAAW,GAAC,SAAS,EACpC,IAAU,EAAE,IAAI,EAAE,EAClB,SAAe,EAAE,MAAM,CAClB;gCAhGuB,mBAAmB;8BACrB,kBAAkB;0BACtB,mBAAmB;yBACV,aAAa;8BAAb,aAAa;8BAClB,gBAAgB;+BACf,gBAAgB;oCACX,sBAAsB"}