chore: bump redis to version ^4.0.1

See also: https://github.com/redis/node-redis/blob/master/docs/v3-to-v4.md

Author: darrachequesne

.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x]
+        node-version: [12.x, 16.x]
 
     services:
       redis:

Readme.md

@@ -44,15 +44,37 @@ The current version is compatible with both:
 
 ## How to use
 
+Installation:
+
+```
+npm i @socket.io/redis-emitter redis
+```
+
 ### CommonJS
 
-Installation: `npm i @socket.io/redis-emitter redis`
+```js
+const { Emitter } = require("@socket.io/redis-emitter");
+const { createClient } = require("redis"); // not included, needs to be explicitly installed
+
+const redisClient = createClient();
+
+redisClient.connect().then(() => {
+  const io = new Emitter(redisClient);
+
+  setInterval(() => {
+    io.emit("time", new Date);
+  }, 5000);
+})
+```
+
+With `redis@3`, calling `connect()` is not needed:
 
 ```js
 const { Emitter } = require("@socket.io/redis-emitter");
 const { createClient } = require("redis"); // not included, needs to be explicitly installed
 
 const redisClient = createClient();
+
 const io = new Emitter(redisClient);
 
 setInterval(() => {
@@ -62,18 +84,19 @@ setInterval(() => {
 
 ### TypeScript
 
-Installation: `npm i @socket.io/redis-emitter redis @types/redis`
-
 ```ts
 import { Emitter } from "@socket.io/redis-emitter";
 import { createClient } from "redis";
 
 const redisClient = createClient();
-const io = new Emitter(redisClient);
 
-setInterval(() => {
-  io.emit("time", new Date);
-}, 5000);
+redisClient.connect().then(() => {
+  const io = new Emitter(redisClient);
+
+  setInterval(() => {
+    io.emit("time", new Date);
+  }, 5000);
+});
 ```
 
 With typed events:
@@ -87,9 +110,12 @@ interface Events {
 }
 
 const redisClient = createClient();
-const io = new Emitter<Events>(redisClient);
 
-io.emit("basicEmit", 1, "2", [3]);
+redisClient.connect().then(() => {
+  const io = new Emitter<Events>(redisClient);
+
+  io.emit("basicEmit", 1, "2", [3]);
+});
 ```
 
 ## Emit cheatsheet

package-lock.json

@@ -24,15 +24,14 @@
     "socket.io-parser": "~4.0.4"
   },
   "devDependencies": {
-    "@socket.io/redis-adapter": "^7.0.0",
+    "@socket.io/redis-adapter": "^7.1.0",
     "@types/mocha": "^8.2.1",
     "@types/node": "^14.14.35",
-    "@types/redis": "^2.8.28",
     "expect.js": "~0.3.1",
     "mocha": "^9.1.3",
     "nyc": "^15.1.0",
     "prettier": "^2.2.1",
-    "redis": "^3.0.2",
+    "redis": "^4.0.1",
     "socket.io": "^4.1.1",
     "socket.io-client": "^4.1.1",
     "ts-node": "^9.1.1",

package.json

@@ -1,5 +1,5 @@
 import expect = require("expect.js");
-import { createClient, RedisClient } from "redis";
+import { createClient, RedisClientType } from "redis";
 import { Server, Socket } from "socket.io";
 import { io as ioc, Socket as ClientSocket } from "socket.io-client";
 import { createAdapter } from "@socket.io/redis-adapter";
@@ -31,18 +31,20 @@ const createPartialDone = (
 describe("emitter", () => {
   let port: number,
     io: Server,
-    pubClient: RedisClient,
-    subClient: RedisClient,
+    pubClient: RedisClientType<any, any>,
+    subClient: RedisClientType<any, any>,
     serverSockets: Socket[],
     clientSockets: ClientSocket[],
     emitter: Emitter;
 
-  beforeEach((done) => {
+  beforeEach(async () => {
     const httpServer = createServer();
 
     pubClient = createClient();
     subClient = createClient();
 
+    await Promise.all([pubClient.connect(), subClient.connect()]);
+
     io = new Server(httpServer, {
       adapter: createAdapter(pubClient, subClient),
     });
@@ -56,14 +58,17 @@ describe("emitter", () => {
     });
 
     serverSockets = [];
-    io.on("connection", (socket) => {
-      serverSockets.push(socket);
-      if (serverSockets.length === SOCKETS_COUNT) {
-        setTimeout(done, 100);
-      }
-    });
 
     emitter = new Emitter(pubClient);
+
+    return new Promise((resolve) => {
+      io.on("connection", (socket) => {
+        serverSockets.push(socket);
+        if (serverSockets.length === SOCKETS_COUNT) {
+          setTimeout(resolve, 100);
+        }
+      });
+    });
   });
 
   afterEach(() => {