@agoric/client-utils 0.1.1-dev-c236c55.0 → 0.1.1-dev-d19b293.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/client-utils",
-  "version": "0.1.1-dev-c236c55.0+c236c55",
+  "version": "0.1.1-dev-d19b293.0+d19b293",
   "description": "Utilities for building Agoric clients",
   "license": "Apache-2.0",
   "publishConfig": {
@@ -27,11 +27,11 @@
     "ts-blank-space": "^0.4.1"
   },
   "dependencies": {
-    "@agoric/casting": "0.4.3-dev-c236c55.0+c236c55",
-    "@agoric/ertp": "0.16.3-dev-c236c55.0+c236c55",
-    "@agoric/internal": "0.3.3-dev-c236c55.0+c236c55",
-    "@agoric/smart-wallet": "0.5.4-dev-c236c55.0+c236c55",
-    "@agoric/vats": "0.15.2-dev-c236c55.0+c236c55",
+    "@agoric/casting": "0.4.3-dev-d19b293.0+d19b293",
+    "@agoric/ertp": "0.16.3-dev-d19b293.0+d19b293",
+    "@agoric/internal": "0.3.3-dev-d19b293.0+d19b293",
+    "@agoric/smart-wallet": "0.5.4-dev-d19b293.0+d19b293",
+    "@agoric/vats": "0.15.2-dev-d19b293.0+d19b293",
     "@cosmjs/stargate": "^0.32.3",
     "@cosmjs/tendermint-rpc": "^0.32.3",
     "@endo/common": "^1.2.7",
@@ -58,5 +58,5 @@
     ],
     "timeout": "20m"
   },
-  "gitHead": "c236c55c008a83a28d324026dcc4a8411a0c4f05"
+  "gitHead": "d19b293d5b28a2d78754eb7912771bdb66d5fb37"
 }

package/src/sync-tools.js

@@ -16,6 +16,7 @@
  * @typedef {object} RetryOptions
  * @property {number} [maxRetries]
  * @property {number} [retryIntervalMs]
+ * @property {boolean} [reusePromise]
  *
  * @typedef {RetryOptions & {errorMessage: string}} WaitUntilOptions
  *
@@ -48,19 +49,51 @@ export const retryUntilCondition = async (
   operation,
   condition,
   message,
-  { maxRetries = 6, retryIntervalMs = 3500, log = console.log, setTimeout },
+  {
+    maxRetries = 6,
+    retryIntervalMs = 3500,
+    reusePromise = false,
+    // XXX mixes ocaps with configuration options
+    log = console.log,
+    setTimeout,
+  },
 ) => {
-  console.log({ maxRetries, retryIntervalMs, message });
-  let retries = 0;
+  console.log({ maxRetries, retryIntervalMs, reusePromise, message });
 
   await null; // separate sync prologue
 
+  const timedOut = Symbol('timed out');
+  let retries = 0;
+  /** @type {Promise | undefined } */
+  let resultP;
   while (retries < maxRetries) {
     try {
-      const result = await operation();
-      log('RESULT', result);
-      if (condition(result)) {
-        return result;
+      if (!reusePromise || !resultP) {
+        resultP = operation();
+        const makeCleanup = ref => {
+          const cleanup = () => {
+            if (resultP === ref) {
+              resultP = undefined;
+            }
+          };
+          return cleanup;
+        };
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
+        resultP.finally(makeCleanup(resultP));
+      }
+      const result = await Promise.race([
+        resultP,
+        // Overload the retryIntervalMs to apply both *to* and *between* iterations
+        sleep(retryIntervalMs, { log() {}, setTimeout }).then(() => timedOut),
+      ]);
+      if (result === timedOut) {
+        log(`Attempt ${retries + 1} timed out`);
+        if (!reusePromise) resultP = undefined;
+      } else {
+        log('RESULT', result);
+        if (condition(result)) {
+          return result;
+        }
       }
     } catch (error) {
       if (error instanceof Error) {
@@ -82,13 +115,14 @@ export const retryUntilCondition = async (
 
 /**
  * @param {WaitUntilOptions} options
+ * @returns {WaitUntilOptions & {log?: typeof console.log}}
  */
 const overrideDefaultOptions = options => {
   const defaultValues = {
     maxRetries: 6,
     retryIntervalMs: 3500,
-    log: console.log,
     errorMessage: 'Error',
+    log: console.log,
   };
 
   return { ...defaultValues, ...options };
@@ -118,14 +152,13 @@ export const waitUntilContractDeployed = (
 ) => {
   const { follow, setTimeout } = ambientAuthority;
   const getInstances = makeGetInstances(follow);
-  const { maxRetries, retryIntervalMs, errorMessage, log } =
-    overrideDefaultOptions(options);
+  const { errorMessage, ...resolvedOptions } = overrideDefaultOptions(options);
 
   return retryUntilCondition(
     getInstances,
     instanceObject => Object.keys(instanceObject).includes(contractName),
     errorMessage,
-    { maxRetries, retryIntervalMs, log, setTimeout },
+    { setTimeout, ...resolvedOptions },
   );
 };
 
@@ -156,14 +189,13 @@ const checkCosmosBalance = (balances, threshold) => {
 export const waitUntilAccountFunded = (destAcct, io, threshold, options) => {
   const { query, setTimeout } = io;
   const queryCosmosBalance = makeQueryCosmosBalance(query);
-  const { maxRetries, retryIntervalMs, errorMessage, log } =
-    overrideDefaultOptions(options);
+  const { errorMessage, ...resolvedOptions } = overrideDefaultOptions(options);
 
   return retryUntilCondition(
     async () => queryCosmosBalance(destAcct),
     balances => checkCosmosBalance(balances, threshold),
     errorMessage,
-    { maxRetries, retryIntervalMs, log, setTimeout },
+    { setTimeout, ...resolvedOptions },
   );
 };
 
@@ -211,14 +243,13 @@ export const waitUntilOfferResult = (
 ) => {
   const { follow, setTimeout } = io;
   const queryWallet = makeQueryWallet(follow);
-  const { maxRetries, retryIntervalMs, errorMessage, log } =
-    overrideDefaultOptions(options);
+  const { errorMessage, ...resolvedOptions } = overrideDefaultOptions(options);
 
   return retryUntilCondition(
     async () => queryWallet(addr),
     status => checkOfferState(status, waitForPayouts, offerId),
     errorMessage,
-    { maxRetries, retryIntervalMs, log, setTimeout },
+    { reusePromise: true, setTimeout, ...resolvedOptions },
   );
 };
 
@@ -247,13 +278,12 @@ const checkForInvitation = update => {
 export const waitUntilInvitationReceived = (addr, io, options) => {
   const { follow, setTimeout } = io;
   const queryWallet = makeQueryWallet(follow);
-  const { maxRetries, retryIntervalMs, errorMessage, log } =
-    overrideDefaultOptions(options);
+  const { errorMessage, ...resolvedOptions } = overrideDefaultOptions(options);
 
   return retryUntilCondition(
     async () => queryWallet(addr),
     checkForInvitation,
     errorMessage,
-    { maxRetries, retryIntervalMs, log, setTimeout },
+    { reusePromise: true, setTimeout, ...resolvedOptions },
   );
 };