@mimik/init 3.9.4 → 5.0.0

package/README.md

@@ -1,13 +1,13 @@
-<a name="module_ini"></a>
+<a name="module_init"></a>
 
-## ini
+## init
 **Example**  
 ```js
 const init = require('@mimik/init');
 
 init(config, dbValidate, { postOps: [suscribe] }).then(result => config = result);
 ```
-<a name="exp_module_ini--module.exports"></a>
+<a name="exp_module_init--module.exports"></a>
 
 ### module.exports(app, rootDir, config, validates, cluster, options) ⇒ <code>object</code> ⏏
 Init process for a micro-service.

package/index.js

@@ -1,31 +1,31 @@
-const swaggerTools = require('swagger-tools');
-const http = require('http');
 const cors = require('cors');
-const path = require('path');
+const http = require('http');
+const pathLib = require('path');
 const Promise = require('bluebird');
 const helmet = require('helmet');
 
 const logger = require('@mimik/sumologic-winston-logger');
-const swagger = require('@mimik/swagger-helper');
-const oauthHelper = require('@mimik/oauth-helper');
 const { startupHealthInfo } = require('@mimik/healthcheck');
-const { healthInfo } = require('@mimik/systeminfo');
 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 { APIRequestMetrics, startHrTimeSet } = require('./lib/metrics');
-const { HEALTHCHECK_ROUTE, METRICS_ROUTE } = require('./lib/common');
-
-const SIGINT = 'SIGINT';
-const SIGTERM = 'SIGTERM';
-const LOCAL = 'local';
-const SET_ON = 'on';
-const CONTENT_TYPE = 'Content-Type';
-const JSON_CONTENT = 'application/json';
+const { startHrTimeSet } = require('./lib/metrics');
+const { healthCheckRoute, metricsRoute } = require('./lib/route');
+const {
+  HEALTHCHECK_ROUTE,
+  METRICS_ROUTE,
+  SIGINT,
+  SIGTERM,
+  LOCAL,
+  SET_ON,
+  BUILD_FILENAME,
+} = require('./lib/common');
 
 /**
- * @module ini
+ * @module init
  * @example
  * const init = require('@mimik/init');
  *
@@ -72,19 +72,41 @@ module.exports = (app, rootDir, config, validates, cluster, options) => {
 
   if (!config) return fatalError(new Error('config is required'));
   const { serverSettings, dependencies } = config;
+  const updateOptions = (origOpts) => {
+    const apiInfo = {
+      provider: serverSettings.swaggerFile.provider,
+      apiApikey: serverSettings.apiApiKey,
+      apiBasicAuth: serverSettings.apiBasicAuth,
+    };
+    let opts = origOpts;
+
+    if (opts) opts.apiInfo = apiInfo;
+    else opts = { apiInfo };
+    return opts;
+  };
   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;
+  const controllersDirectory = pathLib.join(rootDir, './controllers');
+  const buildDirectory = pathLib.join(rootDir, './build');
+  const buildRequire = pathLib.join(buildDirectory, BUILD_FILENAME);
+  const extractName = options ? options.extractName : null;
+  const metrics = options ? options.metrics : null;
+  let apiFilename = serverSettings.api;
   let registration = false;
 
+  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);
+    dependencies.mLG.extractName = extractName;
+  }
+  if (metrics && !metrics.register) return fatalError(new Error('register is required in metrics'), correlationIdStart);
+
   process.on(SIGINT, () => {
     sigProcess(SIGINT, registration, options, config, server, unRegister, getCorrelationId(`system-shutdown(${SIGINT}):${serverSettings.id}`));
   });
@@ -100,78 +122,22 @@ module.exports = (app, rootDir, config, validates, cluster, options) => {
     },
   }));
   app.use(cors({ origin: '*' }));
-  app.use(HEALTHCHECK_ROUTE, (req, res) => {
-    res.setHeader(CONTENT_TYPE, JSON_CONTENT);
-    res.end(JSON.stringify(healthInfo(), null, 2));
-  });
-  if (options.metrics && options.metrics.register) {
-    app.use(METRICS_ROUTE, (req, res) => options.metrics.register.metrics()
-      .then((result) => {
-        res.setHeader(CONTENT_TYPE, options.metrics.register.contentType);
-        res.end(result);
-      })
-      .catch((err) => {
-        res.setHeader(CONTENT_TYPE, JSON_CONTENT);
-        const errResponse = {
-          statusCode: 500,
-          title: http.STATUS_CODES[500],
-          message: err.message,
-        };
-        res.end(JSON.stringify(errResponse), null, 2);
-      }));
+  app.get(HEALTHCHECK_ROUTE, healthCheckRoute());
+  if (metrics) {
+    app.get(METRICS_ROUTE, metricsRoute(options));
+    app.use(startHrTimeSet(metrics.APIRequestDuration));
   }
-  if (options && options.extractName) {
-    ({ extractName } = options);
-    if (!dependencies || !dependencies.mLG) {
-      logger.warn('requesting extraction without mLG configuration', { extractName }, correlationIdStart);
-    }
-    else {
-      dependencies.mLG.extractName = extractName;
-    }
-  }
-  if (swaggerFilename[0] !== '/') swaggerFilename = path.join(rootDir, swaggerFilename);
-  logger.debug('location of the swagger file', { swaggerFilename }, correlationIdStart);
-  return swagger.getAPIFile(swaggerFilename, correlationIdStart, config.apiBasicAuth, options)
-    .then((swaggerJson) => swaggerTools.initializeMiddleware(swaggerJson, (middleware) => {
-      serverSettings.basePath = swaggerJson.basePath;
-      app.use(startHrTimeSet());
-      app.use(middleware.swaggerMetadata());
-      if (options && options.metrics) {
-        app.use(APIRequestMetrics(options.metrics.APIRequestDuration, serverSettings.basePath));
-      }
-      app.use(middleware.swaggerValidator());
-      if ((config.nodeEnvironment && config.nodeEnvironment.toLowerCase() !== LOCAL) || (serverSettings.securitySet === SET_ON)) {
-        const securityOptions = {
-          AdminSecurity: oauth.apiTokenAdminSecurityHelper,
-          SystemSecurity: oauth.apiTokenSecurityHelper,
-          UserSecurity: oauth.apiTokenSecurityHelper,
-          APIKeySecurity: oauth.apiKeySecurityHelper,
-        };
+  if (extractName) { app.use(extractLogs(config, extractName, options)); }
+  if (apiFilename[0] !== '/') 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
+      // 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);
 
-        if (options && options.secOptions) {
-          Object.keys(options.secOptions).forEach((key) => {
-            securityOptions[key] = options.secOptions[key];
-          });
-        }
-        app.use(middleware.swaggerSecurity(securityOptions));
-      }
-      else logger.warn('security disabled: tokens will not be used and /me and /onbehalf will not work', correlationIdStart);
-      if ((config.nodeEnvironment && config.nodeEnvironment.toLowerCase() !== LOCAL) || (config.registration.set === SET_ON)) {
-        registration = true;
-      }
-      else logger.warn('registration disabled: cluster will not work', correlationIdStart);
-      if (extractName) {
-        app.use(extractLogs(config, extractName, options));
-      }
-      app.use(middleware.swaggerRouter({
-        useStubs: config.nodeEnvironment === LOCAL,
-        controllers: `${rootDir}/controllers`,
-      }));
-      app.use(middleware.swaggerUi());
-      app.use(swagger.sendError);
-      if (serverSettings.interceptError === SET_ON) {
-        app.use(swagger.interceptError);
-      }
+      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);
@@ -189,8 +155,8 @@ module.exports = (app, rootDir, config, validates, cluster, options) => {
             if (registration) register(correlationIdStart);
             if (options && options.postOps) options.postOps.forEach((ops) => ops(correlationIdStart, config, server));
           });
-        })
-        .catch((error) => fatalError(error, correlationIdStart));
-    }))
+        });
+    })
+    .catch((error) => fatalError(error, correlationIdStart))
     .then(() => ({ config }));
 };

package/lib/common.js

@@ -2,8 +2,26 @@ const METRICS_ROUTE = '/metrics';
 const HEALTHCHECK_ROUTE = '/healthcheck';
 const OUT_OF_SPEC_ROUTE = 'outOfSpecificationRoute';
 
+const CONTENT_TYPE = 'Content-Type';
+const JSON_CONTENT = 'application/json';
+
+const SIGINT = 'SIGINT';
+const SIGTERM = 'SIGTERM';
+
+const LOCAL = 'local';
+const SET_ON = 'on';
+
+const BUILD_FILENAME = 'register';
+
 module.exports = {
   METRICS_ROUTE,
   HEALTHCHECK_ROUTE,
   OUT_OF_SPEC_ROUTE,
+  CONTENT_TYPE,
+  JSON_CONTENT,
+  SIGINT,
+  SIGTERM,
+  LOCAL,
+  SET_ON,
+  BUILD_FILENAME,
 };

package/lib/metrics.js

@@ -1,31 +1,8 @@
-const { HEALTHCHECK_ROUTE, METRICS_ROUTE, OUT_OF_SPEC_ROUTE } = require('./common');
-
-const APIRequestMetrics = (APIRequestDuration, basePath) => (req, res, next) => {
-  const { swagger } = req;
-  let apiPath = req.originalUrl;
-
-  if (swagger) apiPath = swagger.apiPath;
-  const startHrTime = req.metrics ? req.metrics.startHrTime : process.hrtime();
-
-  res.on('finish', () => {
-    if (apiPath !== METRICS_ROUTE && apiPath !== HEALTHCHECK_ROUTE) {
-      const elapsedHrTime = process.hrtime(startHrTime);
-      const elapsedTimeInMs = elapsedHrTime[0] * 1000 + elapsedHrTime[1] / 1e6;
-
-      APIRequestDuration
-        .labels(req.method, swagger ? `${basePath}${apiPath}` : OUT_OF_SPEC_ROUTE, req.originalUrl.includes('?'), res.statusCode)
-        .observe(elapsedTimeInMs);
-    }
-  });
-  next();
-};
-
-const startHrTimeSet = () => (req, res, next) => {
-  req.metrics = { startHrTime: process.hrtime() };
+const startHrTimeSet = (APIRequestDuration) => (req, res, next) => {
+  req.metrics = { startHrTime: process.hrtime(), APIRequestDuration };
   next();
 };
 
 module.exports = {
   startHrTimeSet,
-  APIRequestMetrics,
 };

package/lib/route.js

@@ -0,0 +1,31 @@
+const http = require('http');
+
+const { healthInfo } = require('@mimik/systeminfo');
+
+const { CONTENT_TYPE, JSON_CONTENT } = require('./common');
+
+const healthCheckRoute = () => (req, res) => {
+  res.setHeader(CONTENT_TYPE, JSON_CONTENT);
+  res.end(JSON.stringify(healthInfo(), null, 2));
+};
+
+const metricsRoute = (options) => (req, res) => options.metrics.register.metrics()
+  .then((result) => {
+    res.setHeader(CONTENT_TYPE, options.metrics.register.contentType);
+    res.end(result);
+  })
+  .catch((err) => {
+    res.setHeader(CONTENT_TYPE, JSON_CONTENT);
+    const errResponse = {
+      statusCode: 500,
+      title: http.STATUS_CODES[500],
+      message: err.message,
+    };
+
+    res.end(JSON.stringify(errResponse), null, 2);
+  });
+
+module.exports = {
+  healthCheckRoute,
+  metricsRoute,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/init",
-  "version": "3.9.4",
+  "version": "5.0.0",
   "description": "Init process for micro-service",
   "main": "index.js",
   "scripts": {
@@ -29,15 +29,15 @@
     "url": "https://bitbucket.org/mimiktech/init"
   },
   "dependencies": {
-    "@mimik/address-helper": "^1.6.7",
+    "@mimik/address-helper": "^1.6.9",
+    "@mimik/api-helper": "^1.0.0",
     "@mimik/healthcheck": "^1.5.10",
-    "@mimik/oauth-helper": "^2.2.0",
-    "@mimik/public-helper": "^1.6.2",
+    "@mimik/oauth-helper": "^3.0.0",
+    "@mimik/public-helper": "^2.0.0",
     "@mimik/request-helper": "^1.7.8",
-    "@mimik/response-helper": "^2.6.3",
+    "@mimik/response-helper": "^3.0.0",
     "@mimik/sumologic-winston-logger": "^1.6.15",
-    "@mimik/swagger-helper": "^3.0.5",
-    "@mimik/systeminfo": "^2.3.12",
+    "@mimik/systeminfo": "^3.0.0",
     "bluebird": "3.7.2",
     "cors": "2.8.5",
     "helmet": "6.1.5",
@@ -46,7 +46,7 @@
   "devDependencies": {
     "@mimik/eslint-plugin-dependencies": "^2.4.5",
     "@mimik/eslint-plugin-document-env": "^1.0.5",
-    "eslint": "8.38.0",
+    "eslint": "8.39.0",
     "eslint-config-airbnb": "19.0.4",
     "eslint-plugin-import": "2.27.5",
     "eslint-plugin-jsx-a11y": "6.7.1",