@mimik/request-retry 4.0.3 → 4.0.4

package/README.md

@@ -10,53 +10,66 @@ import rp from '@mimik/request-retry';
 <a name="module_request-retry..rpRetry"></a>
 
 ### request-retry~rpRetry(options) ⇒ <code>Promise</code>
-Make a request with retry.
+Make a request with retries.
 
 **Kind**: inner method of [<code>request-retry</code>](#module_request-retry)  
-**Returns**: <code>Promise</code> - .  
 **Category**: async  
 **Throws**:
 
-- <code>Promise</code> Will throw an error generated by `getRichError` encapsulating an error generated by [request-promise](https://www.npmjs.com/package/request-promise) or a TimeoutError.
-
-The following properties are added to the `options` object under the `retry` property:
-- retries `{int}`: maximum number of retries independent to the retryStrategy. The default is `2`. If the value is less than `0` the value is set to `0`, and if the value is more that `15` the value is set to `15`,
-- delay `{int}`: in millisecond delay between retries if there is no retryDelay strategy. The default is `1000 ms`. If the value is less than `20 ms` the value is set to `20 ms`, and if the value is more than `30000 ms` the value is set to `30000 ms`,
-- delayStrategy `{function}`: function describing the delay strategy. The parameters are (`nbRetry`, `err`, `options`, `correlationId`). Must return a `number` of miliseconds which is greater to 0 ms but less that 30000 ms, if not the value of `delay` will be used,
-- logLevel `{object}`: has the following properties:
-   - *response*: log level to be set for response. The default is `silly` or if the value is wrong it is set to `silly`,
-   - *error*: log level to be set for error. The default is `silly` or if the value is wrong it is set to `silly`,
-   - *request*: log level to be set for request: The default is `silly` or if the value is wrong it is set to `silly`,
-   - *responseDetails*: level of detail when diplaying the response: `count`, `type`, `full`. The default is `type` or if the value is wrong it is set to `type`,
-   - *responseName*: name to associate with the response. The default is `response`or is the value is not a string or and empty string it is set to `response`,
-- timeout `{int}`: in seconds the timeout to be set for the request and retries. If the timeout is reached, a TimeoutError will be generated. The default is `50 seconds`. If the value is less than `10 seconds` the value is set to `10 seconds`, and if the value is more than `120 seconds` the value is set to `120 seconds`,
-- retryStrategy `{function}`: function describing the retry strategy. The parameters are (`nbRetry`, `err`, `options`, `correlationId`). Must return a `boolean`, if not the function strategy is ignored.
-The following properties are added to the `options` object under the 'metrics' property:
-- HTTPRequestDuration `function`: prom-client function to measure the delay of the request,
-- url: optional url to be added for labelling the metric. If not present the url of the request will be used.
-
-The `default` retryStategy is:
-
-``` javascript
+- <code>Error</code> An error produced by `getRichError`, wrapping an error from
+  [request-promise](https://www.npmjs.com/package/request-promise) 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`.
+  If the value is `< 0` it is set to `0`; if `> 15` it is set to `15`.
+- delay `{int}`: Delay between retries in milliseconds when no `delayStrategy` is provided. Default: `1000`.
+  If the value is `< 20` it is set to `20`; if `> 30000` it is set to `30000`.
+- 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`).
+   - *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`
+     (non-string or empty values fall back to `response`).
+- timeout `{int}`: Request timeout (in seconds) applied to the initial request and all retries.
+  If reached, a `TimeoutError` is thrown. Default: `50`. Values `< 10` are set to `10`; values `> 120` are set to `120`.
+- retryStrategy `{function}`: A function that decides whether to retry. Signature:
+  `(nbRetry, err, options, correlationId)`. Must return a boolean; otherwise it is ignored.
+
+The following properties may be added to the `options` object under the `metrics` property:
+- HTTPRequestDuration `{function}`: A `prom-client` metric function to measure request duration.
+- url `{string}`: Optional URL label for the metric. If omitted, the request URL is used.
+
+The **default** `retryStrategy` is:
+
+```javascript
 defaultRetry = (...args) => {
   const { statusCode } = args[1]; // err
-
-  return (statusCode && (Math.floor(statusCode / 100) === 5 || statusCode === 429)) || (!statusCode && !args[1].message.includes('Invalid URI'));
+  // Retry on 5xx and 429. If there is no statusCode, retry unless it's an "Invalid URI" error.
+  return (statusCode && (Math.floor(statusCode / 100) === 5 || statusCode === 429))
+         || (!statusCode && !args[1].message.includes('Invalid URI'));
 };
 ```
-If logLevel is empty, request and response will be logged as info and the response will be in response property with full details. Error on the request will generate a warning. If logLevel is not empty but not complete, logLevel will take control over default.
 
-If not alredy set,the user agent will the set to `mimik-{serverType}/{serverVersion}/{serverId} {architecture} {node}`;
+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.
+
+If not already set, the `User-Agent` header is set to:
+`mimik-{serverType}/{serverVersion}/{serverId} {architecture} {node}`.
 
-To facilitate the transition from request-promise the following action are taken on options:
-- `uri` takes precednce on `url`
-- `body` takes precedence on `json` if `json` is an object and are used to assign `data`
-- `qs` is used to assign to `params`
+To ease migration from `request-promise`, the following adjustments are applied to `options`:
+- `uri` takes precedence over `url`.
+- If `json` is an object, `body` takes precedence over `json`; both are mapped to Axios `data`.
+- `qs` is mapped to Axios `params`.
 
 **Requires**: <code>module:@mimik/sumologic-winston-logger</code>, <code>module:@mimik/response-helper</code>  
-**Fulfil**: <code>object</code> - Response of the [axios](https://www.npmjs.com/package/axios) response with option `resolveWithFullResponse` set to true otherwise only `response.data` is returned.  
+**Fulfil**: <code>object</code> - The Axios response when `resolveWithFullResponse` is `true`; otherwise `response.data`.  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| options | <code>object</code> | Options for the request. Similar to [axios](https://www.npmjs.com/package/axios) options. `validateStatus` options is disabled, an error will be created for statusCode outside of [200, 300[. The options `resolveWithFullResponse` is added and if set to true, the response will be a full axios response. If set to false or missing only `reponse.data` will be 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/eslint.config.js

@@ -10,6 +10,9 @@ 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 MAX_DEPTH = 6;
+const ALLOWED_CONSTANTS = [0, 1, -1];
 
 export default [
   {
@@ -23,7 +26,7 @@ export default [
       processDoc,
     },
     languageOptions: {
-      ecmaVersion: 2022,
+      ecmaVersion: ECMA_VERSION,
       globals: {
         console: 'readonly',
         describe: 'readonly',
@@ -35,6 +38,7 @@ export default [
     rules: {
       '@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/semi': ['error', 'always'],
       'capitalized-comments': ['off'],
       'complexity': ['error', MAX_COMPLEXITY],
@@ -44,20 +48,22 @@ export default [
       'import/no-unresolved': ['error', { amd: true, caseSensitiveStrict: true, commonjs: true }],
       'init-declarations': ['off'],
       'linebreak-style': ['off'],
-      'max-len': ['warn', MAX_LENGTH_LINE, { ignoreComments: true }],
-      'max-lines': ['warn', { max: MAX_LINES_IN_FILES, skipComments: true }],
-      'max-lines-per-function': ['warn', { max: MAX_LINES_IN_FUNCTION, skipComments: true }],
+      'max-depth': ['error', MAX_DEPTH],
+      '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'], // arrow isnt confusing
+      'no-confusing-arrow': ['off'],
       'no-inline-comments': ['off'],
+      'no-magic-numbers': ['error', { ignore: ALLOWED_CONSTANTS, enforceConst: true, detectObjects: true }],
       'no-process-env': ['error'],
       'no-ternary': ['off'],
       'no-undefined': ['off'],
       'one-var': ['error', 'never'],
       'processDoc/validate-document-env': ['error'],
       'quotes': ['warn', 'single'],
-      'sort-keys': ['error', 'asc', { caseSensitive: true, minKeys: MIN_KEYS_IN_OBJECT, natural: false }],
+      'sort-imports': ['error', { allowSeparatedGroups: true }],
+      'sort-keys': ['error', 'asc', { caseSensitive: true, minKeys: MIN_KEYS_IN_OBJECT, natural: false, allowLineSeparatedGroups: true }],
     },
   },
 ];

package/index.js

@@ -1,3 +1,4 @@
+import { OK, SYSTEM_ERROR } from './lib/common.js';
 import {
   calculateDelay,
   isRetry,
@@ -7,7 +8,7 @@ import {
 import {
   clearTimeout,
   setTimeout,
-} from 'timers';
+} from 'node:timers';
 import {
   getCorrelationId,
   setUserAgent,
@@ -15,7 +16,7 @@ import {
 import Promise from 'bluebird';
 import { getRichError } from '@mimik/response-helper';
 import logger from '@mimik/sumologic-winston-logger';
-import process from 'process';
+import process from 'node:process';
 import { rp } from './lib/rp-axios-wrapper.js';
 
 const DEFAULT_RESPONSE_NAME = 'response';
@@ -26,13 +27,8 @@ const DEFAULT_LOGLEVEL_REQUEST = 'info';
 
 const MILLI_SECONDS = 0;
 const MILLI_NANO_SECONDS = 1;
-const INCR = 1;
 const MILLI = 1000;
 const NANO = 1e6;
-const EMPTY = 0;
-const NONE = 0;
-const OK_RESPONSE = 200;
-const SYSTEM_ERROR = 500;
 
 Promise.config({ cancellation: true });
 
@@ -45,50 +41,67 @@ Promise.config({ cancellation: true });
  */
 
 /**
- * Make a request with retry.
+ * Make a request with retries.
  *
  * @function rpRetry
  * @requires @mimik/sumologic-winston-logger
  * @requires @mimik/response-helper
  * @category async
- * @param {object} options - Options for the request. Similar to [axios](https://www.npmjs.com/package/axios) options. `validateStatus` options is disabled, an error will be created for statusCode outside of [200, 300[. The options `resolveWithFullResponse` is added and if set to true, the response will be a full axios response. If set to false or missing only `reponse.data` will be returned.
- * @return {Promise}.
- * @fulfil {object} - Response of the [axios](https://www.npmjs.com/package/axios) response with option `resolveWithFullResponse` set to true otherwise only `response.data` is returned.
- * @throws {Promise} Will throw an error generated by `getRichError` encapsulating an error generated by [request-promise](https://www.npmjs.com/package/request-promise) or a TimeoutError.
+ * @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.
+ * @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`.
  *
- * The following properties are added to the `options` object under the `retry` property:
- * - retries `{int}`: maximum number of retries independent to the retryStrategy. The default is `2`. If the value is less than `0` the value is set to `0`, and if the value is more that `15` the value is set to `15`,
- * - delay `{int}`: in millisecond delay between retries if there is no retryDelay strategy. The default is `1000 ms`. If the value is less than `20 ms` the value is set to `20 ms`, and if the value is more than `30000 ms` the value is set to `30000 ms`,
- * - delayStrategy `{function}`: function describing the delay strategy. The parameters are (`nbRetry`, `err`, `options`, `correlationId`). Must return a `number` of miliseconds which is greater to 0 ms but less that 30000 ms, if not the value of `delay` will be used,
- * - logLevel `{object}`: has the following properties:
- *    - *response*: log level to be set for response. The default is `silly` or if the value is wrong it is set to `silly`,
- *    - *error*: log level to be set for error. The default is `silly` or if the value is wrong it is set to `silly`,
- *    - *request*: log level to be set for request: The default is `silly` or if the value is wrong it is set to `silly`,
- *    - *responseDetails*: level of detail when diplaying the response: `count`, `type`, `full`. The default is `type` or if the value is wrong it is set to `type`,
- *    - *responseName*: name to associate with the response. The default is `response`or is the value is not a string or and empty string it is set to `response`,
- * - timeout `{int}`: in seconds the timeout to be set for the request and retries. If the timeout is reached, a TimeoutError will be generated. The default is `50 seconds`. If the value is less than `10 seconds` the value is set to `10 seconds`, and if the value is more than `120 seconds` the value is set to `120 seconds`,
- * - retryStrategy `{function}`: function describing the retry strategy. The parameters are (`nbRetry`, `err`, `options`, `correlationId`). Must return a `boolean`, if not the function strategy is ignored.
- * The following properties are added to the `options` object under the 'metrics' property:
- * - HTTPRequestDuration `function`: prom-client function to measure the delay of the request,
- * - url: optional url to be added for labelling the metric. If not present the url of the request will be used.
+ * 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`.
+ *   If the value is `< 0` it is set to `0`; if `> 15` it is set to `15`.
+ * - delay `{int}`: Delay between retries in milliseconds when no `delayStrategy` is provided. Default: `1000`.
+ *   If the value is `< 20` it is set to `20`; if `> 30000` it is set to `30000`.
+ * - 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`).
+ *    - *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`
+ *      (non-string or empty values fall back to `response`).
+ * - timeout `{int}`: Request timeout (in seconds) applied to the initial request and all retries.
+ *   If reached, a `TimeoutError` is thrown. Default: `50`. Values `< 10` are set to `10`; values `> 120` are set to `120`.
+ * - retryStrategy `{function}`: A function that decides whether to retry. Signature:
+ *   `(nbRetry, err, options, correlationId)`. Must return a boolean; otherwise it is ignored.
  *
- * The `default` retryStategy is:
+ * The following properties may be added to the `options` object under the `metrics` property:
+ * - HTTPRequestDuration `{function}`: A `prom-client` metric function to measure request duration.
+ * - url `{string}`: Optional URL label for the metric. If omitted, the request URL is used.
  *
- *``` javascript
+ * The **default** `retryStrategy` is:
+ *
+ * ```javascript
  * defaultRetry = (...args) => {
  *   const { statusCode } = args[1]; // err
- *
- *   return (statusCode && (Math.floor(statusCode / 100) === 5 || statusCode === 429)) || (!statusCode && !args[1].message.includes('Invalid URI'));
+ *   // Retry on 5xx and 429. If there is no statusCode, retry unless it's an "Invalid URI" error.
+ *   return (statusCode && (Math.floor(statusCode / 100) === 5 || statusCode === 429))
+ *          || (!statusCode && !args[1].message.includes('Invalid URI'));
  * };
- *```
- * If logLevel is empty, request and response will be logged as info and the response will be in response property with full details. Error on the request will generate a warning. If logLevel is not empty but not complete, logLevel will take control over default.
+ * ```
+ *
+ * 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.
  *
- * If not alredy set,the user agent will the set to `mimik-{serverType}/{serverVersion}/{serverId} {architecture} {node}`;
+ * If not already set, the `User-Agent` header is set to:
+ * `mimik-{serverType}/{serverVersion}/{serverId} {architecture} {node}`.
  *
- * To facilitate the transition from request-promise the following action are taken on options:
- * - `uri` takes precednce on `url`
- * - `body` takes precedence on `json` if `json` is an object and are used to assign `data`
- * - `qs` is used to assign to `params`
+ * To ease migration from `request-promise`, the following adjustments are applied to `options`:
+ * - `uri` takes precedence over `url`.
+ * - If `json` is an object, `body` takes precedence over `json`; both are mapped to Axios `data`.
+ * - `qs` is mapped to Axios `params`.
  */
 export const rpRetry = (origOptions) => {
   const startHrTime = process.hrtime();
@@ -101,7 +114,7 @@ export const rpRetry = (origOptions) => {
   const criteria = validateOptions(options, correlationId);
   const { logLevel } = criteria;
   const logLevelLength = Object.keys(logLevel).length;
-  let nbRetries = NONE;
+  let nbRetries = 0;
   let mainTimeout;
   const measure = (statusCode) => {
     if (metrics && metrics.HTTPRequestDuration) {
@@ -127,7 +140,7 @@ export const rpRetry = (origOptions) => {
         info[logLevel.responseName] = setResponse(response, logLevel.responseDetails);
         logger[logLevel.response]('request response', info, correlationId);
       }
-      else if (logLevelLength === EMPTY) {
+      else if (logLevelLength === 0) {
         info[DEFAULT_RESPONSE_NAME] = setResponse(response, DEFAULT_LOGLEVEL_DETAILS);
         logger[DEFAULT_LOGLEVEL_RESPONSE]('request response', info, correlationId);
       }
@@ -135,16 +148,16 @@ export const rpRetry = (origOptions) => {
     })
     .catch((err) => {
       if ((nbRetry < criteria.retries) && isRetry(options, nbRetry, criteria, err, correlationId)) {
-        nbRetries = nbRetry + INCR;
+        nbRetries = nbRetry + 1;
         errors.push(err);
         const delayPromise = Promise.delay(calculateDelay(options, nbRetry, criteria, err, correlationId));
 
         delayPromises.unshift(delayPromise);
-        return delayPromise.then(() => retryProcess(nbRetry + INCR));
+        return delayPromise.then(() => retryProcess(nbRetry + 1));
       }
       const error = err;
 
-      if (nbRetries !== NONE) {
+      if (nbRetries !== 0) {
         if (!error.info) error.info = {};
         error.info.retry = {
           nbRetries,
@@ -156,18 +169,18 @@ export const rpRetry = (origOptions) => {
         'request error response',
         { options: optionsInfo },
         error,
-        logLevel.error || ((logLevelLength === EMPTY) ? DEFAULT_LOGLEVEL_ERROR : undefined),
+        logLevel.error || ((logLevelLength === 0) ? DEFAULT_LOGLEVEL_ERROR : undefined),
         correlationId,
       );
     });
 
-  const retryPromise = retryProcess(NONE);
+  const retryPromise = retryProcess(0);
   const mainTimeoutPromise = new Promise((resolve, reject) => {
     mainTimeout = setTimeout(() => {
       delayPromises.forEach(delayPromise => delayPromise.cancel(`retry timeout delay, ${criteria.timeout}, ${nbRetries}`));
       let error = new Error('retry timeout');
 
-      if (nbRetries !== NONE) {
+      if (nbRetries !== 0) {
         error.info = { retry: { nbRetries, errors } };
       }
       error.name = 'TimeoutError';
@@ -176,7 +189,7 @@ export const rpRetry = (origOptions) => {
         'request error response',
         { options: optionsInfo },
         error,
-        logLevel.error || ((logLevelLength === EMPTY) ? DEFAULT_LOGLEVEL_ERROR : undefined),
+        logLevel.error || ((logLevelLength === 0) ? DEFAULT_LOGLEVEL_ERROR : undefined),
         correlationId,
       );
       reject(error);
@@ -184,12 +197,12 @@ export const rpRetry = (origOptions) => {
   });
 
   if (logLevel.request) logger[logLevel.request]('making a request', { options: optionsInfo, criteria }, correlationId);
-  else if (logLevelLength === EMPTY) logger[DEFAULT_LOGLEVEL_REQUEST]('making a request', { options: optionsInfo, criteria }, correlationId);
+  else if (logLevelLength === 0) logger[DEFAULT_LOGLEVEL_REQUEST]('making a request', { options: optionsInfo, criteria }, correlationId);
   return Promise.race([retryPromise, mainTimeoutPromise])
     .then((result) => {
       mainTimeoutPromise.cancel('main timeout');
       clearTimeout(mainTimeout);
-      measure(OK_RESPONSE);
+      measure(OK);
       return result;
     })
     .catch((err) => {

package/lib/common.js

@@ -0,0 +1,13 @@
+const PARAMETER_ERROR = 400;
+const TOO_MANY_REQUESTS_ERROR = 429;
+const SYSTEM_ERROR = 500;
+const OK = 200;
+const CREATED = 201;
+
+export {
+  PARAMETER_ERROR,
+  TOO_MANY_REQUESTS_ERROR,
+  SYSTEM_ERROR,
+  OK,
+  CREATED,
+};

package/lib/rp-axios-wrapper.js

@@ -1,6 +1,8 @@
 import axios from 'axios';
-import clone from 'lodash.clone';
 import { getRichError } from '@mimik/response-helper';
+import rfdc from 'rfdc';
+
+const clone = rfdc();
 
 const rp = (origOptions) => {
   const options = clone(origOptions);

package/lib/validate.js

@@ -1,3 +1,4 @@
+import { TOO_MANY_REQUESTS_ERROR } from './common.js';
 import logger from '@mimik/sumologic-winston-logger';
 
 const DETAILS = ['full', 'type', 'count'];
@@ -7,15 +8,13 @@ const [, , , , , DEFAULT_LOGLEVEL/* 'silly' */] = logger.LEVELS;
 const DEFAULT_RETRIES = 2;
 const MIN_RETRIES = 0;
 const MAX_RETRIES = 15;
-const DEFAULT_DELAY = 1000; // in ms
-const MIN_DELAY = 20; // in ms
-const MAX_DELAY = 30000; // in ms
+const DEFAULT_DELAY = 1000; // in millisecond
+const MIN_DELAY = 20; // in millisecond
+const MAX_DELAY = 30000; // in millisecond
 const NO_DELAY = 0;
-const DEFAULT_TIMEOUT = 50; // in seconds
-const MIN_TIMEOUT = 10; // in seconds
-const MAX_TIMEOUT = 120; // in seconds
-const TOO_MANY_REQUESTS_ERROR = 429;
-const EMPTY = 0;
+const DEFAULT_TIMEOUT = 50; // in second
+const MIN_TIMEOUT = 10; // in second
+const MAX_TIMEOUT = 120; // in second
 const SYSTEM_RANGE = 5;
 const SYSTEM_RANGE_EXTRACT = 100;
 const ARG_ERROR = 1;
@@ -80,7 +79,7 @@ const validateOptions = (options, correlationId) => {
   };
   const validateResponseName = (val, name, defaultValue) => {
     if (!val && val !== '') return defaultValue;
-    if (typeof val !== 'string' || val.length === EMPTY || val.trim().length === EMPTY) {
+    if (typeof val !== 'string' || val.length === 0 || val.trim().length === 0) {
       logger.warn(`invalid logLevel.${name}, reset to default`, { name, value: val, defaultValue }, correlationId);
       return defaultValue;
     }

package/manual-test/httpMock.js

@@ -1,4 +1,5 @@
 /* eslint-disable no-console */
+import { OK } from '../lib/common.js';
 import bodyParser from 'body-parser';
 import express from 'express';
 
@@ -8,9 +9,9 @@ const app = express();
 
 app.use(bodyParser.json());
 app.get('/success', (req, res) => {
-  res.statusCode = 200;
+  res.statusCode = OK;
 
-  res.send({ statusCode: 200 });
+  res.send({ statusCode: OK });
 });
 
 app.listen(PORT, () => {

package/manual-test/man.js

@@ -3,6 +3,8 @@ import './testEnv';
 import { rpRetry } from '../index.js';
 
 const DELAY = 1000;
+const RETRY_TIMEOUT = 10;
+const RETRY_RETRIES = 2;
 
 const correlationId = `--request-retry-test--/${new Date().toISOString()}`;
 
@@ -17,8 +19,8 @@ const options = {
 };
 
 options.retry.delayStrategy = () => DELAY;
-options.retry.timeout = 10;
-options.retry.retries = 2;
+options.retry.timeout = RETRY_TIMEOUT;
+options.retry.retries = RETRY_RETRIES;
 
 rpRetry(options)
   .catch(err => console.log(err));

package/manual-test/retryMockMan.js

@@ -1,24 +1,27 @@
 /* eslint-disable no-console */
+import { CREATED, OK, SYSTEM_ERROR } from '../lib/common.js';
 import bodyParser from 'body-parser';
 import express from 'express';
-import { setTimeout } from 'timers';
+import { setTimeout } from 'node:timers';
 
-const NONE = 0;
-const INCR = 1;
+const PORT = 9080;
+const GET_NB_RETRY = 400;
+const GET_TIMEOUT = 4000;
 
 const app = express();
+
 const config = {
-  port: 9080,
+  port: PORT,
   path: '/retry',
   base: '/test',
   get: {
-    nbRetry: 400,
-    success: 200,
-    error: 500,
-    timeout: 4000,
+    nbRetry: GET_NB_RETRY,
+    success: OK,
+    error: SYSTEM_ERROR,
+    timeout: GET_TIMEOUT,
   },
   post: {
-    success: 201,
+    success: CREATED,
   },
 };
 let nbRequest = 0;
@@ -27,7 +30,7 @@ let message;
 
 app.use(bodyParser.json());
 app.get(`${config.base}${config.path}`, (req, res) => {
-  if (nbRequest === NONE) message = 'Recieved first request';
+  if (nbRequest === 0) message = 'Recieved first request';
   else {
     const timeLap = Date.now() - time;
 
@@ -41,7 +44,7 @@ app.get(`${config.base}${config.path}`, (req, res) => {
     res.send({ statusCode: config.get.success });
     return;
   }
-  nbRequest += INCR;
+  nbRequest += 1;
   setTimeout(() => {
     res.statusCode = config.get.error;
     res.send({ statusCode: config.get.error });

package/manual-test/testRace.js

@@ -4,20 +4,19 @@ import {
   setTimeout,
 } from 'timers';
 
-const INCR = 1;
 const MAX_INCR = 100000000;
-const NO_RESULT = 0;
+const MAIN_TIMEOUT = 1; // in millisecond
 
 const doSomething = () => {
   let add = 0;
 
-  for (let i = 0; i < MAX_INCR; i += INCR) {
-    add += INCR;
+  for (let i = 0; i < MAX_INCR; i += 1) {
+    add += 1;
     console.log(add);
   }
   return add;
 };
-const timeout = 1; // ms
+const timeout = MAIN_TIMEOUT;
 
 const race = () => {
   let result;
@@ -30,7 +29,7 @@ const race = () => {
   }
   catch (err) {
     console.log(err);
-    result = NO_RESULT;
+    result = 0;
   }
   clearTimeout(mainTimeout);
   return result;

package/manual-test/testRetry.js

@@ -2,6 +2,8 @@
 import '../test/testEnv.js';
 import { rpRetry } from '../index.js';
 
+const TIMEOUT = 20000; // in millisecond
+
 const options = {
   method: 'GET',
   url: 'http://api.swaggerhub.com/apis/mimik/Boxes/1.2.1', // 'http://www.google.com', // 'http://blah.com', // 'http://localhost:9070/test/retry', // 'http://www.google.com', // 'http://localhost:8080/mIT/v1/admin/healthCheck1', // 'http://blah.com'
@@ -9,7 +11,7 @@ const options = {
     'x-correlation-id': '---test-request-retry---',
   },
   json: true,
-  timeout: 20000,
+  timeout: TIMEOUT,
   /*
    * retry: {
    * all default: maxRetry: 2, retryDelay: 1000ms, maxTimeout: 50s, logLevel: 3 silly, type response, retryDelayStrategy: setDelay, retryStrategy: defaultRetry

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/request-retry",
-  "version": "4.0.3",
+  "version": "4.0.4",
   "description": "Request retry wrapping axios",
   "main": "./index.js",
   "type": "module",
@@ -30,26 +30,26 @@
   },
   "dependencies": {
     "@mimik/request-helper": "^2.0.2",
-    "@mimik/response-helper": "^4.0.4",
-    "@mimik/sumologic-winston-logger": "^2.0.3",
-    "axios": "1.10.0",
+    "@mimik/response-helper": "^4.0.6",
+    "@mimik/sumologic-winston-logger": "^2.1.6",
+    "axios": "1.12.1",
     "bluebird": "3.7.2",
-    "lodash.clone": "4.5.0"
+    "rfdc": "1.4.1"
   },
   "devDependencies": {
-    "@eslint/js": "9.31.0",
+    "@eslint/js": "9.35.0",
     "@mimik/eslint-plugin-document-env": "^2.0.8",
-    "@stylistic/eslint-plugin": "5.2.0",
+    "@stylistic/eslint-plugin": "5.3.1",
     "acorn": "8.15.0",
     "body-parser": "2.2.0",
     "c8": "10.1.3",
-    "chai": "5.2.1",
-    "eslint": "9.31.0",
+    "chai": "6.0.1",
+    "eslint": "9.35.0",
     "eslint-plugin-import": "2.32.0",
     "express": "5.1.0",
     "husky": "9.1.7",
     "jsdoc-to-markdown": "9.1.2",
-    "mocha": "11.7.1",
+    "mocha": "11.7.2",
     "mochawesome": "7.1.3",
     "sinon": "21.0.0"
   }

package/test/retryMock.js

@@ -1,26 +1,27 @@
 /* eslint-disable no-console */
+import { CREATED, OK, SYSTEM_ERROR } from '../lib/common.js';
 import bodyParser from 'body-parser';
 import express from 'express';
-import process from 'process';
-import { setTimeout } from 'timers';
+import process from 'node:process';
+import { setTimeout } from 'node:timers';
 
-const NONE = 0;
-const INCR = 1;
 const TIMEOUT = 3000;
-const EXIT_NORMAL = 0;
+const EXIT_OK = 0;
+const PORT = 9070;
+const GET_NB_RETRY = 400;
 
 const app = express();
 const config = {
-  port: 9070,
+  port: PORT,
   path: '/retry',
   base: '/test',
   get: {
-    nbRetry: 400,
-    success: 200,
-    error: 500,
+    nbRetry: GET_NB_RETRY,
+    success: OK,
+    error: SYSTEM_ERROR,
   },
   post: {
-    success: 201,
+    success: CREATED,
   },
 };
 let nbRequest = 0;
@@ -29,7 +30,7 @@ let message;
 
 app.use(bodyParser.json());
 app.get(`${config.base}${config.path}`, (req, res) => {
-  if (nbRequest === NONE) message = 'Recieved first request';
+  if (nbRequest === 0) message = 'Recieved first request';
   else {
     const timeLap = Date.now() - time;
 
@@ -43,7 +44,7 @@ app.get(`${config.base}${config.path}`, (req, res) => {
     res.send({ statusCode: config.get.success });
     return;
   }
-  nbRequest += INCR;
+  nbRequest += 1;
   res.statusCode = config.get.error;
 
   res.send({ statusCode: config.get.error });
@@ -58,7 +59,7 @@ app.get('/stop', (req, res) => {
   res.statusCode = config.get.success;
   res.send({ statusCode: config.get.success });
   setTimeout(() => {
-    process.exit(EXIT_NORMAL);
+    process.exit(EXIT_OK);
   }, TIMEOUT);
 });
 

package/test/rpRetry.spec.js

@@ -1,7 +1,8 @@
+/* eslint-disable max-lines-per-function */
 import './testEnv.js';
 import { afterEach, before, beforeEach, describe, it } from 'mocha';
 import { assert, spy } from 'sinon';
-import { expect, should } from 'chai';
+import { expect } from 'chai';
 import { getCorrelationId } from '@mimik/request-helper';
 import { listen } from './retryMock.js';
 import logger from '@mimik/sumologic-winston-logger';
@@ -9,15 +10,19 @@ import { rpRetry } from '../index.js';
 
 const TIMEOUT = 50000;
 const RETRY_DELAY = 10000;
+const OUT_OF_SCOPE_RETRY_DELAY = 100000;
+const IN_SCOPE_RETRY_DELAY = 20000;
 const RETRY_TIMEOUT = 10;
+const OUT_OF_SCOPE_RETRY_TIMEOUT = 150;
+const IN_SCOPE_RETRY_TIMEOUT = 50;
 const RETRY_RETRIES = 2;
+const OUT_OF_SCOPE_RETRIES = 20;
+const IN_SCOPE_RETRIES = 10;
 const DELAY_STRATEGY_RESPONSE_1 = -20;
 const DELAY_STRATEGY_RESPONSE_2 = 50;
 const DELAY_STRATEGY_RESPONSE_3 = 100;
 const CALL_ARG_MESSAGE = 0;
 const FIRST_CALL = 0;
-
-should();
 /*
  * const DEFAULT_NO_MESSAGE = 'no message';
  * const NO_ERROR = 'not an error object';
@@ -69,7 +74,7 @@ describe('request-retry Unit Tests', () => {
       });
     });
     it('should generate warning: out of scope retries: 20 becoming max', () => {
-      options.retry.retries = 20;
+      options.retry.retries = OUT_OF_SCOPE_RETRIES;
       return rpRetry(options).then(() => {
         assert.calledOnce(loggerSpyWarn);
         const callArgs = loggerSpyWarn.getCall(FIRST_CALL).args;
@@ -78,7 +83,7 @@ describe('request-retry Unit Tests', () => {
       });
     });
     it('should not generate warning: in scope retries', () => {
-      options.retry.retries = 10;
+      options.retry.retries = IN_SCOPE_RETRIES;
       return rpRetry(options).then(() => {
         assert.notCalled(loggerSpyWarn);
       });
@@ -102,7 +107,7 @@ describe('request-retry Unit Tests', () => {
       });
     });
     it('should generate warning: out of scope delay: 100000 becoming max', () => {
-      options.retry.delay = 100000;
+      options.retry.delay = OUT_OF_SCOPE_RETRY_DELAY;
       return rpRetry(options).then(() => {
         assert.calledOnce(loggerSpyWarn);
         const callArgs = loggerSpyWarn.getCall(FIRST_CALL).args;
@@ -120,7 +125,7 @@ describe('request-retry Unit Tests', () => {
       });
     });
     it('should not generate warning: in scope delay', () => {
-      options.retry.delay = 20000;
+      options.retry.delay = IN_SCOPE_RETRY_DELAY;
       return rpRetry(options).then(() => {
         assert.notCalled(loggerSpyWarn);
       });
@@ -135,7 +140,7 @@ describe('request-retry Unit Tests', () => {
       });
     });
     it('should generate warning: out of scope timeout: 150  becoming max', () => {
-      options.retry.timeout = 150;
+      options.retry.timeout = OUT_OF_SCOPE_RETRY_TIMEOUT;
       return rpRetry(options).then(() => {
         assert.calledOnce(loggerSpyWarn);
         const callArgs = loggerSpyWarn.getCall(FIRST_CALL).args;
@@ -153,7 +158,7 @@ describe('request-retry Unit Tests', () => {
       });
     });
     it('should not generate warning: in scope timeout', () => {
-      options.retry.timeout = 50;
+      options.retry.timeout = IN_SCOPE_RETRY_TIMEOUT;
       return rpRetry(options).then(() => {
         assert.notCalled(loggerSpyWarn);
       });
@@ -269,7 +274,7 @@ describe('request-retry Unit Tests', () => {
       options.retry.retryStrategy = () => {
         throw new Error('this is a test');
       };
-      options.retry.retries = 2;
+      options.retry.retries = RETRY_RETRIES;
       return rpRetry(options)
         .catch(() => {
           assert.called(loggerSpyWarn);
@@ -280,7 +285,7 @@ describe('request-retry Unit Tests', () => {
     });
     it('should generate warning: bad retry strategy (not returning a boolean), ignoring and using default retries', () => {
       options.retry.retryStrategy = () => 'notABoolean';
-      options.retry.retries = 2;
+      options.retry.retries = RETRY_RETRIES;
       return rpRetry(options)
         .catch(() => {
           assert.called(loggerSpyWarn);
@@ -291,7 +296,7 @@ describe('request-retry Unit Tests', () => {
     });
     it('should not generate warning: retry strategy returning a boolean', () => {
       options.retry.retryStrategy = () => false;
-      options.retry.retries = 2;
+      options.retry.retries = RETRY_RETRIES;
       return rpRetry(options)
         .catch(() => {
           assert.called(loggerSpyWarn);
@@ -301,7 +306,7 @@ describe('request-retry Unit Tests', () => {
       options.retry.delayStrategy = () => {
         throw new Error('this is a test');
       };
-      options.retry.retries = 2;
+      options.retry.retries = RETRY_RETRIES;
       return rpRetry(options)
         .catch(() => {
           assert.called(loggerSpyWarn);
@@ -312,7 +317,7 @@ describe('request-retry Unit Tests', () => {
     });
     it('should generate warning: bad delay strategy (not returning a number), ignoring and using default delay', () => {
       options.retry.delayStrategy = () => 'notANumber';
-      options.retry.retries = 2;
+      options.retry.retries = RETRY_RETRIES;
       return rpRetry(options)
         .catch(() => {
           assert.called(loggerSpyWarn);
@@ -323,7 +328,7 @@ describe('request-retry Unit Tests', () => {
     });
     it('should generate warning: bad delay strategy (returning an out of scope number), ignoring and using default delay', () => {
       options.retry.delayStrategy = () => DELAY_STRATEGY_RESPONSE_1;
-      options.retry.retries = 2;
+      options.retry.retries = RETRY_RETRIES;
       return rpRetry(options)
         .catch(() => {
           assert.called(loggerSpyWarn);
@@ -334,7 +339,7 @@ describe('request-retry Unit Tests', () => {
     });
     it('should not generate warning: delay strategy returning an in scope number', () => {
       options.retry.delayStrategy = () => DELAY_STRATEGY_RESPONSE_2;
-      options.retry.retries = 2;
+      options.retry.retries = RETRY_RETRIES;
       return rpRetry(options)
         .catch(() => {
           assert.called(loggerSpyWarn);

package/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: