@mimik/configuration 5.0.5 → 5.0.7

package/README.md

@@ -199,8 +199,12 @@ When `redis` is used the following environement variables are used for the confi
 
 | Env variable name | Description | Default | Comments |
 | ----------------- | ----------- | ------- | -------- |
-| 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_IP | domain of the redis server to use with port, a comma seperated list if using cluster | localhost:6379 |
+| CACHE_USER | redis user if the redis service is auth protected | null |
+| CACHE_PASSWORD | redis password for the user if the redis service is auth protected | null |
+| CACHE_CLUSTER_SET | set on, when using redis in a cluster. | off |
+| CACHE_CLUSTER_USE_REPLICAS | When set on, distribute load by executing readonly commands (such as GET) across all cluster nodes. When false, only use master nodes | off |
+| CACHE_CLUSTER_MINIMIZE_CONNECTION | When set on, .connect() will only discover the cluster topology, without actually connecting to all the nodes. Useful for short-term or Pub/Sub-only connections. | off |
 | 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
@@ -211,8 +215,8 @@ When `redis` is used the following environement variables are used for the confi
 | REDIS_RECONNECT_INTERVAL | time to wait before retry | 500 | in milliseconds
 | REDIS_REQUEST_MAX_MEMORY | maximum memory size of the request cache | 10 | in megabytes
 | REDIS_REQUEST_MAX_MEMORY_POLICY | eviction policy of the request cache | allkeys-lru |
-| REDIS_SOCKET_KEEPALIVE | keep alive for long running connections | yes |
-| REDIS_ENABLE_OFFLINE_QUEUE | queuing event when not connected | yes |
+| REDIS_SOCKET_KEEPALIVE | keep long running connections alive for x seconds | 5000 | in seconds
+| REDIS_DISABLE_OFFLINE_QUEUE | queuing event when not connected | no |
 
 **Requires**: <code>module:@mimik/sumologic-winston-logger</code>  
 

package/index.js

@@ -35,7 +35,6 @@ const {
   DEFAULT_CLOUD_PROVIDER,
   DEFAULT_CUSTOMER_CODE,
   DEFAULT_CACHE_IP,
-  DEFAULT_CACHE_PASSWORD,
   DEFAULT_CACHE_CONNECTION_TIMEOUT,
   DEFAULT_CACHE_RECONNECTION_OFFSET,
   DEFAULT_CACHE_VALIDATION_CHECK,
@@ -47,7 +46,7 @@ const {
   DEFAULT_REDIS_REQUEST_MAX_MEMORY,
   DEFAULT_REDIS_REQUEST_MAX_MEMORY_POLICY,
   DEFAULT_REDIS_SOCKET_KEEPALIVE,
-  DEFAULT_REDIS_ENABLE_OFFLINE_QUEUE,
+  DEFAULT_REDIS_DISABLE_OFFLINE_QUEUE,
   DEFAULT_AWS_REGION,
   DEFAULT_AWS_LOCAL_PROPERTIES,
   DEFAULT_DYNAMODB_LOCAL_URL,
@@ -104,37 +103,49 @@ const isMSTSet = process.env.MST_SET !== SET_OFF;
 
 const setupRedis = () => {
   const domain = process.env.CACHE_IP || DEFAULT_CACHE_IP;
-  const password = process.env.CACHE_PASSWORD || DEFAULT_CACHE_PASSWORD;
+  const username = process.env.CACHE_USER;
+  const password = process.env.CACHE_PASSWORD;
   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}${domain}`;
+  let url = REDIS_BASE_URL;
+  if (username && password) url += `${username}:${password}@`;
+  url += domain;
+
+  const clusterConfig = {
+    set: process.env.CACHE_CLUSTER_SET || SET_OFF,
+    useReplicas: process.env.CACHE_CLUSTER_USE_REPLICAS || SET_OFF,
+    minimizeConnections: process.env.CACHE_CLUSTER_MINIMIZE_CONNECTION || SET_OFF,
+  };
 
-  if (password) url = `${url}?password=${password}`;
   return {
     domain,
+    username,
     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,
+    cluster: clusterConfig,
     options: {
-      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,
-      socket_keepalive: process.env.REDIS_SOCKET_KEEPALIVE || DEFAULT_REDIS_SOCKET_KEEPALIVE,
-      enable_offline_queue: process.env.REDIS_ENABLE_OFFLINE_QUEUE || DEFAULT_REDIS_ENABLE_OFFLINE_QUEUE,
-      retry_strategy: function retryStrategy(opts) {
-        if (opts.timesConnected > 0 && opts.attempt < reconnectTries) {
-          return reconnectInterval;
-        }
-        if (opts.error && opts.error.code === 'ECONNREFUSED') {
-          if (display) {
-            logger.error('Fatal error: Could not connect to cache', { type: 'redis', error: opts.error.code }, `redis-cache-start@0/${new Date().toISOString()}`);
-            logger.flushAndExit(1);
+      socket: {
+        keepAlive: process.env.REDIS_SOCKET_KEEPALIVE || DEFAULT_REDIS_SOCKET_KEEPALIVE,
+        reconnectStrategy: function retryStrategy(opts) {
+          if (opts.timesConnected > 0 && opts.attempt < reconnectTries) {
+            return reconnectInterval;
           }
-          display = false;
-        }
-        return undefined;
+          if (opts.error && opts.error.code === 'ECONNREFUSED') {
+            if (display) {
+              logger.error('Fatal error: Could not connect to cache', { type: 'redis', error: opts.error.code }, `redis-cache-start@0/${new Date().toISOString()}`);
+              logger.flushAndExit(1);
+            }
+            display = false;
+          }
+          return undefined;
+        },
+        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,
     },
     retryStrategyOptions: {
       reconnectTries,
@@ -642,8 +653,12 @@ configuration.locationProvider = setupLocationProvider();
  *
  * | Env variable name | Description | Default | Comments |
  * | ----------------- | ----------- | ------- | -------- |
- * | 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_IP | domain of the redis server to use with port, a comma seperated list if using cluster | localhost:6379 |
+ * | CACHE_USER | redis user if the redis service is auth protected | null |
+ * | CACHE_PASSWORD | redis password for the user if the redis service is auth protected | null |
+ * | CACHE_CLUSTER_SET | set on, when using redis in a cluster. | off |
+ * | CACHE_CLUSTER_USE_REPLICAS | When set on, distribute load by executing readonly commands (such as GET) across all cluster nodes. When false, only use master nodes | off |
+ * | CACHE_CLUSTER_MINIMIZE_CONNECTION | When set on, .connect() will only discover the cluster topology, without actually connecting to all the nodes. Useful for short-term or Pub/Sub-only connections. | off |
  * | 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
@@ -654,8 +669,8 @@ configuration.locationProvider = setupLocationProvider();
  * | REDIS_RECONNECT_INTERVAL | time to wait before retry | 500 | in milliseconds
  * | REDIS_REQUEST_MAX_MEMORY | maximum memory size of the request cache | 10 | in megabytes
  * | REDIS_REQUEST_MAX_MEMORY_POLICY | eviction policy of the request cache | allkeys-lru |
- * | REDIS_SOCKET_KEEPALIVE | keep alive for long running connections | yes |
- * | REDIS_ENABLE_OFFLINE_QUEUE | queuing event when not connected | yes |
+ * | REDIS_SOCKET_KEEPALIVE | keep long running connections alive for x seconds | 5000 | in seconds
+ * | REDIS_DISABLE_OFFLINE_QUEUE | queuing event when not connected | no |
  */
 const setConfig = (pack, options) => {
   process.env.SERVER_VERSION = pack.version;

package/lib/common.js

@@ -21,7 +21,6 @@ const DEFAULT_CLOUD_PROVIDER = 'noCloud';
 const DEFAULT_CUSTOMER_CODE = '';
 
 const DEFAULT_CACHE_IP = 'localhost:6379';
-const DEFAULT_CACHE_PASSWORD = null;
 const DEFAULT_CACHE_CONNECTION_TIMEOUT = 30; // in seconds
 const DEFAULT_CACHE_RECONNECTION_OFFSET = 5; // in seconds
 const DEFAULT_CACHE_VALIDATION_CHECK = 1000; // in ms
@@ -33,8 +32,8 @@ const DEFAULT_REDIS_RECONNECT_TRIES = 100;
 const DEFAULT_REDIS_RECONNECT_INTERVAL = 500; // in ms
 const DEFAULT_REDIS_REQUEST_MAX_MEMORY = '10mb';
 const DEFAULT_REDIS_REQUEST_MAX_MEMORY_POLICY = 'allkeys-lru';
-const DEFAULT_REDIS_SOCKET_KEEPALIVE = true;
-const DEFAULT_REDIS_ENABLE_OFFLINE_QUEUE = true;
+const DEFAULT_REDIS_SOCKET_KEEPALIVE = 5000;
+const DEFAULT_REDIS_DISABLE_OFFLINE_QUEUE = false;
 
 const DEFAULT_AWS_REGION = '---noRegion--';
 const DEFAULT_AWS_LOCAL_PROPERTIES = '169.254.169.254'; // to access properties of the instance on AWS
@@ -118,7 +117,6 @@ module.exports = {
   DEFAULT_LOCATION_PROVIDER,
   DEFAULT_CLOUD_PROVIDER,
   DEFAULT_CACHE_IP,
-  DEFAULT_CACHE_PASSWORD,
   DEFAULT_CACHE_CONNECTION_TIMEOUT,
   DEFAULT_CACHE_RECONNECTION_OFFSET,
   DEFAULT_CACHE_VALIDATION_CHECK,
@@ -130,7 +128,7 @@ module.exports = {
   DEFAULT_REDIS_REQUEST_MAX_MEMORY,
   DEFAULT_REDIS_REQUEST_MAX_MEMORY_POLICY,
   DEFAULT_REDIS_SOCKET_KEEPALIVE,
-  DEFAULT_REDIS_ENABLE_OFFLINE_QUEUE,
+  DEFAULT_REDIS_DISABLE_OFFLINE_QUEUE,
   DEFAULT_AWS_REGION,
   DEFAULT_AWS_LOCAL_PROPERTIES,
   DEFAULT_DYNAMODB_LOCAL_URL,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/configuration",
-  "version": "5.0.5",
+  "version": "5.0.7",
   "description": "Common configuration for mimik services",
   "main": "index.js",
   "scripts": {
@@ -30,21 +30,21 @@
     "url": "https://bitbucket.org/mimiktech/configuration"
   },
   "dependencies": {
-    "@mimik/request-helper": "^1.7.8",
-    "@mimik/sumologic-winston-logger": "^1.6.15",
+    "@mimik/request-helper": "^1.7.9",
+    "@mimik/sumologic-winston-logger": "^1.6.19",
     "@mimik/user-filters": "1.3.6",
     "ip": "2.0.0",
     "lodash": "4.17.21",
-    "uuid": "9.0.0"
+    "uuid": "9.0.1"
   },
   "devDependencies": {
     "@mimik/eslint-plugin-dependencies": "^2.4.5",
     "@mimik/eslint-plugin-document-env": "^1.0.5",
-    "eslint": "8.40.0",
+    "eslint": "8.50.0",
     "eslint-config-airbnb": "19.0.4",
-    "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-import": "2.28.1",
     "eslint-plugin-jsx-a11y": "6.7.1",
-    "eslint-plugin-react": "7.32.2",
+    "eslint-plugin-react": "7.33.2",
     "eslint-plugin-react-hooks": "4.6.0",
     "husky": "8.0.3",
     "jsdoc-to-markdown": "8.0.0"