clean up

Author: darrachequesne

README.md

@@ -18,7 +18,8 @@ The `@socket.io/redis-adapter` package allows broadcasting packets between multi
   - [With the `ioredis` package](#with-the-ioredis-package)
   - [With the `ioredis` package and a Redis cluster](#with-the-ioredis-package-and-a-redis-cluster)
   - [With Redis sharded Pub/Sub](#with-redis-sharded-pubsub)
-    - [With the `ioredis` package and a Redis cluster](#with-the-ioredis-package-and-a-redis-cluster-1)
+    - [With `redis`](#with-redis)
+    - [With `ioredis`](#with-ioredis)
 - [Options](#options)
   - [Default adapter](#default-adapter)
   - [Sharded adapter](#sharded-adapter)
@@ -162,6 +163,13 @@ Reference: https://redis.io/docs/interact/pubsub/#sharded-pubsub
 
 A dedicated adapter can be created with the `createShardedAdapter()` method:
 
+#### With `redis`
+
+Minimum requirements:
+
+- Redis 7.0
+- [`redis@4.6.0`](https://github.com/redis/node-redis/commit/3b1bad229674b421b2bc6424155b20d4d3e45bd1)
+
 ```js
 import { Server } from "socket.io";
 import { createClient } from "redis";
@@ -182,14 +190,14 @@ const io = new Server({
 io.listen(3000);
 ```
 
+#### With `ioredis`
+
 Minimum requirements:
 
 - Redis 7.0
-- [`redis@4.6.0`](https://github.com/redis/node-redis/commit/3b1bad229674b421b2bc6424155b20d4d3e45bd1)
+- [`ioredis@5.9.0`](https://github.com/redis/ioredis/pull/1956)
 
-#### With the `ioredis` package and a Redis cluster
-
-Starting with `ioredis@5.9.0`, you can use the sharded adapter with an ioredis Cluster by enabling the `shardedSubscribers` option:
+Please note that the `shardedSubscribers` option is required to enable sharded Pub/Sub.
 
 ```js
 import { Cluster } from "ioredis";
@@ -224,8 +232,6 @@ const io = new Server({
 io.listen(3000);
 ```
 
-Reference: https://github.com/redis/ioredis/pull/1956
-
 ## Options
 
 ### Default adapter

lib/sharded-adapter.ts

@@ -7,9 +7,8 @@ import {
 } from "socket.io-adapter";
 import { decode, encode } from "notepack.io";
 import {
+  checkConfiguration,
   hasBinary,
-  hasShardedSubscribers,
-  isIoRedisCluster,
   PUBSUB,
   SPUBLISH,
   SSUBSCRIBE,
@@ -83,6 +82,9 @@ class ShardedRedisAdapter extends ClusterAdapter {
 
   constructor(nsp, pubClient, subClient, opts: ShardedRedisAdapterOptions) {
     super(nsp);
+
+    checkConfiguration(subClient);
+
     this.pubClient = pubClient;
     this.subClient = subClient;
     this.opts = Object.assign(
@@ -93,15 +95,6 @@ class ShardedRedisAdapter extends ClusterAdapter {
       opts
     );
 
-    // Validate ioredis Cluster configuration
-    if (isIoRedisCluster(subClient) && !hasShardedSubscribers(subClient)) {
-      throw new Error(
-        "When using the sharded adapter with an ioredis Cluster, " +
-          "you must enable the 'shardedSubscribers' option. " +
-          "See https://github.com/redis/ioredis/pull/1956"
-      );
-    }
-
     this.channel = `${this.opts.channelPrefix}#${nsp.name}#`;
     this.responseChannel = `${this.opts.channelPrefix}#${nsp.name}#${this.uid}#`;
 

lib/util.ts

@@ -53,26 +53,19 @@ function isRedisV4Client(redisClient: any) {
 }
 
 /**
- * Whether the client is an ioredis Cluster instance
- *
+ * Check the configuration of the client to ensure it is compatible with the sharded adapter
  * @param redisClient
  */
-export function isIoRedisCluster(redisClient: any) {
-  return redisClient.constructor.name === "Cluster" || redisClient.isCluster;
-}
-
-/**
- * Whether the ioredis Cluster has shardedSubscribers enabled
- *
- * @param redisClient
- *
- * @see https://github.com/redis/ioredis/pull/1956
- */
-export function hasShardedSubscribers(redisClient: any) {
-  return (
-    isIoRedisCluster(redisClient) &&
-    redisClient.options?.shardedSubscribers === true
-  );
+export function checkConfiguration(redisClient: any) {
+  const isIORedisCluster =
+    typeof redisClient.ssubscribe === "function" && redisClient.isCluster;
+  if (isIORedisCluster && redisClient.options?.shardedSubscribers !== true) {
+    throw new Error(
+      "When using the sharded adapter with an ioredis Cluster, " +
+        "you must enable the 'shardedSubscribers' option. " +
+        "See https://github.com/redis/ioredis/pull/1956"
+    );
+  }
 }
 
 const kHandlers = Symbol("handlers");

test/test-runner.ts

@@ -38,16 +38,6 @@ const clusterNodes = [
   },
 ];
 
-// NAT mapping for ioredis Cluster (Docker container returns internal IP)
-const ioredisNatMap = {
-  "172.20.0.3:7000": { host: "localhost", port: 7000 },
-  "172.20.0.3:7001": { host: "localhost", port: 7001 },
-  "172.20.0.3:7002": { host: "localhost", port: 7002 },
-  "172.20.0.3:7003": { host: "localhost", port: 7003 },
-  "172.20.0.3:7004": { host: "localhost", port: 7004 },
-  "172.20.0.3:7005": { host: "localhost", port: 7005 },
-};
-
 function testSuite(
   createAdapter: any,
   redisPackage: string = "redis@4",
@@ -149,9 +139,7 @@ describe("@socket.io/redis-adapter", () => {
 
   describe("ioredis cluster", () =>
     testSuite(async () => {
-      const pubClient = new Cluster(clusterNodes, {
-        natMap: ioredisNatMap,
-      });
+      const pubClient = new Cluster(clusterNodes);
       const subClient = pubClient.duplicate();
 
       return [
@@ -271,13 +259,11 @@ describe("@socket.io/redis-adapter", () => {
       true
     ));
 
-  // Fixed in ioredis 5.9.0, see https://github.com/redis/ioredis/pull/1956
   describe("[sharded] ioredis cluster", () =>
     testSuite(
       async () => {
         const pubClient = new Cluster(clusterNodes, {
           shardedSubscribers: true,
-          natMap: ioredisNatMap,
         });
         const subClient = pubClient.duplicate();