ioredis 5.2.0 → 5.2.1

package/built/cluster/ClusterSubscriber.d.ts

@@ -11,5 +11,6 @@ export default class ClusterSubscriber {
     getInstance(): any;
     start(): void;
     stop(): void;
+    private onSubscriberEnd;
     private selectSubscriber;
 }

package/built/cluster/ClusterSubscriber.js

@@ -10,6 +10,25 @@ class ClusterSubscriber {
         this.emitter = emitter;
         this.started = false;
         this.subscriber = null;
+        this.onSubscriberEnd = () => {
+            if (!this.started) {
+                debug("subscriber has disconnected, but ClusterSubscriber is not started, so not reconnecting.");
+                return;
+            }
+            // If the subscriber closes whilst it's still the active connection,
+            // we might as well try to connecting to a new node if possible to
+            // minimise the number of missed publishes.
+            debug("subscriber has disconnected, selecting a new one...");
+            this.selectSubscriber();
+        };
+        // If the current node we're using as the subscriber disappears
+        // from the node pool for some reason, we will select a new one
+        // to connect to.
+        // Note that this event is only triggered if the connection to
+        // the node has been used; cluster subscriptions are setup with
+        // lazyConnect = true. It's possible for the subscriber node to
+        // disappear without this method being called!
+        // See https://github.com/luin/ioredis/pull/1589
         this.connectionPool.on("-node", (_, key) => {
             if (!this.started || !this.subscriber) {
                 return;
@@ -48,9 +67,11 @@ class ClusterSubscriber {
         // Disconnect the previous subscriber even if there
         // will not be a new one.
         if (lastActiveSubscriber) {
+            lastActiveSubscriber.off("end", this.onSubscriberEnd);
             lastActiveSubscriber.disconnect();
         }
         if (this.subscriber) {
+            this.subscriber.off("end", this.onSubscriberEnd);
             this.subscriber.disconnect();
         }
         const sampleNode = (0, utils_1.sample)(this.connectionPool.getNodes());
@@ -79,9 +100,19 @@ class ClusterSubscriber {
             connectionName: (0, util_1.getConnectionName)("subscriber", options.connectionName),
             lazyConnect: true,
             tls: options.tls,
+            // Don't try to reconnect the subscriber connection. If the connection fails
+            // we will get an end event (handled below), at which point we'll pick a new
+            // node from the pool and try to connect to that as the subscriber connection.
+            retryStrategy: null
         });
         // Ignore the errors since they're handled in the connection pool.
         this.subscriber.on("error", utils_1.noop);
+        // The node we lost connection to may not come back up in a
+        // reasonable amount of time (e.g. a slave that's taken down
+        // for maintainence), we could potentially miss many published
+        // messages so we should reconnect as quickly as possible, to
+        // a different node if needed.
+        this.subscriber.once("end", this.onSubscriberEnd);
         // Re-subscribe previous channels
         const previousChannels = { subscribe: [], psubscribe: [] };
         if (lastActiveSubscriber) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ioredis",
-  "version": "5.2.0",
+  "version": "5.2.1",
   "description": "A robust, performance-focused and full-featured Redis client for Node.js.",
   "main": "./built/index.js",
   "types": "./built/index.d.ts",