@mimik/init 2.0.0 → 3.6.0

package/.eslintrc

@@ -1,17 +1,34 @@
-// Use this file as a starting point for your project's .eslintrc.
-// Copy this file, and add rule overrides as needed.
 {
+  "plugins": [
+    "@mimik/document-env",
+    "@mimik/dependencies"
+  ],
   "env": {
     "node": true
   },
+  "parserOptions": {
+    "ecmaVersion": 2020
+  },
   "extends": "airbnb",
   "rules": {
+    "import/no-extraneous-dependencies": ["error", {"devDependencies": 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"]
+    "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/no-unresolved": 2,
+    "@mimik/dependencies/require-json-ext": 2
+  },
+  "settings":{
+    "react": {
+      "version": "latest"
+    }
   },
   "globals": {
     "module": true,

package/.husky/pre-commit

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

package/.husky/pre-push

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

package/.nycrc

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

package/Gulpfile.js

@@ -9,25 +9,25 @@ const jsdoc2md = require('jsdoc-to-markdown');
 const files = [
   'index.js',
   'Gulpfile.js',
-  'test/*.spec.js',
+  'test/**.js',
   'lib/**.js',
 ];
 
-const docs = (done) => {
+const createDocs = (done) => {
   jsdoc2md.render({ files: 'index.js' })
-    .then(output => fs.writeFileSync('README.md', output))
-    .catch(err => log.error('docs creation failed:', err.message));
-  return done();
+    .then((output) => fs.writeFileSync('README.md', output))
+    .catch((err) => log.error('docs creation failed:', err.message))
+    .finally(() => done());
 };
 
 const lint = () => gulp.src(files)
   .pipe(eslint({}))
-  .pipe(eslint.format())
-  .pipe(eslint.failOnError());
+  .pipe(eslint.format());
 
 const add = () => gulp.src('README.md')
   .pipe(git.add({ quiet: true }));
 
+const docs = gulp.series(createDocs, add);
+
 gulp.task('docs', docs);
 gulp.task('lint', lint);
-gulp.task('add', add);

package/README.md

@@ -9,17 +9,18 @@ init(config, dbValidate, { postOps: [suscribe] }).then(result => config = result
 ```
 <a name="exp_module_ini--module.exports"></a>
 
-### module.exports(app, rootDir, config, dbValidate, options) ⇒ <code>object</code> ⏏
+### module.exports(app, rootDir, config, validates, cluster, options) ⇒ <code>object</code> ⏏
 Init process for a micro-service.
 
 **Kind**: Exported function  
 **Returns**: <code>object</code> - The updated configuration.
 
-The  secOptions has the following strucuture:
+The  secOptions has the following structure:
 ``` javascript
  {
    preOps: [function], // functions to process before starting the micro-service
    postOps: [function], // functions to process after starting the micro-service
+   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
  }
@@ -30,13 +31,14 @@ The `return` object has the following strucuture:
    config: The configuration object,
  }
 ```
-For the preOps and postOps the function are executed with 3 parameters (correlationId, config, server)  
+For the preOps, postOps and exitOps the function are executed with 3 parameters (correlationId, config, server)  
 
 | Param | Type | Description |
 | --- | --- | --- |
 | app | <code>object</code> | The app implementing the micro-service. |
 | rootDir | <code>PATH.&lt;string&gt;</code> | The root directory of the micro-service. |
 | config | <code>object</code> | Configuration of the micro-service. |
-| dbValidate | <code>Promise</code> | Promise to validate the databases used. |
+| validates | <code>array</code> | Array of Promises to validate dependent systems (database, topic). |
+| cluster | <code>Promise</code> | Promise to be used for cluster management and registration. |
 | options | <code>object</code> | options to start the micro-service. The options can be `null`. |
 

package/index.js

@@ -7,13 +7,15 @@ const helmet = require('helmet');
 
 const logger = require('@mimik/sumologic-winston-logger');
 const swagger = require('@mimik/swagger-helper');
-const eventHelper = require('@mimik/event-helper');
 const oauthHelper = require('@mimik/oauth-helper');
 const { startupHealthInfo } = require('@mimik/healthcheck');
 const { getPublic } = require('@mimik/public-helper');
-const cluster = require('@mimik/cluster');
-
+const { getCorrelationId } = require('@mimik/request-helper');
 const { extractLogs } = require('./lib/logs');
+const { sigProcess } = require('./lib/exit');
+
+const SIGINT = 'SIGINT';
+const SIGTERM = 'SIGTERM';
 
 /**
  * @module ini
@@ -29,15 +31,17 @@ const { extractLogs } = require('./lib/logs');
  * @param {object} app - The app implementing the micro-service.
  * @param {PATH<string>} rootDir - The root directory of the micro-service.
  * @param {object} config - Configuration of the micro-service.
- * @param {Promise} dbValidate - Promise to validate the databases used.
+ * @param {array} validates - Array of Promises to validate dependent systems (database, topic).
+ * @param {Promise} cluster - Promise to be used for cluster management and registration.
  * @param {object} options - options to start the micro-service. The options can be `null`.
  * @returns {object} The updated configuration.
  *
- * The  secOptions has the following strucuture:
+ * The  secOptions has the following structure:
  * ``` javascript
  *  {
  *    preOps: [function], // functions to process before starting the micro-service
  *    postOps: [function], // functions to process after starting the micro-service
+ *    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
  *  }
@@ -48,31 +52,44 @@ const { extractLogs } = require('./lib/logs');
  *    config: The configuration object,
  *  }
  * ```
- * For the preOps and postOps the function are executed with 3 parameters (correlationId, config, server)
+ * For the preOps, postOps and exitOps the function are executed with 3 parameters (correlationId, config, server)
  */
-module.exports = (app, rootDir, config, dbValidate, options) => {
-  const event = eventHelper(config);
-  const oauth = oauthHelper(config);
-  const { register, unRegister } = cluster(config);
+module.exports = (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) return fatalError(new Error('config is required'));
   const { serverSettings, dependencies } = config;
-  const server = http.createServer(app);
-  const correlationIdStart = `system-start-${serverSettings.id}`;
-  const correlationIdShut = `system-shutdown-${serverSettings.id}`;
   const serverPort = serverSettings.port;
+  const correlationIdStart = getCorrelationId(`system-start:${serverSettings.id}`);
+
+  if (!cluster) return fatalError(new Error('cluster lib required'), correlationIdStart);
+  if (!app) return fatalError(new Error('app is required'), correlationIdStart);
+  const { register, unRegister } = cluster;
+  const oauth = oauthHelper(config);
+  const server = http.createServer(app);
 
   let swaggerFilename = serverSettings.api;
   let extractName = null;
   let registration = false;
 
-  process.on('SIGINT', () => {
-    if (registration) unRegister(correlationIdShut);
-    else {
-      logger.info('service shutdown successfully', { serverId: serverSettings.id }, correlationIdShut);
-      logger.flushAndExit(0);
-    }
+  process.on(SIGINT, () => {
+    sigProcess(SIGINT, registration, options, config, server, unRegister, getCorrelationId(`system-shutdown(${SIGINT}):${serverSettings.id}`));
+  });
+  process.on(SIGTERM, () => {
+    sigProcess(SIGTERM, registration, options, config, server, unRegister, getCorrelationId(`system-shutdown(${SIGTERM}):${serverSettings.id}`));
   });
 
-  app.use(helmet());
+  app.use(helmet.contentSecurityPolicy({
+    directives: {
+      ...helmet.contentSecurityPolicy.getDefaultDirectives(),
+      'script-src': ['\'self\'', '\'unsafe-inline\''],
+      'connect-src': ['\'self\'', '*.swagger.io'],
+    },
+  }));
   if (options && options.extractName) {
     ({ extractName } = options);
     if (!dependencies || !dependencies.mLG) {
@@ -85,7 +102,7 @@ module.exports = (app, rootDir, config, dbValidate, options) => {
   if (swaggerFilename[0] !== '/') swaggerFilename = path.join(rootDir, swaggerFilename);
   logger.debug('location of the swagger file', { swaggerFilename }, correlationIdStart);
   return swagger.getAPIFile(swaggerFilename, correlationIdStart)
-    .then(swaggerJson => swaggerTools.initializeMiddleware(swaggerJson, (middleware) => {
+    .then((swaggerJson) => swaggerTools.initializeMiddleware(swaggerJson, (middleware) => {
       serverSettings.basePath = swaggerJson.basePath;
       app.use(cors({ origin: '*' }));
       app.use(middleware.swaggerMetadata());
@@ -95,6 +112,7 @@ module.exports = (app, rootDir, config, dbValidate, options) => {
           AdminSecurity: oauth.apiTokenAdminSecurityHelper,
           SystemSecurity: oauth.apiTokenSecurityHelper,
           UserSecurity: oauth.apiTokenSecurityHelper,
+          APIKeySecurity: oauth.apiKeySecurityHelper,
         };
 
         if (options && options.secOptions) {
@@ -114,38 +132,32 @@ module.exports = (app, rootDir, config, dbValidate, options) => {
       }
       app.use(middleware.swaggerRouter({
         useStubs: config.nodeEnvironment === 'local',
-        controllers: './controllers',
+        controllers: `${rootDir}/controllers`,
       }));
       app.use(middleware.swaggerUi());
       app.use(swagger.sendError);
       if (serverSettings.interceptError === 'on') {
         app.use(swagger.interceptError);
       }
-      return event.validate()
-        .then(() => dbValidate())
-        .then(() => getPublic(config.locationProvider, config.cloudProvider).then((publicConfig) => {
+      return Promise.each(validates, (validate) => validate())
+        .then(() => getPublic(config.locationProvider, config.cloudProvider, correlationIdStart).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));
+          if (options && options.preOps) return Promise.each(options.preOps, (ops) => ops(correlationIdStart, config, server));
           return null;
         })
         .then(() => {
           server.listen(serverPort, () => {
             startupHealthInfo(config, correlationIdStart);
             if (registration) register(correlationIdStart);
-            if (options && options.postOps) options.postOps.forEach(ops => ops(correlationIdStart, config, server));
+            if (options && options.postOps) options.postOps.forEach((ops) => ops(correlationIdStart, config, server));
           });
         })
-        .catch((error) => {
-          logger.error('fatal error: could not start server', {
-            name: serverSettings.name, id: serverSettings.id, error,
-          }, correlationIdStart);
-          logger.flushAndExit(1);
-        });
+        .catch((error) => fatalError(error, correlationIdStart));
     }))
     .then(() => ({ config }));
 };

package/lib/exit.js

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

package/lib/logs.js

@@ -3,8 +3,10 @@ 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');
 
-const correlationId = 'log-extraction';
+const correlationId = getCorrelationId('log-extraction');
 const NOTIFICATION = '/notifications';
 
 const extractLogs = (config, extractName) => (req, res, next) => {
@@ -27,15 +29,14 @@ const extractLogs = (config, extractName) => (req, res, next) => {
       method: 'POST',
       headers: {
         'x-forwarded-for': xForwardedFor,
+        'x-correlation-id': correlationId,
       },
       url,
       body: {
         Message: req.body[extractName],
       },
       json: true,
-    }).catch(err => logger.warn('could not send extracted data', {
-      url, error: err.message, statusCode: err.statusCode || 500, extractName,
-    }, correlationId));
+    }).catch((err) => getRichError('System', 'could not send extracted data', { url, extractName }, err, 'warn', correlationId));
     delete req.body[extractName];
   }
   next();

package/package.json

@@ -1,54 +1,60 @@
 {
   "name": "@mimik/init",
-  "version": "2.0.0",
+  "version": "3.6.0",
   "description": "Init process for micro-service",
   "main": "index.js",
   "scripts": {
     "lint": "gulp lint",
     "docs": "gulp docs",
-    "test": "exit 0"
+    "test": "exit 0",
+    "prepublishOnly": "gulp docs; gulp lint; npm run test",
+    "commit-ready": "gulp docs; gulp lint; npm run test",
+    "prepare": "husky install"
   },
   "husky": {
     "hooks": {
-      "pre-commit": "npm run lint; npm run docs; gulp add; npm run test",
-      "pre-push": "npm run lint; npm run test"
+      "pre-commit": "npm run commit-ready",
+      "pre-push": "npm run test"
     }
   },
   "keywords": [
     "mimik",
     "microservice"
   ],
-  "author": "mimik",
+  "author": "mimik technology inc <support@mimik.com> (https://developer.mimik.com/)",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
     "url": "https://bitbucket.org/mimiktech/init"
   },
   "dependencies": {
-    "@mimik/address-helper": "1.2.3",
-    "@mimik/cluster": "2.0.0",
-    "@mimik/event-helper": "1.0.1",
-    "@mimik/healthcheck": "1.3.4",
-    "@mimik/oauth-helper": "1.4.5",
-    "@mimik/public-helper": "1.2.4",
-    "@mimik/sumologic-winston-logger": "1.1.2",
-    "@mimik/swagger-helper": "2.0.0",
-    "bluebird": "3.5.5",
+    "@mimik/address-helper": "^1.6.2",
+    "@mimik/healthcheck": "^1.5.7",
+    "@mimik/oauth-helper": "^1.9.6",
+    "@mimik/public-helper": "^1.5.3",
+    "@mimik/request-helper": "^1.7.3",
+    "@mimik/response-helper": "^2.6.0",
+    "@mimik/sumologic-winston-logger": "^1.6.6",
+    "@mimik/swagger-helper": "^2.5.0",
+    "bluebird": "3.7.2",
     "cors": "2.8.5",
-    "helmet": "3.20.0",
+    "helmet": "4.6.0",
     "swagger-tools": "0.10.4"
   },
   "devDependencies": {
-    "eslint": "6.1.0",
-    "eslint-config-airbnb": "17.1.1",
-    "eslint-plugin-import": "2.18.2",
-    "eslint-plugin-jsx-a11y": "6.2.3",
-    "eslint-plugin-react": "7.14.3",
+    "@mimik/eslint-plugin-dependencies": "^2.4.1",
+    "@mimik/eslint-plugin-document-env": "^1.0.0",
+    "eslint": "8.4.1",
+    "eslint-config-airbnb": "18.2.1",
+    "eslint-plugin-import": "2.25.3",
+    "eslint-plugin-jsx-a11y": "6.5.1",
+    "eslint-plugin-react": "7.27.1",
+    "eslint-plugin-react-hooks": "4.3.0",
     "fancy-log": "1.3.3",
     "gulp": "4.0.2",
     "gulp-eslint": "6.0.0",
-    "gulp-git": "2.9.0",
-    "husky": "3.0.2",
-    "jsdoc-to-markdown": "5.0.0"
+    "gulp-git": "2.10.1",
+    "husky": "7.0.4",
+    "jsdoc-to-markdown": "7.1.0"
   }
 }