ioredis 4.27.4 → 4.27.5

package/Changelog.md

@@ -1,3 +1,10 @@
+## [4.27.5](https://github.com/luin/ioredis/compare/v4.27.4...v4.27.5) (2021-06-05)
+
+
+### Bug Fixes
+
+* **SENTINEL:** actively failover detection under an option ([#1363](https://github.com/luin/ioredis/issues/1363)) ([f02e383](https://github.com/luin/ioredis/commit/f02e383996310adaefc2b4c40d946b76e450e5c7))
+
 ## [4.27.4](https://github.com/luin/ioredis/compare/v4.27.3...v4.27.4) (2021-06-04)
 
 

package/built/connectors/SentinelConnector/index.js

@@ -205,6 +205,9 @@ class SentinelConnector extends AbstractConnector_1.default {
     initFailoverDetector() {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            if (!this.options.failoverDetector) {
+                return;
+            }
             // Move the current sentinel to the first position
             this.sentinelIterator.reset(true);
             const sentinels = [];

package/built/redis/RedisOptions.js

@@ -31,6 +31,7 @@ exports.DEFAULT_REDIS_OPTIONS = {
     natMap: null,
     enableTLSForSentinelMode: false,
     updateSentinels: true,
+    failoverDetector: false,
     // Status
     username: null,
     password: null,

package/built/redis/index.js

@@ -93,6 +93,11 @@ const debug = utils_1.Debug("redis");
  * @param {NatMap} [options.natMap=null] NAT map for sentinel connector.
  * @param {boolean} [options.updateSentinels=true] - Update the given `sentinels` list with new IP
  * addresses when communicating with existing sentinels.
+ * @param {boolean} [options.failoverDetector=false] - Detect failover actively by subscribing to the
+ * related channels. With this option disabled, ioredis is still able to detect failovers because Redis
+ * Sentinel will disconnect all clients whenever a failover happens, so ioredis will reconnect to the new
+ * master. This option is useful when you want to detect failover quicker, but it will create more TCP
+ * connections to Redis servers in order to subscribe to related channels.
 * @param {boolean} [options.enableAutoPipelining=false] - When enabled, all commands issued during an event loop
  * iteration are automatically wrapped in a pipeline and sent to the server at the same time.
  * This can dramatically improve performance.

package/package.json

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