fix(types): make RemoteSocket.data type safe (socketio#4234)

Related: - socketio#4229 - socketio@5d78eac
dzad · Jan 6, 2022 · a449c2e · a449c2e
1 parent 4024aed
commit a449c2e
Show file tree

Hide file tree

Showing 5 changed files with 60 additions and 38 deletions.
diff --git a/lib/broadcast-operator.ts b/lib/broadcast-operator.ts
@@ -9,7 +9,7 @@ import type {
   TypedEventBroadcaster,
 } from "./typed-events";
 
-export class BroadcastOperator<EmitEvents extends EventsMap>
+export class BroadcastOperator<EmitEvents extends EventsMap, SocketData>
   implements TypedEventBroadcaster<EmitEvents>
 {
   constructor(
@@ -26,7 +26,7 @@ export class BroadcastOperator<EmitEvents extends EventsMap>
    * @return a new BroadcastOperator instance
    * @public
    */
-  public to(room: Room | Room[]): BroadcastOperator<EmitEvents> {
+  public to(room: Room | Room[]): BroadcastOperator<EmitEvents, SocketData> {
     const rooms = new Set(this.rooms);
     if (Array.isArray(room)) {
       room.forEach((r) => rooms.add(r));
@@ -48,7 +48,7 @@ export class BroadcastOperator<EmitEvents extends EventsMap>
    * @return a new BroadcastOperator instance
    * @public
    */
-  public in(room: Room | Room[]): BroadcastOperator<EmitEvents> {
+  public in(room: Room | Room[]): BroadcastOperator<EmitEvents, SocketData> {
     return this.to(room);
   }
 
@@ -59,7 +59,9 @@ export class BroadcastOperator<EmitEvents extends EventsMap>
    * @return a new BroadcastOperator instance
    * @public
    */
-  public except(room: Room | Room[]): BroadcastOperator<EmitEvents> {
+  public except(
+    room: Room | Room[]
+  ): BroadcastOperator<EmitEvents, SocketData> {
     const exceptRooms = new Set(this.exceptRooms);
     if (Array.isArray(room)) {
       room.forEach((r) => exceptRooms.add(r));
@@ -81,7 +83,9 @@ export class BroadcastOperator<EmitEvents extends EventsMap>
    * @return a new BroadcastOperator instance
    * @public
    */
-  public compress(compress: boolean): BroadcastOperator<EmitEvents> {
+  public compress(
+    compress: boolean
+  ): BroadcastOperator<EmitEvents, SocketData> {
     const flags = Object.assign({}, this.flags, { compress });
     return new BroadcastOperator(
       this.adapter,
@@ -99,7 +103,7 @@ export class BroadcastOperator<EmitEvents extends EventsMap>
    * @return a new BroadcastOperator instance
    * @public
    */
-  public get volatile(): BroadcastOperator<EmitEvents> {
+  public get volatile(): BroadcastOperator<EmitEvents, SocketData> {
     const flags = Object.assign({}, this.flags, { volatile: true });
     return new BroadcastOperator(
       this.adapter,
@@ -115,7 +119,7 @@ export class BroadcastOperator<EmitEvents extends EventsMap>
    * @return a new BroadcastOperator instance
    * @public
    */
-  public get local(): BroadcastOperator<EmitEvents> {
+  public get local(): BroadcastOperator<EmitEvents, SocketData> {
     const flags = Object.assign({}, this.flags, { local: true });
     return new BroadcastOperator(
       this.adapter,
@@ -177,7 +181,9 @@ export class BroadcastOperator<EmitEvents extends EventsMap>
    *
    * @public
    */
-  public fetchSockets(): Promise<RemoteSocket<EmitEvents>[]> {
+  public fetchSockets<SocketData = any>(): Promise<
+    RemoteSocket<EmitEvents, SocketData>[]
+  > {
     return this.adapter
       .fetchSockets({
         rooms: this.rooms,
@@ -187,9 +193,12 @@ export class BroadcastOperator<EmitEvents extends EventsMap>
         return sockets.map((socket) => {
           if (socket instanceof Socket) {
             // FIXME the TypeScript compiler complains about missing private properties
-            return socket as unknown as RemoteSocket<EmitEvents>;
+            return socket as unknown as RemoteSocket<EmitEvents, SocketData>;
           } else {
-            return new RemoteSocket(this.adapter, socket as SocketDetails);
+            return new RemoteSocket(
+              this.adapter,
+              socket as SocketDetails<SocketData>
+            );
           }
         });
       });
@@ -247,27 +256,27 @@ export class BroadcastOperator<EmitEvents extends EventsMap>
 /**
  * Format of the data when the Socket instance exists on another Socket.IO server
  */
-interface SocketDetails {
+interface SocketDetails<SocketData> {
   id: SocketId;
   handshake: Handshake;
   rooms: Room[];
-  data: any;
+  data: SocketData;
 }
 
 /**
  * Expose of subset of the attributes and methods of the Socket class
  */
-export class RemoteSocket<EmitEvents extends EventsMap>
+export class RemoteSocket<EmitEvents extends EventsMap, SocketData>
   implements TypedEventBroadcaster<EmitEvents>
 {
   public readonly id: SocketId;
   public readonly handshake: Handshake;
   public readonly rooms: Set<Room>;
-  public readonly data: any;
+  public readonly data: SocketData;
 
-  private readonly operator: BroadcastOperator<EmitEvents>;
+  private readonly operator: BroadcastOperator<EmitEvents, SocketData>;
 
-  constructor(adapter: Adapter, details: SocketDetails) {
+  constructor(adapter: Adapter, details: SocketDetails<SocketData>) {
     this.id = details.id;
     this.handshake = details.handshake;
     this.rooms = new Set(details.rooms);

diff --git a/lib/index.ts b/lib/index.ts
@@ -664,7 +664,7 @@ export class Server<
    * @return self
    * @public
    */
-  public to(room: Room | Room[]): BroadcastOperator<EmitEvents> {
+  public to(room: Room | Room[]): BroadcastOperator<EmitEvents, SocketData> {
     return this.sockets.to(room);
   }
 
@@ -675,7 +675,7 @@ export class Server<
    * @return self
    * @public
    */
-  public in(room: Room | Room[]): BroadcastOperator<EmitEvents> {
+  public in(room: Room | Room[]): BroadcastOperator<EmitEvents, SocketData> {
     return this.sockets.in(room);
   }
 
@@ -686,7 +686,9 @@ export class Server<
    * @return self
    * @public
    */
-  public except(name: Room | Room[]): BroadcastOperator<EmitEvents> {
+  public except(
+    name: Room | Room[]
+  ): BroadcastOperator<EmitEvents, SocketData> {
     return this.sockets.except(name);
   }
 
@@ -742,7 +744,9 @@ export class Server<
    * @return self
    * @public
    */
-  public compress(compress: boolean): BroadcastOperator<EmitEvents> {
+  public compress(
+    compress: boolean
+  ): BroadcastOperator<EmitEvents, SocketData> {
     return this.sockets.compress(compress);
   }
 
@@ -754,7 +758,7 @@ export class Server<
    * @return self
    * @public
    */
-  public get volatile(): BroadcastOperator<EmitEvents> {
+  public get volatile(): BroadcastOperator<EmitEvents, SocketData> {
     return this.sockets.volatile;
   }
 
@@ -764,7 +768,7 @@ export class Server<
    * @return self
    * @public
    */
-  public get local(): BroadcastOperator<EmitEvents> {
+  public get local(): BroadcastOperator<EmitEvents, SocketData> {
     return this.sockets.local;
   }
 
@@ -773,7 +777,7 @@ export class Server<
    *
    * @public
    */
-  public fetchSockets(): Promise<RemoteSocket<EmitEvents>[]> {
+  public fetchSockets(): Promise<RemoteSocket<EmitEvents, SocketData>[]> {
     return this.sockets.fetchSockets();
   }
 

diff --git a/lib/namespace.ts b/lib/namespace.ts
@@ -175,7 +175,7 @@ export class Namespace<
    * @return self
    * @public
    */
-  public to(room: Room | Room[]): BroadcastOperator<EmitEvents> {
+  public to(room: Room | Room[]): BroadcastOperator<EmitEvents, SocketData> {
     return new BroadcastOperator(this.adapter).to(room);
   }
 
@@ -186,7 +186,7 @@ export class Namespace<
    * @return self
    * @public
    */
-  public in(room: Room | Room[]): BroadcastOperator<EmitEvents> {
+  public in(room: Room | Room[]): BroadcastOperator<EmitEvents, SocketData> {
     return new BroadcastOperator(this.adapter).in(room);
   }
 
@@ -197,7 +197,9 @@ export class Namespace<
    * @return self
    * @public
    */
-  public except(room: Room | Room[]): BroadcastOperator<EmitEvents> {
+  public except(
+    room: Room | Room[]
+  ): BroadcastOperator<EmitEvents, SocketData> {
     return new BroadcastOperator(this.adapter).except(room);
   }
 
@@ -274,7 +276,10 @@ export class Namespace<
     ev: Ev,
     ...args: EventParams<EmitEvents, Ev>
   ): boolean {
-    return new BroadcastOperator<EmitEvents>(this.adapter).emit(ev, ...args);
+    return new BroadcastOperator<EmitEvents, SocketData>(this.adapter).emit(
+      ev,
+      ...args
+    );
   }
 
   /**
@@ -346,7 +351,9 @@ export class Namespace<
    * @return self
    * @public
    */
-  public compress(compress: boolean): BroadcastOperator<EmitEvents> {
+  public compress(
+    compress: boolean
+  ): BroadcastOperator<EmitEvents, SocketData> {
     return new BroadcastOperator(this.adapter).compress(compress);
   }
 
@@ -358,7 +365,7 @@ export class Namespace<
    * @return self
    * @public
    */
-  public get volatile(): BroadcastOperator<EmitEvents> {
+  public get volatile(): BroadcastOperator<EmitEvents, SocketData> {
     return new BroadcastOperator(this.adapter).volatile;
   }
 
@@ -368,7 +375,7 @@ export class Namespace<
    * @return self
    * @public
    */
-  public get local(): BroadcastOperator<EmitEvents> {
+  public get local(): BroadcastOperator<EmitEvents, SocketData> {
     return new BroadcastOperator(this.adapter).local;
   }
 
@@ -377,7 +384,7 @@ export class Namespace<
    *
    * @public
    */
-  public fetchSockets(): Promise<RemoteSocket<EmitEvents>[]> {
+  public fetchSockets(): Promise<RemoteSocket<EmitEvents, SocketData>[]> {
     return new BroadcastOperator(this.adapter).fetchSockets();
   }
 

diff --git a/lib/parent-namespace.ts b/lib/parent-namespace.ts
@@ -65,7 +65,7 @@ export class ParentNamespace<
     return namespace;
   }
 
-  fetchSockets(): Promise<RemoteSocket<EmitEvents>[]> {
+  fetchSockets(): Promise<RemoteSocket<EmitEvents, SocketData>[]> {
     // note: we could make the fetchSockets() method work for dynamic namespaces created with a regex (by sending the
     // regex to the other Socket.IO servers, and returning the sockets of each matching namespace for example), but
     // the behavior for namespaces created with a function is less clear

diff --git a/lib/socket.ts b/lib/socket.ts
@@ -251,7 +251,7 @@ export class Socket<
    * @return self
    * @public
    */
-  public to(room: Room | Room[]): BroadcastOperator<EmitEvents> {
+  public to(room: Room | Room[]): BroadcastOperator<EmitEvents, SocketData> {
     return this.newBroadcastOperator().to(room);
   }
 
@@ -262,7 +262,7 @@ export class Socket<
    * @return self
    * @public
    */
-  public in(room: Room | Room[]): BroadcastOperator<EmitEvents> {
+  public in(room: Room | Room[]): BroadcastOperator<EmitEvents, SocketData> {
     return this.newBroadcastOperator().in(room);
   }
 
@@ -273,7 +273,9 @@ export class Socket<
    * @return self
    * @public
    */
-  public except(room: Room | Room[]): BroadcastOperator<EmitEvents> {
+  public except(
+    room: Room | Room[]
+  ): BroadcastOperator<EmitEvents, SocketData> {
     return this.newBroadcastOperator().except(room);
   }
 
@@ -577,7 +579,7 @@ export class Socket<
    * @return {Socket} self
    * @public
    */
-  public get broadcast(): BroadcastOperator<EmitEvents> {
+  public get broadcast(): BroadcastOperator<EmitEvents, SocketData> {
     return this.newBroadcastOperator();
   }
 
@@ -587,7 +589,7 @@ export class Socket<
    * @return {Socket} self
    * @public
    */
-  public get local(): BroadcastOperator<EmitEvents> {
+  public get local(): BroadcastOperator<EmitEvents, SocketData> {
     return this.newBroadcastOperator().local;
   }
 
@@ -764,7 +766,7 @@ export class Socket<
     return this._anyListeners || [];
   }
 
-  private newBroadcastOperator(): BroadcastOperator<EmitEvents> {
+  private newBroadcastOperator(): BroadcastOperator<EmitEvents, SocketData> {
     const flags = Object.assign({}, this.flags);
     this.flags = {};
     return new BroadcastOperator(