Merge pull request #365 from contentstack/enhancement/DX-2970

enh: modify retry logic based on ratelimit remaining header

Author: nadeem-cs

CHANGELOG.md

@@ -1,4 +1,8 @@
 # Changelog
+## [v1.21.4](https://github.com/contentstack/contentstack-management-javascript/tree/v1.21.4) (2025-06-02)
+ - Enhancement
+   - Retry Logic modification on x-ratelimit-remaining Header
+
 ## [v1.21.3](https://github.com/contentstack/contentstack-management-javascript/tree/v1.21.3) (2025-05-26)
  - Enhancement
    - Update addSettings Method to Support Generic Stack Settings Update

lib/core/concurrency-queue.js

@@ -229,6 +229,7 @@ export function ConcurrencyQueue ({ axios, config }) {
     if (!this.config.retryOnError || networkError > this.config.retryLimit) {
       return Promise.reject(responseHandler(error))
     }
+    // Check rate limit remaining header before retrying
 
     // Error handling
     const wait = this.config.retryDelay
@@ -244,19 +245,26 @@ export function ConcurrencyQueue ({ axios, config }) {
       } else {
         return Promise.reject(responseHandler(error))
       }
-    } else if ((response.status === 401 && this.config.refreshToken)) {
-      retryErrorType = `Error with status: ${response.status}`
-      networkError++
-
-      if (networkError > this.config.retryLimit) {
+    } else {
+      const rateLimitRemaining = response.headers['x-ratelimit-remaining']
+      if (rateLimitRemaining !== undefined && parseInt(rateLimitRemaining) <= 0) {
         return Promise.reject(responseHandler(error))
       }
-      this.running.shift()
-      // Cool down the running requests
-      delay(wait, response.status === 401)
-      error.config.retryCount = networkError
-      // deepcode ignore Ssrf: URL is dynamic
-      return axios(updateRequestConfig(error, retryErrorType, wait))
+
+      if ((response.status === 401 && this.config.refreshToken)) {
+        retryErrorType = `Error with status: ${response.status}`
+        networkError++
+
+        if (networkError > this.config.retryLimit) {
+          return Promise.reject(responseHandler(error))
+        }
+        this.running.shift()
+        // Cool down the running requests
+        delay(wait, response.status === 401)
+        error.config.retryCount = networkError
+        // deepcode ignore Ssrf: URL is dynamic
+        return axios(updateRequestConfig(error, retryErrorType, wait))
+      }
     }
     if (this.config.retryCondition && this.config.retryCondition(error)) {
       retryErrorType = error.response ? `Error with status: ${response.status}` : `Error Code:${error.code}`

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/management",
-  "version": "1.21.3",
+  "version": "1.21.4",
   "description": "The Content Management API is used to manage the content of your Contentstack account",
   "main": "./dist/node/contentstack-management.js",
   "browser": "./dist/web/contentstack-management.js",