@mimik/configuration 4.4.6 → 4.4.9

package/README.md

@@ -82,6 +82,7 @@ The following environement variables are being used for the configuration:
 | LOG_MODE | collector the be used to log events | sumologic | logInfo.mode | can be `sumologic`, `awsS3`, `all`, 'awsKinesis'
 | NO_STACK | disable the inclusion of a the stack in all logs | yes | logInfo.noStack
 | FILTER_FILE | path for the filter file definition | null | logInfo.filterFile |
+| USER_DEFINITIONS_FILE | path for the custom user definitions | null | userDefinitions.file |
 | EXIT_DELAY | delay to allow the log transports to flush | 2000 | logInfo.exitDelay | in milliseconds
 | CLUSTER_MANAGEMENT | switch to enable cluster communication | off | cluster.management | can be `on` or `off`
 | REQUEST_TIMEOUT | timeout for intra cluster http request | 10000 | cluster.timeout | in milliseconds

package/index.js

@@ -1,11 +1,13 @@
 /* eslint no-process-env: "off" */
 const _ = require('lodash');
+const fs = require('fs');
 const ip = require('ip');
 const uuid = require('uuid');
 const querystring = require('querystring');
 
 const logger = require('@mimik/sumologic-winston-logger');
 const { getCorrelationId } = require('@mimik/request-helper');
+const { userDefinitions } = require('@mimik/user-filters');
 /**
  * @module configuration
  * @example
@@ -70,6 +72,7 @@ const {
   DEFAULT_FILTER_FILE,
   DEFAULT_EXIT_DELAY,
   DEFAULT_NO_STACK,
+  DEFAULT_USER_DEFINITIONS_FILE,
   DEFAULT_S3_AWS_TIMEOUT,
   DEFAULT_S3_AWS_MAX_SIZE,
   DEFAULT_S3_AWS_MAX_EVENTS,
@@ -135,7 +138,6 @@ const setupRedis = () => {
       idTTL: parseInt(process.env.CACHE_API_ID_TTL, 10) || DEFAULT_CACHE_API_ID_TTL,
       optionTTL: parseInt(process.env.CACHE_API_OPTION_TTL, 10) || DEFAULT_CACHE_API_OPTION_TTL,
     },
-    isMSTSet,
   };
 };
 
@@ -303,23 +305,42 @@ const setupEncryption = (encryptionOpts) => {
   return encryptionConfig;
 };
 
+const setupUserDefinitions = (definitions) => {
+  const userDefinitionsFile = definitions.file;
+  let customDefinitions = {};
+  if (userDefinitionsFile && userDefinitionsFile !== DEFAULT_USER_DEFINITIONS_FILE) {
+    try { customDefinitions = JSON.parse(fs.readFileSync(userDefinitionsFile).toString()); }
+    catch (err) {
+      throw new Error(`Invalid file for user definitions: ${userDefinitionsFile}, error: ${err.message}`);
+    }
+  }
+  return {
+    ...userDefinitions,
+    ...customDefinitions,
+    file: userDefinitionsFile,
+  };
+};
+
 const checkConfig = (config) => {
-  const errs = [];
+  const errors = [];
 
   function traverseNodeSync(node, path) {
     Object.keys(node).forEach((prop) => {
       if (typeof node[prop] === 'object' && node[prop]) {
         traverseNodeSync(node[prop], `${path}.${prop}`);
       }
-      else if (_.isUndefined(node[prop])) errs.push(`${path}.${prop}`);
+      else if (_.isUndefined(node[prop])) errors.push({ reason: 'missing', value: `${path}.${prop}` });
     });
   }
 
   traverseNodeSync(config, 'configuration');
-  if (errs.length > 0) {
-    const error = new Error('Missing values');
+  // dependency errors
+  if (!isMSTSet && config.security.apiKeys.length === 0) errors.push({ reason: 'invalid', value: 'config.security.apiKeys', cause: 'isMSTSet' });
+
+  if (errors.length > 0) {
+    const error = new Error('Errors in configuration');
 
-    logger.error(error, { values: errs }, correlationIdStart);
+    logger.error(error, { errors }, correlationIdStart);
     throw error;
   }
 };
@@ -372,7 +393,7 @@ const configuration = {
     admin: {
       externalId: process.env.ADMIN_EXTERNAL_ID || DEFAULT_ADMIN_EXTERNAL_ID,
     },
-    server: !isMSTSet ? {} : {
+    server: {
       id: process.env.OAUTH_CLIENT_ID,
       secret: process.env.OAUTH_CLIENT_SECRET,
       accessKey: process.env.OAUTH_CLIENT_ACCESS_KEY,
@@ -395,10 +416,13 @@ const configuration = {
   encryption: {
     set: process.env.ENCRYPTION_SET || DEFAULT_ENCRYPTION_SET,
   },
+  userDefinitions: {
+    file: process.env.USER_DEFINITIONS_FILE || DEFAULT_USER_DEFINITIONS_FILE,
+  },
   topic: {
     set: process.env.TOPIC_SET || DEFAULT_TOPIC_SET,
   },
-  dependencies: !isMSTSet ? {} : { // every server will report to mIT unless mST setup is disabled
+  dependencies: {
     mIT: {
       url: process.env.MIT_URL,
       audience: process.env.MIT_AUDIENCE,
@@ -410,9 +434,12 @@ const configuration = {
   },
 };
 
+// cross dependencies
 if (!isMSTSet) {
   configuration.registration.set = SET_OFF;
   configuration.cluster.management = SET_OFF;
+  configuration.security.server = {};
+  configuration.dependencies = {};
 }
 if (process.env.OAUTH_GENERIC_PREVIOUS_KEY) configuration.security.generic.previousKey = process.env.OAUTH_GENERIC_PREVIOUS_KEY;
 if (process.env.SWAGGER_API_KEY) configuration.serverSettings.apiKey = process.env.SWAGGER_API_KEY;
@@ -477,6 +504,7 @@ configuration.locationProvider = setupLocationProvider();
  * | LOG_MODE | collector the be used to log events | sumologic | logInfo.mode | can be `sumologic`, `awsS3`, `all`, 'awsKinesis'
  * | NO_STACK | disable the inclusion of a the stack in all logs | yes | logInfo.noStack
  * | FILTER_FILE | path for the filter file definition | null | logInfo.filterFile |
+ * | USER_DEFINITIONS_FILE | path for the custom user definitions | null | userDefinitions.file |
  * | EXIT_DELAY | delay to allow the log transports to flush | 2000 | logInfo.exitDelay | in milliseconds
  * | CLUSTER_MANAGEMENT | switch to enable cluster communication | off | cluster.management | can be `on` or `off`
  * | REQUEST_TIMEOUT | timeout for intra cluster http request | 10000 | cluster.timeout | in milliseconds
@@ -656,6 +684,9 @@ const setConfig = (pack, options) => {
   if (options.encryption && configuration.encryption.set === SET_ON) {
     configuration.encryption = setupEncryption(options.encryption);
   }
+  if (options.userDefinitions) {
+    configuration.userDefinitions = setupUserDefinitions(options.userDefinitions);
+  }
   if (options.dependencies) {
     Object.keys(options.dependencies).forEach((dependency) => {
       if (isMSTSet) {

package/lib/common.js

@@ -3,6 +3,7 @@ const AWS_S3 = 'awsS3';
 const ALL = 'all';
 const SET_ON = 'on';
 const SET_OFF = 'off';
+const NOT_SET = 'not set';
 const NO_GENERIC = '--noGeneric--';
 const NO_PUBLIC_PROVIDER = 'noPublic';
 const ENV_VARIABLE = 'environment';
@@ -61,10 +62,12 @@ const DEFAULT_ENCRYPTION_SET = SET_OFF;
 const DEFAULT_KMS_PROVIDER = 'local';
 
 const DEFAULT_LOG_LEVEL = 'debug';
-const DEFAULT_FILTER_FILE = 'not set';
+const DEFAULT_FILTER_FILE = NOT_SET;
 const DEFAULT_EXIT_DELAY = 2000; // in ms
 const DEFAULT_NO_STACK = 'yes';
 
+const DEFAULT_USER_DEFINITIONS_FILE = NOT_SET;
+
 const DEFAULT_S3_AWS_TIMEOUT = 5; // in minutes
 const DEFAULT_S3_AWS_MAX_SIZE = 5; // in mB
 const DEFAULT_S3_AWS_MAX_EVENTS = 1000;
@@ -144,6 +147,7 @@ module.exports = {
   DEFAULT_FILTER_FILE,
   DEFAULT_EXIT_DELAY,
   DEFAULT_NO_STACK,
+  DEFAULT_USER_DEFINITIONS_FILE,
   DEFAULT_S3_AWS_TIMEOUT,
   DEFAULT_S3_AWS_MAX_SIZE,
   DEFAULT_S3_AWS_MAX_EVENTS,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/configuration",
-  "version": "4.4.6",
+  "version": "4.4.9",
   "description": "Common configuration for mimik services",
   "main": "index.js",
   "scripts": {
@@ -31,6 +31,7 @@
   "dependencies": {
     "@mimik/request-helper": "^1.7.3",
     "@mimik/sumologic-winston-logger": "^1.6.6",
+    "@mimik/user-filters": "1.3.3",
     "ip": "1.1.5",
     "lodash": "4.17.21",
     "uuid": "8.3.2"
@@ -38,17 +39,17 @@
   "devDependencies": {
     "@mimik/eslint-plugin-dependencies": "^2.4.1",
     "@mimik/eslint-plugin-document-env": "^1.0.1",
-    "eslint": "8.7.0",
+    "eslint": "8.13.0",
     "eslint-config-airbnb": "18.2.1",
-    "eslint-plugin-import": "2.25.4",
+    "eslint-plugin-import": "2.26.0",
     "eslint-plugin-jsx-a11y": "6.5.1",
-    "eslint-plugin-react": "7.28.0",
-    "eslint-plugin-react-hooks": "4.3.0",
+    "eslint-plugin-react": "7.29.4",
+    "eslint-plugin-react-hooks": "4.4.0",
     "fancy-log": "2.0.0",
     "gulp": "4.0.2",
     "gulp-eslint": "6.0.0",
     "gulp-git": "2.10.1",
     "husky": "7.0.4",
-    "jsdoc-to-markdown": "7.1.0"
+    "jsdoc-to-markdown": "7.1.1"
   }
 }