@resolution/atlassian-api-common 0.13.0 → 0.13.2

package/lib/retryOnNetworkAndInternalErrors.d.ts

@@ -1,4 +1,4 @@
 /**
  * An implementation of the shouldRetryOnError function that retries on network and internal errors.
  */
-export declare function retryOnNetworkAndInternalErrors(error: Error, attemptNumber: number): boolean;
+export declare function retryOnNetworkAndInternalErrors(error: Error, attemptNumber: number): Promise<boolean> | boolean;

package/lib/retryOnNetworkAndInternalErrors.js

@@ -2,18 +2,46 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.retryOnNetworkAndInternalErrors = void 0;
 const ApiError_1 = require("./ApiError");
+/**
+ * A helper async function that waits for a given amount of time and then returns true.
+ */
+function waitAndReturnTrue(ms) {
+    return new Promise((resolve) => setTimeout(() => resolve(true), ms));
+}
+const delayGrowStep = 100;
+/**
+ * The range of the jitter multiplier, follows recommendation from Atlassian.
+ * @see https://developer.atlassian.com/cloud/jira/platform/rate-limiting/#response-handling-pseudo-code
+ */
+const jitterMultiplierRange = [0.7, 1.3];
 /**
  * An implementation of the shouldRetryOnError function that retries on network and internal errors.
  */
 function retryOnNetworkAndInternalErrors(error, attemptNumber) {
-    if (!(error instanceof ApiError_1.ApiError)) {
+    if (!(error instanceof ApiError_1.ApiError) || attemptNumber >= 3) {
         return false;
     }
-    if (attemptNumber >= 3) {
-        return false;
+    const delayMultiplier = 1 +
+        Math.random() * (jitterMultiplierRange[1] - jitterMultiplierRange[0]) +
+        jitterMultiplierRange[0];
+    const defaultDelayBeforeRetry = attemptNumber * delayGrowStep * delayMultiplier;
+    // Network error.
+    if (!error.response) {
+        return waitAndReturnTrue(defaultDelayBeforeRetry);
+    }
+    if (error.response.status === 429 ||
+        (error.response.status >= 500 && error.response.status < 600)) {
+        // Check Retry-After header according to Atlassian recommendations.
+        // See https://developer.atlassian.com/cloud/jira/platform/rate-limiting/#rate-limit-related-headers
+        if (error.response.headers["retry-after"]) {
+            const retryAfter = parseInt(error.response.headers["retry-after"], 10);
+            if (!isNaN(retryAfter)) {
+                return waitAndReturnTrue(retryAfter * 1000 * delayMultiplier);
+            }
+        }
+        return waitAndReturnTrue(defaultDelayBeforeRetry);
     }
-    return (!error.response ||
-        (error.response.status >= 500 && error.response.status < 600));
+    return false;
 }
 exports.retryOnNetworkAndInternalErrors = retryOnNetworkAndInternalErrors;
 //# sourceMappingURL=retryOnNetworkAndInternalErrors.js.map

package/lib/retryOnNetworkAndInternalErrors.js.map

@@ -1 +1 @@
-{"version":3,"file":"retryOnNetworkAndInternalErrors.js","sourceRoot":"","sources":["../src/retryOnNetworkAndInternalErrors.ts"],"names":[],"mappings":";;;AAAA,yCAAsC;AAEtC;;GAEG;AACH,SAAgB,+BAA+B,CAC7C,KAAY,EACZ,aAAqB;IAErB,IAAI,CAAC,CAAC,KAAK,YAAY,mBAAQ,CAAC,EAAE,CAAC;QACjC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,aAAa,IAAI,CAAC,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,CACL,CAAC,KAAK,CAAC,QAAQ;QACf,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAC,CAC9D,CAAC;AACJ,CAAC;AAdD,0EAcC"}
+{"version":3,"file":"retryOnNetworkAndInternalErrors.js","sourceRoot":"","sources":["../src/retryOnNetworkAndInternalErrors.ts"],"names":[],"mappings":";;;AAAA,yCAAsC;AAEtC;;GAEG;AACH,SAAS,iBAAiB,CAAC,EAAU;IACnC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;AACvE,CAAC;AAED,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B;;;GAGG;AACH,MAAM,qBAAqB,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAEzC;;GAEG;AACH,SAAgB,+BAA+B,CAC7C,KAAY,EACZ,aAAqB;IAErB,IAAI,CAAC,CAAC,KAAK,YAAY,mBAAQ,CAAC,IAAI,aAAa,IAAI,CAAC,EAAE,CAAC;QACvD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,eAAe,GACnB,CAAC;QACD,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACrE,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAE3B,MAAM,uBAAuB,GAC3B,aAAa,GAAG,aAAa,GAAG,eAAe,CAAC;IAElD,iBAAiB;IACjB,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;QACpB,OAAO,iBAAiB,CAAC,uBAAuB,CAAC,CAAC;IACpD,CAAC;IAED,IACE,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG;QAC7B,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAC,EAC7D,CAAC;QACD,mEAAmE;QACnE,oGAAoG;QACpG,IAAI,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;YAC1C,MAAM,UAAU,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC,CAAC;YACvE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;gBACvB,OAAO,iBAAiB,CAAC,UAAU,GAAG,IAAI,GAAG,eAAe,CAAC,CAAC;YAChE,CAAC;QACH,CAAC;QACD,OAAO,iBAAiB,CAAC,uBAAuB,CAAC,CAAC;IACpD,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AArCD,0EAqCC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@resolution/atlassian-api-common",
-  "version": "0.13.0",
+  "version": "0.13.2",
   "description": "Shared code across different implementations of Atlassian API Clients.",
   "main": "lib/index.js",
   "scripts": {
@@ -43,5 +43,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "efae5401ad76d0470aad8744f460e11dce3083b5"
+  "gitHead": "7fcfd1a5a87f4238a8e501a61dbac4503a97786d"
 }