[WIP] feature-add-shard-support

lib/index.ts

@@ -8,6 +8,7 @@ import type {
   EventsMap,
   TypedEventBroadcaster,
 } from "./typed-events";
+import { PUBLISH } from "./util";
 
 const debug = debugModule("socket.io-emitter");
 
@@ -41,13 +42,19 @@ export interface EmitterOptions {
    * Defaults to notepack.io, a MessagePack implementation.
    */
   parser?: Parser;
+
+  /**
+   * Enable the sharded PubSub or not. Default to `false`.
+   */
+  sharded?: false;
 }
 
 interface BroadcastOptions {
   nsp: string;
   broadcastChannel: string;
   requestChannel: string;
   parser: Parser;
+  sharded: false;
 }
 
 interface BroadcastFlags {
@@ -68,6 +75,7 @@ export class Emitter<EmitEvents extends EventsMap = DefaultEventsMap> {
       {
         key: "socket.io",
         parser: msgpack,
+        sharded: false,
       },
       opts
     );
@@ -76,6 +84,7 @@ export class Emitter<EmitEvents extends EventsMap = DefaultEventsMap> {
       broadcastChannel: this.opts.key + "#" + nsp + "#",
       requestChannel: this.opts.key + "-request#" + nsp + "#",
       parser: this.opts.parser,
+      sharded: this.opts.sharded,
     };
   }
 
@@ -233,7 +242,12 @@ export class Emitter<EmitEvents extends EventsMap = DefaultEventsMap> {
       data: args,
     });
 
-    this.redisClient.publish(this.broadcastOptions.requestChannel, request);
+    PUBLISH(
+      this.redisClient,
+      this.broadcastOptions.requestChannel,
+      request,
+      this.opts.sharded
+    );
   }
 }
 
@@ -386,7 +400,7 @@ export class BroadcastOperator<EmitEvents extends EventsMap>
 
     debug("publishing message to channel %s", channel);
 
-    this.redisClient.publish(channel, msg);
+    PUBLISH(this.redisClient, channel, msg, this.broadcastOptions.sharded);
 
     return true;
   }
@@ -407,7 +421,12 @@ export class BroadcastOperator<EmitEvents extends EventsMap>
       rooms: Array.isArray(rooms) ? rooms : [rooms],
     });
 
-    this.redisClient.publish(this.broadcastOptions.requestChannel, request);
+    PUBLISH(
+      this.redisClient,
+      this.broadcastOptions.requestChannel,
+      request,
+      this.broadcastOptions.sharded
+    );
   }
 
   /**
@@ -426,7 +445,12 @@ export class BroadcastOperator<EmitEvents extends EventsMap>
       rooms: Array.isArray(rooms) ? rooms : [rooms],
     });
 
-    this.redisClient.publish(this.broadcastOptions.requestChannel, request);
+    PUBLISH(
+      this.redisClient,
+      this.broadcastOptions.requestChannel,
+      request,
+      this.broadcastOptions.sharded
+    );
   }
 
   /**
@@ -445,6 +469,11 @@ export class BroadcastOperator<EmitEvents extends EventsMap>
       close,
     });
 
-    this.redisClient.publish(this.broadcastOptions.requestChannel, request);
+    PUBLISH(
+      this.redisClient,
+      this.broadcastOptions.requestChannel,
+      request,
+      this.broadcastOptions.sharded
+    );
   }
 }

lib/util.ts

@@ -0,0 +1,48 @@
+/**
+ * Whether the client comes from the `redis` package
+ *
+ * @param redisClient
+ *
+ * @see https://github.com/redis/node-redis
+ */
+function isRedisV4Client(redisClient: any) {
+  return typeof redisClient.sSubscribe === "function";
+}
+
+/**
+ * Whether sharded publish using `redis` or `iosredis` package
+ * @param redisClient
+ * @param channel
+ * @param payload
+ */
+export function SPUBLISH(
+  redisClient: any,
+  channel: string,
+  payload: string | Uint8Array
+) {
+  if (isRedisV4Client(redisClient)) {
+    redisClient.sPublish(channel, payload);
+  } else {
+    redisClient.spublish(channel, payload);
+  }
+}
+
+/**
+ * Whether publish in sharded mode.
+ * @param redisClient
+ * @param channel
+ * @param payload
+ * @param sharded
+ */
+export function PUBLISH(
+  redisClient: any,
+  channel: string,
+  payload: string | Uint8Array,
+  sharded: boolean
+) {
+  if (sharded) {
+    SPUBLISH(redisClient, channel, payload);
+  } else {
+    redisClient.publish(channel, payload);
+  }
+}