@mimik/local 1.6.0 → 4.4.2

package/lib/common.js

@@ -4,22 +4,40 @@ const mITConfigFile = '../mITConfig.json';
 const mIDConfigFile = '../mIDConfig.json';
 const sumoLogFile = '../sumoLog.json';
 const s3LogFile = '../s3Log.json';
+const kinesisLogFile = '../kinesisLog.json';
+const locationFile = '../locationConfig.json';
+const keyFile = '../key.json';
 const customerConfigFile = '../customerConfig.json';
 const APIProvider = 'https://api.swaggerhub.com/apis';
 const swaggerExt = 'swagger.json';
 const defaultDirectory = './api';
 
 const AWS_S3 = 'awsS3';
+const AWS_KINESIS = 'awsKinesis';
 const SUMOLOGIC = 'sumologic';
-const ALL = 'all';
+const ALL = 'all'; // legacy support
+const NONE = 'none';
+const ALL_MODES = [AWS_S3, AWS_KINESIS, SUMOLOGIC, ALL, NONE];
+
+const SWAGGER_SEP = '_';
+const TEST = 'test';
+
+const SYSTEM_NAME = 'System';
+const TOKEN_SERVICE = 'mST';
+const IT_REGISTRY = 'mIT';
+const IDENTITY_SERVICE = 'mID';
 
 const testJsonFile = './server-test.json';
 const shellFile = './server-start.sh';
 const startFile = './local/start.json';
 const testStartFile = './local/testStart.json';
 const exampleStartFile = './local/start-example.json';
+const exampleTestStartFile = './local/testStart-example.json';
+
+const LITERAL = true;
+const IGNORE = '!';
 
-const correlationId = 'test-local';
+const correlationId = `test-local@0/${new Date().toISOString()}`;
 
 const DEFAULT_MST = {
   basePath: '/mST/v1',
@@ -41,6 +59,7 @@ const DUMMY_MST = {
     clientSecret: 'timeForSecret',
   },
 };
+const DUMMY_CUSTOMER_CODE = 'dummy-code';
 const DEFAULT_MIT = {
   basePath: '/mIT/v1',
   protocol: 'http:',
@@ -79,7 +98,6 @@ const DEFAULT_SUMOLOG = {
     code: '--- default code ---',
   },
 };
-
 const DEFAULT_S3LOG = {
   region: '--- default region ---',
   accessKeyId: '--- default accessKey Id',
@@ -89,6 +107,21 @@ const DEFAULT_S3LOG = {
   timeout: 1,
   maxSize: 5,
 };
+const DEFAULT_KINESISLOG = {
+  region: '--- default region ---',
+  accessKeyId: '--- default accessKey Id',
+  secretAccessKey: '--- default secret accessKey ---',
+  streamNameInfo: '--- default streamName Info ---',
+  streamNameError: '--- default streamName Error ---',
+  streamNameOther: '--- default streamName Other ---',
+};
+const DEFAULT_KEY = {
+  apiKey: null,
+};
+const DEFAULT_LOCATION = {
+  url: null,
+  key: null,
+};
 
 const ERR_CHECK = '✘';
 const SUCCESS_CHECK = '✔︎';
@@ -100,6 +133,9 @@ module.exports = {
   mIDConfigFile,
   sumoLogFile,
   s3LogFile,
+  kinesisLogFile,
+  locationFile,
+  keyFile,
   customerConfigFile,
   APIProvider,
   swaggerExt,
@@ -109,18 +145,34 @@ module.exports = {
   startFile,
   testStartFile,
   exampleStartFile,
+  exampleTestStartFile,
   correlationId,
+  LITERAL,
+  IGNORE,
+  TEST,
   DEFAULT_MST,
   DEFAULT_MIT,
   DEFAULT_MID,
   DEFAULT_SUMOLOG,
   DEFAULT_S3LOG,
+  DEFAULT_KINESISLOG,
+  DEFAULT_KEY,
+  DEFAULT_LOCATION,
   DUMMY_MST,
+  DUMMY_CUSTOMER_CODE,
   DUMMY_MIT,
   DUMMY_MID,
   ERR_CHECK,
   SUCCESS_CHECK,
   AWS_S3,
+  AWS_KINESIS,
   SUMOLOGIC,
   ALL,
+  NONE,
+  ALL_MODES,
+  SWAGGER_SEP,
+  SYSTEM_NAME,
+  TOKEN_SERVICE,
+  IT_REGISTRY,
+  IDENTITY_SERVICE,
 };

package/lib/commonExt.js

@@ -1,38 +1,46 @@
 const _ = require('lodash');
 
 // duplicate of functions in mST lib/common.js
-const allType = 'all';
-const clusterType = 'cluster';
+const ALL_TYPE = 'all';
+const CLUSTER_TYPE = 'cluster';
 
 const inList = (type, list) => _.findIndex(list, (listItem) => listItem.type === type);
 
-const getClientTypes = (client, type) => {
-  const types = [];
+const setServiceInfo = (sharedWith, type, scopes, customer) => {
+  const result = { type };
 
-  client.targets.forEach((target) => {
-    if (!target.except || !type || target.except.indexOf(type) === -1) {
-      if (target.type !== clusterType) types.push(target.type);
-      else if (type) types.push(type);
-    }
-  });
-  return types;
+  if (customer) result.customer = customer;
+  if (sharedWith) result.sharedWith = sharedWith;
+  if (scopes) result.scopes = scopes;
+  return result;
 };
 
-const getTargets = (type, custConfig) => {
-  const index = inList(type, custConfig);
-  let targets = [];
+const getAllTargets = (serviceType, custConfig, serviceIndex) => {
+  const index = serviceIndex || serviceIndex === 0 ? serviceIndex : inList(serviceType, custConfig);
+  const targets = [];
+  const serviceInfo = (target, st) => {
+    if (target.type !== CLUSTER_TYPE) return setServiceInfo(null, target.type, target.scopes, target.customer);
+    return setServiceInfo(null, st, target.scopes);
+  };
 
   if (index !== -1) {
-    targets = getClientTypes(custConfig[index], type);
-  }
-  const allIndex = inList(allType, custConfig);
-
-  if (allIndex !== -1) {
-    targets = _.union(targets, getClientTypes(custConfig[allIndex], type));
+    custConfig[index].targets.forEach((target) => targets.push(serviceInfo(target, serviceType)));
+    const allIndex = inList(ALL_TYPE, custConfig);
+
+    if (allIndex !== -1) {
+      custConfig[allIndex].targets.forEach((allTarget) => {
+        if (!allTarget.except || !allTarget.except.includes(serviceType)) {
+          const allTargetIndex = inList(allTarget.type === CLUSTER_TYPE ? serviceType : allTarget.type, targets);
+
+          if (allTargetIndex === -1) targets.push(serviceInfo(allTarget, serviceType));
+          else targets[allTargetIndex].scopes = _.union(targets[allTargetIndex].scopes, allTarget.scopes);
+        }
+      });
+    }
   }
   return targets;
 };
 
 module.exports = {
-  getTargets,
+  getAllTargets,
 };

package/lib/helpers.js

@@ -1,4 +1,4 @@
-/* eslint-disable prefer-template, no-console */
+/* eslint-disable prefer-template, no-console, no-process-env, @mimik/document-env/validate-document-env */
 const colors = require('colors');
 const fs = require('fs');
 const ip = require('ip');
@@ -16,14 +16,14 @@ colors.setTheme({
 const exitError = (regType, error, filename) => {
   let details = `{ statusCode: ${error.statusCode || 500}, message: ${error.message || error}`;
 
-  if (filename) details = `, ${details}, filename: ${filename}`;
+  if (filename) details = `${details}, filename: ${filename}`;
   details = `${details} }`;
   console.error(`${regType}status: ` + 'error'.error + ', ' + details.info);
   process.exit(1);
 };
 
 const start2shell = (start) => {
-  let result = '';
+  let result = '#!/bin/sh\n';
 
   Object.keys(start).forEach((key) => {
     if (key[0] !== '/' && key[1] !== '/') {
@@ -32,6 +32,7 @@ const start2shell = (start) => {
       else result = `${result}export ${key}="${start[key]}"\n`;
     }
   });
+  result = `${result}node src/index\n`;
   return result;
 };
 
@@ -62,28 +63,18 @@ const start2process = (start) => {
     }
   });
 };
-
-const baseUrl = (serverType, regType, config) => {
-  if (!config.domainName) {
-    exitError(regType, `domainName must exist in ${serverType}Config.json`);
-  }
-  if (config.domaiName === 'localhost' && !config.port) {
-    exitError(regType, `port missing in ${serverType}Config.json`);
-  }
-  if (!config.basePath) {
-    exitError(regType, `basePath missing in ${serverType}Config.json`);
-  }
-  let { domainName } = config;
-
-  if (domainName === 'localhost') {
-    domainName = `${ip.address()}:${config.port}`;
-  }
-  else if (net.isIP(domainName)) {
-    domainName = `${domainName}:${config.port}`;
-  }
-  const protocol = config.protocol || 'http:';
-
-  return `${protocol}//${domainName}${config.basePath}`;
+const setDomainName = (serverType, regType, domainName, port, literal) => {
+  if (!domainName) exitError(regType, `domainName must exist in ${serverType}Config.json`);
+  const needPort = domainName === 'localhost' || net.isIP(domainName);
+
+  if (needPort && !port) exitError(regType, `port missing in ${serverType}Config.json`);
+  if (domainName === 'localhost' && !literal) return `${ip.address()}:${port}`;
+  if (needPort) return `${domainName}:${port}`;
+  return domainName;
+};
+const baseUrl = (serverType, regType, config, literal) => {
+  if (!config.basePath) exitError(regType, `basePath missing in ${serverType}Config.json`);
+  return `${config.protocol || 'http:'}//${setDomainName(serverType, regType, config.domainName, config.port, literal)}${config.basePath}`;
 };
 
 /**
@@ -100,11 +91,13 @@ const baseUrl = (serverType, regType, config) => {
  *``` javascript
  * {
  *    sourceFilename: {PATH<string>}, // Source filename to use if altFilename does not retrieve any file.
+ *    sourceFilenameSupp: {PATH<string}, // Source filename supplementatry to by use with source filename.
  *    altFilename: {PATH<string>}, // Alternate filename to use if filename does not retrieve any file.
  *    default: {object}, // default content if no file exist
  * }
  *````
  * Will exit 1 if there is an error.
+ * Source filename supp is only used when source filename exist. If environement variables between source filename and source filename supplementatry exist the environement variable in source filename will be commented out.
  *
  */
 const retrieve = (regType, filename, options) => {
@@ -120,22 +113,69 @@ const retrieve = (regType, filename, options) => {
     }
     return readFile;
   };
+
+  const readMerge = (fname, fnameSupp) => {
+    const parse = (rawFile, rawFilename) => {
+      try { return json.parse(rawFile); }
+      catch (errParse) { return exitError(regType, errParse, rawFilename); }
+    };
+
+    const merge = (origRawFile, parsedFile, origRawFileSupp, parsedFileSupp) => {
+      const keysParsedFile = Object.keys(parsedFile);
+      let rawFile = origRawFile;
+      let rawFileSupp = origRawFileSupp;
+
+      Object.keys(parsedFileSupp).forEach((key) => {
+        if (keysParsedFile.includes(key)) {
+          const regex = new RegExp(`\n[ \t]+"${key}"`);
+
+          rawFile = rawFile.replace(regex, `\n// "${key}"`);
+        }
+      });
+      rawFile = rawFile.substring(0, rawFile.length - 2);
+      rawFileSupp = rawFileSupp.substring(1);
+      return `${rawFile},\n//-- test\n${rawFileSupp}`;
+    };
+
+    let readFileRaw;
+    let readFileSuppRaw;
+
+    try { readFileRaw = fs.readFileSync(fname).toString(); }
+    catch (errFname) {
+      if (errFname.code !== 'ENOENT') exitError(regType, errFname, fname);
+      throw errFname;
+    }
+    const readFile = parse(readFileRaw, fname);
+
+    if (!fnameSupp) return readFile;
+    try { readFileSuppRaw = fs.readFileSync(fnameSupp).toString(); }
+    catch (errFnameSupp) {
+      if (errFnameSupp.code !== 'ENOENT') exitError(regType, errFnameSupp, fnameSupp);
+      return readFile;
+    }
+
+    return parse(merge(readFileRaw, readFile, readFileSuppRaw, parse(readFileSuppRaw, fnameSupp)), `${fname} + ${fnameSupp}`);
+  };
+
   const write = (fname, content) => {
     try { fs.writeFileSync(fname, json.stringify(content, null, 2)); }
     catch (err) { exitError(regType, err, fname); }
     return content;
   };
-  const readSourceDefault = (fsource, content, fname) => {
-    let readFile;
 
-    try { readFile = read(fsource); }
+  const readSourceDefault = (fSource, fSourceSupp, content, fname) => {
+    try {
+      const readFile = readMerge(fSource, fSourceSupp);
+
+      if (!fSourceSupp) console.log('- using ' + fSource.warn + ' for ' + fname.info);
+      else console.log('- using ' + fSource.warn + ' + ' + fSourceSupp.warn + ' for ' + fname.info);
+      return readFile;
+    }
     catch (err) {
-      if (!content) exitError(regType, { statusCode: 404, message: 'no files or default' }, fname);
-      console.log('- using ' + 'default'.warn + ' for ' + filename.info);
+      if (!content) exitError(regType, { statusCode: 404, message: `no files or default (${err.message})` }, fname);
+      console.log('- using ' + 'default'.warn + ' for ' + fname.info);
       return content;
     }
-    console.log('- using ' + filename.info);
-    return readFile;
   };
 
   try {
@@ -144,28 +184,28 @@ const retrieve = (regType, filename, options) => {
     return result;
   }
   catch (errFilename) {
-    if (!options) exitError(regType, { statusCode: 404, message: 'no options' }, filename);
+    if (!options) exitError(regType, { statusCode: 404, message: `no options (${errFilename})` }, filename);
     if (options.altFilename) {
       try {
         result = read(options.altFilename);
         console.log('- using ' + options.altFilename.info);
-        return result; // if test cannot create a test start if start is available
+        return result;
       }
       catch (errAltFilename) {
-        if (options.sourceFilename) result = readSourceDefault(options.sourceFilename, options.default, filename);
-        else {
-          if (!options.default) exitError(regType, { statusCode: 404, message: 'no files or default' }, filename);
+        if (!options.sourceFileName) {
+          if (!options.default) exitError(regType, { statusCode: 404, message: `no files or default (${errAltFilename})` }, filename);
           console.log('- using ' + 'default'.warn + ' for ' + filename.info);
-          result = options.default;
+          return write(filename, options.default);
         }
+        return write(filename, readSourceDefault(options.sourceFilename, options.sourceFilenameSupp, options.default, filename));
       }
-      return write(filename, result);
     }
     if (!options.sourceFilename) {
+      if (!options.default) exitError(regType, { statusCode: 404, message: `no files or default (${errFilename.message})` }, filename);
       console.log('- using ' + 'default'.warn + ' for ' + filename.info);
       return write(filename, options.default);
     }
-    return write(filename, readSourceDefault(options.sourceFilename, options.default, filename));
+    return write(filename, readSourceDefault(options.sourceFilename, options.sourceFilenameSupp, options.default, filename));
   }
 };
 
@@ -175,6 +215,7 @@ module.exports = {
   start2env,
   start2process,
   exitError,
+  setDomainName,
   baseUrl,
   retrieve,
 };

package/lib/rp-axios-wrapper.js

@@ -0,0 +1,36 @@
+const axios = require('axios');
+const http = require('http');
+
+const rp = (options) => axios(options)
+  .then((res) => {
+    if (options.resolveWithFullResponse) return res;
+    return res.data;
+  })
+  .catch((err) => {
+    const { response } = err;
+
+    if (!response) {
+      const error = new Error('system Error');
+
+      error.statusCode = 500;
+      error.title = http.STATUS_CODES[error.statusCode];
+      error.info = {
+        code: err.code,
+        address: err.address,
+        port: err.port,
+        syscall: err.syscall,
+      };
+      throw error;
+    }
+    const { data } = response;
+    const error = new Error(data ? data.message || response.statusText : response.statusText);
+
+    error.statusCode = response.status;
+    error.title = response.statusText;
+    if (data && data.info) error.info = data.info;
+    throw error;
+  });
+
+module.exports = {
+  rp,
+};