ioredis 4.23.1 → 4.24.3

package/Changelog.md

@@ -1,3 +1,31 @@
+## [4.24.3](https://github.com/luin/ioredis/compare/v4.24.2...v4.24.3) (2021-03-21)
+
+
+### Bug Fixes
+
+* support parallel script execution in pipelines ([#1304](https://github.com/luin/ioredis/issues/1304)) ([c917719](https://github.com/luin/ioredis/commit/c91771997e5e3a0196d380522b4750de9e84cc9b))
+
+## [4.24.2](https://github.com/luin/ioredis/compare/v4.24.1...v4.24.2) (2021-03-14)
+
+
+### Bug Fixes
+
+* properly handle instant stream errors ([#1299](https://github.com/luin/ioredis/issues/1299)) ([0327ef5](https://github.com/luin/ioredis/commit/0327ef5a57481042d3f7d306917f55ef04f3a6cc))
+
+## [4.24.1](https://github.com/luin/ioredis/compare/v4.24.0...v4.24.1) (2021-03-14)
+
+
+### Bug Fixes
+
+* **cluster:** reconnect when failing to refresh slots cache for all nodes ([8524eea](https://github.com/luin/ioredis/commit/8524eeaedaa2542f119f2b65ab8e2f15644b474e))
+
+# [4.24.0](https://github.com/luin/ioredis/compare/v4.23.1...v4.24.0) (2021-03-14)
+
+
+### Features
+
+* **cluster:** support retrying MOVED with a delay ([#1254](https://github.com/luin/ioredis/issues/1254)) ([8599981](https://github.com/luin/ioredis/commit/8599981141e8357f5ae2706fffb55010490bf002))
+
 ## [4.23.1](https://github.com/luin/ioredis/compare/v4.23.0...v4.23.1) (2021-03-14)
 
 

package/README.md

@@ -148,50 +148,88 @@ See [API Documentation](API.md#new_Redis) for all available options.
 
 ## Pub/Sub
 
-Here is a simple example of the API for publish/subscribe.
-The following program opens two client connections.
-It subscribes to a channel with one connection
-and publishes to that channel with the other:
+Redis provides several commands for developers to implement the [Publish–subscribe pattern](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern). There are two roles in this pattern: publisher and subscriber. Publishers are not programmed to send their messages to specific subscribers. Rather, published messages are characterized into channels, without knowledge of what (if any) subscribers there may be.
+
+By leveraging Node.js's built-in events module, ioredis makes pub/sub very straightforward to use. Below is a simple example that consists of two files, one is publisher.js that publishes messages to a channel, the other is subscriber.js that listens for messages on specific channels.
 
 ```javascript
+// publisher.js
+
 const Redis = require("ioredis");
 const redis = new Redis();
-const pub = new Redis();
-redis.subscribe("news", "music", (err, count) => {
-  // Now we are subscribed to both the 'news' and 'music' channels.
-  // `count` represents the number of channels we are currently subscribed to.
 
-  pub.publish("news", "Hello world!");
-  pub.publish("music", "Hello again!");
+setInterval(() => {
+  const message = { foo: Math.random() };
+  // Publish to my-channel-1 or my-channel-2 randomly.
+  const channel = `my-channel-${1 + Math.round(Math.random())}`;
+
+  // Message can be either a string or a buffer
+  redis.publish(channel, JSON.stringify(message));
+  console.log("Published %s to %s", message, channel);
+}, 1000);
+```
+
+```javascript
+// subscriber.js
+
+const Redis = require("ioredis");
+const redis = new Redis();
+
+redis.subscribe("my-channel-1", "my-channel-2", (err, count) => {
+  if (err) {
+    // Just like other commands, subscribe() can fail for some reasons,
+    // ex network issues.
+    console.error("Failed to subscribe: %s", err.message);
+  } else {
+    // `count` represents the number of channels this client are currently subscribed to.
+    console.log(
+      `Subscribed successfully! This client is currently subscribed to ${count} channels.`
+    );
+  }
 });
 
 redis.on("message", (channel, message) => {
-  // Receive message Hello world! from channel news
-  // Receive message Hello again! from channel music
-  console.log("Receive message %s from channel %s", message, channel);
+  console.log(`Received ${message} from ${channel}`);
 });
 
 // There's also an event called 'messageBuffer', which is the same as 'message' except
 // it returns buffers instead of strings.
+// It's useful when the messages are binary data.
 redis.on("messageBuffer", (channel, message) => {
   // Both `channel` and `message` are buffers.
+  console.log(channel, message);
 });
 ```
 
-`PSUBSCRIBE` is also supported in a similar way:
+It worth noticing that a connection (aka `Redis` instance) can't play both roles together. More specifically, when a client issues `subscribe()` or `psubscribe()`, it enters the "subscriber" mode. From that point, only commands that modify the subscription set are valid. Namely, they are: `subscribe`, `psubscribe`, `unsubscribe`, `punsubscribe`, `ping`, and `quit`. When the subscription set is empty (via `unsubscribe`/`punsubscribe`), the connection is put back into the regular mode.
+
+If you want to do pub/sub in the same file/process, you should create a separate connection:
+
+```javascript
+const Redis = require('ioredis');
+const sub = new Redis();
+const pub = new Redis();
+
+sub.subscribe(/* ... */); // From now, `sub` enters the subscriber mode.
+sub.on("message", /* ... */);
+
+setInterval(() => {
+  // `pub` can be used to publish messages, or send other regular commands (e.g. `hgetall`)
+  // because it's not in the subscriber mode.
+  pub.publish(/* ... */);
+}, 1000);
+```
+
+`PSUBSCRIBE` is also supported in a similar way when you want to subscribe all channels whose name matches a pattern:
 
 ```javascript
 redis.psubscribe("pat?ern", (err, count) => {});
+
+// Event names are "pmessage"/"pmessageBuffer" instead of "message/messageBuffer".
 redis.on("pmessage", (pattern, channel, message) => {});
 redis.on("pmessageBuffer", (pattern, channel, message) => {});
 ```
 
-When a client issues a SUBSCRIBE or PSUBSCRIBE, that connection is put into a "subscriber" mode.
-At that point, only commands that modify the subscription set are valid.
-When the subscription set is empty, the connection is put back into regular mode.
-
-If you need to send regular commands to Redis while in subscriber mode, just open another connection.
-
 ## Handle Binary Data
 
 Arguments can be buffers:
@@ -703,6 +741,7 @@ The Redis instance will emit some events about the state of the connection to th
 | close        | emits when an established Redis server connection has closed.                                                                                                                                                                                   |
 | reconnecting | emits after `close` when a reconnection will be made. The argument of the event is the time (in ms) before reconnecting.                                                                                                                        |
 | end          | emits after `close` when no more reconnections will be made, or the connection is failed to establish.                                                                                                                                          |
+| wait          | emits when `lazyConnect` is set and will wait for the first command to be called before connecting.                                                                                                                                          |
 
 You can also check out the `Redis#status` property to get the current connection status.
 
@@ -889,9 +928,12 @@ cluster.get("foo", (err, res) => {
       will resend the commands after the specified time (in ms).
     - `retryDelayOnTryAgain`: If this option is a number (by default, it is `100`), the client
       will resend the commands rejected with `TRYAGAIN` error after the specified time (in ms).
+    - `retryDelayOnMoved`: By default, this value is `0` (in ms), which means when a `MOVED` error is received, the client will resend
+      the command instantly to the node returned together with the `MOVED` error. However, sometimes it takes time for a cluster to become
+      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`)
+    - `slotsRefreshTimeout`: Milliseconds before a timeout occurs while refreshing slots from the cluster (default `1000`).
+    - `slotsRefreshInterval`: Milliseconds between every automatic slots refresh (default `5000`).
 
 ### Read-write splitting
 

package/built/autoPipelining.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.executeWithAutoPipelining = exports.shouldUseAutoPipelining = exports.notAllowedAutoPipelineCommands = exports.kCallbacks = exports.kExec = void 0;
 const PromiseContainer = require("./promiseContainer");
 const calculateSlot = require("cluster-key-slot");
 const standard_as_callback_1 = require("standard-as-callback");

package/built/cluster/ClusterOptions.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_CLUSTER_OPTIONS = void 0;
 const dns_1 = require("dns");
 exports.DEFAULT_CLUSTER_OPTIONS = {
     clusterRetryStrategy: (times) => Math.min(100 + times * 2, 2000),
@@ -7,6 +8,7 @@ exports.DEFAULT_CLUSTER_OPTIONS = {
     enableReadyCheck: true,
     scaleReads: "master",
     maxRedirections: 16,
+    retryDelayOnMoved: 0,
     retryDelayOnFailover: 100,
     retryDelayOnClusterDown: 100,
     retryDelayOnTryAgain: 100,

package/built/cluster/index.js

@@ -185,12 +185,7 @@ 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) {
-                    if (err && err.message === "Failed to refresh slots cache.") {
-                        redis_1.default.prototype.silentEmit.call(this, "error", err);
-                        this.connectionPool.reset([]);
-                    }
-                }.bind(this));
+                this.refreshSlotsCache();
                 this.subscriber.start();
             })
                 .catch((err) => {
@@ -390,6 +385,8 @@ class Cluster extends events_1.EventEmitter {
         function tryNode(index) {
             if (index === nodes.length) {
                 const error = new ClusterAllFailedError_1.default("Failed to refresh slots cache.", lastNodeError);
+                redis_1.default.prototype.silentEmit.call(_this, "error", error);
+                _this.connectionPool.reset([]);
                 return wrapper(error);
             }
             const node = nodes[index];
@@ -608,8 +605,17 @@ class Cluster extends events_1.EventEmitter {
             return;
         }
         const errv = error.message.split(" ");
-        if (errv[0] === "MOVED" || errv[0] === "ASK") {
-            handlers[errv[0] === "MOVED" ? "moved" : "ask"](errv[1], errv[2]);
+        if (errv[0] === "MOVED") {
+            const timeout = this.options.retryDelayOnMoved;
+            if (timeout && typeof timeout === "number") {
+                this.delayQueue.push("moved", handlers.moved.bind(null, errv[1], errv[2]), { timeout });
+            }
+            else {
+                handlers.moved(errv[1], errv[2]);
+            }
+        }
+        else if (errv[0] === "ASK") {
+            handlers.ask(errv[1], errv[2]);
         }
         else if (errv[0] === "TRYAGAIN") {
             this.delayQueue.push("tryagain", handlers.tryagain, {

package/built/cluster/util.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.weightSrvRecords = exports.groupSrvRecords = exports.getUniqueHostnamesFromOptions = exports.normalizeNodeOptions = exports.nodeKeyToRedisOptions = exports.getNodeKey = void 0;
 const utils_1 = require("../utils");
 const net_1 = require("net");
 function getNodeKey(node) {

package/built/command.js

@@ -274,9 +274,7 @@ const msetArgumentTransformer = function (args) {
     }
     return args;
 };
-Command.setArgumentTransformer("mset", msetArgumentTransformer);
-Command.setArgumentTransformer("msetnx", msetArgumentTransformer);
-Command.setArgumentTransformer("hmset", function (args) {
+const hsetArgumentTransformer = function (args) {
     if (args.length === 2) {
         if (typeof Map !== "undefined" && args[1] instanceof Map) {
             return [args[0]].concat(utils_1.convertMapToArray(args[1]));
@@ -286,7 +284,11 @@ Command.setArgumentTransformer("hmset", function (args) {
         }
     }
     return args;
-});
+};
+Command.setArgumentTransformer("mset", msetArgumentTransformer);
+Command.setArgumentTransformer("msetnx", msetArgumentTransformer);
+Command.setArgumentTransformer("hset", hsetArgumentTransformer);
+Command.setArgumentTransformer("hmset", hsetArgumentTransformer);
 Command.setReplyTransformer("hgetall", function (result) {
     if (Array.isArray(result)) {
         const obj = {};
@@ -297,17 +299,6 @@ Command.setReplyTransformer("hgetall", function (result) {
     }
     return result;
 });
-Command.setArgumentTransformer("hset", function (args) {
-    if (args.length === 2) {
-        if (typeof Map !== "undefined" && args[1] instanceof Map) {
-            return [args[0]].concat(utils_1.convertMapToArray(args[1]));
-        }
-        if (typeof args[1] === "object" && args[1] !== null) {
-            return [args[0]].concat(utils_1.convertObjectToArray(args[1]));
-        }
-    }
-    return args;
-});
 class MixedBuffers {
     constructor() {
         this.length = 0;

package/built/connectors/SentinelConnector/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SentinelIterator = void 0;
 const net_1 = require("net");
 const utils_1 = require("../../utils");
 const tls_1 = require("tls");
@@ -78,6 +79,9 @@ class SentinelConnector extends AbstractConnector_1.default {
                     else {
                         this.stream = net_1.createConnection(resolved);
                     }
+                    this.stream.once("error", (err) => {
+                        this.firstError = err;
+                    });
                     this.sentinelIterator.reset(true);
                     resolve(this.stream);
                 }

package/built/connectors/StandaloneConnector.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isIIpcConnectionOptions = void 0;
 const net_1 = require("net");
 const tls_1 = require("tls");
 const utils_1 = require("../utils");
@@ -62,6 +63,9 @@ class StandaloneConnector extends AbstractConnector_1.default {
                     reject(err);
                     return;
                 }
+                this.stream.once("error", (err) => {
+                    this.firstError = err;
+                });
                 resolve(this.stream);
             });
         });

package/built/connectors/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SentinelConnector = exports.StandaloneConnector = void 0;
 const StandaloneConnector_1 = require("./StandaloneConnector");
 exports.StandaloneConnector = StandaloneConnector_1.default;
 const SentinelConnector_1 = require("./SentinelConnector");

package/built/errors/index.js

@@ -1,4 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.MaxRetriesPerRequestError = void 0;
 const MaxRetriesPerRequestError_1 = require("./MaxRetriesPerRequestError");
 exports.MaxRetriesPerRequestError = MaxRetriesPerRequestError_1.default;

package/built/index.js

@@ -1,21 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.print = exports.ReplyError = void 0;
 exports = module.exports = require("./redis").default;
 var redis_1 = require("./redis");
-exports.default = redis_1.default;
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return redis_1.default; } });
 var cluster_1 = require("./cluster");
-exports.Cluster = cluster_1.default;
+Object.defineProperty(exports, "Cluster", { enumerable: true, get: function () { return cluster_1.default; } });
 var command_1 = require("./command");
-exports.Command = command_1.default;
+Object.defineProperty(exports, "Command", { enumerable: true, get: function () { return command_1.default; } });
 var ScanStream_1 = require("./ScanStream");
-exports.ScanStream = ScanStream_1.default;
+Object.defineProperty(exports, "ScanStream", { enumerable: true, get: function () { return ScanStream_1.default; } });
 var pipeline_1 = require("./pipeline");
-exports.Pipeline = pipeline_1.default;
+Object.defineProperty(exports, "Pipeline", { enumerable: true, get: function () { return pipeline_1.default; } });
 var AbstractConnector_1 = require("./connectors/AbstractConnector");
-exports.AbstractConnector = AbstractConnector_1.default;
+Object.defineProperty(exports, "AbstractConnector", { enumerable: true, get: function () { return AbstractConnector_1.default; } });
 var SentinelConnector_1 = require("./connectors/SentinelConnector");
-exports.SentinelConnector = SentinelConnector_1.default;
-exports.SentinelIterator = SentinelConnector_1.SentinelIterator;
+Object.defineProperty(exports, "SentinelConnector", { enumerable: true, get: function () { return SentinelConnector_1.default; } });
+Object.defineProperty(exports, "SentinelIterator", { enumerable: true, get: function () { return SentinelConnector_1.SentinelIterator; } });
 // No TS typings
 exports.ReplyError = require("redis-errors").ReplyError;
 const PromiseContainer = require("./promiseContainer");

package/built/pipeline.js

@@ -265,11 +265,12 @@ Pipeline.prototype.exec = function (callback) {
             continue;
         }
         const script = this._shaToScript[item.args[0]];
-        if (!script || this.redis._addedScriptHashes[script.sha]) {
+        if (!script ||
+            this.redis._addedScriptHashes[script.sha] ||
+            scripts.includes(script)) {
             continue;
         }
         scripts.push(script);
-        this.redis._addedScriptHashes[script.sha] = true;
     }
     const _this = this;
     if (!scripts.length) {
@@ -279,7 +280,12 @@ Pipeline.prototype.exec = function (callback) {
     if (this.isCluster) {
         return pMap(scripts, (script) => _this.redis.script("load", script.lua), {
             concurrency: 10,
-        }).then(execPipeline);
+        }).then(function () {
+            for (let i = 0; i < scripts.length; i++) {
+                _this.redis._addedScriptHashes[scripts[i].sha] = true;
+            }
+            return execPipeline();
+        });
     }
     return this.redis
         .script("exists", scripts.map(({ sha }) => sha))
@@ -295,7 +301,12 @@ Pipeline.prototype.exec = function (callback) {
             return _this.redis.script("load", script.lua);
         }));
     })
-        .then(execPipeline);
+        .then(function () {
+        for (let i = 0; i < scripts.length; i++) {
+            _this.redis._addedScriptHashes[scripts[i].sha] = true;
+        }
+        return execPipeline();
+    });
     function execPipeline() {
         let data = "";
         let buffers;

package/built/promiseContainer.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.set = exports.get = exports.isPromise = void 0;
 function isPromise(obj) {
     return (!!obj &&
         (typeof obj === "object" || typeof obj === "function") &&

package/built/redis/RedisOptions.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_REDIS_OPTIONS = void 0;
 exports.DEFAULT_REDIS_OPTIONS = {
     // Connection
     port: 6379,

package/built/redis/event_handler.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.readyHandler = exports.errorHandler = exports.closeHandler = exports.connectHandler = void 0;
 const redis_errors_1 = require("redis-errors");
 const command_1 = require("../command");
 const errors_1 = require("../errors");

package/built/redis/index.js

@@ -320,11 +320,22 @@ Redis.prototype.connect = function (callback) {
                     });
                 }
             }
+            else if (stream.destroyed) {
+                const firstError = _this.connector.firstError;
+                if (firstError) {
+                    process.nextTick(() => {
+                        eventHandler.errorHandler(_this)(firstError);
+                    });
+                }
+                process.nextTick(eventHandler.closeHandler(_this));
+            }
             else {
                 process.nextTick(eventHandler.connectHandler(_this));
             }
-            stream.once("error", eventHandler.errorHandler(_this));
-            stream.once("close", eventHandler.closeHandler(_this));
+            if (!stream.destroyed) {
+                stream.once("error", eventHandler.errorHandler(_this));
+                stream.once("close", eventHandler.closeHandler(_this));
+            }
             if (options.noDelay) {
                 stream.setNoDelay(true);
             }

package/built/transaction.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.addTransactionSupport = void 0;
 const utils_1 = require("./utils");
 const standard_as_callback_1 = require("standard-as-callback");
 const pipeline_1 = require("./pipeline");

package/built/utils/debug.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.genRedactedString = exports.getStringValue = exports.MAX_ARGUMENT_LENGTH = void 0;
 const debug_1 = require("debug");
 const MAX_ARGUMENT_LENGTH = 200;
 exports.MAX_ARGUMENT_LENGTH = MAX_ARGUMENT_LENGTH;

package/built/utils/index.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.flatten = exports.noop = exports.defaults = exports.Debug = exports.zipMap = exports.CONNECTION_CLOSED_ERROR_MSG = exports.shuffle = exports.sample = exports.parseURL = exports.optimizeErrorStack = exports.toArg = exports.convertMapToArray = exports.convertObjectToArray = exports.timeout = exports.packObject = exports.isInt = exports.wrapMultiResult = exports.convertBufferToString = exports.bufferEqual = void 0;
 const url_1 = require("url");
 const lodash_1 = require("./lodash");
-exports.defaults = lodash_1.defaults;
-exports.noop = lodash_1.noop;
-exports.flatten = lodash_1.flatten;
+Object.defineProperty(exports, "defaults", { enumerable: true, get: function () { return lodash_1.defaults; } });
+Object.defineProperty(exports, "noop", { enumerable: true, get: function () { return lodash_1.noop; } });
+Object.defineProperty(exports, "flatten", { enumerable: true, get: function () { return lodash_1.flatten; } });
 const debug_1 = require("./debug");
 exports.Debug = debug_1.default;
 /**

package/built/utils/lodash.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.flatten = exports.defaults = exports.noop = void 0;
 const defaults = require("lodash.defaults");
 exports.defaults = defaults;
 const flatten = require("lodash.flatten");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ioredis",
-  "version": "4.23.1",
+  "version": "4.24.3",
   "description": "A robust, performance-focused and full-featured Redis client for Node.js.",
   "main": "built/index.js",
   "files": [
@@ -34,7 +34,7 @@
   },
   "dependencies": {
     "cluster-key-slot": "^1.1.0",
-    "debug": "^4.1.1",
+    "debug": "^4.3.1",
     "denque": "^1.1.0",
     "lodash.defaults": "^4.2.0",
     "lodash.flatten": "^4.4.0",
@@ -42,7 +42,7 @@
     "redis-commands": "1.7.0",
     "redis-errors": "^1.2.0",
     "redis-parser": "^3.0.0",
-    "standard-as-callback": "^2.0.1"
+    "standard-as-callback": "^2.1.0"
   },
   "devDependencies": {
     "@semantic-release/changelog": "^5.0.1",