descript-redis-cache 3.0.0 → 3.1.1

package/README.md

@@ -14,15 +14,19 @@ const context = new de.Context(req, res, {
 
 ## Config
 
-```js
-{
-    defaultKeyTTL: 60 * 60 * 24, // key ttl in seconds
-    generation: 1, // increment generation to invalidate all key across breaking changes releases
-    readTimeout: 100, // read timeout in milliseconds,
-    redisOptions: {}, // @see https://github.com/luin/ioredis/blob/master/API.md#new-redisport-host-options
-}
-```
+| Param         | Type                              | Default        | Description                                                  |
+|---------------|-----------------------------------|----------------|--------------------------------------------------------------|
+| clusterNodes  | `Array`                           | `[]`           | If you're using a cluster: an array of nodes in the cluster `[{ port: number, host: string }]` |
+| defaultKeyTTL | `number`                          | `60 * 60 * 24` | key ttl in seconds                                           |
+| generation    | `number`                          | 1              | increment generation to invalidate all key across breaking changes releases |
+| readTimeout   | `number`                          | 100            | read timeout in milliseconds                                 |
+| redisOptions  | `IRedisOptions` or `IClusterOptions` | `{}`           | Redis constructor [options](https://github.com/luin/ioredis/blob/master/API.md#new-redisport-host-options) or Redis.Cluster constructor [options](https://github.com/luin/ioredis/blob/master/API.md#new-clusterstartupnodes-options) |
+| useCluster    | `boolean`                         | false          | to use [Redis.Cluster](#Cluster)                             |
+
 
 ## Logger
 
 Optionally you can pass logger object in the constructor. It should implement standard `Console` methods.
+
+## Cluster
+It also has a support for Redis Cluster. In this case you should pass `useCluster = true`, an array of `clusterNodes` and also [clusterOptions](https://github.com/luin/ioredis/blob/a46415187d32bfdc974072403edb8aca2df282d6/lib/cluster/ClusterOptions.ts#L30) in `redisOptions`.

package/index.js

@@ -9,19 +9,30 @@ class DescriptRedisCache {
 
     constructor(options, logger) {
         this._options = Object.assign({
+            clusterNodes: [],
             defaultKeyTTL: 60 * 60 * 24, // key ttl in seconds
             generation: 1, // increment generation to invalidate all key across breaking changes releases
             readTimeout: 100, // read timeout in milliseconds,
             redisOptions: {},
+            useCluster: false,
         }, options);
 
         this._logger = logger;
 
-        this._client = new Redis(options.redisOptions);
+        if (this._options.useCluster) {
+            this._client = new Redis.Cluster(this._options.clusterNodes, this._options.redisOptions);
+        } else {
+            this._client = new Redis(this._options.redisOptions);
+        }
+
+        const optionsToLog = Object.assign({}, this._options);
+        // Don't write connection options to log because it can contain password
+        // (not only as a property, but as a part of a connection string, so it's difficult to delete only a password)
+        delete optionsToLog.redisOptions;
 
         this._log({
             type: DescriptRedisCache.EVENT.REDIS_CACHE_INITIALIZED,
-            options: options,
+            options: optionsToLog,
         });
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "descript-redis-cache",
-  "version": "3.0.0",
+  "version": "3.1.1",
   "description": "plugin for descript to use redis as cache",
   "main": "index.js",
   "scripts": {