ioredis 4.27.6 → 4.27.10

package/Changelog.md

@@ -1,3 +1,32 @@
+## [4.27.10](https://github.com/luin/ioredis/compare/v4.27.9...v4.27.10) (2021-10-04)
+
+
+### Bug Fixes
+
+* **cluster:** lazyConnect with pipeline ([#1408](https://github.com/luin/ioredis/issues/1408)) ([b798107](https://github.com/luin/ioredis/commit/b798107e4123d0027ef1bdb3319cd00516221f3b))
+
+## [4.27.9](https://github.com/luin/ioredis/compare/v4.27.8...v4.27.9) (2021-08-30)
+
+
+### Bug Fixes
+
+* Fix undefined property warning in executeAutoPipeline ([#1425](https://github.com/luin/ioredis/issues/1425)) ([f898672](https://github.com/luin/ioredis/commit/f898672a29753774eeb6e166c28ed6f548533517))
+* improve proto checking for hgetall [skip ci] ([#1418](https://github.com/luin/ioredis/issues/1418)) ([cba83cb](https://github.com/luin/ioredis/commit/cba83cba2dba25e59ad87c85d740f15f78e45e14))
+
+## [4.27.8](https://github.com/luin/ioredis/compare/v4.27.7...v4.27.8) (2021-08-18)
+
+
+### Bug Fixes
+
+* handle malicious keys for hgetall ([#1416](https://github.com/luin/ioredis/issues/1416)) ([7d73b9d](https://github.com/luin/ioredis/commit/7d73b9d07b52ec077f235292aa15c7aca203bba9)), closes [#1267](https://github.com/luin/ioredis/issues/1267)
+
+## [4.27.7](https://github.com/luin/ioredis/compare/v4.27.6...v4.27.7) (2021-08-01)
+
+
+### Bug Fixes
+
+* **cluster:** fix autopipeline with keyPrefix or arg array ([#1391](https://github.com/luin/ioredis/issues/1391)) ([d7477aa](https://github.com/luin/ioredis/commit/d7477aa5853388b51037210542372131919ddfb2)), closes [#1264](https://github.com/luin/ioredis/issues/1264) [#1248](https://github.com/luin/ioredis/issues/1248) [#1392](https://github.com/luin/ioredis/issues/1392)
+
 ## [4.27.6](https://github.com/luin/ioredis/compare/v4.27.5...v4.27.6) (2021-06-13)
 
 

package/README.md

@@ -578,7 +578,7 @@ redis.get("k3", (err, result) => {
 });
 ```
 
-Another useful example of a reply transformer is one that changes `hgetall` to return array of arrays instead of objects which avoids a unwanted conversation of hash keys to strings when dealing with binary hash keys:
+Another useful example of a reply transformer is one that changes `hgetall` to return array of arrays instead of objects which avoids an unwanted conversation of hash keys to strings when dealing with binary hash keys:
 
 ```javascript
 Redis.Command.setReplyTransformer("hgetall", (result) => {
@@ -755,7 +755,7 @@ const redis = new Redis({
 
 This feature is useful when using Amazon ElastiCache instances with Auto-failover disabled. On these instances, test your `reconnectOnError` handler by manually promoting the replica node to the primary role using the AWS console. The following writes fail with the error `READONLY`. Using `reconnectOnError`, we can force the connection to reconnect on this error in order to connect to the new master. Furthermore, if the `reconnectOnError` returns `2`, ioredis will resend the failed command after reconnecting.
 
-On ElastiCache insances with Auto-failover enabled, `reconnectOnError` does not execute. Instead of returning a Redis error, AWS closes all connections to the master endpoint until the new primary node is ready. ioredis reconnects via `retryStrategy` instead of `reconnectOnError` after about a minute. On ElastiCache insances with Auto-failover enabled, test failover events with the `Failover primary` option in the AWS console.
+On ElastiCache instances with Auto-failover enabled, `reconnectOnError` does not execute. Instead of returning a Redis error, AWS closes all connections to the master endpoint until the new primary node is ready. ioredis reconnects via `retryStrategy` instead of `reconnectOnError` after about a minute. On ElastiCache instances with Auto-failover enabled, test failover events with the `Failover primary` option in the AWS console.
 
 ## Connection Events
 

package/built/autoPipelining.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.executeWithAutoPipelining = exports.getFirstValueInFlattenedArray = exports.shouldUseAutoPipelining = exports.notAllowedAutoPipelineCommands = exports.kCallbacks = exports.kExec = void 0;
 const PromiseContainer = require("./promiseContainer");
+const lodash_1 = require("./utils/lodash");
 const calculateSlot = require("cluster-key-slot");
 const standard_as_callback_1 = require("standard-as-callback");
 exports.kExec = Symbol("exec");
@@ -26,6 +28,16 @@ function executeAutoPipeline(client, slotKey) {
     if (client._runningAutoPipelines.has(slotKey)) {
         return;
     }
+    if (!client._autoPipelines.has(slotKey)) {
+        /*
+          Rare edge case. Somehow, something has deleted this running autopipeline in an immediate
+          call to executeAutoPipeline.
+         
+          Maybe the callback in the pipeline.exec is sometimes called in the same tick,
+          e.g. if redis is disconnected?
+        */
+        return;
+    }
     client._runningAutoPipelines.add(slotKey);
     // Get the pipeline and immediately delete it so that new commands are queued on a new pipeline
     const pipeline = client._autoPipelines.get(slotKey);
@@ -62,10 +74,35 @@ function shouldUseAutoPipelining(client, functionName, commandName) {
         !client.options.autoPipeliningIgnoredCommands.includes(commandName));
 }
 exports.shouldUseAutoPipelining = shouldUseAutoPipelining;
+/**
+ * @private
+ */
+function getFirstValueInFlattenedArray(args) {
+    for (let i = 0; i < args.length; i++) {
+        const arg = args[i];
+        if (typeof arg === "string") {
+            return arg;
+        }
+        else if (Array.isArray(arg) || lodash_1.isArguments(arg)) {
+            if (arg.length === 0) {
+                continue;
+            }
+            return arg[0];
+        }
+        const flattened = lodash_1.flatten([arg]);
+        if (flattened.length > 0) {
+            return flattened[0];
+        }
+    }
+    return undefined;
+}
+exports.getFirstValueInFlattenedArray = getFirstValueInFlattenedArray;
 function executeWithAutoPipelining(client, functionName, commandName, args, callback) {
     const CustomPromise = PromiseContainer.get();
     // On cluster mode let's wait for slots to be available
     if (client.isCluster && !client.slots.length) {
+        if (client.status === "wait")
+            client.connect().catch(lodash_1.noop);
         return new CustomPromise(function (resolve, reject) {
             client.delayUntilReady((err) => {
                 if (err) {
@@ -77,7 +114,12 @@ function executeWithAutoPipelining(client, functionName, commandName, args, call
         });
     }
     // If we have slot information, we can improve routing by grouping slots served by the same subset of nodes
-    const slotKey = client.isCluster ? client.slots[calculateSlot(args[0])].join(",") : 'main';
+    // Note that the first value in args may be a (possibly empty) array.
+    // ioredis will only flatten one level of the array, in the Command constructor.
+    const prefix = client.options.keyPrefix || "";
+    const slotKey = client.isCluster
+        ? client.slots[calculateSlot(`${prefix}${getFirstValueInFlattenedArray(args)}`)].join(",")
+        : "main";
     if (!client._autoPipelines.has(slotKey)) {
         const pipeline = client.pipeline();
         pipeline[exports.kExec] = false;

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),

package/built/cluster/util.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConnectionName = 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

@@ -313,7 +313,21 @@ Command.setReplyTransformer("hgetall", function (result) {
     if (Array.isArray(result)) {
         const obj = {};
         for (let i = 0; i < result.length; i += 2) {
-            obj[result[i]] = result[i + 1];
+            const key = result[i];
+            const value = result[i + 1];
+            if (key in obj) {
+                // can only be truthy if the property is special somehow, like '__proto__' or 'constructor'
+                // https://github.com/luin/ioredis/issues/1267
+                Object.defineProperty(obj, key, {
+                    value,
+                    configurable: true,
+                    enumerable: true,
+                    writable: true,
+                });
+            }
+            else {
+                obj[key] = value;
+            }
         }
         return obj;
     }

package/built/connectors/SentinelConnector/FailoverDetector.js

@@ -9,6 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.FailoverDetector = void 0;
 const utils_1 = require("../../utils");
 const debug = utils_1.Debug("FailoverDetector");
 const CHANNEL_NAME = "+switch-master";

package/built/connectors/SentinelConnector/index.js

@@ -9,6 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 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");

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");

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

@@ -8,6 +8,7 @@ const calculateSlot = require("cluster-key-slot");
 const pMap = require("p-map");
 const PromiseContainer = require("./promiseContainer");
 const commander_1 = require("./commander");
+const utils_1 = require("./utils");
 /*
   This function derives from the cluster-key-slot implementation.
   Instead of checking that all keys have the same slot, it checks that all slots are served by the same set of nodes.
@@ -140,7 +141,8 @@ Pipeline.prototype.fillResult = function (value, position) {
                 moved: function (slot, key) {
                     _this.preferKey = key;
                     _this.redis.slots[errv[1]] = [key];
-                    _this.redis._groupsBySlot[errv[1]] = _this.redis._groupsIds[_this.redis.slots[errv[1]].join(";")];
+                    _this.redis._groupsBySlot[errv[1]] =
+                        _this.redis._groupsIds[_this.redis.slots[errv[1]].join(";")];
                     _this.redis.refreshSlotsCache();
                     _this.exec();
                 },
@@ -214,6 +216,8 @@ Pipeline.prototype.execBuffer = util_1.deprecate(function () {
 Pipeline.prototype.exec = function (callback) {
     // Wait for the cluster to be connected, since we need nodes information before continuing
     if (this.isCluster && !this.redis.slots.length) {
+        if (this.redis.status === "wait")
+            this.redis.connect().catch(utils_1.noop);
         this.redis.delayUntilReady((err) => {
             if (err) {
                 callback(err);

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/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");
@@ -29,6 +30,8 @@ function addTransactionSupport(redis) {
         pipeline.exec = function (callback) {
             // Wait for the cluster to be connected, since we need nodes information before continuing
             if (this.isCluster && !this.redis.slots.length) {
+                if (this.redis.status === "wait")
+                    this.redis.connect().catch(utils_1.noop);
                 return standard_as_callback_1.default(new Promise((resolve, reject) => {
                     this.redis.delayUntilReady((err) => {
                         if (err) {

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,8 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isArguments = exports.flatten = exports.defaults = exports.noop = void 0;
 const defaults = require("lodash.defaults");
 exports.defaults = defaults;
 const flatten = require("lodash.flatten");
 exports.flatten = flatten;
+const isArguments = require("lodash.isarguments");
+exports.isArguments = isArguments;
 function noop() { }
 exports.noop = noop;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ioredis",
-  "version": "4.27.6",
+  "version": "4.27.10",
   "description": "A robust, performance-focused and full-featured Redis client for Node.js.",
   "main": "built/index.js",
   "files": [
@@ -38,6 +38,7 @@
     "denque": "^1.1.0",
     "lodash.defaults": "^4.2.0",
     "lodash.flatten": "^4.4.0",
+    "lodash.isarguments": "^3.1.0",
     "p-map": "^2.1.0",
     "redis-commands": "1.7.0",
     "redis-errors": "^1.2.0",
@@ -53,6 +54,7 @@
     "@types/debug": "^4.1.5",
     "@types/lodash.defaults": "^4.2.6",
     "@types/lodash.flatten": "^4.4.6",
+    "@types/lodash.isarguments": "^3.1.6",
     "@types/mocha": "^7.0.2",
     "@types/node": "^13.11.0",
     "@types/redis-errors": "1.2.0",