@mimik/configuration 4.4.3 → 4.4.7

package/README.md

@@ -50,7 +50,7 @@ The following environment variables are being setup:
 | CONSOLE_LEVEL | log level for console output | debug | logInfo.consoleLevel
 | LOG_LEVEL | log level for console output | debug | logInfo.logLevel
 | AWS_LOCAL_PROPERTIES | internal ip address to access aws instance properties | 169.254.169.254
-| DISABLE_MST | to setup configuration without mST and oauth token setup | no | yes/no
+| MST_SET | to setup configuration without mST and oauth token setup | on | on/off
 
 The following environement variables are being used for the configuration:
 
@@ -99,6 +99,8 @@ The following environement variables are being used for the configuration:
 
 [2]: defined when registering to mST
 
+When MST_SET is `off`, registration and cluster should not be enabled, so configuration.cluster.management and configuration.registration.set will be set to `off``
+
 When `sumologic` or `all` is used for `LOG_MODE` the following environment variables are used for the configuration:
 
 | Env variable name | Description | Default | Comments |

package/index.js

@@ -17,6 +17,7 @@ const {
   AWS_S3,
   ALL,
   SET_ON,
+  SET_OFF,
   NO_PUBLIC_PROVIDER,
   NO_GENERIC,
   ENV_VARIABLE,
@@ -89,7 +90,7 @@ const {
 let display = true;
 const locParams = [NO_PUBLIC_PROVIDER, ENV_VARIABLE];
 const correlationIdStart = getCorrelationId('config-start');
-const isMSTDisabled = process.env.DISABLE_MST === 'yes';
+const isMSTSet = process.env.MST_SET !== SET_OFF;
 
 const setupRedis = () => {
   const domain = process.env.CACHE_IP || DEFAULT_CACHE_IP;
@@ -134,7 +135,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,
     },
-    isMSTDisabled,
   };
 };
 
@@ -303,22 +303,25 @@ const setupEncryption = (encryptionOpts) => {
 };
 
 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' });
 
-    logger.error(error, { values: errs }, correlationIdStart);
+  if (errors.length > 0) {
+    const error = new Error('Errors in configuration');
+
+    logger.error(error, { errors }, correlationIdStart);
     throw error;
   }
 };
@@ -356,6 +359,7 @@ const configuration = {
     customerCode: process.env.CUSTOMER_CODE || DEFAULT_CUSTOMER_CODE,
     customerCodeSep: process.env.CUSTOMER_CODE ? CUSTOMER_CODE_SEP : '',
     securitySet: process.env.SERVER_SECURITY_SET || DEFAULT_SERVER_SECURITY_SET,
+    isMSTSet,
     port: process.env.SERVER_PORT,
     interceptError: process.env.INTERCEPT_ERROR || DEFAULT_INTERCEPT_ERROR,
     ip: {
@@ -370,7 +374,7 @@ const configuration = {
     admin: {
       externalId: process.env.ADMIN_EXTERNAL_ID || DEFAULT_ADMIN_EXTERNAL_ID,
     },
-    server: isMSTDisabled ? {} : {
+    server: {
       id: process.env.OAUTH_CLIENT_ID,
       secret: process.env.OAUTH_CLIENT_SECRET,
       accessKey: process.env.OAUTH_CLIENT_ACCESS_KEY,
@@ -396,7 +400,7 @@ const configuration = {
   topic: {
     set: process.env.TOPIC_SET || DEFAULT_TOPIC_SET,
   },
-  dependencies: isMSTDisabled ? {} : { // everyserver will resport to mIT unless mST setup is disabled
+  dependencies: {
     mIT: {
       url: process.env.MIT_URL,
       audience: process.env.MIT_AUDIENCE,
@@ -408,6 +412,13 @@ 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;
 configuration.logInfo = setupLog();
@@ -439,7 +450,7 @@ configuration.locationProvider = setupLocationProvider();
  * | CONSOLE_LEVEL | log level for console output | debug | logInfo.consoleLevel
  * | LOG_LEVEL | log level for console output | debug | logInfo.logLevel
  * | AWS_LOCAL_PROPERTIES | internal ip address to access aws instance properties | 169.254.169.254
- * | DISABLE_MST | to setup configuration without mST and oauth token setup | no | yes/no
+ * | MST_SET | to setup configuration without mST and oauth token setup | on | on/off
  *
  * The following environement variables are being used for the configuration:
  *
@@ -488,6 +499,8 @@ configuration.locationProvider = setupLocationProvider();
  *
  * [2]: defined when registering to mST
  *
+ * When MST_SET is `off`, registration and cluster should not be enabled, so configuration.cluster.management and configuration.registration.set will be set to `off``
+ *
  * When `sumologic` or `all` is used for `LOG_MODE` the following environment variables are used for the configuration:
  *
  * | Env variable name | Description | Default | Comments |
@@ -615,7 +628,7 @@ const setConfig = (pack, options) => {
     url: process.env[`${configuration.serverSettings.type}_URL`.toUpperCase()] || 'self', // this url should never be needed
   };
 
-  if (!isMSTDisabled) configuration.dependencies[configuration.serverSettings.type].audience = process.env[`${configuration.serverSettings.type}_AUDIENCE`.toUpperCase()];
+  if (isMSTSet) configuration.dependencies[configuration.serverSettings.type].audience = process.env[`${configuration.serverSettings.type}_AUDIENCE`.toUpperCase()];
 
   if (options.database) {
     if (options.database.type === 'mongodb') {
@@ -650,8 +663,8 @@ const setConfig = (pack, options) => {
   }
   if (options.dependencies) {
     Object.keys(options.dependencies).forEach((dependency) => {
-      if (!isMSTDisabled) {
-        configuration.dependencies[dependency] = options.dependencies[dependency].apiKey;
+      if (isMSTSet) {
+        configuration.dependencies[dependency] = options.dependencies[dependency];
       }
       else if (options.dependencies[dependency].apiKey) {
         configuration.dependencies[dependency] = {

package/lib/common.js

@@ -91,6 +91,7 @@ module.exports = {
   AWS_S3,
   ALL,
   SET_ON,
+  SET_OFF,
   CUSTOMER_CODE_SEP,
   NO_PUBLIC_PROVIDER,
   NO_GENERIC,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/configuration",
-  "version": "4.4.3",
+  "version": "4.4.7",
   "description": "Common configuration for mimik services",
   "main": "index.js",
   "scripts": {
@@ -38,7 +38,7 @@
   "devDependencies": {
     "@mimik/eslint-plugin-dependencies": "^2.4.1",
     "@mimik/eslint-plugin-document-env": "^1.0.1",
-    "eslint": "8.6.0",
+    "eslint": "8.7.0",
     "eslint-config-airbnb": "18.2.1",
     "eslint-plugin-import": "2.25.4",
     "eslint-plugin-jsx-a11y": "6.5.1",