@mimik/configuration 5.0.6 → 5.0.7

package/README.md

@@ -199,9 +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 with port | localhost:6379 |
+| 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

package/index.js

@@ -111,6 +111,12 @@ const setupRedis = () => {
   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,
+  };
+
   return {
     domain,
     username,
@@ -119,6 +125,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,
+    cluster: clusterConfig,
     options: {
       socket: {
         keepAlive: process.env.REDIS_SOCKET_KEEPALIVE || DEFAULT_REDIS_SOCKET_KEEPALIVE,
@@ -646,9 +653,12 @@ configuration.locationProvider = setupLocationProvider();
  *
  * | Env variable name | Description | Default | Comments |
  * | ----------------- | ----------- | ------- | -------- |
- * | CACHE_IP | domain of the redis server to use with port | localhost:6379 |
+ * | 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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/configuration",
-  "version": "5.0.6",
+  "version": "5.0.7",
   "description": "Common configuration for mimik services",
   "main": "index.js",
   "scripts": {
@@ -35,12 +35,12 @@
     "@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.48.0",
+    "eslint": "8.50.0",
     "eslint-config-airbnb": "19.0.4",
     "eslint-plugin-import": "2.28.1",
     "eslint-plugin-jsx-a11y": "6.7.1",