@mimik/request-retry 2.0.11 → 2.1.0

package/README.md

@@ -29,6 +29,10 @@ The following properties are added to the `options` object under the `retry` pro
    - *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

package/index.js

@@ -1,5 +1,4 @@
 const Promise = require('bluebird');
-const axios = require('axios');
 
 const logger = require('@mimik/sumologic-winston-logger');
 const { getRichError } = require('@mimik/response-helper');
@@ -50,6 +49,10 @@ Promise.config({ cancellation: true });
  *    - *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
@@ -69,9 +72,10 @@ Promise.config({ cancellation: true });
  * - `qs` is used to assign to `params`
  */
 const rpRetry = (origOptions) => {
-  const { CancelToken } = axios;
-  const source = CancelToken.source();
+  const startHrTime = process.hrtime();
   const options = origOptions;
+  const { metrics } = options;
+  const enteredUrl = options.uri || options.url;
   const correlationId = (options.headers && options.headers['x-correlation-id']) ? options.headers['x-correlation-id'] : getCorrelationId();
   const errors = [];
   const delayPromises = [];
@@ -80,14 +84,25 @@ const rpRetry = (origOptions) => {
   const logLevelLength = Object.keys(logLevel).length;
   let nbRetries = 0;
   let mainTimeout;
+  const measure = (statusCode) => {
+    if (metrics && metrics.HTTPRequestDuration) {
+      const elapsedHrTime = process.hrtime(startHrTime);
+      const elapsedTimeInMs = elapsedHrTime[0] * 1000 + elapsedHrTime[1] / 1e6;
+
+      metrics.HTTPRequestDuration
+        .labels('rpRetry', options.method, metrics.url || enteredUrl, enteredUrl.includes('?'), statusCode)
+        .observe(elapsedTimeInMs);
+    }
+  };
 
   if (!options.headers) options.headers = { 'user-agent': setUserAgent() };
   else if (!options.headers['user-agent']) options.headers['user-agent'] = setUserAgent();
-  options.cancelToken = source.token;
+  const optionsInfo = { ...options };
+  delete optionsInfo.metrics;
 
   const retryProcess = (nbRetry) => rp(options)
     .then((response) => {
-      const info = { options, nbRetries, errors };
+      const info = { options: optionsInfo, nbRetries, errors };
 
       if (logLevel.response) {
         info[logLevel.responseName] = setResponse(response, logLevel.responseDetails);
@@ -130,8 +145,7 @@ const rpRetry = (origOptions) => {
   const retryPromise = retryProcess(0);
   const mainTimeoutPromise = new Promise((resolve, reject) => {
     mainTimeout = setTimeout(() => {
-      delayPromises.forEach((delayPromise) => delayPromise.cancel(`retry timeout, ${criteria.timeout}, ${nbRetries}`));
-      source.cancel(`retry timeout, ${criteria.timeout}, ${nbRetries}`);
+      delayPromises.forEach((delayPromise) => delayPromise.cancel(`retry timeout delay, ${criteria.timeout}, ${nbRetries}`));
       let error = new Error('retry timeout');
 
       if (nbRetries !== 0) {
@@ -141,7 +155,7 @@ const rpRetry = (origOptions) => {
       error = getRichError(
         'System',
         'request error response',
-        { options },
+        { options: optionsInfo },
         error,
         logLevel.error || ((logLevelLength === 0) ? DEFAULT_LOGLEVEL_ERROR : undefined),
         correlationId,
@@ -150,17 +164,19 @@ const rpRetry = (origOptions) => {
     }, criteria.timeout * 1000);
   });
 
-  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);
+  if (logLevel.request) logger[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(200);
       return result;
     })
     .catch((err) => {
       mainTimeoutPromise.cancel(`main timeout error: ${err.message}`);
       clearTimeout(mainTimeout);
+      measure(err.statusCode || 500);
       throw err;
     });
 };

package/manual-test/man.js

@@ -1,5 +1,5 @@
 /* eslint-disable no-console */
-require('../test/testEnv');
+require('./testEnv');
 
 const { rpRetry } = require('../index');
 
@@ -15,7 +15,7 @@ const options = {
   retry: {},
 };
 
-options.retry.delayStrategy = () => 10000;
+options.retry.delayStrategy = () => 1000;
 options.retry.timeout = 10;
 options.retry.retries = 2;
 

package/manual-test/retryMockMan.js

@@ -11,6 +11,7 @@ const config = {
     nbRetry: 400,
     success: 200,
     error: 500,
+    timeout: 4000,
   },
   post: {
     success: 201,
@@ -37,9 +38,10 @@ app.get(`${config.base}${config.path}`, (req, res) => {
     return;
   }
   nbRequest += 1;
-  res.statusCode = config.get.error;
-
-  res.send({ statusCode: config.get.error });
+  setTimeout(() => {
+    res.statusCode = config.get.error;
+    res.send({ statusCode: config.get.error });
+  }, config.get.timeout);
 });
 app.post(`${config.base}${config.path}`, (req, res) => {
   console.log('----->', 'Received a POST request');

package/manual-test/testEnv.js

@@ -0,0 +1,23 @@
+/* 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
+ * | LOG_MODE | log mode | none
+ */
+
+// 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 = 'debug';
+process.env.CONSOLE_LEVEL = 'debug';
+process.env.LOG_MODE = 'none';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/request-retry",
-  "version": "2.0.11",
+  "version": "2.1.0",
   "description": "Request retry wrapping axios",
   "main": "index.js",
   "scripts": {
@@ -31,8 +31,8 @@
   "dependencies": {
     "@mimik/request-helper": "^1.7.7",
     "@mimik/response-helper": "^2.6.2",
-    "@mimik/sumologic-winston-logger": "^1.6.11",
-    "axios": "1.1.3",
+    "@mimik/sumologic-winston-logger": "^1.6.13",
+    "axios": "1.2.1",
     "bluebird": "3.7.2",
     "lodash": "4.17.21"
   },
@@ -42,7 +42,7 @@
     "acorn": "8.8.1",
     "body-parser": "1.20.1",
     "chai": "4.3.7",
-    "eslint": "8.28.0",
+    "eslint": "8.30.0",
     "eslint-config-airbnb": "19.0.4",
     "eslint-plugin-import": "2.26.0",
     "eslint-plugin-jsx-a11y": "6.6.1",
@@ -51,10 +51,10 @@
     "express": "4.18.2",
     "husky": "8.0.2",
     "jsdoc-to-markdown": "8.0.0",
-    "mocha": "10.1.0",
+    "mocha": "10.2.0",
     "mochawesome": "7.1.3",
     "nyc": "15.1.0",
-    "sinon": "15.0.0",
+    "sinon": "15.0.1",
     "verror": "1.10.1"
   }
 }

package/test/testEnv.js

@@ -10,6 +10,7 @@
  * | 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
+ * | LOG_MODE | log mode | none
  */
 
 // process.env.SUMO_LOGIC_ENDPOINT = 'http://localhost:9080/logs/';
@@ -19,3 +20,4 @@ process.env.SUMO_LOGIC_COLLECTOR_CODE = null;
 process.env.NO_STACK = 'yes';
 process.env.LOG_LEVEL = 'debug';
 process.env.CONSOLE_LEVEL = 'debug';
+process.env.LOG_MODE = 'none';