@mimik/configuration 5.0.3 → 5.0.5

package/README.md

@@ -132,6 +132,12 @@ When `on` is used for `TOPIC_SET` the following environment variables are used f
 | SNS_AWS_SECRET_ACCESS_KEY | secret access key for AWS SNS |  |
 | SNS_AWS_REGION | region where the topic is | ----noRegion---- |
 
+When a database is involved
+| Env variable name | Description | Default | Comments |
+| DATABASE_CONNECTION_TIMEOUT | the time to connect to the database before error is generated | 30 | in seconds
+| DATABASE_VALIDATION_CHECK | the delay before checking for connection | 1000 | in ms
+| DATABASE_RECONNECTION_OFFSET | offset for the time to reconnect to the database before error is generated | 5 | in seconds
+
 When `mongodb` is used the following environment variables are used for the configuration:
 
 | Env variable name | Description | Default | Comments |
@@ -140,8 +146,6 @@ When `mongodb` is used the following environment variables are used for the conf
 | DATABASE_IP | ip address of the database | localhost |
 | DATABASE_USER | user to access the database | null | if missing no user/password will be used
 | DATABASE_PASSWORD | password to access the database | null | if missing no user/password will be used
-| DATABASE_CONNECTION_TIMEOUT | the time to connect to the database before error is generated | 30 | in seconds
-| DATABASE_RECONNECTION_OFFSET | offset for the time to reconnect to the database before error is generated | 5 | in seconds
 | MONGO_USE_SRV | to use srv connection url set to `yes` | `no` |
 | MONGO_AUTH_DATABASE | the auth database where users exists | |
 | MONGO_MAX_POOL_SIZE | the minimum number of connections in the connection pool | 5 |
@@ -197,7 +201,9 @@ When `redis` is used the following environement variables are used for the confi
 | ----------------- | ----------- | ------- | -------- |
 | CACHE_IP | domain of the redis server to use | localhost:6379 |
 | CACHE_PASSWORD | password if the redis service is protected (requirepass in redis.conf) | null |
-| CACHE_CONNECTION_TIMEOUT | time the server will wait at start to connect to the cache | 20 | in seconds
+| CACHE_CONNECTION_TIMEOUT | time the server will wait at start to connect to the cache | 30 | in seconds
+| CACHE_VALIDATION_CHECK | the delay before checking for connection | 1000 | in ms
+| CACHE_RECONNECTION_OFFSET | offset for the time to reconnect to the database before error is generated | 5 | in seconds
 | CACHE_REQUEST_TTL | request time to live in cache | 10 | in seconds
 | CACHE_API_ID_TTL | API request time to live for main resource | 20 | in seconds
 | CACHE_API_OPTION_TTL | API request time to live for option | 5 | in seconds

package/index.js

@@ -37,6 +37,8 @@ const {
   DEFAULT_CACHE_IP,
   DEFAULT_CACHE_PASSWORD,
   DEFAULT_CACHE_CONNECTION_TIMEOUT,
+  DEFAULT_CACHE_RECONNECTION_OFFSET,
+  DEFAULT_CACHE_VALIDATION_CHECK,
   DEFAULT_CACHE_REQUEST_TTL,
   DEFAULT_CACHE_API_ID_TTL,
   DEFAULT_CACHE_API_OPTION_TTL,
@@ -66,6 +68,7 @@ const {
   DEFAULT_DATABASE_PASSWORD,
   DEFAULT_DATABASE_CONNECTION_TIMEOUT,
   DEFAULT_DATABASE_RECONNECTION_OFFSET,
+  DEFAULT_DATABASE_VALIDATION_CHECK,
   DEFAULT_ENCRYPTION_SET,
   DEFAULT_KMS_PROVIDER,
   DEFAULT_LOG_LEVEL,
@@ -111,6 +114,8 @@ const setupRedis = () => {
     domain,
     password,
     connectTimeout: parseInt(process.env.CACHE_CONNECTION_TIMEOUT, 10) || DEFAULT_CACHE_CONNECTION_TIMEOUT,
+    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,
     options: {
       maxMemory: process.env.REDIS_REQUEST_MAX_MEMORY || DEFAULT_REDIS_REQUEST_MAX_MEMORY,
@@ -147,6 +152,9 @@ const setupRedis = () => {
 
 const setupDynamo = (dbOpts) => {
   const dbConfig = {
+    connectTimeout: parseInt(process.env.DATABASE_CONNECTION_TIMEOUT, 10) || DEFAULT_DATABASE_CONNECTION_TIMEOUT,
+    validationCheck: parseInt(process.env.DATABASE_VALIDATION_CHECK, 10) || DEFAULT_DATABASE_VALIDATION_CHECK,
+    reconnectOffset: parseInt(process.env.DATABASE_RECONNECTION_OFFSET, 10) || DEFAULT_DATABASE_RECONNECTION_OFFSET,
     region: process.env.DYNAMODB_AWS_REGION || DEFAULT_AWS_REGION,
     url: process.env.DYNAMODB_LOCAL_URL || DEFAULT_DYNAMODB_LOCAL_URL,
     throughput: {
@@ -215,6 +223,7 @@ const setupMongo = (dbOpts) => {
     user,
     password,
     connectTimeout: parseInt(process.env.DATABASE_CONNECTION_TIMEOUT, 10) || DEFAULT_DATABASE_CONNECTION_TIMEOUT,
+    validationCheck: parseInt(process.env.DATABASE_VALIDATION_CHECK, 10) || DEFAULT_DATABASE_VALIDATION_CHECK,
     reconnectOffset: parseInt(process.env.DATABASE_RECONNECTION_OFFSET, 10) || DEFAULT_DATABASE_RECONNECTION_OFFSET,
     replicat: !!process.env.MONGO_REPLICAT_SET,
     stringOptions: qs,
@@ -566,6 +575,12 @@ configuration.locationProvider = setupLocationProvider();
  * | SNS_AWS_SECRET_ACCESS_KEY | secret access key for AWS SNS |  |
  * | SNS_AWS_REGION | region where the topic is | ----noRegion---- |
  *
+ * When a database is involved
+ * | Env variable name | Description | Default | Comments |
+ * | DATABASE_CONNECTION_TIMEOUT | the time to connect to the database before error is generated | 30 | in seconds
+ * | DATABASE_VALIDATION_CHECK | the delay before checking for connection | 1000 | in ms
+ * | DATABASE_RECONNECTION_OFFSET | offset for the time to reconnect to the database before error is generated | 5 | in seconds
+ *
  * When `mongodb` is used the following environment variables are used for the configuration:
  *
  * | Env variable name | Description | Default | Comments |
@@ -574,8 +589,6 @@ configuration.locationProvider = setupLocationProvider();
  * | DATABASE_IP | ip address of the database | localhost |
  * | DATABASE_USER | user to access the database | null | if missing no user/password will be used
  * | DATABASE_PASSWORD | password to access the database | null | if missing no user/password will be used
- * | DATABASE_CONNECTION_TIMEOUT | the time to connect to the database before error is generated | 30 | in seconds
- * | DATABASE_RECONNECTION_OFFSET | offset for the time to reconnect to the database before error is generated | 5 | in seconds
  * | MONGO_USE_SRV | to use srv connection url set to `yes` | `no` |
  * | MONGO_AUTH_DATABASE | the auth database where users exists | |
  * | MONGO_MAX_POOL_SIZE | the minimum number of connections in the connection pool | 5 |
@@ -631,7 +644,9 @@ configuration.locationProvider = setupLocationProvider();
  * | ----------------- | ----------- | ------- | -------- |
  * | CACHE_IP | domain of the redis server to use | localhost:6379 |
  * | CACHE_PASSWORD | password if the redis service is protected (requirepass in redis.conf) | null |
- * | CACHE_CONNECTION_TIMEOUT | time the server will wait at start to connect to the cache | 20 | in seconds
+ * | CACHE_CONNECTION_TIMEOUT | time the server will wait at start to connect to the cache | 30 | in seconds
+ * | CACHE_VALIDATION_CHECK | the delay before checking for connection | 1000 | in ms
+ * | CACHE_RECONNECTION_OFFSET | offset for the time to reconnect to the database before error is generated | 5 | in seconds
  * | CACHE_REQUEST_TTL | request time to live in cache | 10 | in seconds
  * | CACHE_API_ID_TTL | API request time to live for main resource | 20 | in seconds
  * | CACHE_API_OPTION_TTL | API request time to live for option | 5 | in seconds

package/lib/common.js

@@ -22,7 +22,9 @@ const DEFAULT_CUSTOMER_CODE = '';
 
 const DEFAULT_CACHE_IP = 'localhost:6379';
 const DEFAULT_CACHE_PASSWORD = null;
-const DEFAULT_CACHE_CONNECTION_TIMEOUT = 20; // in seconds
+const DEFAULT_CACHE_CONNECTION_TIMEOUT = 30; // in seconds
+const DEFAULT_CACHE_RECONNECTION_OFFSET = 5; // in seconds
+const DEFAULT_CACHE_VALIDATION_CHECK = 1000; // in ms
 const DEFAULT_CACHE_REQUEST_TTL = 10; // in seconds
 const DEFAULT_CACHE_API_ID_TTL = 20; // in seconds
 const DEFAULT_CACHE_API_OPTION_TTL = 5; // in seconds
@@ -57,6 +59,7 @@ const DEFAULT_DATABASE_USER = null;
 const DEFAULT_DATABASE_PASSWORD = null;
 const DEFAULT_DATABASE_CONNECTION_TIMEOUT = 30; // in seconds
 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';
@@ -89,7 +92,7 @@ const DEFAULT_ADMIN_EXTERNAL_ID = 'admin';
 
 const DEFAULT_SWAGGER_DIR = '../api';
 const DEFAULT_SWAGGER_FILE_PROVIDER = 'bitbucket';
-const SUPPORTED_SWAGGER_FILE_PROVIDERS = [DEFAULT_SWAGGER_FILE_PROVIDER, 'swagggerhub'];
+const SUPPORTED_SWAGGER_FILE_PROVIDERS = [DEFAULT_SWAGGER_FILE_PROVIDER, 'swaggerhub'];
 
 const DEFAULT_BITBUCKET_USERNAME = ' ';
 const DEFAULT_BITBUCKET_PASSWORD = ' ';
@@ -117,6 +120,8 @@ module.exports = {
   DEFAULT_CACHE_IP,
   DEFAULT_CACHE_PASSWORD,
   DEFAULT_CACHE_CONNECTION_TIMEOUT,
+  DEFAULT_CACHE_RECONNECTION_OFFSET,
+  DEFAULT_CACHE_VALIDATION_CHECK,
   DEFAULT_CACHE_REQUEST_TTL,
   DEFAULT_CACHE_API_ID_TTL,
   DEFAULT_CACHE_API_OPTION_TTL,
@@ -146,6 +151,7 @@ module.exports = {
   DEFAULT_DATABASE_PASSWORD,
   DEFAULT_DATABASE_CONNECTION_TIMEOUT,
   DEFAULT_DATABASE_RECONNECTION_OFFSET,
+  DEFAULT_DATABASE_VALIDATION_CHECK,
   DEFAULT_ENCRYPTION_SET,
   DEFAULT_KMS_PROVIDER,
   DEFAULT_LOG_LEVEL,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/configuration",
-  "version": "5.0.3",
+  "version": "5.0.5",
   "description": "Common configuration for mimik services",
   "main": "index.js",
   "scripts": {
@@ -40,7 +40,7 @@
   "devDependencies": {
     "@mimik/eslint-plugin-dependencies": "^2.4.5",
     "@mimik/eslint-plugin-document-env": "^1.0.5",
-    "eslint": "8.38.0",
+    "eslint": "8.40.0",
     "eslint-config-airbnb": "19.0.4",
     "eslint-plugin-import": "2.27.5",
     "eslint-plugin-jsx-a11y": "6.7.1",