@mimik/oauth-helper 4.0.2 → 4.1.0

package/README.md

@@ -1,18 +1,3 @@
-## Modules
-
-<dl>
-<dt><a href="#module_oauth-helper">oauth-helper</a></dt>
-<dd></dd>
-</dl>
-
-## Typedefs
-
-<dl>
-<dt><a href="#requestCallback">requestCallback</a> : <code>function</code></dt>
-<dd><p>This callback is displayed as a global member.</p>
-</dd>
-</dl>
-
 <a name="module_oauth-helper"></a>
 
 ## oauth-helper
@@ -22,8 +7,28 @@ import oauthHelper from '@mimik/oauth-helper';
 ```
 
 * [oauth-helper](#module_oauth-helper)
-    * [~rpAuth(type, options)](#module_oauth-helper..rpAuth) ⇒ <code>Promise</code>
-    * [~authProfile(method, id, correlationId, options)](#module_oauth-helper..authProfile) ⇒ <code>Promise</code>
+    * [~oauthHelper(config)](#module_oauth-helper..oauthHelper) ⇒ <code>object</code>
+    * _async_
+        * [~rpAuth(type, options)](#module_oauth-helper..rpAuth) ⇒ <code>Promise</code>
+        * [~authProfile(method, id, correlationId, [options])](#module_oauth-helper..authProfile) ⇒ <code>Promise</code>
+
+<a name="module_oauth-helper..oauthHelper"></a>
+
+### oauth-helper~oauthHelper(config) ⇒ <code>object</code>
+Create an OAuth helper instance for making authorized requests.
+
+**Kind**: inner method of [<code>oauth-helper</code>](#module_oauth-helper)  
+**Returns**: <code>object</code> - Object with `rpAuth` and `authProfile` methods.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| config | <code>object</code> | Service configuration. |
+| config.security | <code>object</code> | Security settings. |
+| config.security.server | <code>object</code> | Token server configuration. |
+| config.security.server.issuer | <code>string</code> | Token issuer URL. |
+| config.security.server.id | <code>string</code> | Client ID. |
+| config.security.server.secret | <code>string</code> | Client secret. |
+| config.dependencies | <code>object</code> | Dependency type to settings map. Each entry must have an `audience` string. |
 
 <a name="module_oauth-helper..rpAuth"></a>
 
@@ -31,24 +36,24 @@ import oauthHelper from '@mimik/oauth-helper';
 Make an authorized request.
 
 **Kind**: inner method of [<code>oauth-helper</code>](#module_oauth-helper)  
-**Returns**: <code>Promise</code> - .  
+**Returns**: <code>Promise</code> - Resolves with the response from the authorized request.  
 **Category**: async  
 **Throws**:
 
-- <code>Promise</code> Will throw the same error than [request-promise](https://www.npmjs.com/package/request-promise).
+- <code>Error</code> Will throw the same error as [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:
 ```
 {
    "retry": "object to specify how the retry to the token manager will be done. similar to rp-retry retry property",
-   "customerName": "name of the customer for which the token is entended for, see mST API",
+   "customerName": "name of the customer for which the token is intended, see mST API",
    "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:
+```
+The property `metrics` may be added to `options`, in order to set up metrics about calls made to other microservice. The structure is:
 ```
 {
-    "HTTPrequestDuration": "prom-client function to label and record the elapsed time",
+    "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"
 }
 ```
@@ -63,15 +68,15 @@ The property `metrics` may be added to `options`, in order to setup metrics abou
 
 <a name="module_oauth-helper..authProfile"></a>
 
-### oauth-helper~authProfile(method, id, correlationId, options) ⇒ <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)  
-**Returns**: <code>Promise</code> - .  
+**Returns**: <code>Promise</code> - Resolves with the response from mID.  
 **Category**: async  
 **Throws**:
 
-- <code>Promise</code> Will throw a rich error is the request fails or an error if the id is not identified
+- <code>Error</code> Will throw a rich error if the request fails or an error if the id is not identified
 
 **Requires**: <code>module:@mimik/sumologic-winston-logger</code>  
 **Fulfil**: <code>object</code> The response of the request made to `mID`.  
@@ -79,18 +84,7 @@ Make an authProfile request to mID.
 | Param | Type | Description |
 | --- | --- | --- |
 | 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="requestCallback"></a>
-
-## requestCallback : <code>function</code>
-This callback is displayed as a global member.
-
-**Kind**: global typedef  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| either | <code>object</code> | `null` or an `error`. |
+| id | <code>string</code> | `UserId` associated with the request. |
+| correlationId | <code>string</code> | CorrelationId associated with the request. |
+| [options] | <code>object</code> | Options to be added to the request. metrics can then be added to the options. |
 

package/index.js

@@ -16,7 +16,7 @@ Promise.config({ cancellation: true });
 
 const TOKEN_REFRESH_TOLERANCE = 900; // in seconds
 const CLUSTER = 'cluster';
-const CLIENT_CEDENTIALS = 'client_credentials';
+const CLIENT_CREDENTIALS = 'client_credentials';
 const REFRESH_TOKEN = 'refresh_token';
 
 const PARAMETER_ERROR = 400;
@@ -37,13 +37,28 @@ const valid = (token) => {
 };
 
 const createToken = (value) => {
+  const decoded = jwt.decode(value);
+  if (!decoded) throw new Error(`failed to decode token: ${value}`);
   const token = {
     value,
-    exp: jwt.decode(value).exp,
+    exp: decoded.exp,
   };
   return token;
 };
 
+/**
+ * Create an OAuth helper instance for making authorized requests.
+ *
+ * @function oauthHelper
+ * @param {object} config - Service configuration.
+ * @param {object} config.security - Security settings.
+ * @param {object} config.security.server - Token server configuration.
+ * @param {string} config.security.server.issuer - Token issuer URL.
+ * @param {string} config.security.server.id - Client ID.
+ * @param {string} config.security.server.secret - Client secret.
+ * @param {object} config.dependencies - Dependency type to settings map. Each entry must have an `audience` string.
+ * @return {object} Object with `rpAuth` and `authProfile` methods.
+ */
 const oauthHelper = (config) => {
   const { server } = config.security;
   const getToken = (type, origin, correlationId, options) => {
@@ -57,7 +72,7 @@ const oauthHelper = (config) => {
       client_id: server.id,
       client_secret: server.secret,
       audience: config.dependencies[type].audience,
-      grant_type: CLIENT_CEDENTIALS,
+      grant_type: CLIENT_CREDENTIALS,
     };
 
     if (options) {
@@ -71,6 +86,7 @@ const oauthHelper = (config) => {
         tokenOptions.metrics = { HTTPRequestDuration: options.metrics.HTTPRequestDuration, url: tokenOptions.url };
       }
     }
+    const metricsBaseUrl = tokenOptions.metrics ? tokenOptions.metrics.url : undefined;
     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);
@@ -81,24 +97,24 @@ const oauthHelper = (config) => {
         grant_type: REFRESH_TOKEN,
       };
       if (tokenOptions.metrics) {
-        tokenOptions.metrics.url = `${tokenOptions.metrics.url}/${REFRESH_TOKEN}`;
+        tokenOptions.metrics.url = `${metricsBaseUrl}/${REFRESH_TOKEN}`;
       }
     }
     else {
-      logger.silly(`invalid ${REFRESH_TOKEN} trying ${CLIENT_CEDENTIALS}`, { type, origin }, correlationId);
+      logger.silly(`invalid ${REFRESH_TOKEN} trying ${CLIENT_CREDENTIALS}`, { type, origin }, correlationId);
       tokenOptions.body = getCredential;
       if (tokenOptions.metrics) {
-        tokenOptions.metrics.url = `${tokenOptions.metrics.url}/${CLIENT_CEDENTIALS}`;
+        tokenOptions.metrics.url = `${metricsBaseUrl}/${CLIENT_CREDENTIALS}`;
       }
     }
     return rpRetry(tokenOptions).catch((err) => {
-      if (err.statusCode !== PARAMETER_ERROR || tokenOptions.body.grant_type === CLIENT_CEDENTIALS) {
+      if (err.statusCode !== PARAMETER_ERROR || tokenOptions.body.grant_type === CLIENT_CREDENTIALS) {
         throw err;
       }
-      logger.silly(`moving from ${REFRESH_TOKEN} to ${CLIENT_CEDENTIALS}`, { error: err.message }, correlationId);
+      logger.silly(`moving from ${REFRESH_TOKEN} to ${CLIENT_CREDENTIALS}`, { error: err.message }, correlationId);
       tokenOptions.body = getCredential;
       if (tokenOptions.metrics) {
-        tokenOptions.metrics.url = `${tokenOptions.metrics.url}/${CLIENT_CEDENTIALS}`;
+        tokenOptions.metrics.url = `${metricsBaseUrl}/${CLIENT_CREDENTIALS}`;
       }
       return rpRetry(tokenOptions);
     }).then((response) => {
@@ -116,22 +132,22 @@ const oauthHelper = (config) => {
    * @category async
    * @param {string} type - Type of micro service to request.
    * @param {object} options - Options for the request. Similar to [request-promise](https://www.npmjs.com/package/request-promise) options.
-   * @return {Promise}.
+   * @return {Promise} Resolves with the response from the authorized request.
    * @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).
+   * @throws {Error} Will throw the same error as [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:
    * ```
    * {
    *    "retry": "object to specify how the retry to the token manager will be done. similar to rp-retry retry property",
-   *    "customerName": "name of the customer for which the token is entended for, see mST API",
+   *    "customerName": "name of the customer for which the token is intended, see mST API",
    *    "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:
+   * ```
+   * The property `metrics` may be added to `options`, in order to set up metrics about calls made to other microservice. The structure is:
    * ```
    * {
-   *     "HTTPrequestDuration": "prom-client function to label and record the elapsed time",
+   *     "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"
    * }
    * ```
@@ -163,10 +179,7 @@ const oauthHelper = (config) => {
 
     return getToken(type, url.origin, correlationId, options)
       .then((token) => {
-        const opts = options;
-
-        if (!opts.headers) opts.headers = {};
-        opts.headers.authorization = `Bearer ${token}`;
+        const opts = { ...options, headers: { ...options.headers, authorization: `Bearer ${token}` } };
         return rpRetry(opts)
           .then((result) => {
             measure(OK);
@@ -174,9 +187,9 @@ const oauthHelper = (config) => {
           })
           .catch((err) => {
             if (err.statusCode === FORBIDDEN_ERROR) {
-              logger.warn('got a unauthorized request, retrying', { error: err.message, type }, correlationId);
-              tokens[type].accessToken = null;
-              return getToken(type, options.uri || options.url, correlationId, options)
+              logger.warn('got an unauthorized request, retrying', { error: err.message, type }, correlationId);
+              tokens[type][url.origin].accessToken = null;
+              return getToken(type, url.origin, correlationId, options)
                 .then((newToken) => {
                   opts.headers.authorization = `Bearer ${newToken}`;
                   return rpRetry(opts)
@@ -202,12 +215,12 @@ const oauthHelper = (config) => {
    * @requires @mimik/sumologic-winston-logger
    * @category async
    * @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}.
+   * @param {string} id - `UserId` associated with the request.
+   * @param {string} correlationId - CorrelationId associated with the request.
+   * @param {object} [options] - Options to be added to the request. metrics can then be added to the options.
+   * @return {Promise} Resolves with the response from mID.
    * @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
+   * @throws {Error} Will throw a rich error if the request fails or an error if the id is not identified
    */
   const authProfile = (method, id, correlationId, options) => {
     if (!id) return Promise.reject(new Error('Id has to be defined'));
@@ -222,7 +235,7 @@ const oauthHelper = (config) => {
     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);
+        const error = getRichError(err.statusCode, 'could not perform operation on identity server', { method, id }, err);
 
         if (error.statusCode === PARAMETER_ERROR && method === 'DELETE') {
           logger.warn('profile without authprofile', { id, error }, correlationId);
@@ -239,8 +252,3 @@ const oauthHelper = (config) => {
 };
 
 export default oauthHelper;
-/**
- * This callback is displayed as a global member.
- * @callback requestCallback
- * @param {object} either `null` or an `error`.
- */

package/package.json

@@ -1,23 +1,21 @@
 {
   "name": "@mimik/oauth-helper",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "description": "Oauth helper for mimik microservices",
   "main": "./index.js",
   "type": "module",
+  "exports": "./index.js",
+  "engines": {
+    "node": ">=24"
+  },
   "scripts": {
    "lint": "eslint . --no-error-on-unmatched-pattern",
     "docs": "jsdoc2md index.js > README.md",
     "test": "mocha --reporter mochawesome --bail --check-leaks test/",
-    "test-ci": "c8 --reporter=lcov --reporter=text npm test --exit",
+    "test-ci": "c8 --reporter=lcov --reporter=text npm test -- --exit",
     "prepublishOnly": "npm run docs && npm run lint && npm run test-ci",
     "commit-ready": "npm run docs && npm run lint && npm run test-ci"
   },
-  "husky": {
-    "hooks": {
-      "pre-commit": "npm run commit-ready",
-      "pre-push": "npm run test"
-    }
-  },
   "keywords": [
     "mimik",
     "microservice"
@@ -29,26 +27,27 @@
     "url": "https://bitbucket.org/mimiktech/oauth-helper"
   },
   "dependencies": {
-    "@mimik/request-retry": "^4.0.3",
-    "@mimik/response-helper": "^4.0.4",
-    "@mimik/sumologic-winston-logger": "^2.0.3",
+    "@mimik/request-retry": "^4.0.9",
+    "@mimik/response-helper": "^4.0.10",
+    "@mimik/sumologic-winston-logger": "^2.1.14",
     "bluebird": "3.7.2",
-    "jsonwebtoken": "9.0.2"
+    "jsonwebtoken": "9.0.3"
   },
   "devDependencies": {
-    "@eslint/js": "9.31.0",
+    "@eslint/js": "9.39.3",
     "@mimik/eslint-plugin-document-env": "^2.0.8",
-    "@mimik/request-helper": "2.0.2",
-    "@stylistic/eslint-plugin": "5.2.1",
-    "c8": "10.1.3",
-    "body-parser": "2.2.0",
-    "chai": "5.2.1",
-    "eslint": "9.31.0",
+    "@mimik/request-helper": "2.0.5",
+    "@stylistic/eslint-plugin": "5.9.0",
+    "c8": "11.0.0",
+    "body-parser": "2.2.2",
+    "chai": "6.2.2",
+    "eslint": "9.39.3",
     "eslint-plugin-import": "2.32.0",
-    "express": "5.1.0",
+    "express": "5.2.1",
+    "globals": "17.4.0",
     "husky": "9.1.7",
-    "jsdoc-to-markdown": "9.1.2",
-    "mocha": "11.7.1",
-    "mochawesome": "7.1.3"
+    "jsdoc-to-markdown": "9.1.3",
+    "mocha": "11.7.5",
+    "mochawesome": "7.1.4"
   }
 }

package/.husky/pre-commit

@@ -1 +0,0 @@
-npm run commit-ready

package/.husky/pre-push

@@ -1 +0,0 @@
-npm run test

package/.nycrc

@@ -1,4 +0,0 @@
-{
-  "exclude": ["gulpfile.js"],
-  "reporter": ["lcov", "text"]
-}

package/eslint.config.js

@@ -1,64 +0,0 @@
-import importPlugin from 'eslint-plugin-import';
-import js from '@eslint/js';
-import processDoc from '@mimik/eslint-plugin-document-env';
-import stylistic from '@stylistic/eslint-plugin';
-
-const MAX_LENGTH_LINE = 180;
-const MAX_FUNCTION_PARAMETERS = 6;
-const MAX_LINES_IN_FILES = 600;
-const MAX_LINES_IN_FUNCTION = 150;
-const MAX_STATEMENTS_IN_FUNCTION = 45;
-const MIN_KEYS_IN_OBJECT = 10;
-const MAX_COMPLEXITY = 30;
-
-export default [
-  {
-    ignores: ['mochawesome-report/**', 'node_modules/**', 'dist/**'],
-  },
-  importPlugin.flatConfigs.recommended,
-  stylistic.configs['recommended-flat'],
-  js.configs.all,
-  {
-    plugins: {
-      processDoc,
-    },
-    languageOptions: {
-      ecmaVersion: 2022,
-      globals: {
-        console: 'readonly',
-        describe: 'readonly',
-        it: 'readonly',
-        require: 'readonly',
-      },
-      sourceType: 'module',
-    },
-    rules: {
-      '@stylistic/brace-style': ['warn', 'stroustrup', { allowSingleLine: true }],
-      '@stylistic/line-comment-position': ['off'],
-      '@stylistic/semi': ['error', 'always'],
-      'capitalized-comments': ['off'],
-      'complexity': ['error', MAX_COMPLEXITY],
-      'curly': ['off'],
-      'id-length': ['error', { exceptions: ['x', 'y', 'z', 'i', 'j', 'k'] }],
-      'import/no-extraneous-dependencies': ['error', { devDependencies: true }],
-      'import/no-unresolved': ['error', { amd: true, caseSensitiveStrict: true, commonjs: true }],
-      'init-declarations': ['off'],
-      'linebreak-style': ['off'],
-      'max-depth': ['warn', { max: 5 }],
-      'max-len': ['warn', MAX_LENGTH_LINE, { ignoreComments: true }],
-      'max-lines': ['warn', { max: MAX_LINES_IN_FILES, skipComments: true }],
-      'max-lines-per-function': ['warn', { max: MAX_LINES_IN_FUNCTION, skipComments: true }],
-      'max-params': ['error', MAX_FUNCTION_PARAMETERS],
-      'max-statements': ['warn', MAX_STATEMENTS_IN_FUNCTION],
-      'no-confusing-arrow': ['off'], // arrow isnt confusing
-      'no-inline-comments': ['off'],
-      'no-process-env': ['error'],
-      'no-ternary': ['off'],
-      'no-undefined': ['off'],
-      'one-var': ['error', 'never'],
-      'processDoc/validate-document-env': ['error'],
-      'quotes': ['warn', 'single'],
-      'sort-keys': ['error', 'asc', { caseSensitive: true, minKeys: MIN_KEYS_IN_OBJECT, natural: false }],
-    },
-  },
-];

package/test/oauthHelper.spec.js

@@ -1,146 +0,0 @@
-import './testEnv.js';
-import { before, describe, it } from 'mocha';
-import { expect, should } from 'chai';
-import { config } from './testConfig.js';
-import { getCorrelationId } from '@mimik/request-helper';
-import { listen } from './serversMock.js';
-import oauthHelper from '../index.js';
-import { rpRetry } from '@mimik/request-retry';
-
-should();
-
-const SYSTEM_ERROR = 500;
-const TIMEOUT = 200000;
-const DELAY = 100;
-
-const correlationId = getCorrelationId('--test-OauthHelper--');
-// const oauthImplNoGeneric = oauthHelper(config.implNoGeneric);
-// const oauthImplGeneric = oauthHelper(config.implGeneric);
-const oauthAppGeneric = oauthHelper(config.appGeneric);
-const oauthAppUnknownIssuer = oauthHelper(config.appUnknownIssuer);
-// const oauthAppExpiredToken = oauthHelper(config.appExpiredToken);
-const oauthAppExpiredTokenAndFail = oauthHelper(config.appExpiredTokenAndFail);
-
-describe('OauthHelper Unit Tests', () => {
-  before(() => {
-    listen();
-  });
-  describe('rpAuth(type, options)', function Test() {
-    this.timeout(TIMEOUT);
-    const requestOptions = {
-      method: 'GET',
-      headers: {
-        'x-correlation-id': correlationId,
-      },
-      uri: 'http://localhost:9070/getTest',
-      json: true,
-    };
-    it('should generate an error rpAuth type non existent', () => oauthAppGeneric.rpAuth(null, requestOptions)
-      .then(response => expect(response).to.equal('should not return a valid response'))
-      .catch((err) => {
-        expect(err.message).to.equal(`rpAuth type non existent for ${requestOptions.method} on ${requestOptions.uri}`);
-      }));
-    it('should generate an error used in rpAuth with no dependencies ', () => oauthAppGeneric.rpAuth('unknownDependency', requestOptions)
-      .then(response => expect(response).to.equal('should not return a valid response'))
-      .catch((err) => {
-        expect(err.message).to.equal('type unknownDependency used in rpAuth with no dependencies');
-      }));
-    it('should generate an error uri or url non existent', () => {
-      requestOptions.uri = null;
-      return oauthAppGeneric.rpAuth('test1', requestOptions)
-        .then(response => expect(response).to.equal('should not return a valid response'))
-        .catch((err) => {
-          expect(err.message).to.equal('uri or url non existent');
-        });
-    });
-    it('should generate an error invalid url address', () => {
-      requestOptions.uri = 'http//test.com/test';
-      return oauthAppGeneric.rpAuth('test1', requestOptions)
-        .then(response => expect(response).to.equal('should not return a valid response'))
-        .catch((err) => {
-          expect(err.message).to.include('invalid url address');
-        });
-    });
-    it('should generate an error request error response from token server ', () => {
-      requestOptions.uri = 'http://localhost:9070/getTest';
-      return oauthAppUnknownIssuer.rpAuth('test1', requestOptions)
-        .then(response => expect(response).to.equal('should not return a valid response'))
-        .catch((err) => {
-          expect(err.message).to.include('request error response');
-        });
-    });
-    it('should get a response test ok, setting up expiredTokenAndFail ', () => oauthAppExpiredTokenAndFail.rpAuth('test1', requestOptions)
-      .then((response) => {
-        expect(response.data).to.equal('test ok');
-      }));
-    it('should get a response test ok, using refresh_token and go to client_credentials ', () => oauthAppExpiredTokenAndFail.rpAuth('test1', requestOptions)
-      .then((response) => {
-        expect(response.data).to.equal('test ok');
-      }));
-    it('should get a response test ok, using refresh_token ', () => oauthAppGeneric.rpAuth('test1', requestOptions)
-      .then((response) => {
-        expect(response.data).to.equal('test ok');
-      }));
-    it('should get a response test ok, redoing to hit the cache ', () => oauthAppGeneric.rpAuth('test1', requestOptions)
-      .then((response) => {
-        expect(response.data).to.equal('test ok');
-      }));
-    it('should get a response test ok, after retry ', () => {
-      const requestOptionsUnAuthorized = {
-        method: 'GET',
-        uri: 'http://localhost:9070/GetTestUnAuthorized',
-        json: true,
-      };
-      return oauthAppGeneric.rpAuth('test1', requestOptionsUnAuthorized)
-        .then((response) => {
-          expect(response.data).to.equal('test ok');
-        });
-    });
-    it('should get a failure on the target service', () => {
-      const requestOptionsFailed = {
-        method: 'GET',
-        headers: {
-          'x-correlation-id': correlationId,
-        },
-        uri: 'http://localhost:9070/GetTestFailed',
-        json: true,
-      };
-      return oauthAppGeneric.rpAuth('test1', requestOptionsFailed)
-        .then(response => expect(response).to.equal('should not return a valid response'))
-        .catch((err) => {
-          expect(err.statusCode).to.equal(SYSTEM_ERROR);
-        });
-    });
-  });
-  describe('authProfile(method, id, correlationId)', function Test() {
-    this.timeout(TIMEOUT);
-    it('should generate an error invalid id', () => oauthAppGeneric.authProfile('GET', null, correlationId)
-      .then(response => expect(response).to.equal('should not return a valid response'))
-      .catch((err) => {
-        expect(err.message).to.equal('Id has to be defined');
-      }));
-    it('should generate an error on GET', () => oauthAppGeneric.authProfile('GET', '123', correlationId)
-      .then(response => expect(response).to.equal('should not return a valid response'))
-      .catch((err) => {
-        expect(err.message).to.include('could perform operation on identity server');
-      }));
-    it('should return nothing', () => oauthAppGeneric.authProfile('DELETE', '123', correlationId)
-      .then((response) => {
-        expect(response).to.equal(undefined);
-      }));
-    it('should stop mock server', () => rpRetry({
-      method: 'GET',
-      headers: {
-        'x-correlation-id': correlationId,
-      },
-      url: 'http://localhost:9070/stop',
-      retry: {
-        delayStrategy: () => DELAY,
-        retries: 1,
-      },
-    })
-      .catch((err) => {
-        expect(err.name).to.equal('System');
-      }));
-  });
-});

package/test/serversMock.js

@@ -1,135 +0,0 @@
-/* eslint-disable no-console */
-/* eslint camelcase: ["error", { properties: "never" }] */
-import { URL } from 'url';
-import bodyParser from 'body-parser';
-import { config } from './testConfig.js';
-import express from 'express';
-import jwt from 'jsonwebtoken';
-import process from 'process';
-import { setTimeout } from 'timers';
-
-const TAB = 2;
-const OK = 200;
-const PARAMETER_ERROR = 400;
-const SYSTEM_ERROR = 500;
-const FORBIDDEN_ERROR = 403;
-const INCR = 1;
-const NONE = 0;
-const ONE = 1;
-const NORMAL_EXIT = 0;
-const TIMEOUT = 3000;
-
-const app = express();
-const mockConfig = {
-  port: 9070,
-};
-const issuerUrl = new URL(config.appGeneric.security.server.issuer);
-const issuerUrlExpiredToken = new URL(config.appExpiredToken.security.server.issuer);
-const issuerUrlExpiredTokenAndFail = new URL(config.appExpiredTokenAndFail.security.server.issuer);
-const fakeJwt = jwt.sign({}, 'dummy key', { expiresIn: 10000000 });
-const fakeExpiredJwt = jwt.sign({}, 'dummy key', { expiresIn: 20 });
-let tries = 0;
-let expiredTries = 0;
-
-app.use(bodyParser.json());
-app.post(issuerUrl.pathname, (req, res) => {
-  console.log(`-----> received POST on ${config.appGeneric.security.server.issuer} with body: ${JSON.stringify(req.body, null, TAB)}`);
-  res.statusCode = OK;
-  res.send({
-    data: {
-      access_token: fakeJwt,
-      refresh_token: fakeJwt,
-    },
-  });
-});
-app.post(issuerUrlExpiredToken.pathname, (req, res) => {
-  console.log(`-----> received POST on ${config.appExpiredToken.security.server.issuer} with body: ${JSON.stringify(req.body, null, TAB)}`);
-  res.statusCode = OK;
-  res.send({
-    data: {
-      access_token: fakeExpiredJwt,
-      refresh_token: fakeJwt,
-    },
-  });
-});
-app.post(issuerUrlExpiredTokenAndFail.pathname, (req, res) => {
-  console.log(`-----> received POST on ${config.appExpiredTokenAndFail.security.server.issuer} with body: ${JSON.stringify(req.body, null, TAB)}`);
-  if (expiredTries === NONE) {
-    console.log('-----> first POST');
-    expiredTries += INCR;
-    res.statusCode = OK;
-    res.send({
-      data: {
-        access_token: fakeExpiredJwt,
-        refresh_token: fakeJwt,
-      },
-    });
-  }
-  else if (expiredTries === ONE) {
-    console.log('-----> second POST');
-    expiredTries += INCR;
-    res.statusCode = PARAMETER_ERROR;
-    res.send({ statusCode: PARAMETER_ERROR });
-  }
-  else {
-    console.log('-----> third POST');
-    res.statusCode = OK;
-    res.send({
-      data: {
-        access_token: fakeExpiredJwt,
-        refresh_token: fakeJwt,
-      },
-    });
-  }
-});
-app.get('/GetTest', (req, res) => {
-  console.log('-----> received GET');
-  res.statusCode = OK;
-  res.send({ data: 'test ok' });
-});
-app.get('/GetTestUnAuthorized', (req, res) => {
-  if (tries === NONE) {
-    console.log('-----> received first GET to be unAuthorized');
-    tries += INCR;
-    res.statusCode = FORBIDDEN_ERROR;
-    res.send({ statusCode: FORBIDDEN_ERROR });
-  }
-  else {
-    console.log('-----> received second GET to be authorized');
-    res.statusCode = OK;
-    res.send({ data: 'test ok' });
-  }
-});
-app.get('/GetTestFailed', (req, res) => {
-  console.log('-----> received GET failed');
-  res.statusCode = SYSTEM_ERROR;
-  res.send({ statusCode: SYSTEM_ERROR });
-});
-app.get('/mIDUrl/users/:id', (req, res) => {
-  console.log('-----> recieved a GET');
-  res.statusCode = SYSTEM_ERROR;
-  res.send({ statusCode: SYSTEM_ERROR });
-});
-app.delete('/mIDUrl/users/:id', (req, res) => {
-  console.log('-----> received a DELETE');
-  res.statusCode = PARAMETER_ERROR;
-  res.send({ statusCode: PARAMETER_ERROR });
-});
-app.get('/stop', (req, res) => {
-  console.log('----->', 'Received a stop');
-  res.statusCode = OK;
-  res.send({ statusCode: OK });
-  setTimeout(() => {
-    process.exit(NORMAL_EXIT);
-  }, TIMEOUT);
-});
-
-const listen = () => {
-  app.listen(mockConfig.port, () => {
-    console.log('----->', `servers mock at ${mockConfig.port}`);
-  });
-};
-
-export {
-  listen,
-};

package/test/testConfig.js

@@ -1,212 +0,0 @@
-const NO_GENERIC = 'noGeneric';
-
-const config = {
-  implImplicit: {
-    security: {
-      implicit: {
-        audience: 'http://implAudience',
-        issuer: 'http://localhost:9070/implIssuer/oauth/token',
-        key: 'implKey',
-      },
-    },
-    dependencies: {
-      mID: {
-        url: 'http://localhost:9070/mIDUrl',
-      },
-    },
-  },
-  implNoGeneric: {
-    security: {
-      server: {
-        audience: 'http://implServerAudience',
-        issuer: 'http://localhost:9070/implServerIssuer/oauth/token',
-        accessKey: 'implicitAccessKey',
-      },
-      generic: {
-        key: NO_GENERIC,
-        audience: NO_GENERIC,
-      },
-    },
-    dependencies: {
-      mID: {
-        url: 'http://localhost:9070/mIDUrl',
-      },
-    },
-  },
-  implGeneric: {
-    security: {
-      server: {
-        audience: 'http://implServerAudience',
-        issuer: 'http://localhost:9070/implServerIssuer/oauth/token',
-        accessKey: 'implAccessKey',
-      },
-      generic: {
-        audience: 'http://implGenericAudience',
-        key: 'implGenericKey',
-      },
-    },
-    dependencies: {
-      mID: {
-        url: 'http://localhost:9070/mIDUrl',
-      },
-    },
-  },
-  appNoGeneric: {
-    server: {
-      id: 'appServerId',
-    },
-    security: {
-      server: {
-        audience: 'http://appServerAudience.com',
-        issuer: 'http://localhost:9070/appNoGenericServerIssuer/oauth/token',
-        id: 'appServerId',
-        secret: 'appServerSecret',
-        accessKey: 'appnAccessKey',
-      },
-      generic: {
-        audience: NO_GENERIC,
-        key: NO_GENERIC,
-      },
-      admin: {
-        externalId: 'appAdminExternalId',
-      },
-    },
-    dependencies: {
-      test1: {
-        audience: 'http://appTest1DependenciesAudience.com',
-      },
-      test2: {
-        audience: 'http://appTest2DependenciesAudience.com',
-      },
-      mID: {
-        url: 'http://localhost:9070/mIDUrl',
-      },
-    },
-  },
-  appGeneric: {
-    server: {
-      id: 'appServerId',
-    },
-    security: {
-      server: {
-        audience: 'http://appServerAudience',
-        issuer: 'http://localhost:9070/appGenericServerIssuer/oauth/token',
-        id: 'appServerId',
-        secret: 'applServerSecret',
-      },
-      generic: {
-        audience: 'http://appGenericAudience',
-        key: 'appGenericKey',
-      },
-      admin: {
-        externalId: 'appAdminExternalId',
-      },
-      apiKeys: ['12345', '54321'],
-    },
-    dependencies: {
-      test1: {
-        audience: 'http://appTest1DependenciesAudience',
-      },
-      test2: {
-        audience: 'http://appTest2DependenciesAudience.com',
-      },
-      mID: {
-        url: 'http://localhost:9070/mIDUrl',
-      },
-    },
-  },
-  appUnknownIssuer: {
-    server: {
-      id: 'appServerId',
-    },
-    security: {
-      server: {
-        issuer: 'http://localhost:9070/unknown/oauth/token',
-        id: 'appServerId',
-        secret: 'appServerSecret',
-      },
-      generic: {
-        audience: 'http://appGenericAudience',
-        key: 'appGenericKey',
-      },
-      admin: {
-        externalId: 'appAdminExternalId',
-      },
-    },
-    dependencies: {
-      test1: {
-        audience: 'http://appTest1DependenciesAudience',
-      },
-      test2: {
-        audience: 'http://appTest2DependenciesAudience.com',
-      },
-      mID: {
-        url: 'http://localhost:9070/mIDUrl',
-      },
-    },
-  },
-  appExpiredToken: {
-    server: {
-      id: 'appServerId',
-    },
-    security: {
-      server: {
-        issuer: 'http://localhost:9070/appGenericServerIssuer/oauth/expiredToken',
-        id: 'appServerId',
-        secret: 'appServerSecret',
-      },
-      generic: {
-        audience: 'http://appGenericAudience',
-        key: 'appGenericKey',
-      },
-      admin: {
-        externalId: 'appAdminExternalId',
-      },
-    },
-    dependencies: {
-      test1: {
-        audience: 'http://appTest1DependenciesAudience',
-      },
-      test2: {
-        audience: 'http://appTest2DependenciesAudience.com',
-      },
-      mID: {
-        url: 'http://localhost:9070/mIDUrl',
-      },
-    },
-  },
-  appExpiredTokenAndFail: {
-    server: {
-      id: 'appServerId',
-    },
-    security: {
-      server: {
-        issuer: 'http://localhost:9070/appGenericServerIssuer/oauth/expiredTokenAndFail',
-        id: 'appServerId',
-        secret: 'appServerSecret',
-      },
-      generic: {
-        audience: 'http://appGenericAudience',
-        key: 'appGenericKey',
-      },
-      admin: {
-        externalId: 'appAdminExternalId',
-      },
-    },
-    dependencies: {
-      test1: {
-        audience: 'http://appTest1DependenciesAudience',
-      },
-      test2: {
-        audience: 'http://appTest2DependenciesAudience.com',
-      },
-      mID: {
-        url: 'http://localhost:9070/mIDUrl',
-      },
-    },
-  },
-};
-
-export {
-  config,
-};

package/test/testEnv.js

@@ -1,20 +0,0 @@
-/* eslint no-process-env: "off" */
-import process from 'process';
-
-/**
- * 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 = null;
-process.env.SUMO_LOGIC_COLLECTOR_CODE = null;
-process.env.NO_STACK = 'yes';
-process.env.LOG_LEVEL = 'error';
-// process.env.CONSOLE_LEVEL = 'debug';