@mimik/request-retry 2.0.6 → 2.0.9

package/.eslintrc

@@ -12,6 +12,7 @@
   "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], // arrow isnt confusing
     "max-len": [1, 180, { "ignoreComments": true }],
@@ -22,12 +23,11 @@
     "@mimik/document-env/validate-document-env": 2,
     "@mimik/dependencies/case-sensitive": 2,
     "@mimik/dependencies/no-cycles": 2,
-    "@mimik/dependencies/no-unresolved": 2,
     "@mimik/dependencies/require-json-ext": 2
   },
   "settings":{
     "react": {
-      "version": "latest"
+      "version": "detect"
     }
   },
   "globals": {

package/README.md

@@ -17,14 +17,6 @@ Make a request with retry.
 
 - <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 environment variable are being used:
-
-| Env variable name | Description | Default | Comments |
-| ----------------- | ----------- | ------- | -------- |
-| SERVER_TYPE | type of the server instance that makes the call | generic | for defining the agent
-| SERVER_VERSION |version of the server instance that makes the call | 1.0 | for defining the agent
-| SERVER_ID | id of the server instance that makes the call | generic | for defining the agent
-
 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`,

package/index.js

@@ -1,10 +1,9 @@
-/* eslint no-process-env: "off" */
 const Promise = require('bluebird');
 const axios = require('axios');
 
 const logger = require('@mimik/sumologic-winston-logger');
 const { getRichError } = require('@mimik/response-helper');
-const { getCorrelationId } = require('@mimik/request-helper');
+const { getCorrelationId, setUserAgent } = require('@mimik/request-helper');
 const {
   validateOptions,
   calculateDelay,
@@ -19,11 +18,6 @@ const DEFAULT_LOGLEVEL_RESPONSE = 'info';
 const DEFAULT_LOGLEVEL_ERROR = 'warn';
 const DEFAULT_LOGLEVEL_REQUEST = 'info';
 
-const nodeDescription = `${process.release.name} ${process.version} ${process.release.lts}`;
-const serverDescription = `mimik-${process.env.SERVER_TYPE || 'generic'}/${process.env.SERVER_VERSION || '1.0'}/${process.env.SERVER_ID || 'generic'}`;
-const platformDescription = `${process.platform}; ${process.arch}`;
-const userAgent = `${serverDescription} (${platformDescription}; ${nodeDescription})`;
-
 Promise.config({ cancellation: true });
 
 /**
@@ -44,14 +38,6 @@ Promise.config({ cancellation: true });
  * @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 environment variable are being used:
- *
- * | Env variable name | Description | Default | Comments |
- * | ----------------- | ----------- | ------- | -------- |
- * | SERVER_TYPE | type of the server instance that makes the call | generic | for defining the agent
- * | SERVER_VERSION |version of the server instance that makes the call | 1.0 | for defining the agent
- * | SERVER_ID | id of the server instance that makes the call | generic | for defining the agent
- *
  * 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`,
@@ -95,8 +81,8 @@ const rpRetry = (origOptions) => {
   let nbRetries = 0;
   let mainTimeout;
 
-  if (!options.headers) options.headers = { 'user-agent': userAgent };
-  else if (!options.headers['user-agent']) options.headers['user-agent'] = userAgent;
+  if (!options.headers) options.headers = { 'user-agent': setUserAgent() };
+  else if (!options.headers['user-agent']) options.headers['user-agent'] = setUserAgent();
   options.cancelToken = source.token;
 
   const retryProcess = (nbRetry) => rp(options)

package/manual-test/httpMock.js

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

package/manual-test/man.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-console */
 require('../test/testEnv');
 
 const { rpRetry } = require('../index');
@@ -5,18 +6,18 @@ 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: {},
-    };
+  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;
+options.retry.delayStrategy = () => 10000;
+options.retry.timeout = 10;
+options.retry.retries = 2;
 
 rpRetry(options)
-	.catch((err) => console.log(err));
+  .catch((err) => console.log(err));

package/manual-test/retryMockMan.js

@@ -49,12 +49,12 @@ app.post(`${config.base}${config.path}`, (req, res) => {
 
 app.post('/logs/:id', (req, res) => {
   console.log('--->', 'Recieved a log');
-  console.log('---> id:', req.params.id)
+  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,14 +1,15 @@
 {
   "name": "@mimik/request-retry",
-  "version": "2.0.6",
+  "version": "2.0.9",
   "description": "Request retry wrapping axios",
   "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",
+    "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": {
@@ -22,43 +23,38 @@
     "microservice"
   ],
   "author": "mimik technology inc <support@mimik.com> (https://developer.mimik.com/)",
-  "license": "Apache-2.0",
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://bitbucket.org/mimiktech/request-retry"
   },
   "dependencies": {
-    "@mimik/request-helper": "^1.7.3",
-    "@mimik/response-helper": "^2.6.0",
-    "@mimik/sumologic-winston-logger": "^1.6.6",
-    "axios": "0.24.0",
+    "@mimik/request-helper": "^1.7.6",
+    "@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": {
-    "@mimik/eslint-plugin-dependencies": "^2.4.1",
-    "@mimik/eslint-plugin-document-env": "^1.0.0",
-    "acorn": "8.6.0",
-    "body-parser": "1.19.1",
-    "chai": "4.3.4",
-    "eslint": "8.4.1",
-    "eslint-config-airbnb": "18.2.1",
-    "eslint-plugin-import": "2.25.3",
+    "@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.27.1",
-    "eslint-plugin-react-hooks": "4.3.0",
-    "express": "4.17.1",
-    "fancy-log": "1.3.3",
-    "gulp": "4.0.2",
-    "gulp-eslint": "6.0.0",
-    "gulp-git": "2.10.1",
-    "gulp-spawn-mocha": "6.0.0",
-    "husky": "7.0.4",
-    "jsdoc-to-markdown": "7.1.0",
-    "mocha": "9.1.3",
-    "mochawesome": "7.0.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": "12.0.1",
+    "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

@@ -339,5 +339,20 @@ describe('request-retry Unit Tests', () => {
           // 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/Gulpfile.js

@@ -1,41 +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))
-    .finally(() => done());
-};
-
-const lint = () => gulp.src(files)
-  .pipe(eslint({}))
-  .pipe(eslint.format());
-
-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);