@mimik/oauth-helper 1.10.1 → 2.0.0

package/README.md

@@ -24,7 +24,7 @@ const oauthHelper = require('@mimik/oauth-helper');
 * [oauth-helper](#module_oauth-helper)
     * _async_
         * [~rpAuth(type, options)](#module_oauth-helper..rpAuth) ⇒ <code>Promise</code>
-        * [~authProfile(method, id, correlationId)](#module_oauth-helper..authProfile) ⇒ <code>Promise</code>
+        * [~authProfile(method, id, correlationId, options)](#module_oauth-helper..authProfile) ⇒ <code>Promise</code>
     * _callback_
         * [~apiKeySecurityHelper(request, definitions, apiKey, next)](#module_oauth-helper..apiKeySecurityHelper)
         * [~apiTokenSecurityHelper(request, definitions, scopes, next)](#module_oauth-helper..apiTokenSecurityHelper)
@@ -42,7 +42,7 @@ Make an authorized request.
 
 - <code>Promise</code> Will throw the same error than [request-promise](https://www.npmjs.com/package/request-promise).
 
-The property `token` may be added to options, in order to set up how the token is retrieved from the token manager. The structure is:
+The property `token` may be added to `options`, in order to set up how the token is retrieved from the token manager. The structure is:
 ```
 {
    "retry": "object to specify how the retry to the token manager will be done. similar to rp-retry retry property",
@@ -50,6 +50,13 @@ The property `token` may be added to options, in order to set up how the token i
    "cluster": "to set the token to be a cluster token"
 }
 ````
+The property `metrics` may be added to `options`, in order to setup metrics about calls made to other microservice. The structure is:
+```
+{
+    "HTTPrequestDuration": "prom-client function to label and record the elapsed time",
+    "url": "url to be displayed for the metrics. If not present the url of the options will be used"
+}
+```
 
 **Requires**: <code>module:@mimik/sumologic-winston-logger</code>  
 **Fulfil**: <code>object</code> - Response of the [request-promise](https://www.npmjs.com/package/request-promise) request.  
@@ -61,7 +68,7 @@ The property `token` may be added to options, in order to set up how the token i
 
 <a name="module_oauth-helper..authProfile"></a>
 
-### oauth-helper~authProfile(method, id, correlationId) ⇒ <code>Promise</code>
+### oauth-helper~authProfile(method, id, correlationId, options) ⇒ <code>Promise</code>
 Make an authProfile request to mID.
 
 **Kind**: inner method of [<code>oauth-helper</code>](#module_oauth-helper)  
@@ -79,6 +86,7 @@ Make an authProfile request to mID.
 | method | <code>string</code> | Method (`GET`, `DELETE`) of the request to be made. |
 | id | <code>string</code> | `UserId` to associated witht the request. |
 | correlationId | <code>UUID.&lt;string&gt;</code> | CorrelationId to associated with the request. |
+| options | <code>object</code> | Options to be added to the request. metrics can then be added to the options. |
 
 <a name="module_oauth-helper..apiKeySecurityHelper"></a>
 

package/index.js

@@ -202,7 +202,7 @@ module.exports = (config) => {
    * @fulfil {object} - Response of the [request-promise](https://www.npmjs.com/package/request-promise) request.
    * @throws {Promise} Will throw the same error than [request-promise](https://www.npmjs.com/package/request-promise).
    *
-   * The property `token` may be added to options, in order to set up how the token is retrieved from the token manager. The structure is:
+   * The property `token` may be added to `options`, in order to set up how the token is retrieved from the token manager. The structure is:
    * ```
    * {
    *    "retry": "object to specify how the retry to the token manager will be done. similar to rp-retry retry property",
@@ -210,9 +210,28 @@ module.exports = (config) => {
    *    "cluster": "to set the token to be a cluster token"
    * }
    * ````
+   * The property `metrics` may be added to `options`, in order to setup metrics about calls made to other microservice. The structure is:
+   * ```
+   * {
+   *     "HTTPrequestDuration": "prom-client function to label and record the elapsed time",
+   *     "url": "url to be displayed for the metrics. If not present the url of the options will be used"
+   * }
+   * ```
    */
   const rpAuth = (type, options) => {
+    const startHrTime = process.hrtime();
+    const { metrics } = options;
     const enteredUrl = options.uri || options.url; // uri takes precedence over url in request-promise, conserving the order
+    const measure = (statusCode) => {
+      if (metrics && metrics.HTTPRequestDuration) {
+        const elapsedHrTime = process.hrtime(startHrTime);
+        const elapsedTimeInMs = elapsedHrTime[0] * 1000 + elapsedHrTime[1] / 1e6;
+
+        metrics.HTTPRequestDuration
+          .labels('rpAuth', options.method, metrics.url || enteredUrl, enteredUrl.includes('?'), statusCode)
+          .observe(elapsedTimeInMs);
+      }
+    };
     let url;
 
     if (!type) return Promise.reject(new Error(`rpAuth type non existent for ${options.method || 'GET'} on ${enteredUrl}`));
@@ -229,6 +248,10 @@ module.exports = (config) => {
         if (!opts.headers) opts.headers = {};
         opts.headers.authorization = `Bearer ${token}`;
         return rpRetry(opts)
+          .then((result) => {
+            measure(200);
+            return result;
+          })
           .catch((err) => {
             if (err.statusCode === 403) {
               logger.warn('got a unauthorized request, retrying', { error: err.message, type }, correlationId);
@@ -236,11 +259,19 @@ module.exports = (config) => {
               return getToken(type, options.uri || options.url, options.token, correlationId)
                 .then((newToken) => {
                   opts.headers.authorization = `Bearer ${newToken}`;
-                  return rpRetry(opts);
+                  return rpRetry(opts)
+                    .then((result) => {
+                      measure(200);
+                      return result;
+                    });
                 });
             }
             throw err;
           });
+      })
+      .catch((err) => {
+        measure(err.statusCode);
+        throw err;
       });
   };
 
@@ -437,28 +468,32 @@ module.exports = (config) => {
    * @param {string} method - Method (`GET`, `DELETE`) of the request to be made.
    * @param {string} id - `UserId` to associated witht the request.
    * @param {UUID<string>} correlationId - CorrelationId to associated with the request.
+   * @param {object} options - Options to be added to the request. metrics can then be added to the options.
    * @return {Promise}.
    * @fulfil {object} The response of the request made to `mID`.
    * @throws {Promise} Will throw a rich error is the request fails or an error if the id is not identified
    */
-  const authProfile = (method, id, correlationId) => {
+  const authProfile = (method, id, correlationId, options) => {
     if (!id) return Promise.reject(new Error('Id has to be defined'));
-    return rpAuth('mID', {
+    const opts = {
       method,
       uri: `${config.dependencies.mID.url}/users/${id}`,
       headers: {
         'x-correlation-id': correlationId,
       },
       json: true,
-    }).catch((err) => {
-      const error = getRichError(err.statusCode, 'could perform operation on identity server', { method, id }, err);
+    };
+    if (options && options.metrics) opts.metrics = options.metrics;
+    return rpAuth('mID', opts)
+      .catch((err) => {
+        const error = getRichError(err.statusCode, 'could perform operation on identity server', { method, id }, err);
 
-      if (error.statusCode === 400 && method === 'DELETE') {
-        logger.warn('profile without authprofile', { id, error }, correlationId);
-        return;
-      }
-      throw error;
-    });
+        if (error.statusCode === 400 && method === 'DELETE') {
+          logger.warn('profile without authprofile', { id, error }, correlationId);
+          return;
+        }
+        throw error;
+      });
   };
 
   return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/oauth-helper",
-  "version": "1.10.1",
+  "version": "2.0.0",
   "description": "Oauth helper for mimik microservices",
   "main": "index.js",
   "scripts": {
@@ -29,30 +29,30 @@
     "url": "https://bitbucket.org/mimiktech/oauth-helper"
   },
   "dependencies": {
-    "@mimik/request-retry": "^2.0.9",
-    "@mimik/response-helper": "^2.6.1",
-    "@mimik/sumologic-winston-logger": "^1.6.8",
-    "@mimik/swagger-helper": "^2.5.2",
+    "@mimik/request-retry": "^2.0.12",
+    "@mimik/response-helper": "^2.6.2",
+    "@mimik/sumologic-winston-logger": "^1.6.13",
+    "@mimik/swagger-helper": "^2.5.5",
     "bluebird": "3.7.2",
-    "jsonwebtoken": "8.5.1",
+    "jsonwebtoken": "9.0.0",
     "lodash": "4.17.21"
   },
   "devDependencies": {
-    "@mimik/eslint-plugin-dependencies": "^2.4.3",
-    "@mimik/eslint-plugin-document-env": "^1.0.3",
-    "@mimik/request-helper": "^1.7.6",
-    "body-parser": "1.20.0",
-    "chai": "4.3.6",
-    "eslint": "8.15.0",
+    "@mimik/eslint-plugin-dependencies": "^2.4.4",
+    "@mimik/eslint-plugin-document-env": "^1.0.4",
+    "@mimik/request-helper": "^1.7.7",
+    "body-parser": "1.20.1",
+    "chai": "4.3.7",
+    "eslint": "8.30.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",
+    "eslint-plugin-jsx-a11y": "6.6.1",
+    "eslint-plugin-react": "7.31.11",
+    "eslint-plugin-react-hooks": "4.6.0",
+    "express": "4.18.2",
+    "husky": "8.0.2",
+    "jsdoc-to-markdown": "8.0.0",
+    "mocha": "10.2.0",
     "mochawesome": "7.1.3",
     "nyc": "15.1.0"
   }