Adds retry jitter to the retry for 429 requests (#593)

Co-authored-by: michelle <Michelle Wan>
moltin · Feb 25, 2022 · 2c1d230 · 2c1d230
1 parent e13c9af
commit 2c1d230
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 4 deletions.
diff --git a/src/config.js b/src/config.js
@@ -18,7 +18,8 @@ class Config {
       reauth,
       protocol,
       store_id,
-      retryDelay
+      retryDelay,
+      retryJitter
     } = options
 
     this.application = application
@@ -45,6 +46,7 @@ class Config {
     this.disableCart = disableCart || false
     this.reauth = reauth || true
     this.retryDelay = retryDelay || 1000
+    this.retryJitter = retryJitter || 500
   }
 }
 

diff --git a/src/factories/request.js b/src/factories/request.js
@@ -87,7 +87,8 @@ const fetchRetry = (
               )
                 .then(result => resolve(result))
                 .catch(error => reject(error)),
-            attempt * config.retryDelay
+            attempt * config.retryDelay +
+              Math.floor(Math.random() * config.retryJitter)
           )
         } else {
           reject(response.json)

diff --git a/src/types/config.d.ts b/src/types/config.d.ts
@@ -34,6 +34,7 @@ export interface ConfigOptions {
   disableCart?: Boolean
   reauth?: Boolean,
   retryDelay?: number
+  retryJitter?: number
 }
 
 export interface Config {
@@ -57,7 +58,8 @@ export interface Config {
     language: 'JS'
   }
   storage?: StorageFactory
-  retryDelay: number
+  retryDelay?: number
+  retryJitter?: number
 
   constructor(options: ConfigOptions): void
 }

diff --git a/test/unit/error.ts b/test/unit/error.ts
@@ -12,7 +12,8 @@ const apiUrl = 'https://api.moltin.com/v2'
 describe('Moltin error handling', () => {
   const Moltin = MoltinGateway({
     client_id: 'XXX',
-    retryDelay: 10 // Reduce retryDelay for retries during testing
+    retryDelay: 10, // Reduce retryDelay/retryJitter for retries during testing
+    retryJitter: 1
   })
 
   it('should handle a 429 correctly', () => {