@mimik/request-retry 1.0.1 → 2.0.8

package/.eslintrc

@@ -1,21 +1,33 @@
-// Use this file as a starting point for your project's .eslintrc.
-// Copy this file, and add rule overrides as needed.
 {
+  "plugins": [
+    "@mimik/document-env",
+    "@mimik/dependencies"
+  ],
   "env": {
     "node": true
   },
+  "parserOptions": {
+    "ecmaVersion": 2020
+  },
   "extends": "airbnb",
   "rules": {
+    "import/no-extraneous-dependencies": ["error", {"devDependencies": true}],
+    "import/no-unresolved": ["error", { "amd": true, "commonjs": true, "caseSensitiveStrict": true }],
     "brace-style": [1, "stroustrup", {"allowSingleLine": true}],
-    "no-confusing-arrow": [0],
+    "no-confusing-arrow": [0], // arrow isnt confusing
     "max-len": [1, 180, { "ignoreComments": true }],
     "linebreak-style": 0,
     "quotes": [1, "single"],
-    "semi": [1, "always"]
+    "semi": [1, "always"],
+    "no-process-env": ["error"],
+    "@mimik/document-env/validate-document-env": 2,
+    "@mimik/dependencies/case-sensitive": 2,
+    "@mimik/dependencies/no-cycles": 2,
+    "@mimik/dependencies/require-json-ext": 2
   },
   "settings":{
     "react": {
-      "version": "latest"
+      "version": "detect"
     }
   },
   "globals": {

package/.husky/pre-commit

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

package/.husky/pre-push

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

package/README.md

@@ -15,7 +15,7 @@ Make a request with retry.
 **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.
+- <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`,
@@ -38,11 +38,19 @@ defaultRetry = (...args) => {
   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}`;
+
+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`
 
 **Requires**: <code>module:@mimik/sumologic-winston-logger</code>, <code>module:@mimik/response-helper</code>  
-**Fulfil**: <code>object</code> - Response of the [request-promise](https://www.npmjs.com/package/request-promise) request.  
+**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.  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| options | <code>object</code> | Options for the request. Similar to [request-promise](https://www.npmjs.com/package/request-promise) options. |
+| 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. |
 

package/index.js

@@ -1,15 +1,22 @@
-const rp = require('request-promise');
 const Promise = require('bluebird');
+const axios = require('axios');
 
 const logger = require('@mimik/sumologic-winston-logger');
 const { getRichError } = require('@mimik/response-helper');
-
+const { getCorrelationId, getUserAgent } = require('@mimik/request-helper');
 const {
   validateOptions,
   calculateDelay,
   isRetry,
   setResponse,
 } = require('./lib/validate');
+const { rp } = require('./lib/rp-axios-wrapper');
+
+const DEFAULT_RESPONSE_NAME = 'response';
+const DEFAULT_LOGLEVEL_DETAILS = 'full';
+const DEFAULT_LOGLEVEL_RESPONSE = 'info';
+const DEFAULT_LOGLEVEL_ERROR = 'warn';
+const DEFAULT_LOGLEVEL_REQUEST = 'info';
 
 Promise.config({ cancellation: true });
 
@@ -26,10 +33,10 @@ Promise.config({ cancellation: true });
  * @requires @mimik/sumologic-winston-logger
  * @requires @mimik/response-helper
  * @category async
- * @param {object} options - Options for the request. Similar to [request-promise](https://www.npmjs.com/package/request-promise) options.
+ * @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 [request-promise](https://www.npmjs.com/package/request-promise) request.
- * @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.
+ * @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.
  *
  * 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`,
@@ -52,32 +59,54 @@ Promise.config({ cancellation: true });
  *   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}`;
+ *
+ * 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`
  */
-const rpRetry = (options) => {
-  const correlationId = (options.headers && options.headers['x-correlation-id']);
+const rpRetry = (origOptions) => {
+  const { CancelToken } = axios;
+  const source = CancelToken.source();
+  const options = origOptions;
+  const correlationId = (options.headers && options.headers['x-correlation-id']) ? options.headers['x-correlation-id'] : getCorrelationId();
   const errors = [];
   const delayPromises = [];
+  const criteria = validateOptions(options, correlationId);
+  const { logLevel } = criteria;
+  const logLevelLength = Object.keys(logLevel).length;
   let nbRetries = 0;
+  let mainTimeout;
 
-  const retryProcess = (opts, nbRetry, crit, corrId) => rp(opts)
+  if (!options.headers) options.headers = { 'user-agent': getUserAgent() };
+  else if (!options.headers['user-agent']) options.headers['user-agent'] = getUserAgent();
+  options.cancelToken = source.token;
+
+  const retryProcess = (nbRetry) => rp(options)
     .then((response) => {
-      const info = { options: opts, nbRetries, errors };
+      const info = { options, nbRetries, errors };
 
-      if (crit.logLevel.response) {
-        info[crit.logLevel.responseName] = setResponse(response, crit.logLevel.responseDetails);
-        logger[crit.logLevel.response]('request response', info, corrId);
+      if (logLevel.response) {
+        info[logLevel.responseName] = setResponse(response, logLevel.responseDetails);
+        logger[logLevel.response]('request response', info, correlationId);
+      }
+      else if (logLevelLength === 0) {
+        info[DEFAULT_RESPONSE_NAME] = setResponse(response, DEFAULT_LOGLEVEL_DETAILS);
+        logger[DEFAULT_LOGLEVEL_RESPONSE]('request response', info, correlationId);
       }
       return response;
     })
     .catch((err) => {
-      if ((nbRetry < crit.retries) && isRetry(opts, nbRetry, crit, err, corrId)) {
+      if ((nbRetry < criteria.retries) && isRetry(options, nbRetry, criteria, err, correlationId)) {
         nbRetries = nbRetry + 1;
-        errors.push(err.message);
-        const delayPromise = Promise.delay(calculateDelay(opts, nbRetry, crit, err, corrId));
+        errors.push(err);
+        const delayPromise = Promise.delay(calculateDelay(options, nbRetry, criteria, err, correlationId));
 
         delayPromises.unshift(delayPromise);
-        return delayPromise.then(() => retryProcess(opts, nbRetry + 1, crit, corrId));
+        return delayPromise.then(() => retryProcess(nbRetry + 1));
       }
       const error = err;
 
@@ -88,36 +117,49 @@ const rpRetry = (options) => {
           errors,
         };
       }
-      throw getRichError(error.statusCode, 'request error response', { options }, error, crit.logLevel.error, corrId);
+      throw getRichError(
+        error.statusCode,
+        'request error response',
+        { options },
+        error,
+        logLevel.error || ((logLevelLength === 0) ? DEFAULT_LOGLEVEL_ERROR : undefined),
+        correlationId,
+      );
     });
 
-  let mainTimeout;
-  const criteria = validateOptions(options);
-  const retryPromise = retryProcess(options, 0, criteria, correlationId);
+  const retryPromise = retryProcess(0);
   const mainTimeoutPromise = new Promise((resolve, reject) => {
     mainTimeout = setTimeout(() => {
-      delayPromises.forEach((delayPromise) => delayPromise.cancel());
-      retryPromise.cancel();
+      delayPromises.forEach((delayPromise) => delayPromise.cancel(`retry timeout, ${criteria.timeout}, ${nbRetries}`));
+      source.cancel(`retry timeout, ${criteria.timeout}, ${nbRetries}`);
       let error = new Error('retry timeout');
 
       if (nbRetries !== 0) {
         error.info = { retry: { nbRetries, errors } };
       }
       error.name = 'TimeoutError';
-      error = getRichError('System', 'request error response', { options }, error, criteria.logLevel.error, correlationId);
+      error = getRichError(
+        'System',
+        'request error response',
+        { options },
+        error,
+        logLevel.error || ((logLevelLength === 0) ? DEFAULT_LOGLEVEL_ERROR : undefined),
+        correlationId,
+      );
       reject(error);
     }, criteria.timeout * 1000);
   });
 
-  if (criteria.logLevel.request) logger[criteria.logLevel.request]('making a request', { options, criteria }, correlationId);
+  if (logLevel.request) logger[logLevel.request]('making a request', { options, criteria }, correlationId);
+  else if (logLevelLength === 0) logger[DEFAULT_LOGLEVEL_REQUEST]('making a request', { options, criteria }, correlationId);
   return Promise.race([retryPromise, mainTimeoutPromise])
     .then((result) => {
-      mainTimeoutPromise.cancel();
+      mainTimeoutPromise.cancel('main timeout');
       clearTimeout(mainTimeout);
       return result;
     })
     .catch((err) => {
-      mainTimeoutPromise.cancel();
+      mainTimeoutPromise.cancel(`main timeout error: ${err.message}`);
       clearTimeout(mainTimeout);
       throw err;
     });

package/lib/rp-axios-wrapper.js

@@ -0,0 +1,48 @@
+const axios = require('axios');
+const _ = require('lodash');
+
+const { getRichError } = require('@mimik/response-helper');
+
+const rp = (origOptions) => {
+  const options = _.clone(origOptions);
+
+  if (options.uri) options.url = options.uri;
+  delete options.uri;
+  delete options.validateStatus;
+  if (options.body) {
+    options.data = options.body;
+    delete options.body;
+  }
+  else if (typeof options.json === 'object') {
+    options.data = options.body;
+    delete options.json;
+  }
+  else delete options.json;
+  if (options.qs) options.params = options.qs;
+  return axios(options)
+    .then((res) => {
+      if (options.resolveWithFullResponse) return res;
+      return res.data;
+    })
+    .catch((err) => {
+      const { response } = err;
+      let errorMsg = 'no response';
+
+      if (err.message) errorMsg = `${errorMsg}: ${err.message}`;
+      if (!response) {
+        throw getRichError('System', errorMsg, {
+          code: err.code,
+          address: err.address,
+          port: err.port,
+          syscall: err.syscall,
+        });
+      }
+      const { data } = response;
+
+      throw getRichError(response.status, data ? data.message || response.statusText : response.statusText, data);
+    });
+};
+
+module.exports = {
+  rp,
+};

package/lib/validate.js

@@ -3,7 +3,7 @@ const logger = require('@mimik/sumologic-winston-logger');
 const DETAILS = ['full', 'type', 'count'];
 const TYPE = DETAILS[1];
 const RESPONSE = 'response';
-const DEFAULT_LOG_LEVEL = logger.LEVELS[5]; // silly
+const DEFAULT_LOGLEVEL = logger.LEVELS[5]; // silly
 const DEFAULT_RETRIES = 2;
 const MIN_RETRIES = 0;
 const MAX_RETRIES = 15;
@@ -22,7 +22,7 @@ const defaultRetry = (...args) => {
 const unknownRetry = () => true;
 const defaultDelay = () => DEFAULT_DELAY;
 
-const validateOptions = (options) => {
+const validateOptions = (options, correlationId) => {
   if (!options.retry) {
     return {
       delay: DEFAULT_DELAY,
@@ -44,22 +44,22 @@ const validateOptions = (options) => {
   const validateLogLevel = (val, name) => {
     if (!val[name]) return null;
     if (!logger.LEVELS.includes(val[name])) {
-      logger.warn(`invalid logLevel.${name}, reset to default`, { name, value: val[name], default: DEFAULT_LOG_LEVEL });
-      return DEFAULT_LOG_LEVEL;
+      logger.warn(`invalid logLevel.${name}, reset to default`, { name, value: val[name], default: DEFAULT_LOGLEVEL }, correlationId);
+      return DEFAULT_LOGLEVEL;
     }
     return val[name];
   };
   const validateValue = (val, name, defaultValue, minValue, maxValue) => {
     if (typeof val !== 'number') {
-      if (val) logger.warn(`invalid ${name}, reset to default`, { type: typeof val, defaultValue });
+      if (val) logger.warn(`invalid ${name}, reset to default`, { type: typeof val, defaultValue }, correlationId);
       return defaultValue;
     }
     if (val < minValue) {
-      logger.warn(`out of scope ${name}, reset to min`, { value: val, minValue });
+      logger.warn(`out of scope ${name}, reset to min`, { value: val, minValue }, correlationId);
       return minValue;
     }
     if (val > maxValue) {
-      logger.warn(`out of scope ${name}, reset to max`, { value: val, maxValue });
+      logger.warn(`out of scope ${name}, reset to max`, { value: val, maxValue }, correlationId);
       return maxValue;
     }
     return val;
@@ -67,7 +67,7 @@ const validateOptions = (options) => {
   const validateResponseDetails = (val, name, defaultValue) => {
     if (!val) return defaultValue;
     if (!DETAILS.includes(val)) {
-      logger.warn(`invalid logLevel.${name}, reset to default`, { name, value: val, defaultValue });
+      logger.warn(`invalid logLevel.${name}, reset to default`, { name, value: val, defaultValue }, correlationId);
       return defaultValue;
     }
     return val;
@@ -75,7 +75,7 @@ const validateOptions = (options) => {
   const validateResponseName = (val, name, defaultValue) => {
     if (!val && val !== '') return defaultValue;
     if (typeof val !== 'string' || val.length === 0 || val.trim().length === 0) {
-      logger.warn(`invalid logLevel.${name}, reset to default`, { name, value: val, defaultValue });
+      logger.warn(`invalid logLevel.${name}, reset to default`, { name, value: val, defaultValue }, correlationId);
       return defaultValue;
     }
     return val;
@@ -88,14 +88,14 @@ const validateOptions = (options) => {
   if (typeof delayStrategy !== 'function') {
     if (!delayStrategy) delayStrategy = defaultDelay;
     else {
-      logger.warn('invalid delayStrategy, using delay', { strategyType: typeof delayStrategy, delay, default: DEFAULT_DELAY });
+      logger.warn('invalid delayStrategy, using delay', { strategyType: typeof delayStrategy, delay, default: DEFAULT_DELAY }, correlationId);
       delayStrategy = setDelay;
     }
   }
   if (typeof retryStrategy !== 'function') {
     if (!retryStrategy) retryStrategy = defaultRetry;
     else {
-      logger.warn('invalid retryStrategy, ignoring', { strategyType: typeof retryStrategy, using: unknownRetry });
+      logger.warn('invalid retryStrategy, ignoring', { strategyType: typeof retryStrategy, using: unknownRetry }, correlationId);
       retryStrategy = unknownRetry;
     }
   }

package/manual-test/httpMock.js

@@ -0,0 +1,16 @@
+/* eslint-disable no-console */
+const express = require('express');
+const bodyParser = require('body-parser');
+
+const app = express();
+
+app.use(bodyParser.json());
+app.get('/success', (req, res) => {
+  res.statusCode = 200;
+
+  res.send({ statusCode: 200 });
+});
+
+app.listen(9000, () => {
+  console.log('----->', `retry mock at ${9000}`);
+});

package/manual-test/man.js

@@ -0,0 +1,23 @@
+/* eslint-disable no-console */
+require('../test/testEnv');
+
+const { rpRetry } = require('../index');
+
+const correlationId = `--request-retry-test--/${new Date().toISOString()}`;
+
+const options = {
+  method: 'GET',
+  headers: {
+    'x-correlation-id': correlationId,
+  },
+  url: 'http://localhost:9080/test/retry',
+  json: true,
+  retry: {},
+};
+
+options.retry.delayStrategy = () => 10000;
+options.retry.timeout = 10;
+options.retry.retries = 2;
+
+rpRetry(options)
+  .catch((err) => console.log(err));

package/manual-test/retryMockMan.js

@@ -0,0 +1,60 @@
+/* eslint-disable no-console */
+const express = require('express');
+const bodyParser = require('body-parser');
+
+const app = express();
+const config = {
+  port: 9080,
+  path: '/retry',
+  base: '/test',
+  get: {
+    nbRetry: 400,
+    success: 200,
+    error: 500,
+  },
+  post: {
+    success: 201,
+  },
+};
+let nbRequest = 0;
+let time = 0;
+let message;
+
+app.use(bodyParser.json());
+app.get(`${config.base}${config.path}`, (req, res) => {
+  if (nbRequest === 0) message = 'Recieved first request';
+  else {
+    const timeLap = Date.now() - time;
+
+    message = `Received ${nbRequest} retry with timelap ${timeLap}`;
+  }
+  console.log('----->', message);
+  time = Date.now();
+
+  if (nbRequest === config.get.nbRetry) {
+    res.statusCode = config.get.success;
+    res.send({ statusCode: config.get.success });
+    return;
+  }
+  nbRequest += 1;
+  res.statusCode = config.get.error;
+
+  res.send({ statusCode: config.get.error });
+});
+app.post(`${config.base}${config.path}`, (req, res) => {
+  console.log('----->', 'Received a POST request');
+  res.statusCode = config.post.success;
+  res.send({ statusCode: config.post.success });
+});
+
+app.post('/logs/:id', (req, res) => {
+  console.log('--->', 'Recieved a log');
+  console.log('---> id:', req.params.id);
+  console.log('---> body:', req.body);
+  res.statusCode = config.post.success;
+  res.send({ statusCode: config.post.success });
+});
+
+app.listen(config.port, () => {
+  console.log('----->', `retry mock at ${config.port}`);
+});

package/manual-test/testRace.js

@@ -1,27 +1,28 @@
-const doSomething = () => { 
-	let add = 0;
+/* eslint-disable no-console */
+const doSomething = () => {
+  let add = 0;
 
-	for (i = 0; i < 100000000; i++) {
-		add +=1;
-		console.log(add)
-	};
-	return add 
+  for (let i = 0; i < 100000000; i += 1) {
+    add += 1;
+    console.log(add);
+  }
+  return add;
 };
 const timeout = 1; // ms
 
 const race = () => {
-	let result;
-	const mainTimeout = setTimeout(() => {
-		throw new Error('timeout')
-	}, timeout);
+  let result;
+  const mainTimeout = setTimeout(() => {
+    throw new Error('timeout');
+  }, timeout);
 
-	try { result = doSomething() }
-	catch (err) { 
-		console.log(err);
-		result = 0;
-	}
-	clearTimeout(mainTimeout);
-	return result;
-}
+  try { result = doSomething(); }
+  catch (err) {
+    console.log(err);
+    result = 0;
+  }
+  clearTimeout(mainTimeout);
+  return result;
+};
 
 console.log(race());

package/manual-test/testRetry.js

@@ -1,4 +1,5 @@
-const { rpRetry } = require('../../../common/rp-retry-34/index.js');
+/* eslint-disable no-console */
+const { rpRetry } = require('../index');
 
 const options = {
   method: 'GET',
@@ -9,49 +10,50 @@ const options = {
   json: true,
   timeout: 200,
   // retry: {
-    // all default: maxRetry: 2, retryDelay: 1000ms, maxTimeout: 50s, logLevel: 3 silly, type response, retryDelayStrategy: setDelay, retryStrategy: defaultRetry
-    // retries: -1,  // => 0
-    // retries: 20, // => 15
-    // retries: 'joe', // => 2
-    // retries: 0, // OK
-    // delay: 0, // => 20ms
-    // delay: 100000, // => 30000ms
-    // delay: 'joe', // => 1000ms
-    // delay: 1, // => 20ms
-    // 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: 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
-    // },
-    // retryStrategy: function invalidRetry(...args) { // defaultRetry
-    //   const { statusCode } = args[34]; // null value
-    //  
-    //   return true // no retry
-    // },
-    // timeout: 0, // => 10s
-    // timeout: 150, // => 120s
-    // timeout: 'joe', // => 50s
-    // logLevel: {
-    //   response: 'test', // silly with warning
-    //   error: 1234, // => silly with warning
-    //   request: null, // => silly no warning
-    //   responseDetails: 'test', // => type with warning
-    //   responseName: '', // => response with warning
-    // },
-    // logLevel: {
-    //   response: 'info', // ok all the other value to default no warning
-    // }, 
-  //}
+  // all default: maxRetry: 2, retryDelay: 1000ms, maxTimeout: 50s, logLevel: 3 silly, type response, retryDelayStrategy: setDelay, retryStrategy: defaultRetry
+  // retries: -1,  // => 0
+  // retries: 20, // => 15
+  // retries: 'joe', // => 2
+  // retries: 0, // OK
+  // delay: 0, // => 20ms
+  // delay: 100000, // => 30000ms
+  // delay: 'joe', // => 1000ms
+  // delay: 1, // => 20ms
+  // 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: 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
+  // },
+  // retryStrategy: function invalidRetry(...args) { // defaultRetry
+  //   const { statusCode } = args[34]; // null value
+  //
+  //   return true // no retry
+  // },
+  // timeout: 0, // => 10s
+  // timeout: 150, // => 120s
+  // timeout: 'joe', // => 50s
+  // logLevel: {
+  //   response: 'test', // silly with warning
+  //   error: 1234, // => silly with warning
+  //   request: null, // => silly no warning
+  //   responseDetails: 'test', // => type with warning
+  //   responseName: '', // => response with warning
+  // },
+  // logLevel: {
+  //   response: 'info', // ok all the other value to default no warning
+  // },
+  // }
 };
 
 const sDate = Date.now();
 
 rpRetry(options)
-  .then(response => console.log('success', { response: typeof response }, Date.now() - sDate))
-  .catch(err => { console.log('failure', { error: err, info: err.info }, Date.now() - sDate);
-  })
+  .then((response) => console.log('success', { response: typeof response }, Date.now() - sDate))
+  .catch((err) => {
+    console.log('failure', { error: err, info: err.info }, Date.now() - sDate);
+  });

package/package.json

@@ -1,13 +1,16 @@
 {
   "name": "@mimik/request-retry",
-  "version": "1.0.1",
-  "description": "Request retry wrapping request-promise",
+  "version": "2.0.8",
+  "description": "Request retry wrapping axios",
   "main": "index.js",
   "scripts": {
-    "lint": "gulp lint",
-    "docs": "gulp docs",
-    "test": "nyc gulp test",
-    "commit-ready": "gulp docs; gulp lint; npm run test"
+    "lint": "eslint --ignore-path .gitignore .",
+    "docs": "jsdoc2md index.js > README.md",
+    "test": "mocha --reporter mochawesome --bail --check-leaks test/",
+    "test-ci": "nyc --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",
+    "prepare": "husky install"
   },
   "husky": {
     "hooks": {
@@ -19,41 +22,39 @@
     "mimik",
     "microservice"
   ],
-  "author": "mimik",
-  "license": "Apache-2.0",
+  "author": "mimik technology inc <support@mimik.com> (https://developer.mimik.com/)",
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://bitbucket.org/mimiktech/request-retry"
   },
   "dependencies": {
-    "@mimik/response-helper": "2.2.1",
-    "@mimik/sumologic-winston-logger": "1.3.0",
-    "bluebird": "3.7.1",
-    "request": "2.88.0",
-    "request-promise": "4.2.5"
+    "@mimik/request-helper": "^1.7.5",
+    "@mimik/response-helper": "^2.6.1",
+    "@mimik/sumologic-winston-logger": "^1.6.8",
+    "axios": "0.27.2",
+    "bluebird": "3.7.2",
+    "lodash": "4.17.21"
   },
   "devDependencies": {
-    "acorn": "7.1.0",
-    "body-parser": "1.19.0",
-    "chai": "4.2.0",
-    "eslint": "6.6.0",
-    "eslint-config-airbnb": "18.0.1",
-    "eslint-plugin-import": "2.18.2",
-    "eslint-plugin-jsx-a11y": "6.2.3",
-    "eslint-plugin-react": "7.16.0",
-    "eslint-plugin-react-hooks": "2.2.0",
-    "express": "4.17.1",
-    "fancy-log": "1.3.3",
-    "gulp": "4.0.2",
-    "gulp-eslint": "6.0.0",
-    "gulp-git": "2.9.0",
-    "gulp-spawn-mocha": "6.0.0",
-    "husky": "3.0.9",
-    "jsdoc-to-markdown": "5.0.2",
-    "mocha": "6.2.2",
-    "mochawesome": "4.1.0",
-    "nyc": "14.1.1",
-    "sinon": "7.5.0",
-    "verror": "1.10.0"
+    "@mimik/eslint-plugin-dependencies": "^2.4.3",
+    "@mimik/eslint-plugin-document-env": "^1.0.3",
+    "acorn": "8.7.1",
+    "body-parser": "1.20.0",
+    "chai": "4.3.6",
+    "eslint": "8.15.0",
+    "eslint-config-airbnb": "19.0.4",
+    "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-jsx-a11y": "6.5.1",
+    "eslint-plugin-react": "7.29.4",
+    "eslint-plugin-react-hooks": "4.5.0",
+    "express": "4.18.1",
+    "husky": "8.0.1",
+    "jsdoc-to-markdown": "7.1.1",
+    "mocha": "10.0.0",
+    "mochawesome": "7.1.3",
+    "nyc": "15.1.0",
+    "sinon": "14.0.0",
+    "verror": "1.10.1"
   }
 }

package/test/retryMock.js

@@ -46,6 +46,14 @@ app.post(`${config.base}${config.path}`, (req, res) => {
   res.statusCode = config.post.success;
   res.send({ statusCode: config.post.success });
 });
+app.get('/stop', (req, res) => {
+  console.log('----->', 'Received a stop');
+  res.statusCode = config.get.success;
+  res.send({ statusCode: config.get.success });
+  setTimeout(() => {
+    process.exit(0);
+  }, 3000);
+});
 
 const listen = () => {
   app.listen(config.port, () => {

package/test/rpRetry.spec.js

@@ -2,10 +2,11 @@ const chai = require('chai');
 const sinon = require('sinon');
 const VError = require('verror');
 const { beforeEach, afterEach } = require('mocha');
+require('./testEnv');
 
 const logger = require('@mimik/sumologic-winston-logger');
+const { getCorrelationId } = require('@mimik/request-helper');
 
-require('./testEnv');
 const mockServer = require('./retryMock');
 const { rpRetry } = require('../index');
 
@@ -16,7 +17,7 @@ chai.should();
 // const NO_ERROR = 'not an error object';
 
 describe('request-retry Unit Tests', () => {
-  const correlationId = '--request-retry-test--';
+  const correlationId = getCorrelationId('--request-retry-test--');
   // let loggerSpyError;
   let loggerSpyWarn;
   let loggerSpyInfo;
@@ -261,7 +262,7 @@ describe('request-retry Unit Tests', () => {
       options.retry.retries = 2;
       return rpRetry(options)
         .catch(() => {
-          sinon.assert.calledTwice(loggerSpyWarn);
+          sinon.assert.called(loggerSpyWarn);
           const callArgs = loggerSpyWarn.getCall(0).args;
           expect(callArgs[0]).to.be.a('string');
           expect(callArgs[0]).to.equal('bad retry strategy');
@@ -272,7 +273,7 @@ describe('request-retry Unit Tests', () => {
       options.retry.retries = 2;
       return rpRetry(options)
         .catch(() => {
-          sinon.assert.calledTwice(loggerSpyWarn);
+          sinon.assert.called(loggerSpyWarn);
           const callArgs = loggerSpyWarn.getCall(0).args;
           expect(callArgs[0]).to.be.a('string');
           expect(callArgs[0]).to.equal('bad retry strategy');
@@ -282,10 +283,8 @@ describe('request-retry Unit Tests', () => {
       options.retry.retryStrategy = () => false;
       options.retry.retries = 2;
       return rpRetry(options)
-        .then(() => {
-        })
         .catch(() => {
-          sinon.assert.notCalled(loggerSpyWarn);
+          sinon.assert.called(loggerSpyWarn);
         });
     });
     it('should generate warning: bad delay strategy (throwing an error), ignoring and using default delay', () => {
@@ -293,7 +292,7 @@ describe('request-retry Unit Tests', () => {
       options.retry.retries = 2;
       return rpRetry(options)
         .catch(() => {
-          sinon.assert.calledTwice(loggerSpyWarn);
+          sinon.assert.called(loggerSpyWarn);
           const callArgs = loggerSpyWarn.getCall(0).args;
           expect(callArgs[0]).to.be.a('string');
           expect(callArgs[0]).to.equal('bad delay strategy');
@@ -304,7 +303,7 @@ describe('request-retry Unit Tests', () => {
       options.retry.retries = 2;
       return rpRetry(options)
         .catch(() => {
-          sinon.assert.calledTwice(loggerSpyWarn);
+          sinon.assert.called(loggerSpyWarn);
           const callArgs = loggerSpyWarn.getCall(0).args;
           expect(callArgs[0]).to.be.a('string');
           expect(callArgs[0]).to.equal('bad delay strategy');
@@ -315,7 +314,7 @@ describe('request-retry Unit Tests', () => {
       options.retry.retries = 2;
       return rpRetry(options)
         .catch(() => {
-          sinon.assert.calledTwice(loggerSpyWarn);
+          sinon.assert.called(loggerSpyWarn);
           const callArgs = loggerSpyWarn.getCall(0).args;
           expect(callArgs[0]).to.be.a('string');
           expect(callArgs[0]).to.equal('calculated delay out of scope: using delay or default');
@@ -325,10 +324,8 @@ describe('request-retry Unit Tests', () => {
       options.retry.delayStrategy = () => 50;
       options.retry.retries = 2;
       return rpRetry(options)
-        .then(() => {
-        })
         .catch(() => {
-          sinon.assert.notCalled(loggerSpyWarn);
+          sinon.assert.called(loggerSpyWarn);
         });
     });
     it('should generate a timeout error', () => {
@@ -336,13 +333,26 @@ describe('request-retry Unit Tests', () => {
       options.retry.timeout = 10;
       options.retry.retries = 2;
       return rpRetry(options)
-        .then(() => {
-        })
         .catch((err) => {
           expect(err.name).to.equal('System');
           expect(VError.cause(err).name).to.equal('TimeoutError');
-          sinon.assert.notCalled(loggerSpyWarn);
+          // sinon.assert.called(loggerSpyWarn);
         });
     });
+    it('should stop mock server', () => rpRetry({
+      method: 'GET',
+      headers: {
+        'x-correlation-id': correlationId,
+      },
+      url: 'http://localhost:9070/stop',
+      retry: {
+        delayStrategy: () => 100,
+        retries: 1,
+      },
+    })
+      .catch((err) => {
+        expect(err.name).to.equal('System');
+        expect(VError.cause(err).name).to.equal('TimeoutError');
+      }));
   });
 });

package/test/testEnv.js

@@ -1,5 +1,21 @@
+/* eslint no-process-env: "off" */
+
+/**
+ * The following environment variables are set for the test:
+ *
+ * | Env variable name | Description | Default | Comments |
+ * | ----------------- | ----------- | ------- | -------- |
+ * | SUMO_LOGIC_ENDPOINT | endpoint to use to log on sumologic | null
+ * | 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
+ */
+
+// process.env.SUMO_LOGIC_ENDPOINT = 'http://localhost:9080/logs/';
+// process.env.SUMO_LOGIC_COLLECTOR_CODE = '1234';
 process.env.SUMO_LOGIC_ENDPOINT = null;
 process.env.SUMO_LOGIC_COLLECTOR_CODE = null;
 process.env.NO_STACK = 'yes';
-process.env.LOG_LEVEL = 'error';
-// process.env.CONSOLE_LEVEL = 'debug';
+process.env.LOG_LEVEL = 'debug';
+process.env.CONSOLE_LEVEL = 'debug';

package/Gulpfile.js

@@ -1,42 +0,0 @@
-/* eslint-disable import/no-extraneous-dependencies */
-const fs = require('fs');
-const log = require('fancy-log');
-const gulp = require('gulp');
-const eslint = require('gulp-eslint');
-const git = require('gulp-git');
-const jsdoc2md = require('jsdoc-to-markdown');
-const mocha = require('gulp-spawn-mocha');
-
-const files = [
-  'index.js',
-  'Gulpfile.js',
-  'test/**.js',
-  'lib/**.js',
-];
-
-const createDocs = (done) => {
-  jsdoc2md.render({ files: 'index.js' })
-    .then((output) => fs.writeFileSync('README.md', output))
-    .catch((err) => log.error('docs creation failed:', err.message));
-  return done();
-};
-
-const lint = () => gulp.src(files)
-  .pipe(eslint({}))
-  .pipe(eslint.format())
-  .pipe(eslint.failOnError());
-
-const add = () => gulp.src('README.md')
-  .pipe(git.add({ quiet: true }));
-
-const test = () => gulp.src(['test/*.spec.js'])
-  .pipe(mocha({
-    reporter: 'mochawesome',
-    exit: true,
-  }));
-
-const docs = gulp.series(createDocs, add);
-
-gulp.task('lint', lint);
-gulp.task('docs', docs);
-gulp.task('test', test);

package/package.json.bak

@@ -1,60 +0,0 @@
-{
-  "name": "@mimik/request-retry",
-  "version": "1.0.1",
-  "description": "Request retry wrapping request-promise",
-  "main": "index.js",
-  "scripts": {
-    "lint": "gulp lint",
-    "docs": "gulp docs",
-    "test": "nyc gulp test",
-    "prepublishOnly": "gulp docs; gulp lint; npm run test",
-    "commit-ready": "gulp docs; gulp lint; npm run test"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "npm run commit-ready",
-      "pre-push": "npm run test"
-    }
-  },
-  "keywords": [
-    "mimik",
-    "microservice"
-  ],
-  "author": "mimik",
-  "license": "Apache-2.0",
-  "repository": {
-    "type": "git",
-    "url": "https://bitbucket.org/mimiktech/request-retry"
-  },
-  "dependencies": {
-    "@mimik/response-helper": "2.2.1",
-    "@mimik/sumologic-winston-logger": "1.3.0",
-    "bluebird": "3.7.1",
-    "request": "2.88.0",
-    "request-promise": "4.2.5"
-  },
-  "devDependencies": {
-    "acorn": "7.1.0",
-    "body-parser": "1.19.0",
-    "chai": "4.2.0",
-    "eslint": "6.6.0",
-    "eslint-config-airbnb": "18.0.1",
-    "eslint-plugin-import": "2.18.2",
-    "eslint-plugin-jsx-a11y": "6.2.3",
-    "eslint-plugin-react": "7.16.0",
-    "eslint-plugin-react-hooks": "2.2.0",
-    "express": "4.17.1",
-    "fancy-log": "1.3.3",
-    "gulp": "4.0.2",
-    "gulp-eslint": "6.0.0",
-    "gulp-git": "2.9.0",
-    "gulp-spawn-mocha": "6.0.0",
-    "husky": "3.0.9",
-    "jsdoc-to-markdown": "5.0.2",
-    "mocha": "6.2.2",
-    "mochawesome": "4.1.0",
-    "nyc": "14.1.1",
-    "sinon": "7.5.0",
-    "verror": "1.10.0"
-  }
-}