@mimik/oauth-helper 2.0.1 → 2.1.0

package/index.js

@@ -31,6 +31,8 @@ const CLAIMS_SEPARATOR = ',';
 const RESOURCE_SEPARATOR = ':';
 const SCOPE_CLAIMS_SEPARATOR = '::';
 const CLAIMS_DEFINITION = 'Claims';
+const CLIENT_CEDENTIALS = 'client_credentials';
+const REFRESH_TOKEN = 'refresh_token';
 
 const tokens = {};
 
@@ -143,7 +145,7 @@ module.exports = (config) => {
     return { onBehalf, claims };
   };
 
-  const getToken = (type, origin, options, correlationId) => {
+  const getToken = (type, origin, correlationId, options) => {
     const tokenOptions = {
       method: 'POST',
       url: server.issuer,
@@ -154,34 +156,49 @@ module.exports = (config) => {
       client_id: server.id,
       client_secret: server.secret,
       audience: config.dependencies[type].audience,
-      grant_type: 'client_credentials',
+      grant_type: CLIENT_CEDENTIALS,
     };
 
     if (options) {
-      if (options.customerName) getCredential.customer_name = options.customerName;
-      if (options.retry) tokenOptions.retry = options.retry;
-      if (options.cluster) getCredential.type = CLUSTER;
+      if (options.token) {
+        const { token } = options;
+        if (token.customerName) getCredential.customer_name = token.customerName;
+        if (token.retry) tokenOptions.retry = token.retry;
+        if (token.cluster) getCredential.type = CLUSTER;
+      }
+      if (options.metrics) {
+        tokenOptions.metrics = { HTTPRequestDuration: options.metrics.HTTPRequestDuration, url: tokenOptions.url };
+      }
     }
     if (!tokens[type]) tokens[type] = {};
     if (!tokens[type][origin]) tokens[type][origin] = {};
     if (valid(tokens[type][origin].accessToken)) return Promise.resolve(tokens[type][origin].accessToken.value);
     if (valid(tokens[type][origin].refreshToken)) {
-      logger.silly('valid refresh_token, refresh_token', { type, origin }, correlationId);
+      logger.silly(`valid ${REFRESH_TOKEN}`, { type, origin }, correlationId);
       tokenOptions.body = {
         refresh_token: tokens[type][origin].refreshToken.value,
-        grant_type: 'refresh_token',
+        grant_type: REFRESH_TOKEN,
       };
+      if (tokenOptions.metrics) {
+        tokenOptions.metrics.url = `${tokenOptions.metrics.url}/${REFRESH_TOKEN}`;
+      }
     }
     else {
-      logger.silly('invalid refresh_token, client_credentials', { type, origin }, correlationId);
+      logger.silly(`invalid ${REFRESH_TOKEN} trying ${CLIENT_CEDENTIALS}`, { type, origin }, correlationId);
       tokenOptions.body = getCredential;
+      if (tokenOptions.metrics) {
+        tokenOptions.metrics.url = `${tokenOptions.metrics.url}/${CLIENT_CEDENTIALS}`;
+      }
     }
     return rpRetry(tokenOptions).catch((err) => {
-      if (err.statusCode !== 400 || tokenOptions.body.grant_type === 'client_credentials') {
+      if (err.statusCode !== 400 || tokenOptions.body.grant_type === CLIENT_CEDENTIALS) {
         throw err;
       }
-      logger.silly('moving from refresh_token to client_credential', { error: err.message }, correlationId);
+      logger.silly(`moving from ${REFRESH_TOKEN} to ${CLIENT_CEDENTIALS}`, { error: err.message }, correlationId);
       tokenOptions.body = getCredential;
+      if (tokenOptions.metrics) {
+        tokenOptions.metrics.url = `${tokenOptions.metrics.url}/${CLIENT_CEDENTIALS}`;
+      }
       return rpRetry(tokenOptions);
     }).then((response) => {
       tokens[type][origin].accessToken = createToken(response.data.access_token);
@@ -241,7 +258,7 @@ module.exports = (config) => {
     catch (err) { return Promise.reject(new Error(`invalid url address: ${enteredUrl}: ${err.message}`)); }
     const correlationId = (options.headers && options.headers['x-correlation-id']);
 
-    return getToken(type, url.origin, options.token, correlationId)
+    return getToken(type, url.origin, correlationId, options)
       .then((token) => {
         const opts = options;
 
@@ -256,7 +273,7 @@ module.exports = (config) => {
             if (err.statusCode === 403) {
               logger.warn('got a unauthorized request, retrying', { error: err.message, type }, correlationId);
               tokens[type].accessToken = null;
-              return getToken(type, options.uri || options.url, options.token, correlationId)
+              return getToken(type, options.uri || options.url, correlationId, options)
                 .then((newToken) => {
                   opts.headers.authorization = `Bearer ${newToken}`;
                   return rpRetry(opts)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/oauth-helper",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "Oauth helper for mimik microservices",
   "main": "index.js",
   "scripts": {
@@ -29,28 +29,28 @@
     "url": "https://bitbucket.org/mimiktech/oauth-helper"
   },
   "dependencies": {
-    "@mimik/request-retry": "^2.1.0",
-    "@mimik/response-helper": "^2.6.2",
-    "@mimik/sumologic-winston-logger": "^1.6.13",
-    "@mimik/swagger-helper": "^2.5.5",
+    "@mimik/request-retry": "^2.1.4",
+    "@mimik/response-helper": "^2.6.3",
+    "@mimik/sumologic-winston-logger": "^1.6.14",
+    "@mimik/swagger-helper": "^2.5.7",
     "bluebird": "3.7.2",
     "jsonwebtoken": "9.0.0",
     "lodash": "4.17.21"
   },
   "devDependencies": {
-    "@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",
+    "@mimik/eslint-plugin-dependencies": "^2.4.5",
+    "@mimik/eslint-plugin-document-env": "^1.0.5",
+    "@mimik/request-helper": "^1.7.8",
+    "body-parser": "1.20.2",
     "chai": "4.3.7",
-    "eslint": "8.30.0",
+    "eslint": "8.35.0",
     "eslint-config-airbnb": "19.0.4",
-    "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-jsx-a11y": "6.6.1",
-    "eslint-plugin-react": "7.31.11",
+    "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-jsx-a11y": "6.7.1",
+    "eslint-plugin-react": "7.32.2",
     "eslint-plugin-react-hooks": "4.6.0",
     "express": "4.18.2",
-    "husky": "8.0.2",
+    "husky": "8.0.3",
     "jsdoc-to-markdown": "8.0.0",
     "mocha": "10.2.0",
     "mochawesome": "7.1.3",