@mimik/request-retry 4.0.6 → 4.0.8

package/.husky/pre-commit

@@ -1,4 +1,2 @@
 #!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
 npm run commit-ready

package/.husky/pre-push

@@ -1,4 +1,2 @@
 #!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
 npm run test

package/README.md

@@ -4,20 +4,21 @@
 **Example**  
 ```js
 import { rpRetry } from '@mimik/request-retry';
-or
+// or
 import rp from '@mimik/request-retry';
 ```
 <a name="module_request-retry..rpRetry"></a>
 
-### request-retry~rpRetry(options) ⇒ <code>Promise</code>
+### request-retry~rpRetry(options) ⇒ <code>Promise.&lt;object&gt;</code>
 Make a request with retries.
 
 **Kind**: inner method of [<code>request-retry</code>](#module_request-retry)  
+**Returns**: <code>Promise.&lt;object&gt;</code> - A bluebird promise (supports cancellation).  
 **Category**: async  
 **Throws**:
 
-- <code>Error</code> An error produced by `getRichError`, wrapping an error from
-[request-promise](https://www.npmjs.com/package/request-promise) or a `TimeoutError`.
+- <code>Error</code> An error produced by `getRichError`, wrapping an
+[Axios](https://www.npmjs.com/package/axios) error or a `TimeoutError`.
 
 The following properties may be added to the `options` object under the `retry` property:
 - retries `{int}`: Maximum number of retries, independent of the `retryStrategy`. Default: `2`.
@@ -27,9 +28,9 @@ The following properties may be added to the `options` object under the `retry`
 - delayStrategy `{function}`: A function that returns the delay (in milliseconds) to wait before the next retry.
   Signature: `(nbRetry, err, options, correlationId)`. Must return a number `> 0` and `< 30000`; otherwise `delay` is used.
 - logLevel `{object}`: Controls logging behavior:
-   - *response*: Log level for responses. Default: `silly` (invalid values fall back to `silly`).
-   - *error*: Log level for errors. Default: `silly` (invalid values fall back to `silly`).
-   - *request*: Log level for requests. Default: `silly` (invalid values fall back to `silly`).
+   - *response*: Log level for responses. Invalid values fall back to `silly`.
+   - *error*: Log level for errors. Invalid values fall back to `silly`.
+   - *request*: Log level for requests. Invalid values fall back to `silly`.
    - *responseDetails*: Detail level when displaying the response: `count`, `type`, or `full`. Default: `type`
      (invalid values fall back to `type`).
    - *responseName*: Label associated with the response. Default: `response`
@@ -55,8 +56,8 @@ defaultRetry = (...args) => {
 ```
 
 If `logLevel` is empty, requests and responses are logged at `info`, the response is logged with full details
-under the `response` property, and request errors generate a `warn`. If `logLevel` is provided but incomplete,
-the provided keys override the defaults.
+under the `response` property, and request errors generate a `warn`. If logLevel is provided but incomplete,
+only the provided keys are active; missing keys disable that logging.
 
 If not already set, the `User-Agent` header is set to:
 `mimik-{serverType}/{serverVersion}/{serverId} {architecture} {node}`.

package/eslint.config.js

@@ -1,3 +1,4 @@
+import globals from 'globals';
 import importPlugin from 'eslint-plugin-import';
 import js from '@eslint/js';
 import processDoc from '@mimik/eslint-plugin-document-env';
@@ -10,13 +11,13 @@ const MAX_LINES_IN_FUNCTION = 150;
 const MAX_STATEMENTS_IN_FUNCTION = 45;
 const MIN_KEYS_IN_OBJECT = 10;
 const MAX_COMPLEXITY = 30;
-const ECMA_VERSION = 2022;
+const ECMA_VERSION = 'latest';
 const MAX_DEPTH = 6;
 const ALLOWED_CONSTANTS = [0, 1, -1];
 
 export default [
   {
-    ignores: ['mochawesome-report/**', 'node_modules/**', 'dist/**'],
+    ignores: ['coverage/**', 'mochawesome-report/**', 'node_modules/**', 'dist/**'],
   },
   importPlugin.flatConfigs.recommended,
   stylistic.configs.recommended,
@@ -28,10 +29,8 @@ export default [
     languageOptions: {
       ecmaVersion: ECMA_VERSION,
       globals: {
-        console: 'readonly',
-        describe: 'readonly',
-        it: 'readonly',
-        require: 'readonly',
+        ...globals.mocha,
+        ...globals.nodeBuiltin,
       },
       sourceType: 'module',
     },
@@ -39,6 +38,7 @@ export default [
       '@stylistic/brace-style': ['warn', 'stroustrup', { allowSingleLine: true }],
       '@stylistic/line-comment-position': ['off'],
       '@stylistic/max-len': ['warn', MAX_LENGTH_LINE, { ignoreComments: true, ignoreStrings: true, ignoreRegExpLiterals: true }],
+      '@stylistic/quotes': ['warn', 'single'],
       '@stylistic/semi': ['error', 'always'],
       'capitalized-comments': ['off'],
       'complexity': ['error', MAX_COMPLEXITY],
@@ -49,19 +49,20 @@ export default [
       'init-declarations': ['off'],
       'linebreak-style': ['off'],
       'max-depth': ['error', MAX_DEPTH],
+      'max-len': ['off'],
       'max-lines': ['warn', { max: MAX_LINES_IN_FILES, skipComments: true, skipBlankLines: true }],
       'max-lines-per-function': ['warn', { max: MAX_LINES_IN_FUNCTION, skipComments: true, skipBlankLines: true }],
       'max-params': ['error', MAX_FUNCTION_PARAMETERS],
       'max-statements': ['warn', MAX_STATEMENTS_IN_FUNCTION],
       'no-confusing-arrow': ['off'],
       'no-inline-comments': ['off'],
-      'no-magic-numbers': ['error', { ignore: ALLOWED_CONSTANTS, enforceConst: true, detectObjects: true }],
+      'no-magic-numbers': ['error', { ignore: ALLOWED_CONSTANTS, enforceConst: true, detectObjects: false }],
       'no-process-env': ['error'],
       'no-ternary': ['off'],
       'no-undefined': ['off'],
       'one-var': ['error', 'never'],
       'processDoc/validate-document-env': ['error'],
-      'quotes': ['warn', 'single'],
+      'quotes': ['off'],
       'sort-imports': ['error', { allowSeparatedGroups: true }],
       'sort-keys': ['error', 'asc', { caseSensitive: true, minKeys: MIN_KEYS_IN_OBJECT, natural: false, allowLineSeparatedGroups: true }],
     },

package/index.js

@@ -25,10 +25,8 @@ const DEFAULT_LOGLEVEL_RESPONSE = 'info';
 const DEFAULT_LOGLEVEL_ERROR = 'warn';
 const DEFAULT_LOGLEVEL_REQUEST = 'info';
 
-const MILLI_SECONDS = 0;
-const MILLI_NANO_SECONDS = 1;
 const MILLI = 1000;
-const NANO = 1e6;
+const NANO_TO_MS = 1000000;
 
 Promise.config({ cancellation: true });
 
@@ -36,7 +34,7 @@ Promise.config({ cancellation: true });
  * @module request-retry
  * @example
  * import { rpRetry } from '@mimik/request-retry';
- * or
+ * // or
  * import rp from '@mimik/request-retry';
  */
 
@@ -51,10 +49,10 @@ Promise.config({ cancellation: true });
  * The `validateStatus` option is disabled: an error is thrown for status codes outside **[200, 300)**.
  * An additional option, `resolveWithFullResponse`, controls the return shape:
  * when `true`, the full Axios response object is returned; when `false` or omitted, only `response.data` is returned.
- * @return {Promise}
+ * @return {Promise<object>} A bluebird promise (supports cancellation).
  * @fulfil {object} - The Axios response when `resolveWithFullResponse` is `true`; otherwise `response.data`.
- * @throws {Error} An error produced by `getRichError`, wrapping an error from
- * [request-promise](https://www.npmjs.com/package/request-promise) or a `TimeoutError`.
+ * @throws {Error} An error produced by `getRichError`, wrapping an
+ * [Axios](https://www.npmjs.com/package/axios) error or a `TimeoutError`.
  *
  * The following properties may be added to the `options` object under the `retry` property:
  * - retries `{int}`: Maximum number of retries, independent of the `retryStrategy`. Default: `2`.
@@ -64,9 +62,9 @@ Promise.config({ cancellation: true });
  * - delayStrategy `{function}`: A function that returns the delay (in milliseconds) to wait before the next retry.
  *   Signature: `(nbRetry, err, options, correlationId)`. Must return a number `> 0` and `< 30000`; otherwise `delay` is used.
  * - logLevel `{object}`: Controls logging behavior:
- *    - *response*: Log level for responses. Default: `silly` (invalid values fall back to `silly`).
- *    - *error*: Log level for errors. Default: `silly` (invalid values fall back to `silly`).
- *    - *request*: Log level for requests. Default: `silly` (invalid values fall back to `silly`).
+ *    - *response*: Log level for responses. Invalid values fall back to `silly`.
+ *    - *error*: Log level for errors. Invalid values fall back to `silly`.
+ *    - *request*: Log level for requests. Invalid values fall back to `silly`.
  *    - *responseDetails*: Detail level when displaying the response: `count`, `type`, or `full`. Default: `type`
  *      (invalid values fall back to `type`).
  *    - *responseName*: Label associated with the response. Default: `response`
@@ -92,8 +90,8 @@ Promise.config({ cancellation: true });
  * ```
  *
  * If `logLevel` is empty, requests and responses are logged at `info`, the response is logged with full details
- * under the `response` property, and request errors generate a `warn`. If `logLevel` is provided but incomplete,
- * the provided keys override the defaults.
+ * under the `response` property, and request errors generate a `warn`. If logLevel is provided but incomplete,
+ * only the provided keys are active; missing keys disable that logging.
  *
  * If not already set, the `User-Agent` header is set to:
  * `mimik-{serverType}/{serverVersion}/{serverId} {architecture} {node}`.
@@ -104,7 +102,7 @@ Promise.config({ cancellation: true });
  * - `qs` is mapped to Axios `params`.
  */
 export const rpRetry = (origOptions) => {
-  const startHrTime = process.hrtime();
+  const startHrTime = process.hrtime.bigint();
   const options = origOptions;
   const { metrics } = options;
   const enteredUrl = options.uri || options.url;
@@ -118,8 +116,7 @@ export const rpRetry = (origOptions) => {
   let mainTimeout;
   const measure = (statusCode) => {
     if (metrics && metrics.HTTPRequestDuration) {
-      const elapsedHrTime = process.hrtime(startHrTime);
-      const elapsedTimeInMs = elapsedHrTime[MILLI_SECONDS] * MILLI + elapsedHrTime[MILLI_NANO_SECONDS] / NANO;
+      const elapsedTimeInMs = Number(process.hrtime.bigint() - startHrTime) / NANO_TO_MS;
 
       metrics.HTTPRequestDuration
         .labels('rpRetry', options.method, metrics.url || enteredUrl, enteredUrl.includes('?'), statusCode)

package/lib/rp-axios-wrapper.js

@@ -13,7 +13,7 @@ const rp = (origOptions) => {
     delete options.body;
   }
   else if (typeof options.json === 'object') {
-    options.data = options.body;
+    options.data = options.json;
     delete options.json;
   }
   else delete options.json;

package/manual-test/man.js

@@ -1,5 +1,5 @@
 /* eslint-disable no-console */
-import './testEnv';
+import './testEnv.js';
 import { rpRetry } from '../index.js';
 
 const DELAY = 1000;

package/manual-test/retryMockMan.js

@@ -30,11 +30,11 @@ let message;
 
 app.use(bodyParser.json());
 app.get(`${config.base}${config.path}`, (req, res) => {
-  if (nbRequest === 0) message = 'Recieved first request';
+  if (nbRequest === 0) message = 'Received first request';
   else {
-    const timeLap = Date.now() - time;
+    const timeLapse = Date.now() - time;
 
-    message = `Received ${nbRequest} retry with timelap ${timeLap}`;
+    message = `Received ${nbRequest} retry with timelapse ${timeLapse}`;
   }
   console.log('----->', message);
   time = Date.now();
@@ -57,7 +57,7 @@ app.post(`${config.base}${config.path}`, (req, res) => {
 });
 
 app.post('/logs/:id', (req, res) => {
-  console.log('--->', 'Recieved a log');
+  console.log('--->', 'Received a log');
   console.log('---> id:', req.params.id);
   console.log('---> body:', req.body);
   res.statusCode = config.post.success;

package/manual-test/testEnv.js

@@ -1,5 +1,5 @@
 /* eslint no-process-env: "off" */
-import process from 'process';
+import process from 'node:process';
 
 /**
  * The following environment variables are set for the test:

package/manual-test/testRace.js

@@ -1,8 +1,5 @@
 /* eslint-disable no-console */
-import {
-  clearTimeout,
-  setTimeout,
-} from 'timers';
+import { clearTimeout, setTimeout } from 'node:timers';
 
 const MAX_INCR = 100000000;
 const MAIN_TIMEOUT = 1; // in millisecond

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@mimik/request-retry",
-  "version": "4.0.6",
+  "version": "4.0.8",
   "description": "Request retry wrapping axios",
   "main": "./index.js",
   "type": "module",
   "scripts": {
     "lint": "eslint . --no-error-on-unmatched-pattern",
     "docs": "jsdoc2md index.js > README.md",
-    "test": "mocha --reporter mochawesome --bail --check-leaks test/",
-    "test-ci": "c8 --reporter=lcov --reporter=text npm test --exit",
+    "test": "mocha --reporter mochawesome --bail --check-leaks --exit test/",
+    "test-ci": "c8 --reporter=lcov --reporter=text npm test",
     "prepublishOnly": "npm run docs && npm run lint && npm run test-ci",
     "commit-ready": "npm run docs && npm run lint && npm run test-ci"
   },
@@ -29,27 +29,27 @@
     "url": "https://bitbucket.org/mimiktech/request-retry"
   },
   "dependencies": {
-    "@mimik/request-helper": "^2.0.2",
-    "@mimik/response-helper": "^4.0.6",
-    "@mimik/sumologic-winston-logger": "^2.1.8",
-    "axios": "1.12.2",
+    "@mimik/request-helper": "^2.0.5",
+    "@mimik/response-helper": "^4.0.10",
+    "@mimik/sumologic-winston-logger": "^2.1.12",
+    "axios": "1.13.5",
     "bluebird": "3.7.2"
   },
   "devDependencies": {
-    "@eslint/js": "9.36.0",
+    "@eslint/js": "9.39.2",
     "@mimik/eslint-plugin-document-env": "^2.0.8",
-    "@stylistic/eslint-plugin": "5.4.0",
-    "acorn": "8.15.0",
-    "body-parser": "2.2.0",
+    "@stylistic/eslint-plugin": "5.9.0",
+    "body-parser": "2.2.2",
     "c8": "10.1.3",
-    "chai": "6.0.1",
-    "eslint": "9.36.0",
+    "chai": "6.2.2",
+    "eslint": "9.39.2",
     "eslint-plugin-import": "2.32.0",
-    "express": "5.1.0",
+    "express": "5.2.1",
+    "globals": "17.3.0",
     "husky": "9.1.7",
-    "jsdoc-to-markdown": "9.1.2",
-    "mocha": "11.7.2",
+    "jsdoc-to-markdown": "9.1.3",
+    "mocha": "11.7.5",
     "mochawesome": "7.1.4",
-    "sinon": "21.0.0"
+    "sinon": "21.0.1"
   }
 }

package/test/retryMock.js

@@ -30,11 +30,11 @@ let message;
 
 app.use(bodyParser.json());
 app.get(`${config.base}${config.path}`, (req, res) => {
-  if (nbRequest === 0) message = 'Recieved first request';
+  if (nbRequest === 0) message = 'Received first request';
   else {
-    const timeLap = Date.now() - time;
+    const timeLapse = Date.now() - time;
 
-    message = `Received ${nbRequest} retry with timelap ${timeLap}`;
+    message = `Received ${nbRequest} retry with timelapse ${timeLapse}`;
   }
   console.log('----->', message);
   time = Date.now();

package/test/rpRetry.spec.js

@@ -139,7 +139,7 @@ describe('request-retry Unit Tests', () => {
         expect(callArgs[CALL_ARG_MESSAGE]).to.equal('out of scope timeout, reset to min');
       });
     });
-    it('should generate warning: out of scope timeout: 150  becoming max', () => {
+    it('should generate warning: out of scope timeout: 150 becoming max', () => {
       options.retry.timeout = OUT_OF_SCOPE_RETRY_TIMEOUT;
       return rpRetry(options).then(() => {
         assert.calledOnce(loggerSpyWarn);
@@ -163,7 +163,7 @@ describe('request-retry Unit Tests', () => {
         assert.notCalled(loggerSpyWarn);
       });
     });
-    it('should generate warning: invalid retryStrategy: "notANumber" becoming default function', () => {
+    it('should generate warning: invalid retryStrategy: "notAFunction" becoming default function', () => {
       options.retry.retryStrategy = 'notAFunction';
       return rpRetry(options).then(() => {
         assert.calledOnce(loggerSpyWarn);
@@ -172,7 +172,7 @@ describe('request-retry Unit Tests', () => {
         expect(callArgs[CALL_ARG_MESSAGE]).to.equal('invalid retryStrategy, ignoring');
       });
     });
-    it('should generate warning: invalid delayStrategy: "notANumber" becoming delay or default', () => {
+    it('should generate warning: invalid delayStrategy: "notAFunction" becoming delay or default', () => {
       options.retry.delayStrategy = 'notAFunction';
       return rpRetry(options).then(() => {
         assert.calledOnce(loggerSpyWarn);
@@ -240,7 +240,7 @@ describe('request-retry Unit Tests', () => {
         expect(callArgs[CALL_ARG_MESSAGE]).to.equal('invalid logLevel.responseName, reset to default');
       });
     });
-    it('should generate warning: invalid logLevel.responseName ("    ""), reset to default', () => {
+    it('should generate warning: invalid logLevel.responseName (" "), reset to default', () => {
       options.retry.logLevel = {
         responseName: '    ',
       };
@@ -252,6 +252,63 @@ describe('request-retry Unit Tests', () => {
       });
     });
   });
+  describe('rpRetry(options) request mapping and response details', () => {
+    it('should succeed with body mapped to axios data', () => rpRetry({
+      method: 'POST',
+      headers: { 'x-correlation-id': correlationId },
+      url: 'http://localhost:9070/test/retry',
+      body: { test: 'data' },
+      retry: {},
+    }).then((response) => {
+      expect(response).to.have.property('statusCode');
+    }));
+    it('should succeed with json object mapped to axios data', () => rpRetry({
+      method: 'POST',
+      headers: { 'x-correlation-id': correlationId },
+      url: 'http://localhost:9070/test/retry',
+      json: { test: 'data' },
+      retry: {},
+    }).then((response) => {
+      expect(response).to.have.property('statusCode');
+    }));
+    it('should succeed with qs mapped to axios params', () => rpRetry({
+      method: 'POST',
+      headers: { 'x-correlation-id': correlationId },
+      url: 'http://localhost:9070/test/retry',
+      json: true,
+      qs: { key: 'value' },
+      retry: {},
+    }).then((response) => {
+      expect(response).to.have.property('statusCode');
+    }));
+    it('should throw a System error on network failure', () => rpRetry({
+      method: 'GET',
+      headers: { 'x-correlation-id': correlationId },
+      url: 'http://localhost:1/unreachable',
+      retry: { retries: 0, timeout: 10 },
+    }).catch((err) => {
+      expect(err.name).to.be.a('string');
+    }));
+    it('should log response with count details', () => {
+      const loggerSpySilly = spy(logger, 'silly');
+
+      return rpRetry({
+        method: 'POST',
+        headers: { 'x-correlation-id': correlationId },
+        url: 'http://localhost:9070/test/retry',
+        json: true,
+        retry: {
+          logLevel: {
+            response: 'silly',
+            responseDetails: 'count',
+          },
+        },
+      }).then(() => {
+        assert.calledOnce(loggerSpySilly);
+        loggerSpySilly.restore();
+      });
+    });
+  });
   describe('rpRetry(options) options validation run', function Test() {
     this.timeout(TIMEOUT);
     const options = {
@@ -294,7 +351,7 @@ describe('request-retry Unit Tests', () => {
           expect(callArgs[CALL_ARG_MESSAGE]).to.equal('bad retry strategy');
         });
     });
-    it('should not generate warning: retry strategy returning a boolean', () => {
+    it('should not generate warning for retry strategy, but warn on request error', () => {
       options.retry.retryStrategy = () => false;
       options.retry.retries = RETRY_RETRIES;
       return rpRetry(options)
@@ -337,7 +394,7 @@ describe('request-retry Unit Tests', () => {
           expect(callArgs[CALL_ARG_MESSAGE]).to.equal('calculated delay out of scope: using delay or default');
         });
     });
-    it('should not generate warning: delay strategy returning an in scope number', () => {
+    it('should not generate warning for delay strategy, but warn on request error', () => {
       options.retry.delayStrategy = () => DELAY_STRATEGY_RESPONSE_2;
       options.retry.retries = RETRY_RETRIES;
       return rpRetry(options)

package/.nycrc

@@ -1,4 +0,0 @@
-{
-  "exclude": ["gulpfile.js"],
-  "reporter": ["lcov", "text"]
-}