fix: client no longer delays when it wont retry (#51)

* fix: client no longer delays when it wont retry * chore: added jsdoc retry critical error behaviour --------- Co-authored-by: chris stevens <chris.stevens01.ext@bbc.co.uk>
bbc · Sep 13, 2024 · 5958210 · 5958210
1 parent 0c04335
commit 5958210
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/lib/client.js b/lib/client.js
@@ -353,14 +353,17 @@ function toRetry(err) {
   };
 }
 
+/**
+ * Retries only work on critical HTTP 5XX errors
+ */
 function retry(fn, ctx) {
   ctx.retryAttempts = [];
   const maxAttempts = ctx.retries;
 
   function attempt(i) {
     return fn(ctx)
       .catch((err) => {
-        if (maxAttempts > 0) {
+        if (i < maxAttempts && isCriticalError(err) && ctx.retryDelay && ctx.retryDelay > 0) {
           const delayBy = rejectedPromise(ctx.retryDelay);
           return delayBy(err);
         }

diff --git a/lib/context.js b/lib/context.js
@@ -10,6 +10,9 @@ const USER_AGENT = `${packageInfo.name}/${packageInfo.version}`;
 
 class Context {
   constructor(defaults) {
+    /**
+     * Retries only work on critical HTTP 5XX errors
+     */
     this.retries = 0;
     this.redirect = undefined;
     this._retryAttempts = [];