ioredis 4.28.0 → 4.28.4

package/Changelog.md

@@ -1,3 +1,33 @@
+## [4.28.4](https://github.com/luin/ioredis/compare/v4.28.3...v4.28.4) (2022-02-02)
+
+
+### Bug Fixes
+
+* make sure timers is cleared on exit ([#1502](https://github.com/luin/ioredis/issues/1502)) ([cfb04a0](https://github.com/luin/ioredis/commit/cfb04a062b380bad5655b6f97b4259f328f1ee4a))
+
+## [4.28.3](https://github.com/luin/ioredis/compare/v4.28.2...v4.28.3) (2022-01-11)
+
+
+### Bug Fixes
+
+* fix exceptions on messages of client side cache ([#1479](https://github.com/luin/ioredis/issues/1479)) ([02adca4](https://github.com/luin/ioredis/commit/02adca4bc1cc50a232703d2b48ea41a18fa82c93))
+
+## [4.28.2](https://github.com/luin/ioredis/compare/v4.28.1...v4.28.2) (2021-12-01)
+
+
+### Bug Fixes
+
+* add Redis campaign ([#1475](https://github.com/luin/ioredis/issues/1475)) ([3f3d8e9](https://github.com/luin/ioredis/commit/3f3d8e9eb868f4e58bb63926d3b683d9892835f2))
+* fix a memory leak with autopipelining. ([#1470](https://github.com/luin/ioredis/issues/1470)) ([f5d8b73](https://github.com/luin/ioredis/commit/f5d8b73c747a0db5cb36e83e6fe022a19a544bd2))
+* unhandled Promise rejections in pipeline.exec [skip ci] ([#1466](https://github.com/luin/ioredis/issues/1466)) ([e5615da](https://github.com/luin/ioredis/commit/e5615da8786956df08a9b33b6cd4dd31e6eaa759))
+
+## [4.28.1](https://github.com/luin/ioredis/compare/v4.28.0...v4.28.1) (2021-11-23)
+
+
+### Bug Fixes
+
+* handle possible unhandled promise rejection with autopipelining+cluster ([#1467](https://github.com/luin/ioredis/issues/1467)) ([6ad285a](https://github.com/luin/ioredis/commit/6ad285a59f4a46d5452a799371dfbd69a07ac9f9)), closes [#1466](https://github.com/luin/ioredis/issues/1466)
+
 # [4.28.0](https://github.com/luin/ioredis/compare/v4.27.11...v4.28.0) (2021-10-13)
 
 

package/README.md

@@ -1,6 +1,7 @@
 [![ioredis](https://cdn.jsdelivr.net/gh/luin/ioredis@b5e8c74/logo.svg)](https://github.com/luin/ioredis)
 
 [![Build Status](https://travis-ci.org/luin/ioredis.svg?branch=master)](https://travis-ci.org/luin/ioredis)
+[![Build Status](https://github.com/luin/ioredis/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/luin/ioredis/actions/workflows/main.yml?query=branch%3Amaster)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
 [![Join the chat at https://gitter.im/luin/ioredis](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/luin/ioredis?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
@@ -42,11 +43,34 @@ used in the world's biggest online commerce company [Alibaba](http://www.alibaba
 - [Error Handling](#error-handling)
 
 <hr>
-<a href="http://bit.ly/medis-macos"><img align="right" src="resources/medis.png" alt="Download on the App Store"></a>
 
-### [AD] Medis: Redis GUI for OS X
+# Sponsors
 
-Looking for a Redis GUI manager for OS X, Windows and Linux? Here's [Medis](http://bit.ly/medis-macos)!
+### Upstash: Serverless Database for Redis
+
+<a href="https://upstash.com/?utm_source=ioredis"><img align="right" width="320" src="resources/upstash.png" alt="Upstash"></a>
+
+Upstash is a Serverless Database with Redis/REST API and durable storage. It is the perfect database for your applications thanks to its per request pricing and low latency data.
+
+[Start for free in 30 seconds!](https://upstash.com/?utm_source=ioredis)
+
+<br clear="both"/>
+
+### Redis Cloud: From the creators of Redis
+
+<a href="https://redis.info/ioredis-tryfree"><img align="right" width="320" src="resources/redis-tryfree.png" alt="redis-tryfree"></a>
+
+Experience the best Redis. For a limited time, sign up to Redis Enterprise Cloud and use **MATRIX200** to get $200 credits, and a chance to win a Tesla!
+
+[Sign Up Now!](https://redis.info/ioredis-tryfree)
+
+<br clear="both"/>
+
+### Medis: Redis GUI for macOS
+
+<a href="https://getmedis.com/"><img align="right" width="404" src="resources/medis.png" alt="Download on the App Store"></a>
+
+Looking for a Redis GUI for macOS, Windows and Linux? Here's [Medis](https://getmedis.com/)!
 
 Medis is an open-sourced, beautiful, easy-to-use Redis GUI management application.
 
@@ -55,14 +79,11 @@ Medis starts with all the basic features you need:
 - Keys viewing/editing
 - SSH Tunnel for connecting with remote servers
 - Terminal for executing custom commands
-- JSON/MessagePack format viewing/editing and built-in highlighting/validator
 - And other awesome features...
 
-[Medis is open sourced on GitHub](https://github.com/luin/medis)
-
-### [AD] Kuber: Kubernetes Dashboard for iOS
+[Medis 1 is open sourced on GitHub](https://github.com/luin/medis)
 
-<a href="http://bit.ly/kuber-ios"><img src="resources/kuber.png" alt="Download on the App Store"></a>
+<br clear="both"/>
 
 <hr>
 
@@ -144,7 +165,7 @@ new Redis(
 );
 ```
 
-See [API Documentation](API.md#new_Redis) for all available options.
+See [API Documentation](API.md#new-redisport-host-options) for all available options.
 
 ## Pub/Sub
 
@@ -863,6 +884,7 @@ The arguments passed to the constructor are different from the ones you use to c
 - `sentinels` are a list of sentinels to connect to. The list does not need to enumerate all your sentinel instances, but a few so that if one is down the client will try the next one.
 - `role` (optional) with a value of `slave` will return a random slave from the Sentinel group.
 - `preferredSlaves` (optional) can be used to prefer a particular slave or set of slaves based on priority. It accepts a function or array.
+- `enableTLSForSentinelMode` (optional) set to true if connecting to sentinel instances that are encrypted
 
 ioredis **guarantees** that the node you connected to is always a master even after a failover. When a failover happens, instead of trying to reconnect to the failed node (which will be demoted to slave when it's available again), ioredis will ask sentinels for the new master node and connect to it. All commands sent during the failover are queued and will be executed when the new connection is established so that none of the commands will be lost.
 

package/built/DataHandler.js

@@ -77,7 +77,7 @@ class DataHandler {
             case "message":
                 if (this.redis.listeners("message").length > 0) {
                     // Check if there're listeners to avoid unnecessary `toString()`.
-                    this.redis.emit("message", reply[1].toString(), reply[2].toString());
+                    this.redis.emit("message", reply[1].toString(), reply[2] ? reply[2].toString() : '');
                 }
                 this.redis.emit("messageBuffer", reply[1], reply[2]);
                 break;

package/built/autoPipelining.js

@@ -42,6 +42,10 @@ function executeAutoPipeline(client, slotKey) {
     const pipeline = client._autoPipelines.get(slotKey);
     client._autoPipelines.delete(slotKey);
     const callbacks = pipeline[exports.kCallbacks];
+    // Stop keeping a reference to callbacks immediately after the callbacks stop being used.
+    // This allows the GC to reclaim objects referenced by callbacks, especially with 16384 slots
+    // in Redis.Cluster
+    pipeline[exports.kCallbacks] = null;
     // Perform the call
     pipeline.exec(function (err, results) {
         client._runningAutoPipelines.delete(slotKey);
@@ -102,15 +106,15 @@ function executeWithAutoPipelining(client, functionName, commandName, args, call
     if (client.isCluster && !client.slots.length) {
         if (client.status === "wait")
             client.connect().catch(lodash_1.noop);
-        return new CustomPromise(function (resolve, reject) {
+        return standard_as_callback_1.default(new CustomPromise(function (resolve, reject) {
             client.delayUntilReady((err) => {
                 if (err) {
                     reject(err);
                     return;
                 }
-                executeWithAutoPipelining(client, functionName, commandName, args, callback).then(resolve, reject);
+                executeWithAutoPipelining(client, functionName, commandName, args, null).then(resolve, reject);
             });
-        });
+        }), callback);
     }
     // If we have slot information, we can improve routing by grouping slots served by the same subset of nodes
     // Note that the first value in args may be a (possibly empty) array.
@@ -139,7 +143,7 @@ function executeWithAutoPipelining(client, functionName, commandName, args, call
         */
         setImmediate(executeAutoPipeline, client, slotKey);
     }
-    // Create the promise which will execute the
+    // Create the promise which will execute the command in the pipeline.
     const autoPipelinePromise = new CustomPromise(function (resolve, reject) {
         pipeline[exports.kCallbacks].push(function (err, value) {
             if (err) {

package/built/cluster/index.js

@@ -100,6 +100,12 @@ class Cluster extends events_1.EventEmitter {
             this.slotsTimer = null;
         }
     }
+    clearAddedScriptHashesCleanInterval() {
+        if (this._addedScriptHashesCleanInterval) {
+            clearInterval(this._addedScriptHashesCleanInterval);
+            this._addedScriptHashesCleanInterval = null;
+        }
+    }
     resetNodesRefreshInterval() {
         if (this.slotsTimer) {
             return;
@@ -130,7 +136,7 @@ class Cluster extends events_1.EventEmitter {
                 return;
             }
             // Make sure only one timer is active at a time
-            clearInterval(this._addedScriptHashesCleanInterval);
+            this.clearAddedScriptHashesCleanInterval();
             // Start the script cache cleaning
             this._addedScriptHashesCleanInterval = setInterval(() => {
                 this._addedScriptHashes = {};
@@ -215,6 +221,7 @@ class Cluster extends events_1.EventEmitter {
         if (reason) {
             debug("closed because %s", reason);
         }
+        this.clearAddedScriptHashesCleanInterval();
         let retryDelay;
         if (!this.manuallyClosing &&
             typeof this.options.clusterRetryStrategy === "function") {
@@ -244,8 +251,7 @@ class Cluster extends events_1.EventEmitter {
     disconnect(reconnect = false) {
         const status = this.status;
         this.setStatus("disconnecting");
-        clearInterval(this._addedScriptHashesCleanInterval);
-        this._addedScriptHashesCleanInterval = null;
+        this.clearAddedScriptHashesCleanInterval();
         if (!reconnect) {
             this.manuallyClosing = true;
         }
@@ -274,8 +280,7 @@ class Cluster extends events_1.EventEmitter {
     quit(callback) {
         const status = this.status;
         this.setStatus("disconnecting");
-        clearInterval(this._addedScriptHashesCleanInterval);
-        this._addedScriptHashesCleanInterval = null;
+        this.clearAddedScriptHashesCleanInterval();
         this.manuallyClosing = true;
         if (this.reconnectTimeout) {
             clearTimeout(this.reconnectTimeout);
@@ -495,7 +500,8 @@ class Cluster extends events_1.EventEmitter {
                         else {
                             _this.slots[slot] = [key];
                         }
-                        _this._groupsBySlot[slot] = _this._groupsIds[_this.slots[slot].join(';')];
+                        _this._groupsBySlot[slot] =
+                            _this._groupsIds[_this.slots[slot].join(";")];
                         _this.connectionPool.findOrCreate(_this.natMapper(key));
                         tryConnection();
                         debug("refreshing slot caches... (triggered by MOVED error)");
@@ -702,7 +708,7 @@ class Cluster extends events_1.EventEmitter {
             this._groupsIds = Object.create(null);
             let j = 0;
             for (let i = 0; i < 16384; i++) {
-                const target = (this.slots[i] || []).join(';');
+                const target = (this.slots[i] || []).join(";");
                 if (!target.length) {
                     this._groupsBySlot[i] = undefined;
                     continue;

package/built/pipeline.js

@@ -213,6 +213,12 @@ Pipeline.prototype.execBuffer = util_1.deprecate(function () {
     }
     return execBuffer.apply(this, arguments);
 }, "Pipeline#execBuffer: Use Pipeline#exec instead");
+// NOTE: To avoid an unhandled promise rejection, this will unconditionally always return this.promise,
+// which always has the rejection handled by standard-as-callback
+// adding the provided rejection callback.
+//
+// If a different promise instance were returned, that promise would cause its own unhandled promise rejection
+// errors, even if that promise unconditionally resolved to **the resolved value of** this.promise.
 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) {
@@ -286,16 +292,18 @@ Pipeline.prototype.exec = function (callback) {
     }
     // In cluster mode, always load scripts before running the pipeline
     if (this.isCluster) {
-        return pMap(scripts, (script) => _this.redis.script("load", script.lua), {
+        pMap(scripts, (script) => _this.redis.script("load", script.lua), {
             concurrency: 10,
-        }).then(function () {
+        })
+            .then(function () {
             for (let i = 0; i < scripts.length; i++) {
                 _this.redis._addedScriptHashes[scripts[i].sha] = true;
             }
-            return execPipeline();
-        });
+        })
+            .then(execPipeline, this.reject);
+        return this.promise;
     }
-    return this.redis
+    this.redis
         .script("exists", scripts.map(({ sha }) => sha))
         .then(function (results) {
         const pending = [];
@@ -313,8 +321,9 @@ Pipeline.prototype.exec = function (callback) {
         for (let i = 0; i < scripts.length; i++) {
             _this.redis._addedScriptHashes[scripts[i].sha] = true;
         }
-        return execPipeline();
-    });
+    })
+        .then(execPipeline, this.reject);
+    return this.promise;
     function execPipeline() {
         let data = "";
         let buffers;

package/built/redis/event_handler.js

@@ -144,6 +144,7 @@ function closeHandler(self) {
         if (self.offlineQueue.length) {
             abortTransactionFragments(self.offlineQueue);
         }
+        self.clearAddedScriptHashesCleanInterval();
         if (self.manuallyClosing) {
             self.manuallyClosing = false;
             debug("skip reconnecting since the connection is manually closed.");

package/built/redis/index.js

@@ -243,6 +243,12 @@ Redis.prototype.setStatus = function (status, arg) {
     this.status = status;
     process.nextTick(this.emit.bind(this, status, arg));
 };
+Redis.prototype.clearAddedScriptHashesCleanInterval = function () {
+    if (this._addedScriptHashesCleanInterval) {
+        clearInterval(this._addedScriptHashesCleanInterval);
+        this._addedScriptHashesCleanInterval = null;
+    }
+};
 /**
  * Create a connection to Redis.
  * This method will be invoked automatically when creating a new Redis instance
@@ -264,7 +270,7 @@ Redis.prototype.connect = function (callback) {
             return;
         }
         // Make sure only one timer is active at a time
-        clearInterval(this._addedScriptHashesCleanInterval);
+        this.clearAddedScriptHashesCleanInterval();
         // Start the script cache cleaning
         this._addedScriptHashesCleanInterval = setInterval(() => {
             this._addedScriptHashes = {};
@@ -372,8 +378,7 @@ Redis.prototype.connect = function (callback) {
  * @public
  */
 Redis.prototype.disconnect = function (reconnect) {
-    clearInterval(this._addedScriptHashesCleanInterval);
-    this._addedScriptHashesCleanInterval = null;
+    this.clearAddedScriptHashesCleanInterval();
     if (!reconnect) {
         this.manuallyClosing = true;
     }
@@ -637,8 +642,7 @@ Redis.prototype.sendCommand = function (command, stream) {
         command.setTimeout(this.options.commandTimeout);
     }
     if (command.name === "quit") {
-        clearInterval(this._addedScriptHashesCleanInterval);
-        this._addedScriptHashesCleanInterval = null;
+        this.clearAddedScriptHashesCleanInterval();
     }
     let writable = this.status === "ready" ||
         (!stream &&

package/built/utils/index.js

@@ -97,7 +97,7 @@ function wrapMultiResult(arr) {
 }
 exports.wrapMultiResult = wrapMultiResult;
 /**
- * Detect the argument is a int
+ * Detect if the argument is a int
  *
  * @param {string} value
  * @return {boolean} Whether the value is a int
@@ -174,7 +174,7 @@ exports.timeout = timeout;
  */
 function convertObjectToArray(obj) {
     const result = [];
-    const keys = Object.keys(obj);
+    const keys = Object.keys(obj); // Object.entries requires node 7+
     for (let i = 0, l = keys.length; i < l; i++) {
         result.push(keys[i], obj[keys[i]]);
     }
@@ -188,7 +188,7 @@ exports.convertObjectToArray = convertObjectToArray;
  * @return {array}
  * @example
  * ```js
- * > convertObjectToArray(new Map([[1, '2']]))
+ * > convertMapToArray(new Map([[1, '2']]))
  * [1, '2']
  * ```
  */

package/package.json

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