feat: shouldretry function

#297
kukhariev · May 6, 2021 · 445d7b0 · 445d7b0
1 parent 637e258
commit 445d7b0
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/src/uploadx/lib/retry-handler.spec.ts b/src/uploadx/lib/retry-handler.spec.ts
@@ -1,4 +1,4 @@
-import { ErrorType, RetryHandler } from './retry-handler';
+import { ErrorType, RetryHandler, ShouldRetryFunction } from './retry-handler';
 
 describe('ErrorHandler', () => {
   it('ErrorHandler.kind(status)', () => {
@@ -11,4 +11,12 @@ describe('ErrorHandler', () => {
     expect(errorHandler.kind(404)).toBe(ErrorType.NotFound);
     expect(errorHandler.kind(401)).toBe(ErrorType.Auth);
   });
+
+  it('Custom shouldRetry', () => {
+    const shouldRetry: ShouldRetryFunction = (c, a = 0) => c === 500 && a < 2;
+    const errorHandler = new RetryHandler({ shouldRetry });
+    expect(errorHandler.kind(500)).toBe(ErrorType.Retryable);
+    errorHandler.attempts = 3;
+    expect(errorHandler.kind(500)).toBe(ErrorType.Fatal);
+  });
 });
diff --git a/src/uploadx/lib/retry-handler.ts b/src/uploadx/lib/retry-handler.ts
@@ -5,6 +5,8 @@ export enum ErrorType {
   Fatal
 }
 
+export type ShouldRetryFunction = (code: number, attempts?: number) => boolean;
+
 export interface RetryConfig {
   /** Maximum number of retry attempts */
   maxAttempts?: number;
@@ -14,6 +16,8 @@ export interface RetryConfig {
   authErrorCodes?: number[];
   /** Retryable 4xx status codes */
   shouldRetryCodes?: number[];
+  /** Overrides the built-in function that determines whether the operation should be repeated */
+  shouldRetry?: ShouldRetryFunction;
   minDelay?: number;
   maxDelay?: number;
 }
@@ -23,6 +27,9 @@ const defaultRetryConfig: Required<RetryConfig> = {
   shouldRestartCodes: [404, 410],
   authErrorCodes: [401],
   shouldRetryCodes: [423, 429],
+  shouldRetry(code: number): boolean {
+    return code < 400 || code >= 500 || this.shouldRetryCodes.indexOf(code) !== -1;
+  },
   minDelay: 500,
   maxDelay: 50000
 };
@@ -50,7 +57,7 @@ export class RetryHandler {
     if (this.config.shouldRestartCodes.indexOf(code) !== -1) {
       return ErrorType.NotFound;
     }
-    if (code < 400 || code >= 500 || this.config.shouldRetryCodes.indexOf(code) !== -1) {
+    if (this.config.shouldRetry(code, this.attempts)) {
       return ErrorType.Retryable;
     }
     return ErrorType.Fatal;