From 5908ea18948949e7bf2f8aef73fd8a7ed3d63099 Mon Sep 17 00:00:00 2001 From: harshithad0703 <104908717+harshithad0703@users.noreply.github.com> Date: Tue, 27 May 2025 11:37:42 +0530 Subject: [PATCH 1/3] Update .talismanrc --- .talismanrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.talismanrc b/.talismanrc index 80cd6c29..e784c309 100644 --- a/.talismanrc +++ b/.talismanrc @@ -16,4 +16,4 @@ fileignoreconfig: checksum: 6aab5edf85efb17951418b4dc4402889cd24c8d786c671185074aeb4d50f0242 - filename: test/sanity-check/api/stack-test.js checksum: 198d5cf7ead33b079249dc3ecdee61a9c57453e93f1073ed0341400983e5aa53 -version: "1.0" \ No newline at end of file +version: "1.0" From 786ad31eb70e5dd50fddf617e960093bb5d06276 Mon Sep 17 00:00:00 2001 From: harshithad0703 <104908717+harshithad0703@users.noreply.github.com> Date: Tue, 27 May 2025 11:39:04 +0530 Subject: [PATCH 2/3] Update .talismanrc From 3472b2fa29a8edee71d77b534f35c55aefc8a095 Mon Sep 17 00:00:00 2001 From: Nadeem Patwekar Date: Wed, 28 May 2025 13:17:57 +0530 Subject: [PATCH 3/3] enh: modify retry logic based on ratelimit remaining header --- CHANGELOG.md | 4 ++ lib/core/concurrency-queue.js | 30 ++++++++----- package-lock.json | 64 +------------------------- package.json | 2 +- test/unit/concurrency-Queue-test.js | 70 +++++++++++++++++++++++++++++ 5 files changed, 96 insertions(+), 74 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b638938a..6b74d43c 100644 --- a/CHANGELOG.md +++ b/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 diff --git a/lib/core/concurrency-queue.js b/lib/core/concurrency-queue.js index 868307e3..247184bd 100644 --- a/lib/core/concurrency-queue.js +++ b/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}` diff --git a/package-lock.json b/package-lock.json index 32aa93f5..be7d6f59 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@contentstack/management", - "version": "1.21.3", + "version": "1.21.4", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@contentstack/management", - "version": "1.21.3", + "version": "1.21.4", "license": "MIT", "dependencies": { "assert": "^2.1.0", @@ -83,8 +83,6 @@ }, "node_modules/@babel/cli": { "version": "7.27.0", - "resolved": "https://registry.npmjs.org/@babel/cli/-/cli-7.27.0.tgz", - "integrity": "sha512-bZfxn8DRxwiVzDO5CEeV+7IqXeCkzI4yYnrQbpwjT76CUyossQc6RYE7n+xfm0/2k40lPaCpW0FhxYs7EBAetw==", "dev": true, "license": "MIT", "dependencies": { @@ -134,8 +132,6 @@ }, "node_modules/@babel/core": { "version": "7.26.10", - "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.26.10.tgz", - "integrity": "sha512-vMqyb7XCDMPvJFFOaT9kxtiRh42GwlZEg1/uIgtZshS5a/8OaduUfCi7kynKgc3Tw/6Uo2D+db9qBttghhmxwQ==", "dev": true, "license": "MIT", "dependencies": { @@ -165,8 +161,6 @@ }, "node_modules/@babel/eslint-parser": { "version": "7.27.0", - "resolved": "https://registry.npmjs.org/@babel/eslint-parser/-/eslint-parser-7.27.0.tgz", - "integrity": "sha512-dtnzmSjXfgL/HDgMcmsLSzyGbEosi4DrGWoCNfuI+W4IkVJw6izpTe7LtOdwAXnkDqw5yweboYCTkM2rQizCng==", "dev": true, "license": "MIT", "dependencies": { @@ -184,8 +178,6 @@ }, "node_modules/@babel/eslint-parser/node_modules/eslint-visitor-keys": { "version": "2.1.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-2.1.0.tgz", - "integrity": "sha512-0rSmRBzXgDzIsD6mGdJgevzgezI534Cer5L/vyMX0kHzT/jiB43jRhd9YUlMGYLQy2zprNmoT8qasCGtY+QaKw==", "dev": true, "license": "Apache-2.0", "engines": { @@ -194,8 +186,6 @@ }, "node_modules/@babel/generator": { "version": "7.27.0", - "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.27.0.tgz", - "integrity": "sha512-VybsKvpiN1gU1sdMZIp7FcqphVVKEwcuj02x73uvcHE0PTihx1nlBcowYWhDwjpoAXRv43+gDzyggGnn1XZhVw==", "dev": true, "license": "MIT", "dependencies": { @@ -428,8 +418,6 @@ }, "node_modules/@babel/helpers": { "version": "7.27.0", - "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.27.0.tgz", - "integrity": "sha512-U5eyP/CTFPuNE3qk+WZMxFkp/4zUzdceQlfzf7DdGdhp+Fezd7HD+i8Y24ZuTMKX3wQBld449jijbGq6OdGNQg==", "dev": true, "license": "MIT", "dependencies": { @@ -442,8 +430,6 @@ }, "node_modules/@babel/parser": { "version": "7.27.0", - "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.27.0.tgz", - "integrity": "sha512-iaepho73/2Pz7w2eMS0Q5f83+0RKI7i4xmiYeBmDzfRVbQtTOG7Ts0S4HzJVsTMGI9keU8rNfuZr8DKfSt7Yyg==", "dev": true, "license": "MIT", "dependencies": { @@ -1370,8 +1356,6 @@ }, "node_modules/@babel/plugin-transform-runtime": { "version": "7.26.10", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-runtime/-/plugin-transform-runtime-7.26.10.tgz", - "integrity": "sha512-NWaL2qG6HRpONTnj4JvDU6th4jYeZOJgu3QhmFTCihib0ermtOJqktA5BduGm3suhhVe9EMP9c9+mfJ/I9slqw==", "dev": true, "license": "MIT", "dependencies": { @@ -1634,8 +1618,6 @@ }, "node_modules/@babel/runtime": { "version": "7.27.0", - "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.27.0.tgz", - "integrity": "sha512-VtPOkrdPHZsKc/clNqyi9WUA8TINkZ4cGk63UUE3u4pmB2k+ZMQRDuIOagv8UVd6j7k0T3+RRIb7beKTebNbcw==", "dev": true, "license": "MIT", "dependencies": { @@ -1647,8 +1629,6 @@ }, "node_modules/@babel/template": { "version": "7.27.0", - "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.27.0.tgz", - "integrity": "sha512-2ncevenBqXI6qRMukPlXwHKHchC7RyMuu4xv5JBXRfOGVcTy1mXCD12qrp7Jsoxll1EV3+9sE4GugBVRjT2jFA==", "dev": true, "license": "MIT", "dependencies": { @@ -1662,8 +1642,6 @@ }, "node_modules/@babel/traverse": { "version": "7.27.0", - "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.27.0.tgz", - "integrity": "sha512-19lYZFzYVQkkHkl4Cy4WrAVcqBkgvV2YM2TU3xG6DIwO7O3ecbDPfW3yM3bjAGcqcQHi+CCtjMR3dIEHxsd6bA==", "dev": true, "license": "MIT", "dependencies": { @@ -1681,8 +1659,6 @@ }, "node_modules/@babel/types": { "version": "7.27.0", - "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.27.0.tgz", - "integrity": "sha512-H45s8fVLYjbhFH62dIJ3WtmJ6RSPt/3DRO0ZcT2SUiYiQyz3BLVb9ADEnLl91m74aQPS3AzzeajZHYOalWe3bg==", "dev": true, "license": "MIT", "dependencies": { @@ -2637,8 +2613,6 @@ }, "node_modules/@nicolo-ribaudo/eslint-scope-5-internals": { "version": "5.1.1-v1", - "resolved": "https://registry.npmjs.org/@nicolo-ribaudo/eslint-scope-5-internals/-/eslint-scope-5-internals-5.1.1-v1.tgz", - "integrity": "sha512-54/JRvkLIzzDWshCWfuhadfrfZVPiElY8Fcgmg1HroEly/EDSszzhBAsarCux+D/kOslTRquNzuyGSmUSTTHGg==", "dev": true, "license": "MIT", "dependencies": { @@ -2647,8 +2621,6 @@ }, "node_modules/@nicolo-ribaudo/eslint-scope-5-internals/node_modules/eslint-scope": { "version": "5.1.1", - "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", - "integrity": "sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==", "dev": true, "license": "BSD-2-Clause", "dependencies": { @@ -2661,8 +2633,6 @@ }, "node_modules/@nicolo-ribaudo/eslint-scope-5-internals/node_modules/estraverse": { "version": "4.3.0", - "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz", - "integrity": "sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==", "dev": true, "license": "BSD-2-Clause", "engines": { @@ -3087,8 +3057,6 @@ }, "node_modules/@types/mocha": { "version": "8.2.3", - "resolved": "https://registry.npmjs.org/@types/mocha/-/mocha-8.2.3.tgz", - "integrity": "sha512-ekGvFhFgrc2zYQoX4JeZPmVzZxw6Dtllga7iGHzfbYIYkAMUx/sAFP2GdFpLff+vdHXu5fl7WX9AT+TtqYcsyw==", "dev": true, "license": "MIT" }, @@ -3667,8 +3635,6 @@ }, "node_modules/assert": { "version": "2.1.0", - "resolved": "https://registry.npmjs.org/assert/-/assert-2.1.0.tgz", - "integrity": "sha512-eLHpSK/Y4nhMJ07gDaAzoX/XAKS8PSaojml3M0DM4JpV1LAi5JOJ/p6H/XWrl8L+DzVEvVCW1z3vWAaB9oTsQw==", "license": "MIT", "dependencies": { "call-bind": "^1.0.2", @@ -3713,8 +3679,6 @@ }, "node_modules/axios": { "version": "1.9.0", - "resolved": "https://registry.npmjs.org/axios/-/axios-1.9.0.tgz", - "integrity": "sha512-re4CqKTJaURpzbLHtIi6XpDv20/CnpXOtjRY5/CU32L8gU8ek9UIivcfvSWvmKEngmVbrUtPpdDwWDWL7DNHvg==", "license": "MIT", "dependencies": { "follow-redirects": "^1.15.6", @@ -3981,8 +3945,6 @@ }, "node_modules/babel-plugin-polyfill-corejs3": { "version": "0.11.1", - "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.11.1.tgz", - "integrity": "sha512-yGCqvBT4rwMczo28xkH/noxJ6MZ4nJfkVYdoDaC/utLtWrXxv27HVrzAeSbqR8SxDsp46n0YF47EbHoixy6rXQ==", "dev": true, "license": "MIT", "dependencies": { @@ -4173,8 +4135,6 @@ }, "node_modules/base64-js": { "version": "1.5.1", - "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz", - "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==", "funding": [ { "type": "github", @@ -4311,8 +4271,6 @@ }, "node_modules/buffer": { "version": "6.0.3", - "resolved": "https://registry.npmjs.org/buffer/-/buffer-6.0.3.tgz", - "integrity": "sha512-FTiCpNxtwiZZHEZbcbTIcZjERVICn9yq/pDFkTl95/AxzD1naBctN7YO68riM/gLSDY7sdrMby8hofADYuuqOA==", "funding": [ { "type": "github", @@ -5045,8 +5003,6 @@ }, "node_modules/dotenv": { "version": "16.5.0", - "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-16.5.0.tgz", - "integrity": "sha512-m/C+AwOAr9/W1UOIZUo232ejMNnJAJtYQjUbHoNTBNTJSvqzzDh7vnrei3o3r3m9blf6ZoDkvcw0VmozNRFJxg==", "dev": true, "license": "BSD-2-Clause", "engines": { @@ -6577,8 +6533,6 @@ }, "node_modules/husky": { "version": "9.1.7", - "resolved": "https://registry.npmjs.org/husky/-/husky-9.1.7.tgz", - "integrity": "sha512-5gs5ytaNjBrh5Ow3zrvdUUY+0VxIuWVL4i9irt6friV+BqdCfmV11CQTWMiBYWHbXhco+J1kHfTOUkePhCDvMA==", "license": "MIT", "bin": { "husky": "bin.js" @@ -6603,8 +6557,6 @@ }, "node_modules/ieee754": { "version": "1.2.1", - "resolved": "https://registry.npmjs.org/ieee754/-/ieee754-1.2.1.tgz", - "integrity": "sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==", "funding": [ { "type": "github", @@ -7040,8 +6992,6 @@ }, "node_modules/is-nan": { "version": "1.3.2", - "resolved": "https://registry.npmjs.org/is-nan/-/is-nan-1.3.2.tgz", - "integrity": "sha512-E+zBKpQ2t6MEo1VsonYmluk9NxGrbzpeeLC2xIViuO2EjU2xsXsBPwTr3Ykv9l08UYEVEdWeRZNouaZqF6RN0w==", "license": "MIT", "dependencies": { "call-bind": "^1.0.0", @@ -10724,8 +10674,6 @@ }, "node_modules/readable-stream": { "version": "3.6.2", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", - "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", "license": "MIT", "dependencies": { "inherits": "^2.0.3", @@ -11616,8 +11564,6 @@ }, "node_modules/stream-browserify": { "version": "3.0.0", - "resolved": "https://registry.npmjs.org/stream-browserify/-/stream-browserify-3.0.0.tgz", - "integrity": "sha512-H73RAHsVBapbim0tU2JwwOiXUj+fikfiaoYAKHF3VJfA0pe2BCzkhAHBlLG6REzE+2WNZcxOXjK7lkso+9euLA==", "license": "MIT", "dependencies": { "inherits": "~2.0.4", @@ -11626,8 +11572,6 @@ }, "node_modules/string_decoder": { "version": "1.3.0", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", - "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==", "license": "MIT", "dependencies": { "safe-buffer": "~5.2.0" @@ -12486,8 +12430,6 @@ }, "node_modules/util": { "version": "0.12.5", - "resolved": "https://registry.npmjs.org/util/-/util-0.12.5.tgz", - "integrity": "sha512-kZf/K6hEIrWHI6XqOFUiiMa+79wE/D8Q+NCNAWclkyg3b4d2k7s0QGepNjiABc+aR3N1PAyHL7p6UcLY6LmrnA==", "license": "MIT", "dependencies": { "inherits": "^2.0.3", @@ -12499,8 +12441,6 @@ }, "node_modules/util-deprecate": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", - "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==", "license": "MIT" }, "node_modules/utils-merge": { diff --git a/package.json b/package.json index d2e6a11a..e2844460 100644 --- a/package.json +++ b/package.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", diff --git a/test/unit/concurrency-Queue-test.js b/test/unit/concurrency-Queue-test.js index de3e2197..f90e85c2 100644 --- a/test/unit/concurrency-Queue-test.js +++ b/test/unit/concurrency-Queue-test.js @@ -506,6 +506,76 @@ describe('Concurrency queue test', () => { }) .catch(done) }) + + it('should not retry when rate limit remaining is 0', done => { + const mock = new MockAdapter(api) + mock.onGet('/ratelimit').reply(429, { errorCode: 429 }, { + 'x-ratelimit-remaining': '0' + }) + + reconfigureQueue({ + retryOnError: true, + retryLimit: 3, + retryDelay: 300 + }) + + api.get('/ratelimit') + .catch(error => { + expect(error.response.status).to.equal(429) + expect(error.config.retryCount).to.equal(0) // Should not have retried + expect(logHandlerStub.callCount).to.equal(0) // No retry logs + mock.restore() + done() + }) + }) + + it('should retry when rate limit remaining is greater than 0', done => { + const mock = new MockAdapter(api) + mock.onGet('/ratelimit').reply(429, { errorCode: 429 }, { + 'x-ratelimit-remaining': '5' + }) + mock.onGet('/ratelimit').reply(200, { success: true }) + + reconfigureQueue({ + retryOnError: true, + retryLimit: 3, + retryDelay: 300 + }) + + api.get('/ratelimit') + .then(response => { + /* eslint-disable no-unused-expressions */ + expect(response.status).to.equal(200) + expect(response.data.success).to.be.true + /* eslint-enable no-unused-expressions */ + mock.restore() + done() + }) + .catch(done) + }) + + it('should retry when rate limit remaining header is not present', done => { + const mock = new MockAdapter(api) + mock.onGet('/ratelimit').reply(429, { errorCode: 429 }) + mock.onGet('/ratelimit').reply(200, { success: true }) + + reconfigureQueue({ + retryOnError: true, + retryLimit: 3, + retryDelay: 300 + }) + + api.get('/ratelimit') + .then(response => { + /* eslint-disable no-unused-expressions */ + expect(response.status).to.equal(200) + expect(response.data.success).to.be.true + /* eslint-enable no-unused-expressions */ + mock.restore() + done() + }) + .catch(done) + }) }) function makeConcurrencyQueue (config) {