ioredis 4.29.1 → 4.30.0

package/README.md

@@ -1007,7 +1007,7 @@ cluster.get("foo", (err, res) => {
       state stabilized after a failover, so adding a delay before resending can prevent a ping pong effect.
     - `redisOptions`: Default options passed to the constructor of `Redis` when connecting to a node.
     - `slotsRefreshTimeout`: Milliseconds before a timeout occurs while refreshing slots from the cluster (default `1000`).
-    - `slotsRefreshInterval`: Milliseconds between every automatic slots refresh (default `5000`).
+    - `slotsRefreshInterval`: Milliseconds between every automatic slots refresh (default `5000`), setting it to a negative value will disable the slots refresh.
 
 ### Read-write splitting
 

package/built/cluster/index.js

@@ -41,6 +41,7 @@ class Cluster extends events_1.EventEmitter {
         this.delayQueue = new DelayQueue_1.default();
         this.offlineQueue = new Deque();
         this.isRefreshing = false;
+        this._refreshSlotsCacheCallbacks = [];
         this.isCluster = true;
         this._autoPipelines = new Map();
         this._groupsIds = {};
@@ -110,7 +111,7 @@ class Cluster extends events_1.EventEmitter {
         }
     }
     resetNodesRefreshInterval() {
-        if (this.slotsTimer) {
+        if (this.slotsTimer || this.options.slotsRefreshInterval < 0) {
             return;
         }
         const nextRound = () => {
@@ -198,12 +199,12 @@ class Cluster extends events_1.EventEmitter {
                 this.once("refresh", refreshListener);
                 this.once("close", closeListener);
                 this.once("close", this.handleCloseEvent.bind(this));
-                this.refreshSlotsCache(function (err) {
+                this.refreshSlotsCache((err) => {
                     if (err && err.message === "Failed to refresh slots cache.") {
                         redis_1.default.prototype.silentEmit.call(this, "error", err);
                         this.connectionPool.reset([]);
                     }
-                }.bind(this));
+                });
                 this.subscriber.start();
                 if (this.options.shardedSubscribers) {
                     this.shardedSubscribers.start();
@@ -389,23 +390,23 @@ class Cluster extends events_1.EventEmitter {
      * @memberof Cluster
      */
     refreshSlotsCache(callback) {
+        if (typeof callback === "function") {
+            this._refreshSlotsCacheCallbacks.push(callback);
+        }
         if (this.isRefreshing) {
-            if (typeof callback === "function") {
-                process.nextTick(callback);
-            }
             return;
         }
         this.isRefreshing = true;
-        const _this = this;
-        const wrapper = function (error) {
-            _this.isRefreshing = false;
-            if (typeof callback === "function") {
+        const wrapper = (error) => {
+            this.isRefreshing = false;
+            for (const callback of this._refreshSlotsCacheCallbacks) {
                 callback(error);
             }
+            this._refreshSlotsCacheCallbacks = [];
         };
         const nodes = utils_2.shuffle(this.connectionPool.getNodes());
         let lastNodeError = null;
-        function tryNode(index) {
+        const tryNode = (index) => {
             if (index === nodes.length) {
                 const error = new ClusterAllFailedError_1.default("Failed to refresh slots cache.", lastNodeError);
                 return wrapper(error);
@@ -413,8 +414,8 @@ class Cluster extends events_1.EventEmitter {
             const node = nodes[index];
             const key = `${node.options.host}:${node.options.port}`;
             debug("getting slot cache from %s", key);
-            _this.getInfoFromNode(node, function (err) {
-                switch (_this.status) {
+            this.getInfoFromNode(node, (err) => {
+                switch (this.status) {
                     case "close":
                     case "end":
                         return wrapper(new Error("Cluster is disconnected."));
@@ -422,16 +423,16 @@ class Cluster extends events_1.EventEmitter {
                         return wrapper(new Error("Cluster is disconnecting."));
                 }
                 if (err) {
-                    _this.emit("node error", err, key);
+                    this.emit("node error", err, key);
                     lastNodeError = err;
                     tryNode(index + 1);
                 }
                 else {
-                    _this.emit("refresh");
+                    this.emit("refresh");
                     wrapper();
                 }
             });
-        }
+        };
         tryNode(0);
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ioredis",
-  "version": "4.29.1",
+  "version": "4.30.0",
   "description": "A robust, performance-focused and full-featured Redis client for Node.js.",
   "main": "built/index.js",
   "files": [