@mimik/configuration 5.0.10 → 5.0.12

package/README.md

@@ -161,8 +161,6 @@ When `mongodb` is used the following environment variables are used for the conf
 | MONGO_REPLICAT_SET | specifies the name of the replica set, if the mongod is a member of a replica set |  | not mandatory
 | MONGO_WAIT_QUEUE_MULTIPLE | a number that the driver multiples the maxPoolSize value to, to provide the maximum number of threads allowed to wait for a connection to become available from the pool |  | no mandatory
 | MONGO_WAIT_QUEUE_TIMEOUT | the maximum time in milliseconds that a thread can wait for a connection to become available |  | not mandatory
-| MONGO_KEEP_ALIVE | pall th kep the connection with the database alive | true |
-| MONGO_KEEP_ALIVE_INITIAL_DELAY | is the number of milliseconds to wait before initiating keepAlive on the socket | 300000 | in milliseconds
 | MONGO_SOCKET_TIMEOUT | The time in milliseconds to attempt a send or receive on a socket before the attempt times out | 20000 | in milliseconds
 | MONGO_FAMILY | IP address family | 4 | 4 -> IPV4, 6 -> IPV6
 | MONGO_SERVER_SELECTION_TIMEOUT | the MongoDB driver will try to find a server to send any given operation to, and keep retrying for serverSelectionTimeoutMS milliseconds | 30000 | in milliseconds

package/index.js

@@ -1,5 +1,11 @@
 /* eslint no-process-env: "off" */
-const _ = require('lodash');
+const includes = require('lodash.includes');
+const isNaN = require('lodash.isnan');
+const isNil = require('lodash.isnil');
+const isString = require('lodash.isstring');
+const isUndefined = require('lodash.isundefined');
+const split = require('lodash.split');
+const trim = require('lodash.trim');
 const fs = require('fs');
 const ip = require('ip');
 const uuid = require('uuid');
@@ -56,8 +62,6 @@ const {
   DEFAULT_MONGO_MAX_POOL_SIZE,
   DEFAULT_MONGO_MIN_POOL_SIZE,
   DEFAULT_MONGO_MAX_IDLE_TIME,
-  DEFAULT_MONGO_KEEP_ALIVE,
-  DEFAULT_MONGO_KEEP_ALIVE_INITIAL_DELAY,
   DEFAULT_MONGO_SOCKET_TIMEOUT,
   DEFAULT_MONGO_FAMILY,
   DEFAULT_MONGO_SERVER_SELECTION_TIMEOUT,
@@ -94,6 +98,8 @@ const {
   DEFAULT_INTERCEPT_ERROR,
   DEFAULT_BITBUCKET_USERNAME,
   DEFAULT_BITBUCKET_PASSWORD,
+  YES,
+  NO,
 } = require('./lib/common');
 
 let display = true;
@@ -108,8 +114,10 @@ const setupRedis = () => {
   const reconnectTries = parseInt(process.env.REDIS_RECONNECT_TRIES, 10) || DEFAULT_REDIS_RECONNECT_TRIES;
   const reconnectInterval = parseInt(process.env.REDIS_RECONNECT_INTERVAL, 10) || DEFAULT_REDIS_RECONNECT_INTERVAL;
   let url = REDIS_BASE_URL;
+  let noAuthUrl = url;
   if (username && password) url += `${username}:${password}@`;
   url += domain;
+  noAuthUrl += domain;
 
   const clusterConfig = {
     set: process.env.CACHE_CLUSTER_SET || SET_OFF,
@@ -125,6 +133,7 @@ const setupRedis = () => {
     validationCheck: parseInt(process.env.CACHE_VALIDATION_CHECK, 10) || DEFAULT_CACHE_VALIDATION_CHECK,
     reconnectOffset: parseInt(process.env.CACHE_RECONNECTION_OFFSET, 10) || DEFAULT_CACHE_RECONNECTION_OFFSET,
     url,
+    noAuthUrl,
     cluster: clusterConfig,
     options: {
       socket: {
@@ -142,7 +151,7 @@ const setupRedis = () => {
           }
           return undefined;
         },
-        disableOfflineQueue: (process.env.REDIS_DISABLE_OFFLINE_QUEUE === 'yes') || DEFAULT_REDIS_DISABLE_OFFLINE_QUEUE,
+        disableOfflineQueue: (process.env.REDIS_DISABLE_OFFLINE_QUEUE === YES) || DEFAULT_REDIS_DISABLE_OFFLINE_QUEUE,
       },
       maxMemory: process.env.REDIS_REQUEST_MAX_MEMORY || DEFAULT_REDIS_REQUEST_MAX_MEMORY,
       maxMemoryPolicy: process.env.REDIS_REQUEST_MAX_MEMORY_POLICY || DEFAULT_REDIS_REQUEST_MAX_MEMORY_POLICY,
@@ -178,17 +187,17 @@ const setupDynamo = (dbOpts) => {
     },
     tableName: dbOpts.table,
   };
-  if (!_.isNil(process.env.DYNAMODB_AWS_ACCESS_KEY_ID)) dbConfig.accessKeyId = process.env.DYNAMODB_AWS_ACCESS_KEY_ID;
-  if (!_.isNil(process.env.DYNAMODB_AWS_SECRET_ACCESS_KEY)) dbConfig.secretAccessKey = process.env.DYNAMODB_AWS_SECRET_ACCESS_KEY;
+  if (!isNil(process.env.DYNAMODB_AWS_ACCESS_KEY_ID)) dbConfig.accessKeyId = process.env.DYNAMODB_AWS_ACCESS_KEY_ID;
+  if (!isNil(process.env.DYNAMODB_AWS_SECRET_ACCESS_KEY)) dbConfig.secretAccessKey = process.env.DYNAMODB_AWS_SECRET_ACCESS_KEY;
 
   if (process.env.DYNAMO_SCHEMA_THROUGHPUT === 'ON_DEMAND') {
     dbConfig.schemaThroughput = process.env.DYNAMO_SCHEMA_THROUGHPUT;
     delete dbConfig.throughput;
   }
-  else if (!_.isNil(process.env.DYNAMO_SCHEMA_THROUGHPUT)) {
+  else if (!isNil(process.env.DYNAMO_SCHEMA_THROUGHPUT)) {
     const throughput = parseInt(process.env.DYNAMO_SCHEMA_THROUGHPUT, 10);
 
-    if (_.isNil(throughput) || _.isNaN(throughput)) dbConfig.schemaThroughput = DEFAULT_DYNAMO_THROUGHPUT;
+    if (isNil(throughput) || isNaN(throughput)) dbConfig.schemaThroughput = DEFAULT_DYNAMO_THROUGHPUT;
     else dbConfig.schemaThroughput = throughput;
   }
   return dbConfig;
@@ -203,9 +212,9 @@ const setupMongo = (dbOpts) => {
       maxIdleTimeMS: parseInt(process.env.MONGO_MAX_IDLE_TIME, 10) || DEFAULT_MONGO_MAX_IDLE_TIME,
     };
     // string variables without default
-    if (process.env.MONGO_SSL === 'yes') stringOptions.ssl = true; // default value of mongo driver is false
-    if (process.env.MONGO_SSL_VALIDATE === 'no') stringOptions.sslValidate = false; // default value of mongo driver is true, if ssl is true
-    if (process.env.MONGO_SSL_ALLOW_INVALID_HOSTNAMES === 'yes') stringOptions.allowInvalidHostnames = true;
+    if (process.env.MONGO_SSL === YES) stringOptions.ssl = true; // default value of mongo driver is false
+    if (process.env.MONGO_SSL_VALIDATE === NO) stringOptions.sslValidate = false; // default value of mongo driver is true, if ssl is true
+    if (process.env.MONGO_SSL_ALLOW_INVALID_HOSTNAMES === YES) stringOptions.allowInvalidHostnames = true;
     // if (process.env.MONGO_SSL_CA) stringOptions.sslCA = process.env.MONGO_SSL_CA; // commented out for now as we're not using a pem file at the moment
     if (process.env.MONGO_REPLICAT_SET) stringOptions.replicaSet = process.env.MONGO_REPLICAT_SET;
     if (process.env.MONGO_AUTH_DATABASE) stringOptions.authSource = process.env.MONGO_AUTH_DATABASE;
@@ -223,7 +232,7 @@ const setupMongo = (dbOpts) => {
   const user = process.env.DATABASE_USER || DEFAULT_DATABASE_USER;
   const password = process.env.DATABASE_PASSWORD || DEFAULT_DATABASE_PASSWORD;
   const qs = processStringOptions();
-  let url = (process.env.MONGO_USE_SRV === 'yes') ? MONGO_BASE_URL_SRV : MONGO_BASE_URL;
+  let url = (process.env.MONGO_USE_SRV === YES) ? MONGO_BASE_URL_SRV : MONGO_BASE_URL;
   let noAuthUrl = url;
 
   if (user && password) url = `${url}${user}:${password}@`;
@@ -248,8 +257,6 @@ const setupMongo = (dbOpts) => {
     noAuthUrl,
     options: {
       family: parseInt(process.env.MONGO_FAMILY, 10) || DEFAULT_MONGO_FAMILY,
-      keepAlive: process.env.MONGO_KEEP_ALIVE || DEFAULT_MONGO_KEEP_ALIVE,
-      keepAliveInitialDelay: parseInt(process.env.MONGO_KEEP_ALIVE_INITIAL_DELAY, 10) || DEFAULT_MONGO_KEEP_ALIVE_INITIAL_DELAY,
       socketTimeoutMS: parseInt(process.env.MONGO_SOCKET_TIMEOUT, 10) || DEFAULT_MONGO_SOCKET_TIMEOUT,
       serverSelectionTimeoutMS: parseInt(process.env.MONGO_SERVER_SELECTION_TIMEOUT, 10) || DEFAULT_MONGO_SERVER_SELECTION_TIMEOUT,
       heartbeatFrequencyMS: parseInt(process.env.MONGO_HEARTBEAT_FREQUENCY, 10) || DEFAULT_MONGO_HEARTBEAT_FREQUENCY,
@@ -261,7 +268,7 @@ const setupLocationProvider = () => {
   const url = process.env.LOCATION_PROVIDER;
 
   if (!url) return NO_PUBLIC_PROVIDER;
-  if (_.includes(locParams, url)) return url;
+  if (includes(locParams, url)) return url;
   const locationProvider = { url };
 
   if (process.env.LOCATION_PROVIDER_KEY) locationProvider.key = process.env.LOCATION_PROVIDER_KEY;
@@ -294,8 +301,8 @@ const setupLog = () => {
       maxSize: parseInt(process.env.S3_AWS_MAX_SIZE, 10) || DEFAULT_S3_AWS_MAX_SIZE,
       maxEvents: parseInt(process.env.S3_AWS_MAX_EVENTS, 10) || DEFAULT_S3_AWS_MAX_EVENTS,
     };
-    if (!_.isNil(process.env.S3_AWS_ACCESS_KEY_ID)) logInfo[AWS_S3].accessKeyId = process.env.S3_AWS_ACCESS_KEY_ID;
-    if (!_.isNil(process.env.S3_AWS_SECRET_ACCESS_KEY)) logInfo[AWS_S3].secretAccessKey = process.env.S3_AWS_SECRET_ACCESS_KEY;
+    if (!isNil(process.env.S3_AWS_ACCESS_KEY_ID)) logInfo[AWS_S3].accessKeyId = process.env.S3_AWS_ACCESS_KEY_ID;
+    if (!isNil(process.env.S3_AWS_SECRET_ACCESS_KEY)) logInfo[AWS_S3].secretAccessKey = process.env.S3_AWS_SECRET_ACCESS_KEY;
   }
   return logInfo;
 };
@@ -304,13 +311,13 @@ const setupTopic = (topicOpts) => {
   const topicConfig = {
     region: process.env.SNS_AWS_REGION || DEFAULT_AWS_REGION,
     name: topicOpts.name,
-    isFifoTopic: process.env.SET_SNS_TOPIC_FIFO === 'yes',
+    isFifoTopic: process.env.SET_SNS_TOPIC_FIFO === YES,
     contentBasedDeduplication: false,
   };
 
-  if (topicConfig.isFifoTopic) topicConfig.contentBasedDeduplication = process.env.SET_SNS_CONTENT_DEDUPLICATION === 'yes';
-  if (!_.isNil(process.env.SNS_AWS_ACCESS_KEY_ID)) topicConfig.accessKeyId = process.env.SNS_AWS_ACCESS_KEY_ID;
-  if (!_.isNil(process.env.SNS_AWS_SECRET_ACCESS_KEY)) topicConfig.secretAccessKey = process.env.SNS_AWS_SECRET_ACCESS_KEY;
+  if (topicConfig.isFifoTopic) topicConfig.contentBasedDeduplication = process.env.SET_SNS_CONTENT_DEDUPLICATION === YES;
+  if (!isNil(process.env.SNS_AWS_ACCESS_KEY_ID)) topicConfig.accessKeyId = process.env.SNS_AWS_ACCESS_KEY_ID;
+  if (!isNil(process.env.SNS_AWS_SECRET_ACCESS_KEY)) topicConfig.secretAccessKey = process.env.SNS_AWS_SECRET_ACCESS_KEY;
 
   return topicConfig;
 };
@@ -328,8 +335,8 @@ const setupEncryption = (encryptionOpts) => {
     encryptionConfig.region = process.env.MASTER_KEY_AWS_REGION || DEFAULT_AWS_REGION;
     encryptionConfig.masterKeyARN = process.env.MASTER_KEY_ARN;
 
-    if (!_.isNil(process.env.ENCRYPTION_ACCESS_KEY_ID)) encryptionConfig.aws.accessKeyId = process.env.ENCRYPTION_ACCESS_KEY_ID;
-    if (!_.isNil(process.env.ENCRYPTION_SECRET_ACCESS_KEY)) encryptionConfig.aws.secretAccessKey = process.env.ENCRYPTION_SECRET_ACCESS_KEY;
+    if (!isNil(process.env.ENCRYPTION_ACCESS_KEY_ID)) encryptionConfig.aws.accessKeyId = process.env.ENCRYPTION_ACCESS_KEY_ID;
+    if (!isNil(process.env.ENCRYPTION_SECRET_ACCESS_KEY)) encryptionConfig.aws.secretAccessKey = process.env.ENCRYPTION_SECRET_ACCESS_KEY;
   }
   else encryptionConfig.localMasterKey = process.env.LOCAL_MASTER_KEY;
 
@@ -362,7 +369,7 @@ const checkConfig = (config) => {
       if (typeof node[prop] === 'object' && node[prop]) {
         traverseNodeSync(node[prop], `${path}.${prop}`);
       }
-      else if (_.isUndefined(node[prop])) errors.push({ reason: 'missing', value: `${path}.${prop}` });
+      else if (isUndefined(node[prop])) errors.push({ reason: 'missing', value: `${path}.${prop}` });
     });
   }
 
@@ -392,7 +399,7 @@ const checkConfig = (config) => {
  * | NODE_ENV | environnment of the microservice |
  */
 const isProd = () => {
-  if (_.isString(process.env.NODE_ENV)) return _.includes(PRODUCTIONS, process.env.NODE_ENV.toLowerCase());
+  if (isString(process.env.NODE_ENV)) return includes(PRODUCTIONS, process.env.NODE_ENV.toLowerCase());
   return false;
 };
 
@@ -412,7 +419,7 @@ const configuration = {
     customerCodeSep: process.env.CUSTOMER_CODE ? CUSTOMER_CODE_SEP : '',
     securitySet: process.env.SERVER_SECURITY_SET || DEFAULT_SERVER_SECURITY_SET,
     isMSTSet,
-    port: process.env.SERVER_PORT,
+    port: parseInt(process.env.SERVER_PORT, 10),
     interceptError: process.env.INTERCEPT_ERROR || DEFAULT_INTERCEPT_ERROR,
     ip: {
       local: process.env.SERVER_LOCAL_IPV4,
@@ -437,7 +444,7 @@ const configuration = {
       key: process.env.OAUTH_GENERIC_KEY || NO_GENERIC,
       audience: process.env.OAUTH_GENERIC_AUDIENCE || NO_GENERIC,
     },
-    apiKeys: process.env.API_KEYS ? _.split(_.trim(process.env.API_KEYS), /\s*,\s*/) : [],
+    apiKeys: process.env.API_KEYS ? split(trim(process.env.API_KEYS), /\s*,\s*/) : [],
   },
   cluster: {
     management: process.env.CLUSTER_MANAGEMENT || DEFAULT_CLUSTER_MANAGEMENT,
@@ -624,8 +631,6 @@ configuration.locationProvider = setupLocationProvider();
  * | MONGO_REPLICAT_SET | specifies the name of the replica set, if the mongod is a member of a replica set |  | not mandatory
  * | MONGO_WAIT_QUEUE_MULTIPLE | a number that the driver multiples the maxPoolSize value to, to provide the maximum number of threads allowed to wait for a connection to become available from the pool |  | no mandatory
  * | MONGO_WAIT_QUEUE_TIMEOUT | the maximum time in milliseconds that a thread can wait for a connection to become available |  | not mandatory
- * | MONGO_KEEP_ALIVE | pall th kep the connection with the database alive | true |
- * | MONGO_KEEP_ALIVE_INITIAL_DELAY | is the number of milliseconds to wait before initiating keepAlive on the socket | 300000 | in milliseconds
  * | MONGO_SOCKET_TIMEOUT | The time in milliseconds to attempt a send or receive on a socket before the attempt times out | 20000 | in milliseconds
  * | MONGO_FAMILY | IP address family | 4 | 4 -> IPV4, 6 -> IPV6
  * | MONGO_SERVER_SELECTION_TIMEOUT | the MongoDB driver will try to find a server to send any given operation to, and keep retrying for serverSelectionTimeoutMS milliseconds | 30000 | in milliseconds

package/lib/common.js

@@ -1,3 +1,7 @@
+const YES = 'yes';
+const NO = 'no';
+const LOCAL = 'local';
+
 const SUMOLOGIC = 'sumologic';
 const AWS_S3 = 'awsS3';
 const ALL = 'all';
@@ -15,7 +19,7 @@ const SWAGGER_SEP = '_';
 const CUSTOMER_CODE_SEP = '__';
 const PRODUCTIONS = ['prod', 'production'];
 
-const DEFAULT_ENV = 'local';
+const DEFAULT_ENV = LOCAL;
 const DEFAULT_LOCATION_PROVIDER = NO_PUBLIC_PROVIDER;
 const DEFAULT_CLOUD_PROVIDER = 'noCloud';
 const DEFAULT_CUSTOMER_CODE = '';
@@ -46,8 +50,6 @@ const DEFAULT_DYNAMO_THROUGHPUT = 1;
 const DEFAULT_MONGO_MAX_POOL_SIZE = 10;
 const DEFAULT_MONGO_MIN_POOL_SIZE = 0;
 const DEFAULT_MONGO_MAX_IDLE_TIME = 30000; // in ms
-const DEFAULT_MONGO_KEEP_ALIVE = true;
-const DEFAULT_MONGO_KEEP_ALIVE_INITIAL_DELAY = 300000; // in ms
 const DEFAULT_MONGO_SOCKET_TIMEOUT = 20000; // in ms
 const DEFAULT_MONGO_FAMILY = 4; // 4 -> ipv4, 6 -> ipv6
 const DEFAULT_MONGO_SERVER_SELECTION_TIMEOUT = 30000; // in ms
@@ -61,12 +63,12 @@ const DEFAULT_DATABASE_RECONNECTION_OFFSET = 5; // in seconds
 const DEFAULT_DATABASE_VALIDATION_CHECK = 1000; // in ms
 
 const DEFAULT_ENCRYPTION_SET = SET_OFF;
-const DEFAULT_KMS_PROVIDER = 'local';
+const DEFAULT_KMS_PROVIDER = LOCAL;
 
 const DEFAULT_LOG_LEVEL = 'debug';
 const DEFAULT_FILTER_FILE = NOT_SET;
 const DEFAULT_EXIT_DELAY = 2000; // in ms
-const DEFAULT_NO_STACK = 'yes';
+const DEFAULT_NO_STACK = YES;
 
 const DEFAULT_USER_DEFINITIONS_FILE = NOT_SET;
 
@@ -102,6 +104,8 @@ module.exports = {
   ALL,
   SET_ON,
   SET_OFF,
+  YES,
+  NO,
   CUSTOMER_CODE_SEP,
   NO_PUBLIC_PROVIDER,
   NO_GENERIC,
@@ -138,8 +142,6 @@ module.exports = {
   DEFAULT_MONGO_MAX_POOL_SIZE,
   DEFAULT_MONGO_MIN_POOL_SIZE,
   DEFAULT_MONGO_MAX_IDLE_TIME,
-  DEFAULT_MONGO_KEEP_ALIVE,
-  DEFAULT_MONGO_KEEP_ALIVE_INITIAL_DELAY,
   DEFAULT_MONGO_SOCKET_TIMEOUT,
   DEFAULT_MONGO_FAMILY,
   DEFAULT_MONGO_SERVER_SELECTION_TIMEOUT,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/configuration",
-  "version": "5.0.10",
+  "version": "5.0.12",
   "description": "Common configuration for mimik services",
   "main": "index.js",
   "scripts": {
@@ -9,8 +9,7 @@
     "test": "echo \"Error: no test specified\" && exit 0",
     "test-ci": "echo \"Error: no test specified\" && exit 0",
     "prepublishOnly": "npm run docs && npm run lint && npm run test-ci",
-    "commit-ready": "npm run docs && npm run lint && npm run test-ci",
-    "prepare": "husky install"
+    "commit-ready": "npm run docs && npm run lint && npm run test-ci"
   },
   "husky": {
     "hooks": {
@@ -33,20 +32,26 @@
     "@mimik/request-helper": "^1.7.10",
     "@mimik/sumologic-winston-logger": "^1.6.20",
     "@mimik/user-filters": "^1.3.7",
-    "ip": "2.0.0",
-    "lodash": "4.17.21",
+    "ip": "2.0.1",
+    "lodash.includes": "4.3.0",
+    "lodash.isnan": "3.0.2",
+    "lodash.isnil": "4.0.0",
+    "lodash.isstring": "4.0.1",
+    "lodash.isundefined": "3.0.1",
+    "lodash.split": "4.4.2",
+    "lodash.trim": "4.5.1",
     "uuid": "9.0.1"
   },
   "devDependencies": {
     "@mimik/eslint-plugin-dependencies": "^2.4.6",
     "@mimik/eslint-plugin-document-env": "^1.0.6",
-    "eslint": "8.56.0",
+    "eslint": "8.57.0",
     "eslint-config-airbnb": "19.0.4",
     "eslint-plugin-import": "2.29.1",
     "eslint-plugin-jsx-a11y": "6.8.0",
-    "eslint-plugin-react": "7.33.2",
+    "eslint-plugin-react": "7.34.0",
     "eslint-plugin-react-hooks": "4.6.0",
-    "husky": "8.0.3",
-    "jsdoc-to-markdown": "8.0.0"
+    "husky": "9.0.11",
+    "jsdoc-to-markdown": "8.0.1"
   }
 }