@mimik/request-retry 4.0.5 → 4.0.7

package/README.md

@@ -4,7 +4,7 @@
 **Example**  
 ```js
 import { rpRetry } from '@mimik/request-retry';
-or
+// or
 import rp from '@mimik/request-retry';
 ```
 <a name="module_request-retry..rpRetry"></a>
@@ -16,8 +16,8 @@ Make a request with retries.
 **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 +27,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 +55,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}`.
@@ -71,5 +71,5 @@ To ease migration from `request-promise`, the following adjustments are applied
 
 | Param | Type | Description |
 | --- | --- | --- |
-| options | <code>object</code> | Options for the request (similar to [axios](https://www.npmjs.com/package/axios)).   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. |
+| options | <code>object</code> | Options for the request (similar to [axios](https://www.npmjs.com/package/axios)). 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. |
 

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';
  */
 
@@ -48,13 +46,13 @@ Promise.config({ cancellation: true });
  * @requires @mimik/response-helper
  * @category async
  * @param {object} options - Options for the request (similar to [axios](https://www.npmjs.com/package/axios)).
- *   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.
+ * 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}
  * @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;
 
-    message = `Received ${nbRequest} retry with timelap ${timeLap}`;
+    message = `Received ${nbRequest} retry with timelapse ${timeLap}`;
   }
   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:
@@ -10,7 +10,7 @@ import process from 'process';
  * | SUMO_LOGIC_COLLECTOR_CODE | code to use to log on sumologic | null
  * | NO_STACK | flag to have a stack associated with the log | yes
  * | LOG_LEVEL | log level to log | error
- * | CONSOLE_LEVEL | log level to diplay | debug
+ * | CONSOLE_LEVEL | log level to display | debug
  * | LOG_MODE | log mode | none
  */
 /*

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/manual-test/testRetry.js

@@ -26,12 +26,12 @@ const options = {
    * delayStrategy: 'joe', // => setDelay returning retryDelay
    * delayStrategy: function badDelay() { return 'joe' }, // => no change then bad delay strategy => retryDelay
    * delayStrategy: function userDelay(...args) { return (Math.pow(2, args[0]) * 100) + Math.floor(Math.random() * 50) }, // OK
-   * retryStrategy: 'joe', // => unknowRetry returning false
+   * retryStrategy: 'joe', // => unknownRetry returning false
    * retryStrategy: function badRetry() { return 'joe' }, // => no change then bad retry strategy => false
    * retryStrategy: function userRetry(...args) { // OK
    *   const { statusCode } = args[1]; // err
    *
-   *   return statusCode && (Math.floor(statusCode/100) !== 5 || statusCode !== 429); // retry if there is no statusCode or if there is 500 range statucCode or 429
+   *   return statusCode && (Math.floor(statusCode/100) !== 5 || statusCode !== 429); // retry if there is no statusCode or if there is 500 range statusCode or 429
    * },
    * retryStrategy: function invalidRetry(...args) { // defaultRetry
    *   const { statusCode } = args[34]; // null value

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/request-retry",
-  "version": "4.0.5",
+  "version": "4.0.7",
   "description": "Request retry wrapping axios",
   "main": "./index.js",
   "type": "module",
@@ -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.6",
-    "axios": "1.12.2",
+    "@mimik/request-helper": "^2.0.3",
+    "@mimik/response-helper": "^4.0.9",
+    "@mimik/sumologic-winston-logger": "^2.1.10",
+    "axios": "1.13.5",
     "bluebird": "3.7.2"
   },
   "devDependencies": {
-    "@eslint/js": "9.35.0",
+    "@eslint/js": "9.39.2",
     "@mimik/eslint-plugin-document-env": "^2.0.8",
-    "@stylistic/eslint-plugin": "5.3.1",
+    "@stylistic/eslint-plugin": "5.8.0",
     "acorn": "8.15.0",
-    "body-parser": "2.2.0",
+    "body-parser": "2.2.2",
     "c8": "10.1.3",
-    "chai": "6.0.1",
-    "eslint": "9.35.0",
+    "chai": "6.2.2",
+    "eslint": "9.39.2",
     "eslint-plugin-import": "2.32.0",
-    "express": "5.1.0",
+    "express": "5.2.1",
     "husky": "9.1.7",
-    "jsdoc-to-markdown": "9.1.2",
-    "mocha": "11.7.2",
-    "mochawesome": "7.1.3",
-    "sinon": "21.0.0"
+    "jsdoc-to-markdown": "9.1.3",
+    "mocha": "11.7.5",
+    "mochawesome": "7.1.4",
+    "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;
 
-    message = `Received ${nbRequest} retry with timelap ${timeLap}`;
+    message = `Received ${nbRequest} retry with timelapse ${timeLap}`;
   }
   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);
@@ -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: '    ',
       };

package/test/testEnv.js

@@ -10,7 +10,7 @@ import process from 'node:process';
  * | SUMO_LOGIC_COLLECTOR_CODE | code to use to log on sumologic | null
  * | NO_STACK | flag to have a stack associated with the log | yes
  * | LOG_LEVEL | log level to log | error
- * | CONSOLE_LEVEL | log level to diplay | debug
+ * | CONSOLE_LEVEL | log level to display | debug
  * | LOG_MODE | log mode | none
  */