@agoric/vow 0.1.1-dev-442f07c.0 → 0.1.1-dev-69f8e4b.0

package/README.md

@@ -150,8 +150,8 @@ Here is an (oversimplified) algorithm that `watch` and `when` use to obtain a
 final result:
 
 ```js
-// Directly await the non-retriable original specimen.
-// This is non-retriable because we don't know how our caller obtained
+// Directly await the non-retryable original specimen.
+// This is non-retryable because we don't know how our caller obtained
 // it in the first place, since it is an application-specific detail
 // that may not be side-effect free.
 let result = await specimenP;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/vow",
-  "version": "0.1.1-dev-442f07c.0+442f07c",
+  "version": "0.1.1-dev-69f8e4b.0+69f8e4b",
   "description": "Remote (shortening and disconnection-tolerant) Promise-likes",
   "type": "module",
   "main": "src/index.js",
@@ -19,8 +19,8 @@
     "lint:types": "tsc"
   },
   "dependencies": {
-    "@agoric/base-zone": "0.1.1-dev-442f07c.0+442f07c",
-    "@agoric/internal": "0.3.3-dev-442f07c.0+442f07c",
+    "@agoric/base-zone": "0.1.1-dev-69f8e4b.0+69f8e4b",
+    "@agoric/internal": "0.3.3-dev-69f8e4b.0+69f8e4b",
     "@endo/env-options": "^1.1.6",
     "@endo/errors": "^1.2.5",
     "@endo/eventual-send": "^1.2.5",
@@ -30,8 +30,8 @@
   },
   "devDependencies": {
     "@agoric/internal": "^0.3.2",
-    "@agoric/swingset-vat": "0.32.3-dev-442f07c.0+442f07c",
-    "@agoric/zone": "0.2.3-dev-442f07c.0+442f07c",
+    "@agoric/swingset-vat": "0.32.3-dev-69f8e4b.0+69f8e4b",
+    "@agoric/zone": "0.2.3-dev-69f8e4b.0+69f8e4b",
     "@endo/far": "^1.1.5",
     "@endo/init": "^1.1.4",
     "ava": "^5.3.0",
@@ -55,7 +55,7 @@
     "access": "public"
   },
   "typeCoverage": {
-    "atLeast": 89.96
+    "atLeast": 91.85
   },
-  "gitHead": "442f07c8f0af03281b52b90e90c27131eef6f331"
+  "gitHead": "69f8e4b5e04b66df5400716251e66fbce468c86e"
 }

package/src/retryable.d.ts

@@ -0,0 +1,75 @@
+export function prepareRetryableTools(outerZone: Zone, outerOptions: PreparationOptions): {
+    prepareRetryableFlowKit: (zone: Zone, tag: string, retryableFunc: RetryableFunc) => (activationArgs: any) => import("@endo/exo").GuardedKit<{
+        flow: {
+            /**
+             * Calls the retryable function, either for the initial run or when
+             * the result of the previous run fails with a retryable reason.
+             */
+            restart(): void;
+            getOutcome(): Vow<any>;
+        };
+        resultWatcher: {
+            onFulfilled(value: any, runId: any): void;
+            onRejected(reason: any, runId: any): void;
+        };
+    }>;
+    adminRetryableFlow: import("@endo/exo").Guarded<{
+        /**
+         * @param {Vow} outcomeVow
+         */
+        getFlowForOutcomeVow(outcomeVow: Vow): import("@endo/exo").Guarded<{
+            /**
+             * Calls the retryable function, either for the initial run or when
+             * the result of the previous run fails with a retryable reason.
+             */
+            restart(): void;
+            getOutcome(): Vow<any>;
+        }>;
+    }>;
+    retryable: import("./types.js").RetryableTool;
+};
+export type PreparationOptions = {
+    makeVowKit: () => VowKit<any>;
+    isRetryableReason: IsRetryableReason;
+};
+export type RetryableFunc = (...args: Passable[]) => Promise<any>;
+export type RetryableTools = ReturnType<(outerZone: Zone, outerOptions: PreparationOptions) => {
+    prepareRetryableFlowKit: (zone: Zone, tag: string, retryableFunc: RetryableFunc) => (activationArgs: any) => import("@endo/exo").GuardedKit<{
+        flow: {
+            /**
+             * Calls the retryable function, either for the initial run or when
+             * the result of the previous run fails with a retryable reason.
+             */
+            restart(): void;
+            getOutcome(): Vow<any>;
+        };
+        resultWatcher: {
+            onFulfilled(value: any, runId: any): void;
+            onRejected(reason: any, runId: any): void;
+        };
+    }>;
+    adminRetryableFlow: import("@endo/exo").Guarded<{
+        /**
+         * @param {Vow} outcomeVow
+         */
+        getFlowForOutcomeVow(outcomeVow: Vow): import("@endo/exo").Guarded<{
+            /**
+             * Calls the retryable function, either for the initial run or when
+             * the result of the previous run fails with a retryable reason.
+             */
+            restart(): void;
+            getOutcome(): Vow<any>;
+        }>;
+    }>;
+    retryable: import("./types.js").RetryableTool;
+}>;
+export type AdminRetryableFlow = RetryableTools["adminRetryableFlow"];
+export type MakeRetryableFlowKit = ReturnType<RetryableTools["prepareRetryableFlowKit"]>;
+export type RetryableFlowKit = ReturnType<MakeRetryableFlowKit>;
+export type RetryableFlow = RetryableFlowKit["flow"];
+import type { Zone } from '@agoric/base-zone';
+import type { Vow } from './types.js';
+import type { VowKit } from './types.js';
+import type { IsRetryableReason } from './types.js';
+import type { Passable } from '@endo/pass-style';
+//# sourceMappingURL=retryable.d.ts.map

package/src/retryable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"retryable.d.ts","sourceRoot":"","sources":["retryable.js"],"names":[],"mappings":"AAwCO,iDAHI,IAAI,gBACJ,kBAAkB;oCAoBhB,IAAI,OACJ,MAAM,iBACN,aAAa;;YAsBhB;;;eAGG;;;;;;;;;;QAuGP;;WAEG;yCADQ,GAAG;YA3GV;;;eAGG;;;;;;EAqHZ;;gBA5La,MAAM,OAAO,GAAG,CAAC;uBACjB,iBAAiB;;4BAIlB,CAAC,GAAG,IAAI,EAAE,QAAQ,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC;6BA2LrC,UAAU,aAzKZ,IAAI,gBACJ,kBAAkB;oCAoBhB,IAAI,OACJ,MAAM,iBACN,aAAa;;YAsBhB;;;eAGG;;;;;;;;;;QAuGP;;WAEG;yCADQ,GAAG;YA3GV;;;eAGG;;;;;;EAyHiC;iCAIjC,cAAc,CAAC,oBAAoB,CAAC;mCAIpC,UAAU,CAAC,cAAc,CAAC,yBAAyB,CAAC,CAAC;+BAIrD,UAAU,CAAC,oBAAoB,CAAC;4BAIhC,gBAAgB,CAAC,MAAM,CAAC;0BAvNd,mBAAmB;yBACiB,YAAY;4BAAZ,YAAY;uCAAZ,YAAY;8BAC/B,kBAAkB"}

package/src/retryable.js

@@ -0,0 +1,224 @@
+import { Fail } from '@endo/errors';
+import { M } from '@endo/patterns';
+import { PromiseWatcherI } from '@agoric/base-zone';
+import { makeAsVow, toPassableCap, VowShape } from './vow-utils.js';
+
+/**
+ * @import {MapStore, WeakMapStore} from '@agoric/store'
+ * @import {Zone} from '@agoric/base-zone'
+ * @import {Vow, VowKit, IsRetryableReason, VowTools} from './types.js'
+ * @import {Passable, PassableCap} from '@endo/pass-style'
+ */
+
+/**
+ * @typedef {object} PreparationOptions
+ * @property {() => VowKit<any>} makeVowKit
+ * @property {IsRetryableReason} isRetryableReason
+ */
+
+/**
+ * @typedef {(...args: Passable[]) => Promise<any>} RetryableFunc
+ */
+
+const { defineProperties } = Object;
+
+const RetryableFlowIKit = harden({
+  flow: M.interface('Flow', {
+    restart: M.call().returns(),
+    getOutcome: M.call().returns(VowShape),
+  }),
+  resultWatcher: PromiseWatcherI,
+});
+
+const AdminRetryableFlowI = M.interface('RetryableFlowAdmin', {
+  getFlowForOutcomeVow: M.call(VowShape).returns(M.opt(M.remotable('flow'))),
+});
+
+/**
+ * @param {Zone} outerZone
+ * @param {PreparationOptions} outerOptions
+ */
+export const prepareRetryableTools = (outerZone, outerOptions) => {
+  const { makeVowKit, isRetryableReason } = outerOptions;
+
+  const asVow = makeAsVow(makeVowKit);
+
+  /**
+   * So we can give out wrapper functions easily and recover flow objects
+   * for their activations later.
+   */
+  const flowForOutcomeVowKey =
+    /** @type {MapStore<PassableCap, RetryableFlow>} */ (
+      outerZone.mapStore('retryableFlowForOutcomeVow', {
+        keyShape: M.remotable('toPassableCap'),
+        valueShape: M.remotable('flow'), // isDone === false
+      })
+    );
+
+  /**
+   * @param {Zone} zone
+   * @param {string} tag
+   * @param {RetryableFunc} retryableFunc
+   */
+  const prepareRetryableFlowKit = (zone, tag, retryableFunc) => {
+    typeof retryableFunc === 'function' ||
+      Fail`retryableFunc must be a callable function ${retryableFunc}`;
+
+    const internalMakeRetryableFlowKit = zone.exoClassKit(
+      tag,
+      RetryableFlowIKit,
+      activationArgs => {
+        harden(activationArgs);
+
+        return {
+          activationArgs, // restarting the retryable function uses the original args
+          outcomeKit: makeVowKit(), // outcome of activation as vow
+          lastRetryReason: undefined,
+          runs: 0n,
+          isDone: false, // persistently done
+        };
+      },
+      {
+        flow: {
+          /**
+           * Calls the retryable function, either for the initial run or when
+           * the result of the previous run fails with a retryable reason.
+           */
+          restart() {
+            const { state, facets } = this;
+            const { activationArgs, isDone } = state;
+            const { flow, resultWatcher } = facets;
+
+            !isDone ||
+              // separate line so I can set a breakpoint
+              Fail`Cannot restart a done retryable flow ${flow}`;
+
+            const runId = state.runs + 1n;
+            state.runs = runId;
+
+            let resultP;
+            try {
+              resultP = Promise.resolve(retryableFunc(...activationArgs));
+            } catch (err) {
+              resultP = Promise.reject(err);
+            }
+
+            outerZone.watchPromise(harden(resultP), resultWatcher, runId);
+          },
+          getOutcome() {
+            const { state } = this;
+            const { outcomeKit } = state;
+            return outcomeKit.vow;
+          },
+        },
+        resultWatcher: {
+          onFulfilled(value, runId) {
+            const { state } = this;
+            const { runs, outcomeKit } = state;
+            if (runId !== runs) return;
+            !state.isDone ||
+              Fail`Cannot resolve a done retryable flow ${this.facets.flow}`;
+            outcomeKit.resolver.resolve(value);
+            flowForOutcomeVowKey.delete(toPassableCap(outcomeKit.vow));
+            state.isDone = true;
+          },
+          onRejected(reason, runId) {
+            const { state } = this;
+            const { runs, outcomeKit } = state;
+            if (runId !== runs) return;
+            !state.isDone ||
+              Fail`Cannot reject a done retryable flow ${this.facets.flow}`;
+            const retryReason = isRetryableReason(
+              reason,
+              state.lastRetryReason,
+            );
+            if (retryReason) {
+              state.lastRetryReason = retryReason;
+              this.facets.flow.restart();
+            } else {
+              outcomeKit.resolver.reject(reason);
+              flowForOutcomeVowKey.delete(toPassableCap(outcomeKit.vow));
+              state.isDone = true;
+            }
+          },
+        },
+      },
+    );
+    const makeRetryableFlowKit = activationArgs => {
+      const retryableKit = internalMakeRetryableFlowKit(activationArgs);
+      const { flow } = retryableKit;
+
+      const vow = flow.getOutcome();
+      flowForOutcomeVowKey.init(toPassableCap(vow), flow);
+      flow.restart();
+      return retryableKit;
+    };
+    return harden(makeRetryableFlowKit);
+  };
+
+  /**
+   * @type {VowTools['retryable']}
+   */
+  const retryable = (zone, tag, retryableFunc) => {
+    const makeRetryableKit = prepareRetryableFlowKit(zone, tag, retryableFunc);
+    const wrapperFuncName = `${tag}_retryable`;
+
+    const wrapperFunc = {
+      /** @param {any[]} args */
+      [wrapperFuncName](...args) {
+        // Make sure any error results in a rejected vow
+        return asVow(() => {
+          zone.isStorable(harden(args)) ||
+            Fail`retryable arguments must be storable ${args}`;
+          const { flow } = makeRetryableKit(args);
+          return flow.getOutcome();
+        });
+      },
+    }[wrapperFuncName];
+    defineProperties(wrapperFunc, {
+      length: { value: retryableFunc.length },
+    });
+    // @ts-expect-error inferred generic func
+    return harden(wrapperFunc);
+  };
+
+  const adminRetryableFlow = outerZone.exo(
+    'AdminRetryableFlow',
+    AdminRetryableFlowI,
+    {
+      /**
+       * @param {Vow} outcomeVow
+       */
+      getFlowForOutcomeVow(outcomeVow) {
+        return flowForOutcomeVowKey.get(toPassableCap(outcomeVow));
+      },
+    },
+  );
+
+  return harden({
+    prepareRetryableFlowKit,
+    adminRetryableFlow,
+    retryable,
+  });
+};
+harden(prepareRetryableTools);
+
+/**
+ * @typedef {ReturnType<prepareRetryableTools>} RetryableTools
+ */
+
+/**
+ * @typedef {RetryableTools['adminRetryableFlow']} AdminRetryableFlow
+ */
+
+/**
+ * @typedef {ReturnType<RetryableTools['prepareRetryableFlowKit']>} MakeRetryableFlowKit
+ */
+
+/**
+ * @typedef {ReturnType<MakeRetryableFlowKit>} RetryableFlowKit
+ */
+
+/**
+ * @typedef {RetryableFlowKit['flow']} RetryableFlow
+ */

package/src/tools.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tools.d.ts","sourceRoot":"","sources":["tools.js"],"names":[],"mappings":"AAsBO,2CALI,IAAI;;gBAGF,QAAQ,CA+EpB;0BA3FsB,mBAAmB;uCAE4B,YAAY;8BAAZ,YAAY"}
+{"version":3,"file":"tools.d.ts","sourceRoot":"","sources":["tools.js"],"names":[],"mappings":"AAuBO,2CALI,IAAI;;gBAGF,QAAQ,CAiEpB;0BA7EsB,mBAAmB;uCAE4B,YAAY;8BAAZ,YAAY"}

package/src/tools.js

@@ -3,6 +3,7 @@ import { makeAsVow } from './vow-utils.js';
 import { prepareVowKit } from './vow.js';
 import { prepareWatchUtils } from './watch-utils.js';
 import { prepareWatch } from './watch.js';
+import { prepareRetryableTools } from './retryable.js';
 import { makeWhen } from './when.js';
 
 /**
@@ -35,25 +36,10 @@ export const prepareBasicVowTools = (zone, powers = {}) => {
   const watchUtils = makeWatchUtils();
   const asVow = makeAsVow(makeVowKit);
 
-  // FIXME in https://github.com/Agoric/agoric-sdk/pull/9785
-  /**
-   * @alpha Not yet implemented
-   *
-   * Create a function that retries the given function if the underlying
-   * functions rejects due to upgrade disconnection.
-   *
-   * @template {(...args: any[]) => Promise<any>} F
-   * @param {Zone} fnZone - the zone for the named function
-   * @param {string} name
-   * @param {F} fn
-   * @returns {F extends (...args: infer Args) => Promise<infer R> ? (...args: Args) => Vow<R> : never}
-   */
-  const retriable =
-    (fnZone, name, fn) =>
-    // @ts-expect-error cast
-    (...args) => {
-      return watch(fn(...args));
-    };
+  const { retryable } = prepareRetryableTools(zone, {
+    makeVowKit,
+    isRetryableReason,
+  });
 
   /**
    * Vow-tolerant implementation of Promise.all that takes an iterable of vows
@@ -95,7 +81,8 @@ export const prepareBasicVowTools = (zone, powers = {}) => {
     allSettled,
     asVow,
     asPromise,
-    retriable,
+    retryable,
+    retriable: retryable, // For temporary backwards compat with alpha implementation
   });
 };
 harden(prepareBasicVowTools);

package/src/types.d.ts

@@ -58,6 +58,20 @@ export type Watcher<T = any, TResult1 = T, TResult2 = never, C extends any[] = a
  * Converts a vow or promise to a promise, ensuring proper handling of ephemeral promises.
  */
 export type AsPromiseFunction<T = any, TResult1 = T, TResult2 = never, C extends any[] = any[]> = (specimenP: ERef<T | Vow<T>>, watcher?: Watcher<T, TResult1, TResult2, C> | undefined, watcherArgs?: C | undefined) => Promise<TResult1 | TResult2>;
+export interface RetryableTool {
+    /**
+     * Create a function that retries the given function if the underlying
+     * async function rejects due to an upgrade disconnection. The return value
+     * of the created function is a vow that settles to the final retry result.
+     *
+     * The retried function should be idempotent.
+     *
+     * @param fnZone the zone for the named function
+     * @param name base name to use in the zone
+     * @param fn the retried function
+     */
+    <F extends (...args: any[]) => Promise<any>>(fnZone: Zone, name: string, fn: F): F extends (...args: infer Args) => Promise<infer R> ? (...args: Args) => Vow<R> : never;
+}
 export type VowTools = {
     /**
      * Vow-tolerant implementation of Promise.all that takes an iterable of vows
@@ -93,7 +107,11 @@ export type VowTools = {
      */
     asVow: <T extends unknown>(fn: (...args: any[]) => Vow<Awaited<T>> | Awaited<T> | PromiseVow<T>) => Vow<Awaited<T>>;
     makeVowKit: <T>() => VowKit<T>;
-    retriable: <F extends (...args: any[]) => Promise<any>>(fnZone: Zone, name: string, fn: F) => F extends (...args: infer Args) => Promise<infer R> ? (...args: Args) => Vow<R> : never;
+    retryable: RetryableTool;
+    /**
+     * @deprecated use `retryable`
+     */
+    retriable: RetryableTool;
     watch: <T = any, TResult1 = T, TResult2 = never, C extends any[] = any[]>(specimenP: EVow<T>, watcher?: Watcher<T, TResult1, TResult2, C> | undefined, ...watcherArgs: C) => Vow<Exclude<TResult1, void> | Exclude<TResult2, void> extends never ? TResult1 : Exclude<TResult1, void> | Exclude<TResult2, void>>;
     /**
      * Shorten `specimenP` until we achieve a final result.

package/src/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,MAAM,EAAE,GAAG,EAAE,eAAe,EAAE,GAAG,KAAK,GAAG,CAAC;AAE3E;;;GAGG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAEhD,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;AACzC;;GAEG;AACH,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAEvC;;;GAGG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,IACnB,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,CAAC,GAClB,OAAO,CAAC,CAAC,CAAC,GACV,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,CAAC,GAC5B,OAAO,CAAC,CAAC,CAAC,GACV,CAAC,CAAC;AAEV;;;;;GAKG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,GAAG,GAAG,IAAI;IAC3B;;;;;OAKG;IACH,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,GAAG,IAAI;IAChC,KAAK,EAAE,eAAe,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,GAAG,CAAC,CAAC,GAAG,GAAG,IAAI,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAE5D,MAAM,MAAM,MAAM,CAAC,CAAC,GAAG,GAAG,IAAI;IAC5B,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IACZ,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,GAAG,IAAI;IACjC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IACzC,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,OAAO,CACjB,CAAC,GAAG,GAAG,EACP,QAAQ,GAAG,CAAC,EACZ,QAAQ,GAAG,KAAK,EAChB,CAAC,SAAS,GAAG,EAAE,GAAG,GAAG,EAAE,IACrB;IACF,WAAW,CAAC,EACR,CAAC,CACC,KAAK,EAAE,CAAC,EACR,GAAG,IAAI,EAAE,CAAC,KACP,GAAG,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC,GACrD,SAAS,CAAC;IACd,UAAU,CAAC,EACP,CAAC,CACC,MAAM,EAAE,GAAG,EACX,GAAG,IAAI,EAAE,CAAC,KACP,GAAG,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC,GACrD,SAAS,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAC3B,CAAC,GAAG,GAAG,EACP,QAAQ,GAAG,CAAC,EACZ,QAAQ,GAAG,KAAK,EAChB,CAAC,SAAS,GAAG,EAAE,GAAG,GAAG,EAAE,IACrB,CACF,SAAS,EAAE,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,EAC3B,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,GAAG,SAAS,EACvD,WAAW,CAAC,EAAE,CAAC,GAAG,SAAS,KACxB,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC,CAAC;AAElC,MAAM,MAAM,QAAQ,GAAG;IACrB;;;;;;OAMG;IACH,GAAG,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,KAAK,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;IAC1C;;;;;;OAMG;IACH,UAAU,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,KAAK,GAAG,CACvC,CACI;QACE,MAAM,EAAE,WAAW,CAAC;QACpB,KAAK,EAAE,GAAG,CAAC;KACZ,GACD;QACE,MAAM,EAAE,UAAU,CAAC;QACnB,MAAM,EAAE,GAAG,CAAC;KACb,CACJ,EAAE,CACJ,CAAC;IACF,OAAO,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,KAAK,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;IAC9C;;OAEG;IACH,SAAS,EAAE,iBAAiB,CAAC;IAC7B;;;;OAIG;IACH,KAAK,EAAE,CAAC,CAAC,SAAS,OAAO,EACvB,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,KACjE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IACrB,UAAU,EAAE,CAAC,CAAC,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;IAC/B,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,EACpD,MAAM,EAAE,IAAI,EACZ,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,CAAC,KACF,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,IAAI,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,GACpD,CAAC,GAAG,IAAI,EAAE,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,GACzB,KAAK,CAAC;IACV,KAAK,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,QAAQ,GAAG,CAAC,EAAE,QAAQ,GAAG,KAAK,EAAE,CAAC,SAAS,GAAG,EAAE,GAAG,GAAG,EAAE,EACtE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,EAClB,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,GAAG,SAAS,EACvD,GAAG,WAAW,EAAE,CAAC,KACd,GAAG,CACN,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,KAAK,GAC3D,QAAQ,GACR,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CACtD,CAAC;IACF;;;;;;OAMG;IACH,IAAI,EAAE,CAAC,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ,GAAG,KAAK,EAC/C,SAAS,EAAE,CAAC,EACZ,WAAW,CAAC,EACR,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GACzD,SAAS,EACb,UAAU,CAAC,EACP,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GACnD,SAAS,KACV,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC,CAAC;CACnC,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,MAAM,EAAE,GAAG,EAAE,eAAe,EAAE,GAAG,KAAK,GAAG,CAAC;AAE3E;;;GAGG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAEhD,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;AACzC;;GAEG;AACH,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAEvC;;;GAGG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,IACnB,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,CAAC,GAClB,OAAO,CAAC,CAAC,CAAC,GACV,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,CAAC,GAC5B,OAAO,CAAC,CAAC,CAAC,GACV,CAAC,CAAC;AAEV;;;;;GAKG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,GAAG,GAAG,IAAI;IAC3B;;;;;OAKG;IACH,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,GAAG,IAAI;IAChC,KAAK,EAAE,eAAe,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,GAAG,CAAC,CAAC,GAAG,GAAG,IAAI,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAE5D,MAAM,MAAM,MAAM,CAAC,CAAC,GAAG,GAAG,IAAI;IAC5B,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IACZ,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,GAAG,IAAI;IACjC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IACzC,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,OAAO,CACjB,CAAC,GAAG,GAAG,EACP,QAAQ,GAAG,CAAC,EACZ,QAAQ,GAAG,KAAK,EAChB,CAAC,SAAS,GAAG,EAAE,GAAG,GAAG,EAAE,IACrB;IACF,WAAW,CAAC,EACR,CAAC,CACC,KAAK,EAAE,CAAC,EACR,GAAG,IAAI,EAAE,CAAC,KACP,GAAG,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC,GACrD,SAAS,CAAC;IACd,UAAU,CAAC,EACP,CAAC,CACC,MAAM,EAAE,GAAG,EACX,GAAG,IAAI,EAAE,CAAC,KACP,GAAG,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC,GACrD,SAAS,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAC3B,CAAC,GAAG,GAAG,EACP,QAAQ,GAAG,CAAC,EACZ,QAAQ,GAAG,KAAK,EAChB,CAAC,SAAS,GAAG,EAAE,GAAG,GAAG,EAAE,IACrB,CACF,SAAS,EAAE,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,EAC3B,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,GAAG,SAAS,EACvD,WAAW,CAAC,EAAE,CAAC,GAAG,SAAS,KACxB,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC,CAAC;AAElC,MAAM,WAAW,aAAa;IAC5B;;;;;;;;;;OAUG;IACH,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,EACzC,MAAM,EAAE,IAAI,EACZ,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,CAAC,GACJ,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,IAAI,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,GAClD,CAAC,GAAG,IAAI,EAAE,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,GACzB,KAAK,CAAC;CACX;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB;;;;;;OAMG;IACH,GAAG,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,KAAK,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;IAC1C;;;;;;OAMG;IACH,UAAU,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,KAAK,GAAG,CACvC,CACI;QACE,MAAM,EAAE,WAAW,CAAC;QACpB,KAAK,EAAE,GAAG,CAAC;KACZ,GACD;QACE,MAAM,EAAE,UAAU,CAAC;QACnB,MAAM,EAAE,GAAG,CAAC;KACb,CACJ,EAAE,CACJ,CAAC;IACF,OAAO,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,KAAK,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;IAC9C;;OAEG;IACH,SAAS,EAAE,iBAAiB,CAAC;IAC7B;;;;OAIG;IACH,KAAK,EAAE,CAAC,CAAC,SAAS,OAAO,EACvB,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,KACjE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IACrB,UAAU,EAAE,CAAC,CAAC,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;IAC/B,SAAS,EAAE,aAAa,CAAC;IACzB;;OAEG;IACH,SAAS,EAAE,aAAa,CAAC;IACzB,KAAK,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,QAAQ,GAAG,CAAC,EAAE,QAAQ,GAAG,KAAK,EAAE,CAAC,SAAS,GAAG,EAAE,GAAG,GAAG,EAAE,EACtE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,EAClB,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,GAAG,SAAS,EACvD,GAAG,WAAW,EAAE,CAAC,KACd,GAAG,CACN,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,KAAK,GAC3D,QAAQ,GACR,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CACtD,CAAC;IACF;;;;;;OAMG;IACH,IAAI,EAAE,CAAC,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ,GAAG,KAAK,EAC/C,SAAS,EAAE,CAAC,EACZ,WAAW,CAAC,EACR,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GACzD,SAAS,EACb,UAAU,CAAC,EACP,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GACnD,SAAS,KACV,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC,CAAC;CACnC,CAAC"}

package/src/types.ts

@@ -100,6 +100,27 @@ export type AsPromiseFunction<
   watcherArgs?: C | undefined,
 ) => Promise<TResult1 | TResult2>;
 
+export interface RetryableTool {
+  /**
+   * Create a function that retries the given function if the underlying
+   * async function rejects due to an upgrade disconnection. The return value
+   * of the created function is a vow that settles to the final retry result.
+   *
+   * The retried function should be idempotent.
+   *
+   * @param fnZone the zone for the named function
+   * @param name base name to use in the zone
+   * @param fn the retried function
+   */
+  <F extends (...args: any[]) => Promise<any>>(
+    fnZone: Zone,
+    name: string,
+    fn: F,
+  ): F extends (...args: infer Args) => Promise<infer R>
+    ? (...args: Args) => Vow<R>
+    : never;
+}
+
 export type VowTools = {
   /**
    * Vow-tolerant implementation of Promise.all that takes an iterable of vows
@@ -142,13 +163,11 @@ export type VowTools = {
     fn: (...args: any[]) => Vow<Awaited<T>> | Awaited<T> | PromiseVow<T>,
   ) => Vow<Awaited<T>>;
   makeVowKit: <T>() => VowKit<T>;
-  retriable: <F extends (...args: any[]) => Promise<any>>(
-    fnZone: Zone,
-    name: string,
-    fn: F,
-  ) => F extends (...args: infer Args) => Promise<infer R>
-    ? (...args: Args) => Vow<R>
-    : never;
+  retryable: RetryableTool;
+  /**
+   * @deprecated use `retryable`
+   */
+  retriable: RetryableTool;
   watch: <T = any, TResult1 = T, TResult2 = never, C extends any[] = any[]>(
     specimenP: EVow<T>,
     watcher?: Watcher<T, TResult1, TResult2, C> | undefined,

package/src/vow-utils.js

@@ -29,7 +29,7 @@ harden(isVow);
 /**
  * A vow is a passable tagged as 'Vow'.  Its payload is a record with
  * API-versioned remotables.  payload.vowV0 is the API for the `watch` and
- * `when` operators to use for retriable shortening of the vow chain.
+ * `when` operators to use for retryable shortening of the vow chain.
  *
  * If the specimen is a Vow, return its payload, otherwise undefined.
  *

package/vat.js

@@ -5,7 +5,10 @@
 
 /* global globalThis */
 // @ts-check
-import { isUpgradeDisconnection } from '@agoric/internal/src/upgrade-api.js';
+import {
+  isUpgradeDisconnection,
+  isAbandonedError,
+} from '@agoric/internal/src/upgrade-api.js';
 import { makeHeapZone } from '@agoric/base-zone/heap.js';
 
 import { prepareBasicVowTools } from './src/tools.js';
@@ -15,11 +18,16 @@ import makeE from './src/E.js';
 const isRetryableReason = (reason, priorRetryValue) => {
   if (
     isUpgradeDisconnection(reason) &&
-    (!priorRetryValue ||
+    (!isUpgradeDisconnection(priorRetryValue) ||
       reason.incarnationNumber > priorRetryValue.incarnationNumber)
   ) {
     return reason;
   }
+  // For abandoned errors there is no way to differentiate errors from
+  // consecutive upgrades
+  if (isAbandonedError(reason) && !isAbandonedError(priorRetryValue)) {
+    return reason;
+  }
   return undefined;
 };