@mimik/oauth-helper 3.0.1 → 4.0.0

package/.husky/pre-commit

@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npm run commit-ready
+npm run commit-ready

package/.husky/pre-push

@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npm run test
+npm run test

package/eslint.config.js

@@ -0,0 +1,64 @@
+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/index.js

@@ -1,9 +1,11 @@
-const Promise = require('bluebird');
-const jwt = require('jsonwebtoken');
-
-const { rpRetry } = require('@mimik/request-retry');
-const logger = require('@mimik/sumologic-winston-logger');
-const { getRichError } = require('@mimik/response-helper');
+/* eslint camelcase: ["error", { properties: "never" }] */
+import Promise from 'bluebird';
+import { URL } from 'url';
+import { getRichError } from '@mimik/response-helper';
+import jwt from 'jsonwebtoken';
+import logger from '@mimik/sumologic-winston-logger';
+import process from 'process';
+import { rpRetry } from '@mimik/request-retry';
 
 Promise.config({ cancellation: true });
 /**
@@ -17,11 +19,20 @@ const CLUSTER = 'cluster';
 const CLIENT_CEDENTIALS = 'client_credentials';
 const REFRESH_TOKEN = 'refresh_token';
 
+const PARAMETER_ERROR = 400;
+const FORBIDDEN_ERROR = 403;
+const OK = 200;
+const MILLI_SECONDS = 0;
+const MILLI_NANO_SECONDS = 1;
+const MILLI = 1000;
+const NANO = 1e6;
+const ZERO = 0;
+
 const tokens = {};
 
 const valid = (token) => {
   if (!token) return false;
-  if (token.exp - (Math.floor(Date.now() / 1000) + TOKEN_REFRESH_TOLERANCE) < 0) return false;
+  if (token.exp - (Math.floor(Date.now() / MILLI) + TOKEN_REFRESH_TOLERANCE) < ZERO) return false;
   return true;
 };
 
@@ -33,7 +44,7 @@ const createToken = (value) => {
   return token;
 };
 
-module.exports = (config) => {
+export default (config) => {
   const { server } = config.security;
   const getToken = (type, origin, correlationId, options) => {
     const tokenOptions = {
@@ -81,7 +92,7 @@ module.exports = (config) => {
       }
     }
     return rpRetry(tokenOptions).catch((err) => {
-      if (err.statusCode !== 400 || tokenOptions.body.grant_type === CLIENT_CEDENTIALS) {
+      if (err.statusCode !== PARAMETER_ERROR || tokenOptions.body.grant_type === CLIENT_CEDENTIALS) {
         throw err;
       }
       logger.silly(`moving from ${REFRESH_TOKEN} to ${CLIENT_CEDENTIALS}`, { error: err.message }, correlationId);
@@ -132,7 +143,7 @@ module.exports = (config) => {
     const measure = (statusCode) => {
       if (metrics && metrics.HTTPRequestDuration) {
         const elapsedHrTime = process.hrtime(startHrTime);
-        const elapsedTimeInMs = elapsedHrTime[0] * 1000 + elapsedHrTime[1] / 1e6;
+        const elapsedTimeInMs = elapsedHrTime[MILLI_SECONDS] * MILLI + elapsedHrTime[MILLI_NANO_SECONDS] / NANO;
 
         metrics.HTTPRequestDuration
           .labels('rpAuth', options.method, metrics.url || enteredUrl, enteredUrl.includes('?'), statusCode)
@@ -144,7 +155,9 @@ module.exports = (config) => {
     if (!type) return Promise.reject(new Error(`rpAuth type non existent for ${options.method || 'GET'} on ${enteredUrl}`));
     if (!config.dependencies[type]) return Promise.reject(new Error(`type ${type} used in rpAuth with no dependencies`));
     if (!options.url && !options.uri) return Promise.reject(new Error('uri or url non existent'));
-    try { url = new URL(enteredUrl); }
+    try {
+      url = new URL(enteredUrl);
+    }
     catch (err) { return Promise.reject(new Error(`invalid url address: ${enteredUrl}: ${err.message}`)); }
     const correlationId = (options.headers && options.headers['x-correlation-id']);
 
@@ -156,11 +169,11 @@ module.exports = (config) => {
         opts.headers.authorization = `Bearer ${token}`;
         return rpRetry(opts)
           .then((result) => {
-            measure(200);
+            measure(OK);
             return result;
           })
           .catch((err) => {
-            if (err.statusCode === 403) {
+            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)
@@ -168,7 +181,7 @@ module.exports = (config) => {
                   opts.headers.authorization = `Bearer ${newToken}`;
                   return rpRetry(opts)
                     .then((result) => {
-                      measure(200);
+                      measure(OK);
                       return result;
                     });
                 });
@@ -211,7 +224,7 @@ module.exports = (config) => {
       .catch((err) => {
         const error = getRichError(err.statusCode, 'could perform operation on identity server', { method, id }, err);
 
-        if (error.statusCode === 400 && method === 'DELETE') {
+        if (error.statusCode === PARAMETER_ERROR && method === 'DELETE') {
           logger.warn('profile without authprofile', { id, error }, correlationId);
           return;
         }

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@mimik/oauth-helper",
-  "version": "3.0.1",
+  "version": "4.0.0",
   "description": "Oauth helper for mimik microservices",
-  "main": "index.js",
+  "main": "./index.js",
+  "type": "module",
   "scripts": {
-    "lint": "eslint --ignore-path .gitignore .",
+   "lint": "eslint . --no-error-on-unmatched-pattern",
     "docs": "jsdoc2md index.js > README.md",
     "test": "mocha --reporter mochawesome --bail --check-leaks test/",
-    "test-ci": "nyc --reporter=lcov --reporter=text npm test",
+    "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",
-    "prepare": "husky install"
+    "commit-ready": "npm run docs && npm run lint && npm run test-ci"
   },
   "husky": {
     "hooks": {
@@ -29,29 +29,26 @@
     "url": "https://bitbucket.org/mimiktech/oauth-helper"
   },
   "dependencies": {
-    "@mimik/request-retry": "^3.0.1",
-    "@mimik/response-helper": "^3.0.1",
-    "@mimik/sumologic-winston-logger": "^1.6.20",
+    "@mimik/request-retry": "^4.0.1",
+    "@mimik/response-helper": "^4.0.1",
+    "@mimik/sumologic-winston-logger": "^2.0.2",
     "bluebird": "3.7.2",
     "jsonwebtoken": "9.0.2"
   },
   "devDependencies": {
-    "@mimik/eslint-plugin-dependencies": "^2.4.6",
-    "@mimik/eslint-plugin-document-env": "^1.0.6",
-    "@mimik/request-helper": "^1.7.10",
-    "body-parser": "1.20.2",
-    "chai": "4.3.10",
-    "eslint": "8.55.0",
-    "eslint-config-airbnb": "19.0.4",
-    "eslint-plugin-import": "2.29.0",
-    "eslint-plugin-jsx-a11y": "6.8.0",
-    "eslint-plugin-react": "7.33.2",
-    "eslint-plugin-react-hooks": "4.6.0",
-    "express": "4.18.2",
-    "husky": "8.0.3",
-    "jsdoc-to-markdown": "8.0.0",
-    "mocha": "10.2.0",
-    "mochawesome": "7.1.3",
-    "nyc": "15.1.0"
+    "@eslint/js": "9.24.0",
+    "@mimik/eslint-plugin-document-env": "^2.0.5",
+    "@mimik/request-helper": "2.0.1",
+    "@stylistic/eslint-plugin": "4.2.0",
+    "c8": "10.1.3",
+    "body-parser": "2.2.0",
+    "chai": "5.2.0",
+    "eslint": "9.24.0",
+    "eslint-plugin-import": "2.31.0",
+    "express": "4.21.2",
+    "husky": "9.1.7",
+    "jsdoc-to-markdown": "9.1.1",
+    "mocha": "11.1.0",
+    "mochawesome": "7.1.3"
   }
 }

package/test/oauthHelper.spec.js

@@ -1,18 +1,17 @@
-const chai = require('chai');
+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';
 
-require('./testEnv');
+should();
 
-const { getCorrelationId } = require('@mimik/request-helper');
-const { rpRetry } = require('@mimik/request-retry');
-
-const oauthHelper = require('../index');
-const {
-  config,
-} = require('./testConfig');
-const mockServer = require('./serversMock');
-
-const { expect } = chai;
-chai.should();
+const SYSTEM_ERROR = 500;
+const TIMEOUT = 200000;
+const DELAY = 100;
 
 const correlationId = getCorrelationId('--test-OauthHelper--');
 // const oauthImplNoGeneric = oauthHelper(config.implNoGeneric);
@@ -24,10 +23,10 @@ const oauthAppExpiredTokenAndFail = oauthHelper(config.appExpiredTokenAndFail);
 
 describe('OauthHelper Unit Tests', () => {
   before(() => {
-    mockServer.listen();
+    listen();
   });
-  describe('rpAuth(type, options)', function test() {
-    this.timeout(200000);
+  describe('rpAuth(type, options)', function Test() {
+    this.timeout(TIMEOUT);
     const requestOptions = {
       method: 'GET',
       headers: {
@@ -37,19 +36,19 @@ describe('OauthHelper Unit Tests', () => {
       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'))
+      .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'))
+      .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'))
+        .then(response => expect(response).to.equal('should not return a valid response'))
         .catch((err) => {
           expect(err.message).to.equal('uri or url non existent');
         });
@@ -57,7 +56,7 @@ describe('OauthHelper Unit Tests', () => {
     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'))
+        .then(response => expect(response).to.equal('should not return a valid response'))
         .catch((err) => {
           expect(err.message).to.include('invalid url address');
         });
@@ -65,9 +64,9 @@ describe('OauthHelper Unit Tests', () => {
     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'))
+        .then(response => expect(response).to.equal('should not return a valid response'))
         .catch((err) => {
-          expect(err.message).to.include('request error response: Not Found');
+          expect(err.message).to.include('request error response');
         });
     });
     it('should get a response test ok, setting up expiredTokenAndFail ', () => oauthAppExpiredTokenAndFail.rpAuth('test1', requestOptions)
@@ -107,23 +106,23 @@ describe('OauthHelper Unit Tests', () => {
         json: true,
       };
       return oauthAppGeneric.rpAuth('test1', requestOptionsFailed)
-        .then((response) => expect(response).to.equal('should not return a valid response'))
+        .then(response => expect(response).to.equal('should not return a valid response'))
         .catch((err) => {
-          expect(err.statusCode).to.equal(500);
+          expect(err.statusCode).to.equal(SYSTEM_ERROR);
         });
     });
   });
-  describe('authProfile(method, id, correlationId)', function test() {
-    this.timeout(200000);
+  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'))
+      .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'))
+      .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: request error response');
+        expect(err.message).to.include('could perform operation on identity server');
       }));
     it('should return nothing', () => oauthAppGeneric.authProfile('DELETE', '123', correlationId)
       .then((response) => {
@@ -136,7 +135,7 @@ describe('OauthHelper Unit Tests', () => {
       },
       url: 'http://localhost:9070/stop',
       retry: {
-        delayStrategy: () => 100,
+        delayStrategy: () => DELAY,
         retries: 1,
       },
     })

package/test/serversMock.js

@@ -1,11 +1,23 @@
 /* eslint-disable no-console */
-const jwt = require('jsonwebtoken');
-const express = require('express');
-const bodyParser = require('body-parser');
+/* 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 {
-  config,
-} = require('./testConfig');
+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 = {
@@ -21,8 +33,8 @@ 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, 2)}`);
-  res.statusCode = 200;
+  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,
@@ -31,8 +43,8 @@ app.post(issuerUrl.pathname, (req, res) => {
   });
 });
 app.post(issuerUrlExpiredToken.pathname, (req, res) => {
-  console.log(`-----> received POST on ${config.appExpiredToken.security.server.issuer} with body: ${JSON.stringify(req.body, null, 2)}`);
-  res.statusCode = 200;
+  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,
@@ -41,11 +53,11 @@ app.post(issuerUrlExpiredToken.pathname, (req, res) => {
   });
 });
 app.post(issuerUrlExpiredTokenAndFail.pathname, (req, res) => {
-  console.log(`-----> received POST on ${config.appExpiredTokenAndFail.security.server.issuer} with body: ${JSON.stringify(req.body, null, 2)}`);
-  if (expiredTries === 0) {
+  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 += 1;
-    res.statusCode = 200;
+    expiredTries += INCR;
+    res.statusCode = OK;
     res.send({
       data: {
         access_token: fakeExpiredJwt,
@@ -53,15 +65,15 @@ app.post(issuerUrlExpiredTokenAndFail.pathname, (req, res) => {
       },
     });
   }
-  else if (expiredTries === 1) {
+  else if (expiredTries === ONE) {
     console.log('-----> second POST');
-    expiredTries += 1;
-    res.statusCode = 400;
-    res.send({ statusCode: 400 });
+    expiredTries += INCR;
+    res.statusCode = PARAMETER_ERROR;
+    res.send({ statusCode: PARAMETER_ERROR });
   }
   else {
     console.log('-----> third POST');
-    res.statusCode = 200;
+    res.statusCode = OK;
     res.send({
       data: {
         access_token: fakeExpiredJwt,
@@ -72,44 +84,44 @@ app.post(issuerUrlExpiredTokenAndFail.pathname, (req, res) => {
 });
 app.get('/GetTest', (req, res) => {
   console.log('-----> received GET');
-  res.statusCode = 200;
+  res.statusCode = OK;
   res.send({ data: 'test ok' });
 });
 app.get('/GetTestUnAuthorized', (req, res) => {
-  if (tries === 0) {
+  if (tries === NONE) {
     console.log('-----> received first GET to be unAuthorized');
-    tries += 1;
-    res.statusCode = 403;
-    res.send({ statusCode: 403 });
+    tries += INCR;
+    res.statusCode = FORBIDDEN_ERROR;
+    res.send({ statusCode: FORBIDDEN_ERROR });
   }
   else {
     console.log('-----> received second GET to be authorized');
-    res.statusCode = 200;
+    res.statusCode = OK;
     res.send({ data: 'test ok' });
   }
 });
 app.get('/GetTestFailed', (req, res) => {
   console.log('-----> received GET failed');
-  res.statusCode = 500;
-  res.send({ statusCode: 500 });
+  res.statusCode = SYSTEM_ERROR;
+  res.send({ statusCode: SYSTEM_ERROR });
 });
 app.get('/mIDUrl/users/:id', (req, res) => {
   console.log('-----> recieved a GET');
-  res.statusCode = 500;
-  res.send({ statusCode: 500 });
+  res.statusCode = SYSTEM_ERROR;
+  res.send({ statusCode: SYSTEM_ERROR });
 });
 app.delete('/mIDUrl/users/:id', (req, res) => {
   console.log('-----> received a DELETE');
-  res.statusCode = 400;
-  res.send({ statusCode: 400 });
+  res.statusCode = PARAMETER_ERROR;
+  res.send({ statusCode: PARAMETER_ERROR });
 });
 app.get('/stop', (req, res) => {
   console.log('----->', 'Received a stop');
-  res.statusCode = 200;
-  res.send({ statusCode: 200 });
+  res.statusCode = OK;
+  res.send({ statusCode: OK });
   setTimeout(() => {
-    process.exit(0);
-  }, 3000);
+    process.exit(NORMAL_EXIT);
+  }, TIMEOUT);
 });
 
 const listen = () => {
@@ -118,6 +130,6 @@ const listen = () => {
   });
 };
 
-module.exports = {
+export {
   listen,
 };

package/test/testConfig.js

@@ -207,6 +207,6 @@ const config = {
   },
 };
 
-module.exports = {
+export {
   config,
 };

package/test/testEnv.js

@@ -1,4 +1,5 @@
 /* eslint no-process-env: "off" */
+import process from 'process';
 
 /**
  * The following environment variables are set for the test:

package/.eslintrc

@@ -1,43 +0,0 @@
-{
-  "plugins": [
-    "@mimik/document-env",
-    "@mimik/dependencies"
-  ],
-  "env": {
-    "node": true
-  },
-  "parserOptions": {
-    "ecmaVersion": 2020
-  },
-  "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 }],
-    "linebreak-style": 0,
-    "quotes": [1, "single"],
-    "semi": [1, "always"],
-    "no-process-env": ["error"],
-    "@mimik/document-env/validate-document-env": 2,
-    "@mimik/dependencies/case-sensitive": 2,
-    "@mimik/dependencies/no-cycles": 2,
-    "@mimik/dependencies/require-json-ext": 2
-  },
-  "settings":{
-    "react": {
-      "version": "detect"
-    }
-  },
-  "globals": {
-    "module": true,
-    "require": true,
-    "const": false,
-    "it": false,
-    "describe": false,
-    "before": true,
-    "after": true,
-    "JSON": true
-  }
-}