@mimik/init 5.3.0 → 6.0.0

package/README.md

@@ -3,16 +3,16 @@
 ## init
 **Example**  
 ```js
-const init = require('@mimik/init');
+import init from '@mimik/init';
 
 init(config, dbValidate, { postOps: [suscribe] }).then(result => config = result);
 ```
-<a name="exp_module_init--module.exports"></a>
+<a name="module_init..init"></a>
 
-### module.exports(app, rootDir, config, validates, cluster, options) ⇒ <code>object</code> ⏏
+### init~init(app, rootDir, config, validates, cluster, options) ⇒ <code>object</code>
 Init process for a micro-service.
 
-**Kind**: Exported function  
+**Kind**: inner method of [<code>init</code>](#module_init)  
 **Returns**: <code>object</code> - The updated configuration.
 
 The  secOptions has the following structure:

package/eslint.config.js

@@ -0,0 +1,63 @@
+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 = 7;
+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,
+  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-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,37 +1,41 @@
-const cors = require('cors');
-const http = require('http');
-const pathLib = require('path');
-const Promise = require('bluebird');
-const helmet = require('helmet');
-
-const logger = require('@mimik/sumologic-winston-logger');
-const { startupHealthInfo } = require('@mimik/healthcheck');
-const { getPublic } = require('@mimik/public-helper');
-const { getCorrelationId } = require('@mimik/request-helper');
-const { apiSetup, setupServerFiles } = require('@mimik/api-helper');
-
-const { extractLogs } = require('./lib/logs');
-const { sigProcess } = require('./lib/exit');
-const { startHrTimeSet } = require('./lib/metrics');
-const { healthCheckRoute, metricsRoute, bodyParserRoute } = require('./lib/route');
-const {
+import {
+  BUILD_FILENAME,
   HEALTHCHECK_ROUTE,
+  LOCAL,
   METRICS_ROUTE,
+  SET_ON,
   SIGINT,
   SIGTERM,
-  LOCAL,
-  SET_ON,
-  BUILD_FILENAME,
-} = require('./lib/common');
+} from './lib/common.js';
+import { apiSetup, setupServerFiles } from '@mimik/api-helper';
+import { bodyParserRoute, healthCheckRoute, metricsRoute } from './lib/route.js';
+import Promise from 'bluebird';
+import cors from 'cors';
+import { extractLogs } from './lib/logs.js';
+import { getCorrelationId } from '@mimik/request-helper';
+import { getPublic } from '@mimik/public-helper';
+import helmet from 'helmet';
+import http from 'http';
+import logger from '@mimik/sumologic-winston-logger';
+import pathLib from 'path';
+import process from 'process';
+import { sigProcess } from './lib/exit.js';
+import { startHrTimeSet } from './lib/metrics.js';
+import { startupHealthInfo } from '@mimik/healthcheck';
 
 /**
  * @module init
  * @example
- * const init = require('@mimik/init');
+ * import init from '@mimik/init';
  *
  * init(config, dbValidate, { postOps: [suscribe] }).then(result => config = result);
  *
  */
+
+const EXIT_ERROR = 1;
+const FIRST = 0;
+const FIRST_PATH_ELEMENT = 0;
+
 /**
  * Init process for a micro-service.
  *
@@ -64,11 +68,11 @@ const {
  * The following routes are reserved: `/healthcheck` and `/metrics`.
  * The base path is defined by taking the url property of the first item of the servers array in the api defintion file. Only relative url address will be handled (e.g. /mss/v1) and templates in the url are not allowed.
  */
-module.exports = (app, rootDir, config, validates, cluster, options) => {
+const init = (app, rootDir, config, validates, cluster, options) => {
   const fatalError = (error, correlationId) => {
-    if (!config) logger.error('fatal error: could not start server', { error }, getCorrelationId('system-start'));
-    else logger.error('fatal error: could not start server', { name: config.serverSettings.name, id: config.serverSettings.id, error }, correlationId);
-    logger.flushAndExit(1);
+    if (config) logger.error('fatal error: could not start server', { name: config.serverSettings.name, id: config.serverSettings.id, error }, correlationId);
+    else logger.error('fatal error: could not start server', { error }, getCorrelationId('system-start'));
+    logger.flushAndExit(EXIT_ERROR);
   };
 
   if (!config) return fatalError(new Error('config is required'));
@@ -101,7 +105,9 @@ module.exports = (app, rootDir, config, validates, cluster, options) => {
   let apiFilename = serverSettings.api;
   let registration = false;
 
-  if ((config.nodeEnvironment.toLowerCase() !== LOCAL) || (config.registration.set === SET_ON)) { registration = true; }
+  if ((config.nodeEnvironment.toLowerCase() !== LOCAL) || (config.registration.set === SET_ON)) {
+    registration = true;
+  }
   else logger.warn('registration disabled: cluster will not work', correlationIdStart);
   if (extractName) {
     if (!dependencies || !dependencies.mLG) return fatalError(new Error('requesting extraction without mLG configuration'), correlationIdStart);
@@ -133,13 +139,15 @@ module.exports = (app, rootDir, config, validates, cluster, options) => {
   if (oidcOps && typeof oidcOps === 'function') {
     oidcOps();
   }
-  if (extractName) { app.use(extractLogs(config, extractName, options)); }
-  if (apiFilename[0] !== '/') apiFilename = pathLib.join(rootDir, apiFilename);
+  if (extractName) {
+    app.use(extractLogs(config, extractName, options));
+  }
+  if (apiFilename[FIRST_PATH_ELEMENT] !== '/') apiFilename = pathLib.join(rootDir, apiFilename);
   logger.debug('location of the api file', { apiFilename }, correlationIdStart);
   return setupServerFiles(apiFilename, controllersDirectory, buildDirectory, correlationIdStart, updateOptions(options))
     .then((setupResult) => {
-      serverSettings.basePath = setupResult.apiDefinition.servers[0].url; // need to address that later
-      // this will be deprecated by init 6.0
+      serverSettings.basePath = setupResult.apiDefinition.servers[FIRST].url; // need to address that later
+      // this will be deprecated by init 7.0, to handle lower case paths
       app.use((req, res, next) => {
         const parts = req.url.split('/');
         const partsLength = parts.length;
@@ -154,47 +162,51 @@ module.exports = (app, rootDir, config, validates, cluster, options) => {
         next();
       });
       // end of deprecation
-      // eslint-disable-next-line import/no-dynamic-require,global-require
-      const registeredOperations = require(buildRequire);
-      const api = apiSetup(setupResult, registeredOperations, options?.secOptions, options?.formats, config, correlationIdStart);
+      return import(pathLib.resolve(buildRequire))
+        .then((registeredOperationsModule) => {
+          const registeredOperations = registeredOperationsModule.default;
+          const api = apiSetup(setupResult, registeredOperations, options?.secOptions, options?.formats, config, correlationIdStart);
 
-      app.use((req, res) => api.handleRequest(req, req, res));
-      return Promise.each(validates, (validate) => validate())
-        .then(() => getPublic(config.locationProvider, config.cloudProvider, correlationIdStart, options).then((publicConfig) => {
-          logger.info('public environment', { status: publicConfig.status }, correlationIdStart);
-          serverSettings.ip.public = publicConfig.ip || serverSettings.ip.public;
-          serverSettings.instanceId = publicConfig.id;
-          serverSettings.public.location = publicConfig.location || serverSettings.public.location;
-        }))
-        .then(() => {
-          if (options && options.preOps) return Promise.each(options.preOps, (ops) => ops(correlationIdStart, config, server));
-          return null;
-        })
-        .then(() => {
-          server.listen(serverPort, () => {
-            startupHealthInfo(config, correlationIdStart);
-            const afterPostOps = config.registration.afterPostOpsSet === SET_ON;
+          app.use((req, res) => api.handleRequest(req, req, res));
+          return Promise.each(validates, validate => validate())
+            .then(() => getPublic(config.locationProvider, config.cloudProvider, correlationIdStart, options).then((publicConfig) => {
+              logger.info('public environment', { status: publicConfig.status }, correlationIdStart);
+              serverSettings.ip.public = publicConfig.ip || serverSettings.ip.public;
+              serverSettings.instanceId = publicConfig.id;
+              serverSettings.public.location = publicConfig.location || serverSettings.public.location;
+            }))
+            .then(() => {
+              if (options && options.preOps) return Promise.each(options.preOps, ops => ops(correlationIdStart, config, server));
+              return null;
+            })
+            .then(() => {
+              server.listen(serverPort, () => {
+                startupHealthInfo(config, correlationIdStart);
+                const afterPostOps = config.registration.afterPostOpsSet === SET_ON;
 
-            return Promise.resolve()
-              .then(() => {
-                if (afterPostOps) {
-                  if (options && options.postOps) return Promise.each(options.postOps, (ops) => ops(correlationIdStart, config, server));
-                  return null;
-                }
-                if (registration) return register(correlationIdStart);
-                return null;
-              })
-              .then(() => {
-                if (afterPostOps) {
-                  if (registration) return register(correlationIdStart);
-                  return null;
-                }
-                if (options && options.postOps) return Promise.each(options.postOps, (ops) => ops(correlationIdStart, config, server));
-                return null;
+                return Promise.resolve()
+                  .then(() => {
+                    if (afterPostOps) {
+                      if (options && options.postOps) return Promise.each(options.postOps, ops => ops(correlationIdStart, config, server));
+                      return null;
+                    }
+                    if (registration) return register(correlationIdStart);
+                    return null;
+                  })
+                  .then(() => {
+                    if (afterPostOps) {
+                      if (registration) return register(correlationIdStart);
+                      return null;
+                    }
+                    if (options && options.postOps) return Promise.each(options.postOps, ops => ops(correlationIdStart, config, server));
+                    return null;
+                  });
               });
-          });
+            });
         });
     })
-    .catch((error) => fatalError(error, correlationIdStart))
+    .catch(error => fatalError(error, correlationIdStart))
     .then(() => ({ config }));
 };
+
+export default init;

package/lib/common.js

@@ -13,7 +13,7 @@ const SET_ON = 'on';
 
 const BUILD_FILENAME = 'register';
 
-module.exports = {
+export {
   METRICS_ROUTE,
   HEALTHCHECK_ROUTE,
   OUT_OF_SPEC_ROUTE,

package/lib/exit.js

@@ -1,22 +1,23 @@
-const Promise = require('bluebird');
-
-const logger = require('@mimik/sumologic-winston-logger');
+import Promise from 'bluebird';
+import logger from '@mimik/sumologic-winston-logger';
 
 const SHUTDOWN = 'service shutdown successfully';
 const SHUTDOWN_WITH_ERROR = 'service shutdown with error';
+const EXIT_OK = 0;
+const EXIT_ERROR = 1;
 
 const shutdown = (res, correlationId) => {
   if (res.errors) {
     logger.warn(SHUTDOWN_WITH_ERROR, res, correlationId);
-    logger.flushAndExit(1);
+    logger.flushAndExit(EXIT_ERROR);
   }
   else {
     logger.info(SHUTDOWN, res, correlationId);
-    logger.flushAndExit(0);
+    logger.flushAndExit(EXIT_OK);
   }
 };
 
-const sigProcess = (signal, registration, options, config, server, unRegister, correlationId) => {
+export const sigProcess = (signal, registration, options, config, server, unRegister, correlationId) => {
   if (registration) {
     return unRegister(correlationId)
       .then((origResult) => {
@@ -26,7 +27,7 @@ const sigProcess = (signal, registration, options, config, server, unRegister, c
         if (!options || !options.exitOps) {
           return shutdown(result, correlationId);
         }
-        return Promise.each(options.exitOps, (ops) => ops(correlationId, config, server)
+        return Promise.each(options.exitOps, ops => ops(correlationId, config, server)
           .catch((err) => {
             if (result.errors) result.errors.push(err);
             else result.errors = [err];
@@ -35,10 +36,10 @@ const sigProcess = (signal, registration, options, config, server, unRegister, c
       });
   }
   logger.info(SHUTDOWN, { serverId: config.serverSettings.id, signal }, correlationId);
-  logger.flushAndExit(0);
+  logger.flushAndExit(EXIT_OK);
   return null;
 };
 
-module.exports = {
+export default {
   sigProcess,
 };

package/lib/logs.js

@@ -1,15 +1,14 @@
-const urlLib = require('url');
-
-const { publicIpFromRequest } = require('@mimik/address-helper');
-const oauthHelper = require('@mimik/oauth-helper');
-const logger = require('@mimik/sumologic-winston-logger');
-const { getRichError } = require('@mimik/response-helper');
-const { getCorrelationId } = require('@mimik/request-helper');
+import { getCorrelationId } from '@mimik/request-helper';
+import { getRichError } from '@mimik/response-helper';
+import logger from '@mimik/sumologic-winston-logger';
+import oauthHelper from '@mimik/oauth-helper';
+import { publicIpFromRequest } from '@mimik/address-helper';
+import urlLib from 'url';
 
 const correlationId = getCorrelationId('log-extraction');
 const NOTIFICATION = '/notifications';
 
-const extractLogs = (config, extractName, options) => (req, res, next) => {
+export const extractLogs = (config, extractName, options) => (req, res, next) => {
   const { rpAuth } = oauthHelper(config);
   let url = `${config.dependencies.mLG.url}${NOTIFICATION}`;
   const params = new urlLib.URLSearchParams();
@@ -42,12 +41,12 @@ const extractLogs = (config, extractName, options) => (req, res, next) => {
       opts.metrics.url = url;
     }
     rpAuth('mLG', opts)
-      .catch((err) => getRichError('System', 'could not send extracted data', { url, extractName }, err, 'warn', correlationId));
+      .catch(err => getRichError('System', 'could not send extracted data', { url, extractName }, err, 'warn', correlationId));
     delete req.body[extractName];
   }
   next();
 };
 
-module.exports = {
+export default {
   extractLogs,
 };

package/lib/metrics.js

@@ -1,8 +1,10 @@
-const startHrTimeSet = (APIRequestDuration) => (req, res, next) => {
+import process from 'process';
+
+export const startHrTimeSet = APIRequestDuration => (req, res, next) => {
   req.metrics = { startHrTime: process.hrtime(), APIRequestDuration };
   next();
 };
 
-module.exports = {
+export default {
   startHrTimeSet,
 };

package/lib/route.js

@@ -1,18 +1,20 @@
-const http = require('http');
-
-const { healthInfo } = require('@mimik/systeminfo');
-const logger = require('@mimik/sumologic-winston-logger');
-const { getCorrelationId, getUserAgent } = require('@mimik/request-helper');
-const { publicIpFromRequest } = require('@mimik/address-helper');
-
-const { CONTENT_TYPE, JSON_CONTENT } = require('./common');
-
-const healthCheckRoute = () => (req, res) => {
+import { CONTENT_TYPE, JSON_CONTENT } from './common.js';
+import { getCorrelationId, getUserAgent } from '@mimik/request-helper';
+import { healthInfo } from '@mimik/systeminfo';
+import http from 'http';
+import logger from '@mimik/sumologic-winston-logger';
+import { publicIpFromRequest } from '@mimik/address-helper';
+
+const TAB = 2;
+const SYSTEM_ERROR = 500;
+const PARAMETER_ERROR = 400;
+
+export const healthCheckRoute = () => (req, res) => {
   res.setHeader(CONTENT_TYPE, JSON_CONTENT);
-  res.end(JSON.stringify({ data: healthInfo() }, null, 2));
+  res.end(JSON.stringify({ data: healthInfo() }, null, TAB));
 };
 
-const metricsRoute = (options) => (req, res) => options.metrics.register.metrics()
+export const metricsRoute = options => (req, res) => options.metrics.register.metrics()
   .then((result) => {
     res.setHeader(CONTENT_TYPE, options.metrics.register.contentType);
     res.end(result);
@@ -20,16 +22,16 @@ const metricsRoute = (options) => (req, res) => options.metrics.register.metrics
   .catch((err) => {
     res.setHeader(CONTENT_TYPE, JSON_CONTENT);
     const errResponse = {
-      statusCode: 500,
-      title: http.STATUS_CODES[500],
+      statusCode: SYSTEM_ERROR,
+      title: http.STATUS_CODES[SYSTEM_ERROR],
       message: err.message,
     };
 
-    res.end(JSON.stringify(errResponse), null, 2);
+    res.end(JSON.stringify(errResponse), null, TAB);
   });
 
-const bodyParserRoute = () => (err, req, res, next) => {
-  if (err instanceof SyntaxError && err.status === 400 && 'body' in err) {
+export const bodyParserRoute = () => (err, req, res, next) => {
+  if (err instanceof SyntaxError && err.status === PARAMETER_ERROR && 'body' in err) {
     const { originalUrl } = req;
     const method = req.method.toUpperCase();
     const correlationId = getCorrelationId(req);
@@ -37,15 +39,15 @@ const bodyParserRoute = () => (err, req, res, next) => {
     logger.warn(`Rejecting request with 400 for ${method} ${originalUrl}`, {
       method,
       path: originalUrl,
-      statusCode: 400,
+      statusCode: PARAMETER_ERROR,
       userAgent: getUserAgent(req),
       clientIP: publicIpFromRequest(req),
       error: err,
     }, correlationId);
     if (correlationId) res.setHeader('x-correlation-id', correlationId);
-    return res.status(400).json({
-      statusCode: 400,
-      title: http.STATUS_CODES[400],
+    return res.status(PARAMETER_ERROR).json({
+      statusCode: PARAMETER_ERROR,
+      title: http.STATUS_CODES[PARAMETER_ERROR],
       message: err.message,
       error: err,
     });
@@ -53,7 +55,7 @@ const bodyParserRoute = () => (err, req, res, next) => {
   return next();
 };
 
-module.exports = {
+export default {
   healthCheckRoute,
   metricsRoute,
   bodyParserRoute,

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@mimik/init",
-  "version": "5.3.0",
+  "version": "6.0.0",
   "description": "Init process for micro-service",
-  "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": "echo \"Error: no test specified\" && exit 0",
     "test-ci": "echo \"Error: no test specified\" && exit 0",
@@ -28,29 +29,26 @@
     "url": "https://bitbucket.org/mimiktech/init"
   },
   "dependencies": {
-    "@mimik/address-helper": "^1.6.10",
-    "@mimik/api-helper": "^1.1.0",
-    "@mimik/healthcheck": "^1.5.11",
-    "@mimik/oauth-helper": "^3.0.2",
-    "@mimik/public-helper": "^2.0.1",
-    "@mimik/request-helper": "^1.7.11",
-    "@mimik/response-helper": "^3.1.0",
-    "@mimik/sumologic-winston-logger": "^1.6.21",
-    "@mimik/systeminfo": "^3.0.1",
+    "@mimik/address-helper": "^2.0.4",
+    "@mimik/api-helper": "^2.0.2",
+    "@mimik/healthcheck": "^2.0.0",
+    "@mimik/oauth-helper": "^4.0.2",
+    "@mimik/public-helper": "^3.0.3",
+    "@mimik/request-helper": "^2.0.2",
+    "@mimik/response-helper": "^4.0.4",
+    "@mimik/sumologic-winston-logger": "^2.0.3",
+    "@mimik/systeminfo": "^4.0.1",
     "bluebird": "3.7.2",
     "cors": "2.8.5",
-    "helmet": "7.1.0"
+    "helmet": "8.1.0"
   },
   "devDependencies": {
-    "@mimik/eslint-plugin-dependencies": "^2.4.6",
-    "@mimik/eslint-plugin-document-env": "^1.0.6",
-    "eslint": "8.57.0",
-    "eslint-config-airbnb": "19.0.4",
-    "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-jsx-a11y": "6.9.0",
-    "eslint-plugin-react": "7.35.0",
-    "eslint-plugin-react-hooks": "4.6.2",
-    "husky": "9.1.4",
-    "jsdoc-to-markdown": "8.0.3"
+    "@eslint/js": "9.31.0",
+    "@mimik/eslint-plugin-document-env": "^2.0.8",
+    "@stylistic/eslint-plugin": "5.2.2",
+    "eslint": "9.31.0",
+    "eslint-plugin-import": "2.32.0",
+    "husky": "9.1.7",
+    "jsdoc-to-markdown": "9.1.2"
   }
 }

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
-  }
-}