@mimik/init 6.0.2 → 6.0.4

package/README.md

@@ -5,7 +5,7 @@
 ```js
 import init from '@mimik/init';
 
-init(config, dbValidate, { postOps: [suscribe] }).then(result => config = result);
+init(config, dbValidate, { postOps: [subscribe] }).then(result => config = result);
 ```
 <a name="module_init..init"></a>
 
@@ -23,10 +23,10 @@ The  secOptions has the following structure:
    exitOps: [function], // functions to process before exiting the micro-service
    secOptions: { securityDefinition: function }, // extra security options to validate the API request
    extractName: string, // ability to extract data from the req and send it to a logging environment
-   metrics: object, // to genetrate information for `/metrics`
+   metrics: object, // to generate information for `/metrics`
  }
 ```
-The `return` object has the following strucuture:
+The `return` object has the following structure:
 ``` javascript
  {
    config: The configuration object,
@@ -34,7 +34,7 @@ The `return` object has the following strucuture:
 ```
 For the preOps, postOps and exitOps the function are executed with 3 parameters (correlationId, config, server).
 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.  
+The base path is defined by taking the url property of the first item of the servers array in the api definition file. Only relative url address will be handled (e.g. /mss/v1) and templates in the url are not allowed.  
 
 | Param | Type | Description |
 | --- | --- | --- |

package/eslint.config.js

@@ -3,6 +3,7 @@ import js from '@eslint/js';
 import processDoc from '@mimik/eslint-plugin-document-env';
 import stylistic from '@stylistic/eslint-plugin';
 
+const ECMA_VERSION = 'latest';
 const MAX_LENGTH_LINE = 180;
 const MAX_FUNCTION_PARAMETERS = 7;
 const MAX_LINES_IN_FILES = 600;
@@ -23,11 +24,13 @@ export default [
       processDoc,
     },
     languageOptions: {
-      ecmaVersion: 2022,
+      ecmaVersion: ECMA_VERSION,
       globals: {
         console: 'readonly',
         describe: 'readonly',
+        http: 'readonly',
         it: 'readonly',
+        process: 'readonly',
         require: 'readonly',
       },
       sourceType: 'module',
@@ -49,7 +52,7 @@ export default [
       '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-confusing-arrow': ['off'],
       'no-inline-comments': ['off'],
       'no-process-env': ['error'],
       'no-ternary': ['off'],

package/index.js

@@ -1,5 +1,6 @@
 import {
   BUILD_FILENAME,
+  EXIT_ERROR,
   HEALTHCHECK_ROUTE,
   LOCAL,
   METRICS_ROUTE,
@@ -15,10 +16,9 @@ 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 http from 'node:http';
 import logger from '@mimik/sumologic-winston-logger';
-import pathLib from 'path';
-import process from 'process';
+import pathLib from 'node:path';
 import { sigProcess } from './lib/exit.js';
 import { startHrTimeSet } from './lib/metrics.js';
 import { startupHealthInfo } from '@mimik/healthcheck';
@@ -28,11 +28,10 @@ import { startupHealthInfo } from '@mimik/healthcheck';
  * @example
  * import init from '@mimik/init';
  *
- * init(config, dbValidate, { postOps: [suscribe] }).then(result => config = result);
+ * init(config, dbValidate, { postOps: [subscribe] }).then(result => config = result);
  *
  */
 
-const EXIT_ERROR = 1;
 const FIRST = 0;
 const FIRST_PATH_ELEMENT = 0;
 
@@ -55,10 +54,10 @@ const FIRST_PATH_ELEMENT = 0;
  *    exitOps: [function], // functions to process before exiting the micro-service
  *    secOptions: { securityDefinition: function }, // extra security options to validate the API request
  *    extractName: string, // ability to extract data from the req and send it to a logging environment
- *    metrics: object, // to genetrate information for `/metrics`
+ *    metrics: object, // to generate information for `/metrics`
  *  }
  *```
- * The `return` object has the following strucuture:
+ * The `return` object has the following structure:
  * ``` javascript
  *  {
  *    config: The configuration object,
@@ -66,7 +65,7 @@ const FIRST_PATH_ELEMENT = 0;
  * ```
  * For the preOps, postOps and exitOps the function are executed with 3 parameters (correlationId, config, server).
  * 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.
+ * The base path is defined by taking the url property of the first item of the servers array in the api definition file. Only relative url address will be handled (e.g. /mss/v1) and templates in the url are not allowed.
  */
 const init = (app, rootDir, config, validates, cluster, options) => {
   const fatalError = (error, correlationId) => {

package/lib/common.js

@@ -1,3 +1,5 @@
+import logger from '@mimik/sumologic-winston-logger';
+
 const METRICS_ROUTE = '/metrics';
 const HEALTHCHECK_ROUTE = '/healthcheck';
 const OUT_OF_SPEC_ROUTE = 'outOfSpecificationRoute';
@@ -8,11 +10,22 @@ const JSON_CONTENT = 'application/json';
 const SIGINT = 'SIGINT';
 const SIGTERM = 'SIGTERM';
 
+const SHUTDOWN = 'service shutdown successfully';
+const SHUTDOWN_WITH_ERROR = 'service shutdown with error';
+const EXIT_OK = 0;
+const EXIT_ERROR = 1;
+
 const LOCAL = 'local';
 const SET_ON = 'on';
 
+const TAB = 2;
+const DEBUG = 4;
+
 const BUILD_FILENAME = 'register.js';
 
+const NOTIFICATION = '/notifications';
+const EXTRACT_LOG_LEVEL = logger.LEVELS[DEBUG];
+
 export {
   METRICS_ROUTE,
   HEALTHCHECK_ROUTE,
@@ -24,4 +37,11 @@ export {
   LOCAL,
   SET_ON,
   BUILD_FILENAME,
+  NOTIFICATION,
+  EXTRACT_LOG_LEVEL,
+  TAB,
+  SHUTDOWN,
+  SHUTDOWN_WITH_ERROR,
+  EXIT_OK,
+  EXIT_ERROR,
 };

package/lib/exit.js

@@ -1,11 +1,7 @@
+import { EXIT_ERROR, EXIT_OK, SHUTDOWN, SHUTDOWN_WITH_ERROR } from './common.js';
 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);

package/lib/logs.js

@@ -1,18 +1,19 @@
+import { EXTRACT_LOG_LEVEL, NOTIFICATION } from './common.js';
 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';
+import urlLib from 'node:url';
 
-const correlationId = getCorrelationId('log-extraction');
-const NOTIFICATION = '/notifications';
+let correlationId = getCorrelationId('log-extraction');
 
 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();
 
+  if (req.headers['x-correlation-id']) correlationId = `${req.headers['x-correlation-id']}:${correlationId}`;
   if (req.tokenType) params.append('serverType', req.tokenType);
   if (req.clientId) params.append('serverId', req.clientId);
   if (params.keys().length) url = `${url}?${params.toString()}`;
@@ -34,6 +35,13 @@ export const extractLogs = (config, extractName, options) => (req, res, next) =>
       data: {
         Message: req.body[extractName],
       },
+      retry: {
+        logLevel: {
+          request: EXTRACT_LOG_LEVEL,
+          response: EXTRACT_LOG_LEVEL,
+          error: EXTRACT_LOG_LEVEL,
+        },
+      },
     };
 
     if (options && options.metrics) {

package/lib/metrics.js

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

package/lib/route.js

@@ -1,14 +1,11 @@
-import { CONTENT_TYPE, JSON_CONTENT } from './common.js';
+import { CONTENT_TYPE, JSON_CONTENT, TAB } from './common.js';
 import { getCorrelationId, getUserAgent } from '@mimik/request-helper';
+import { ERROR_CODE } from '@mimik/response-helper';
 import { healthInfo } from '@mimik/systeminfo';
-import http from 'http';
+import http from 'node: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, TAB));
@@ -22,8 +19,8 @@ export const metricsRoute = options => (req, res) => options.metrics.register.me
   .catch((err) => {
     res.setHeader(CONTENT_TYPE, JSON_CONTENT);
     const errResponse = {
-      statusCode: SYSTEM_ERROR,
-      title: http.STATUS_CODES[SYSTEM_ERROR],
+      statusCode: ERROR_CODE.SYSTEM,
+      title: http.STATUS_CODES[ERROR_CODE.SYSTEM],
       message: err.message,
     };
 
@@ -31,7 +28,7 @@ export const metricsRoute = options => (req, res) => options.metrics.register.me
   });
 
 export const bodyParserRoute = () => (err, req, res, next) => {
-  if (err instanceof SyntaxError && err.status === PARAMETER_ERROR && 'body' in err) {
+  if (err instanceof SyntaxError && err.status === ERROR_CODE.PARAMETER && 'body' in err) {
     const { originalUrl } = req;
     const method = req.method.toUpperCase();
     const correlationId = getCorrelationId(req);
@@ -39,15 +36,15 @@ export const bodyParserRoute = () => (err, req, res, next) => {
     logger.warn(`Rejecting request with 400 for ${method} ${originalUrl}`, {
       method,
       path: originalUrl,
-      statusCode: PARAMETER_ERROR,
+      statusCode: ERROR_CODE.PARAMETER,
       userAgent: getUserAgent(req),
       clientIP: publicIpFromRequest(req),
       error: err,
     }, correlationId);
     if (correlationId) res.setHeader('x-correlation-id', correlationId);
-    return res.status(PARAMETER_ERROR).json({
-      statusCode: PARAMETER_ERROR,
-      title: http.STATUS_CODES[PARAMETER_ERROR],
+    return res.status(ERROR_CODE.PARAMETER).json({
+      statusCode: ERROR_CODE.PARAMETER,
+      title: http.STATUS_CODES[ERROR_CODE.PARAMETER],
       message: err.message,
       error: err,
     });

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "@mimik/init",
-  "version": "6.0.2",
+  "version": "6.0.4",
   "description": "Init process for micro-service",
   "main": "./index.js",
   "type": "module",  
+  "engines": {
+    "node": ">=20.0.0"
+  },
   "scripts": {
     "lint": "eslint . --no-error-on-unmatched-pattern",
     "docs": "jsdoc2md index.js > README.md",
@@ -29,26 +32,26 @@
     "url": "https://bitbucket.org/mimiktech/init"
   },
   "dependencies": {
-    "@mimik/address-helper": "^2.0.4",
-    "@mimik/api-helper": "^2.0.5",
+    "@mimik/address-helper": "^2.0.5",
+    "@mimik/api-helper": "^2.0.7",
     "@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/response-helper": "^4.0.6",
+    "@mimik/sumologic-winston-logger": "^2.1.8",
     "@mimik/systeminfo": "^4.0.1",
     "bluebird": "3.7.2",
     "cors": "2.8.5",
     "helmet": "8.1.0"
   },
   "devDependencies": {
-    "@eslint/js": "9.31.0",
+    "@eslint/js": "9.39.1",
     "@mimik/eslint-plugin-document-env": "^2.0.8",
-    "@stylistic/eslint-plugin": "5.2.2",
-    "eslint": "9.31.0",
+    "@stylistic/eslint-plugin": "5.5.0",
+    "eslint": "9.39.1",
     "eslint-plugin-import": "2.32.0",
     "husky": "9.1.7",
-    "jsdoc-to-markdown": "9.1.2"
+    "jsdoc-to-markdown": "9.1.3"
   }
 }