Merge pull request #40 from ndowmon/allow-async-handleError-signed-co…

…mmits Allow async handleError
lifeomic · Oct 19, 2021 · d273f62 · d273f62
2 parents ecb6d8c + 62316ad
commit d273f62
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -163,7 +163,7 @@ to your target environment.
 
   (default: `0`)
 
-- **`handleError`**: `(err, context, options) => void`
+- **`handleError`**: `(err, context, options) => Promise<void> | void`
 
   `handleError` is a function that will be invoked when an error occurs
   for an attempt. The first argument is the error and the second

diff --git a/src/index.ts b/src/index.ts
@@ -8,7 +8,7 @@ export interface AttemptContext {
 export type AttemptFunction<T> = (context: AttemptContext, options: AttemptOptions<T>) => Promise<T>;
 export type BeforeAttempt<T> = (context: AttemptContext, options: AttemptOptions<T>) => void;
 export type CalculateDelay<T> = (context: AttemptContext, options: AttemptOptions<T>) => number;
-export type HandleError<T> = (err: any, context: AttemptContext, options: AttemptOptions<T>) => void;
+export type HandleError<T> = (err: any, context: AttemptContext, options: AttemptOptions<T>) => Promise<void> | void;
 export type HandleTimeout<T> = (context: AttemptContext, options: AttemptOptions<T>) => Promise<T>;
 
 export interface AttemptOptions<T> {
@@ -139,7 +139,7 @@ export async function retry<T> (
 
     const onError = async (err: any) => {
       if (options.handleError) {
-        options.handleError(err, context, options);
+        await options.handleError(err, context, options);
       }
 
       if (context.aborted || (context.attemptsRemaining === 0)) {

diff --git a/test/index.test.ts b/test/index.test.ts
@@ -460,6 +460,26 @@ test('should allow attempts to be aborted via handleError', async (t) => {
   t.is(err.retryable, false);
 });
 
+test('should wait for async handleError to resolve before retrying', async (t) => {
+  let promiseHasResolved = false;
+  await t.notThrows(retry(async ({ attemptNum }) => {
+    if (attemptNum === 0) {
+      throw new Error('Try again after handleError resolves.');
+    }
+    if (!promiseHasResolved) {
+      throw new Error('handleError has not yet resolved!');
+    }
+    return 'handleError has resolved';
+  }, {
+    delay: 0,
+    maxAttempts: 2,
+    handleError: async () => {
+      await sleep(1000);
+      promiseHasResolved = true;
+    }
+  }));
+});
+
 test('should allow handleError to return new error', async (t) => {
   const err = await t.throws(retry(async (context) => {
     if (context.attemptNum === 1) {