ioredis 5.3.1 → 5.4.0

package/README.md

@@ -1,14 +1,18 @@
-[![ioredis](https://cdn.jsdelivr.net/gh/luin/ioredis@b5e8c74/logo.svg)](https://github.com/luin/ioredis)
+[![ioredis](https://cdn.jsdelivr.net/gh/redis/ioredis@b5e8c74/logo.svg)](https://github.com/redis/ioredis)
 
-[![Build Status](https://github.com/luin/ioredis/actions/workflows/release.yml/badge.svg?branch=main)](https://github.com/luin/ioredis/actions/workflows/release.yml?query=branch%3Amain)
+[![Build Status](https://github.com/redis/ioredis/actions/workflows/release.yml/badge.svg?branch=main)](https://github.com/redis/ioredis/actions/workflows/release.yml?query=branch%3Amain)
 [![Coverage Status](https://coveralls.io/repos/github/luin/ioredis/badge.svg?branch=main)](https://coveralls.io/github/luin/ioredis?branch=main)
-[![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/)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
+[![Discord](https://img.shields.io/discord/697882427875393627.svg?style=social&logo=discord)](https://discord.gg/redis)
+[![Twitch](https://img.shields.io/twitch/status/redisinc?style=social)](https://www.twitch.tv/redisinc)
+[![YouTube](https://img.shields.io/youtube/channel/views/UCD78lHSwYqMlyetR0_P4Vig?style=social)](https://www.youtube.com/redisinc)
+[![Twitter](https://img.shields.io/twitter/follow/redisinc?style=social)](https://twitter.com/redisinc)
+
 A robust, performance-focused and full-featured [Redis](http://redis.io) client for [Node.js](https://nodejs.org).
 
-Supports Redis >= 2.6.12 and (Node.js >= 12.22.0). Completely compatible with Redis 7.x.
+Supports Redis >= 2.6.12. Completely compatible with Redis 7.x.
 
 # Features
 
@@ -20,9 +24,9 @@ used in the world's biggest online commerce company [Alibaba](http://www.alibaba
 2. Delightful API 😄. It works with Node callbacks and Native promises.
 3. Transformation of command arguments and replies.
 4. Transparent key prefixing.
-5. Abstraction for Lua scripting, allowing you to [define custom commands](https://github.com/luin/ioredis#lua-scripting).
-6. Supports [binary data](https://github.com/luin/ioredis#handle-binary-data).
-7. Supports [TLS](https://github.com/luin/ioredis#tls-options) 🔒.
+5. Abstraction for Lua scripting, allowing you to [define custom commands](https://github.com/redis/ioredis#lua-scripting).
+6. Supports [binary data](https://github.com/redis/ioredis#handle-binary-data).
+7. Supports [TLS](https://github.com/redis/ioredis#tls-options) 🔒.
 8. Supports offline queue and ready checking.
 9. Supports ES6 types, such as `Map` and `Set`.
 10. Supports GEO commands 📍.
@@ -44,46 +48,12 @@ used in the world's biggest online commerce company [Alibaba](http://www.alibaba
 
 Refer to [CHANGELOG.md](CHANGELOG.md) for features and bug fixes introduced in v5.
 
-🚀 [Upgrading from v4 to v5](https://github.com/luin/ioredis/wiki/Upgrading-from-v4-to-v5)
+🚀 [Upgrading from v4 to v5](https://github.com/redis/ioredis/wiki/Upgrading-from-v4-to-v5)
 
 # Links
 
-- [API Documentation](https://luin.github.io/ioredis/) ([Redis](https://luin.github.io/ioredis/classes/Redis.html), [Cluster](https://luin.github.io/ioredis/classes/Cluster.html))
+- [API Documentation](https://redis.github.io/ioredis/) ([Redis](https://redis.github.io/ioredis/classes/Redis.html), [Cluster](https://redis.github.io/ioredis/classes/Cluster.html))
 - [Changelog](CHANGELOG.md)
-- [Migrating from node_redis](https://github.com/luin/ioredis/wiki/Migrating-from-node_redis)
-
-<hr>
-
-# Sponsors
-
-### 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"/>
-
-### 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.
-
-Medis starts with all the basic features you need:
-
-- Keys viewing/editing
-- SSH Tunnel for connecting with remote servers
-- Terminal for executing custom commands
-- And other awesome features...
-
-[Medis 1 is open sourced on GitHub](https://github.com/luin/medis)
-
-<br clear="both"/>
 
 <hr>
 
@@ -156,7 +126,7 @@ See the `examples/` folder for more examples. For example:
 - [Streams](examples/stream.js)
 - [Redis Modules](examples/module.js) e.g. RedisJSON
 
-All Redis commands are supported. See [the documentation](https://luin.github.io/ioredis/classes/Redis.html) for details.
+All Redis commands are supported. See [the documentation](https://redis.github.io/ioredis/classes/Redis.html) for details.
 
 ## Connect to Redis
 
@@ -188,7 +158,7 @@ new Redis("redis://:authpassword@127.0.0.1:6380/4");
 new Redis("redis://username:authpassword@127.0.0.1:6380/4");
 ```
 
-See [API Documentation](https://luin.github.io/ioredis/index.html#RedisOptions) for all available options.
+See [API Documentation](https://redis.github.io/ioredis/index.html#RedisOptions) for all available options.
 
 ## Pub/Sub
 
@@ -302,6 +272,16 @@ async function listenForMessage(lastId = "$") {
 listenForMessage();
 ```
 
+## Expiration
+
+Redis can set a timeout to expire your key, after the timeout has expired the key will be automatically deleted. (You can find the [official Expire documentation](https://redis.io/commands/expire/) to understand better the different parameters you can use), to set your key to expire in 60 seconds, we will have the following code:
+
+```javascript
+redis.set("key", "data", "EX", 60);
+// Equivalent to redis command "SET key data EX 60", because on ioredis set method,
+// all arguments are passed directly to the redis server.
+```
+
 ## Handle Binary Data
 
 Binary data support is out of the box. Pass buffers to send binary data:
@@ -559,8 +539,8 @@ This feature allows you to specify a string that will automatically be prepended
 to all the keys in a command, which makes it easier to manage your key
 namespaces.
 
-**Warning** This feature won't apply to commands like [KEYS](http://redis.io/commands/KEYS) and [SCAN](http://redis.io/commands/scan) that take patterns rather than actual keys([#239](https://github.com/luin/ioredis/issues/239)),
-and this feature also won't apply to the replies of commands even if they are key names ([#325](https://github.com/luin/ioredis/issues/325)).
+**Warning** This feature won't apply to commands like [KEYS](http://redis.io/commands/KEYS) and [SCAN](http://redis.io/commands/scan) that take patterns rather than actual keys([#239](https://github.com/redis/ioredis/issues/239)),
+and this feature also won't apply to the replies of commands even if they are key names ([#325](https://github.com/redis/ioredis/issues/325)).
 
 ```javascript
 const fooRedis = new Redis({ keyPrefix: "foo:" });
@@ -884,6 +864,15 @@ Alternatively, specify the connection through a [`rediss://` URL](https://www.ia
 const redis = new Redis("rediss://redis.my-service.com");
 ```
 
+If you do not want to use a connection string, you can also specify an empty `tls: {}` object:
+
+```javascript
+const redis = new Redis({
+  host: "redis.my-service.com",
+  tls: {},
+});
+```
+
 ### TLS Profiles
 
 > **Warning**
@@ -1412,19 +1401,11 @@ I'm happy to receive bug reports, fixes, documentation enhancements, and any oth
 
 And since I'm not a native English speaker, if you find any grammar mistakes in the documentation, please also let me know. :)
 
-# Become a Sponsor
-
-Open source is hard and time-consuming. If you want to invest in ioredis's future you can become a sponsor and make us spend more time on this library's improvements and new features.
-
-<a href="https://opencollective.com/ioredis"><img src="https://opencollective.com/ioredis/tiers/sponsor.svg?avatarHeight=36"></a>
-
-Thank you for using ioredis :-)
-
 # Contributors
 
 This project exists thanks to all the people who contribute:
 
-<a href="https://github.com/luin/ioredis/graphs/contributors"><img src="https://opencollective.com/ioredis/contributors.svg?width=890&showBtn=false" /></a>
+<a href="https://github.com/redis/ioredis/graphs/contributors"><img src="https://opencollective.com/ioredis/contributors.svg?width=890&showBtn=false" /></a>
 
 # License
 

package/built/Redis.d.ts

@@ -63,6 +63,7 @@ declare class Redis extends Commander implements DataHandledable {
     private connectionEpoch;
     private retryAttempts;
     private manuallyClosing;
+    private socketTimeoutTimer;
     private _autoPipelines;
     private _runningAutoPipelines;
     constructor(port: number, host: string, options: RedisOptions);
@@ -159,6 +160,7 @@ declare class Redis extends Commander implements DataHandledable {
      * @ignore
      */
     sendCommand(command: Command, stream?: WriteableStream): unknown;
+    private setSocketTimeout;
     scanStream(options?: ScanStreamOptions): ScanStream;
     scanBufferStream(options?: ScanStreamOptions): ScanStream;
     sscanStream(key: string, options?: ScanStreamOptions): ScanStream;
@@ -207,6 +209,20 @@ declare class Redis extends Commander implements DataHandledable {
     private _readyCheck;
 }
 interface Redis extends EventEmitter {
+    on(event: "message", cb: (channel: string, message: string) => void): this;
+    once(event: "message", cb: (channel: string, message: string) => void): this;
+    on(event: "messageBuffer", cb: (channel: Buffer, message: Buffer) => void): this;
+    once(event: "messageBuffer", cb: (channel: Buffer, message: Buffer) => void): this;
+    on(event: "pmessage", cb: (pattern: string, channel: string, message: string) => void): this;
+    once(event: "pmessage", cb: (pattern: string, channel: string, message: string) => void): this;
+    on(event: "pmessageBuffer", cb: (pattern: string, channel: Buffer, message: Buffer) => void): this;
+    once(event: "pmessageBuffer", cb: (pattern: string, channel: Buffer, message: Buffer) => void): this;
+    on(event: "error", cb: (error: Error) => void): this;
+    once(event: "error", cb: (error: Error) => void): this;
+    on(event: RedisStatus, cb: () => void): this;
+    once(event: RedisStatus, cb: () => void): this;
+    on(event: string | symbol, listener: (...args: any[]) => void): this;
+    once(event: string | symbol, listener: (...args: any[]) => void): this;
 }
 interface Redis extends Transaction {
 }

package/built/Redis.js

@@ -401,6 +401,9 @@ class Redis extends Commander_1.default {
             if (Command_1.default.checkFlag("WILL_DISCONNECT", command.name)) {
                 this.manuallyClosing = true;
             }
+            if (this.options.socketTimeout !== undefined && this.socketTimeoutTimer === undefined) {
+                this.setSocketTimeout();
+            }
         }
         if (command.name === "select" && (0, utils_1.isInt)(command.args[0])) {
             const db = parseInt(command.args[0], 10);
@@ -412,6 +415,22 @@ class Redis extends Commander_1.default {
         }
         return command.promise;
     }
+    setSocketTimeout() {
+        this.socketTimeoutTimer = setTimeout(() => {
+            this.stream.destroy(new Error(`Socket timeout. Expecting data, but didn't receive any in ${this.options.socketTimeout}ms.`));
+            this.socketTimeoutTimer = undefined;
+        }, this.options.socketTimeout);
+        // this handler must run after the "data" handler in "DataHandler"
+        // so that `this.commandQueue.length` will be updated
+        this.stream.once("data", () => {
+            console.log('GOT DATA, CLEARING TIMER');
+            clearTimeout(this.socketTimeoutTimer);
+            this.socketTimeoutTimer = undefined;
+            if (this.commandQueue.length === 0)
+                return;
+            this.setSocketTimeout();
+        });
+    }
     scanStream(options) {
         return this.createScanStream("scan", { options });
     }

package/built/cluster/index.d.ts

@@ -44,6 +44,7 @@ declare class Cluster extends Commander {
     private slotsTimer;
     private reconnectTimeout;
     private isRefreshing;
+    private _refreshSlotsCacheCallbacks;
     private _autoPipelines;
     private _runningAutoPipelines;
     private _readyDelayedCallbacks;

package/built/cluster/index.js

@@ -46,6 +46,7 @@ class Cluster extends Commander_1.default {
         this.delayQueue = new DelayQueue_1.default();
         this.offlineQueue = new Deque();
         this.isRefreshing = false;
+        this._refreshSlotsCacheCallbacks = [];
         this._autoPipelines = new Map();
         this._runningAutoPipelines = new Set();
         this._readyDelayedCallbacks = [];
@@ -287,19 +288,20 @@ class Cluster extends Commander_1.default {
      * @ignore
      */
     refreshSlotsCache(callback) {
+        if (callback) {
+            this._refreshSlotsCacheCallbacks.push(callback);
+        }
         if (this.isRefreshing) {
-            if (callback) {
-                process.nextTick(callback);
-            }
             return;
         }
         this.isRefreshing = true;
         const _this = this;
         const wrapper = (error) => {
             this.isRefreshing = false;
-            if (callback) {
+            for (const callback of this._refreshSlotsCacheCallbacks) {
                 callback(error);
             }
+            this._refreshSlotsCacheCallbacks = [];
         };
         const nodes = (0, utils_1.shuffle)(this.connectionPool.getNodes());
         let lastNodeError = null;

package/built/redis/RedisOptions.d.ts

@@ -11,6 +11,13 @@ export interface CommonRedisOptions extends CommanderOptions {
      * a "Command timed out" error will be thrown.
      */
     commandTimeout?: number;
+    /**
+     * If the socket does not receive data within a set number of milliseconds:
+     * 1. the socket is considered "dead" and will be destroyed
+     * 2. the client will reject any running commands (altought they might have been processed by the server)
+     * 3. the reconnect strategy will kick in (depending on the configuration)
+     */
+    socketTimeout?: number;
     /**
      * Enable/disable keep-alive functionality.
      * @link https://nodejs.org/api/net.html#socketsetkeepaliveenable-initialdelay

package/package.json

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