@mimik/configuration 4.4.2 → 4.4.6

package/README.md

@@ -49,7 +49,8 @@ The following environment variables are being setup:
 | SERVER_LOCAL_IPV4 | IP address of the micro-service | ip.address() | serverSettings.ip.local
 | 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 insrance properties | 169.254.169.254
+| AWS_LOCAL_PROPERTIES | internal ip address to access aws instance properties | 169.254.169.254
+| MST_SET | to setup configuration without mST and oauth token setup | on | on/off
 
 The following environement variables are being used for the configuration:
 
@@ -98,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,
@@ -86,9 +87,10 @@ const {
   DEFAULT_INTERCEPT_ERROR,
 } = require('./lib/common');
 
-const correlationIdStart = getCorrelationId('config-start');
 let display = true;
 const locParams = [NO_PUBLIC_PROVIDER, ENV_VARIABLE];
+const correlationIdStart = getCorrelationId('config-start');
+const isMSTSet = process.env.MST_SET !== SET_OFF;
 
 const setupRedis = () => {
   const domain = process.env.CACHE_IP || DEFAULT_CACHE_IP;
@@ -133,6 +135,7 @@ 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,
   };
 };
 
@@ -354,6 +357,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: {
@@ -368,7 +372,7 @@ const configuration = {
     admin: {
       externalId: process.env.ADMIN_EXTERNAL_ID || DEFAULT_ADMIN_EXTERNAL_ID,
     },
-    server: {
+    server: !isMSTSet ? {} : {
       id: process.env.OAUTH_CLIENT_ID,
       secret: process.env.OAUTH_CLIENT_SECRET,
       accessKey: process.env.OAUTH_CLIENT_ACCESS_KEY,
@@ -394,7 +398,7 @@ const configuration = {
   topic: {
     set: process.env.TOPIC_SET || DEFAULT_TOPIC_SET,
   },
-  dependencies: { // everyserver will resport to mIT
+  dependencies: !isMSTSet ? {} : { // every server will report to mIT unless mST setup is disabled
     mIT: {
       url: process.env.MIT_URL,
       audience: process.env.MIT_AUDIENCE,
@@ -406,6 +410,10 @@ const configuration = {
   },
 };
 
+if (!isMSTSet) {
+  configuration.registration.set = SET_OFF;
+  configuration.cluster.management = SET_OFF;
+}
 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();
@@ -436,7 +444,8 @@ configuration.locationProvider = setupLocationProvider();
  * | SERVER_LOCAL_IPV4 | IP address of the micro-service | ip.address() | serverSettings.ip.local
  * | 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 insrance properties | 169.254.169.254
+ * | AWS_LOCAL_PROPERTIES | internal ip address to access aws instance properties | 169.254.169.254
+ * | MST_SET | to setup configuration without mST and oauth token setup | on | on/off
  *
  * The following environement variables are being used for the configuration:
  *
@@ -485,6 +494,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 |
@@ -598,6 +609,7 @@ const setConfig = (pack, options) => {
     process.env.SWAGGER_FILE_NAME = pack.swaggerFile.name;
   }
 
+  // eslint-disable-next-line max-len
   const apiFilename = `${process.env.SWAGGER_FILE_ACCOUNT}${SWAGGER_SEP}${process.env.SWAGGER_FILE_NAME}${SWAGGER_SEP}${process.env.SWAGGER_FILE_VERSION}${SWAGGER_SEP}${SWAGGER_EXT}`;
 
   configuration.serverSettings.name = process.env.SERVER_NAME;
@@ -609,9 +621,10 @@ const setConfig = (pack, options) => {
   // default for every server for cluster management
   configuration.dependencies[configuration.serverSettings.type] = {
     url: process.env[`${configuration.serverSettings.type}_URL`.toUpperCase()] || 'self', // this url should never be needed
-    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') {
       configuration.mongoSettings = setupMongo(options.database);
@@ -645,7 +658,15 @@ const setConfig = (pack, options) => {
   }
   if (options.dependencies) {
     Object.keys(options.dependencies).forEach((dependency) => {
-      configuration.dependencies[dependency] = options.dependencies[dependency];
+      if (isMSTSet) {
+        configuration.dependencies[dependency] = options.dependencies[dependency];
+      }
+      else if (options.dependencies[dependency].apiKey) {
+        configuration.dependencies[dependency] = {
+          url: options.dependencies[dependency].url,
+          apiKey: options.dependencies[dependency].apiKey,
+        };
+      }
     });
   }
   if (options.custom) {

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.2",
+  "version": "4.4.6",
   "description": "Common configuration for mimik services",
   "main": "index.js",
   "scripts": {
@@ -37,14 +37,14 @@
   },
   "devDependencies": {
     "@mimik/eslint-plugin-dependencies": "^2.4.1",
-    "@mimik/eslint-plugin-document-env": "^1.0.0",
-    "eslint": "8.4.1",
+    "@mimik/eslint-plugin-document-env": "^1.0.1",
+    "eslint": "8.7.0",
     "eslint-config-airbnb": "18.2.1",
-    "eslint-plugin-import": "2.25.3",
+    "eslint-plugin-import": "2.25.4",
     "eslint-plugin-jsx-a11y": "6.5.1",
-    "eslint-plugin-react": "7.27.1",
+    "eslint-plugin-react": "7.28.0",
     "eslint-plugin-react-hooks": "4.3.0",
-    "fancy-log": "1.3.3",
+    "fancy-log": "2.0.0",
     "gulp": "4.0.2",
     "gulp-eslint": "6.0.0",
     "gulp-git": "2.10.1",