Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 6, 2022
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b0e7d46
chore(types): make `RemoteSocket.data` type safe
OrkhanAlikhanov Jan 3, 2022
7230c5b
chore(types): add `SocketData` to `BroadcastOperator`
OrkhanAlikhanov Jan 5, 2022
8faf21c
Merge branch 'master' of https://github.com/socketio/socket.io into r…
OrkhanAlikhanov Jan 5, 2022
3c6b7e9
Add missing SocketData type
OrkhanAlikhanov Jan 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 25 additions & 16 deletions lib/broadcast-operator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand All @@ -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));
Expand All @@ -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);
}

Expand All @@ -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));
Expand All @@ -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,
Expand All @@ -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,
Expand All @@ -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,
Expand Down Expand Up @@ -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,
Expand All @@ -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>
);
}
});
});
Expand Down Expand Up @@ -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);
Expand Down
18 changes: 11 additions & 7 deletions lib/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}

Expand All @@ -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);
}

Expand All @@ -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);
}

Expand Down Expand Up @@ -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);
}

Expand All @@ -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;
}

Expand All @@ -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;
}

Expand All @@ -773,7 +777,7 @@ export class Server<
*
* @public
*/
public fetchSockets(): Promise<RemoteSocket<EmitEvents>[]> {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So we would have:

const sockets = await io.fetchSockets();

// with the BroadcastOperator
const sockets = await io.in("room-1").fetchSockets<SocketData>();

Is that right?

Copy link
Contributor Author

@OrkhanAlikhanov OrkhanAlikhanov Jan 4, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Exactly. We loss the SocketData type when BroadcastOperator is created, so it has to be specified. Otherwise it will default to any

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In that case, I think it would make more sense to go with your first solution here, so we have the same API with and without operator (like to() or except()).

const sockets = await io.fetchSockets();
const sockets = await io.in("room-1").fetchSockets(); // no additional types

What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good to me. Will update the PR

public fetchSockets(): Promise<RemoteSocket<EmitEvents, SocketData>[]> {
return this.sockets.fetchSockets();
}

Expand Down
23 changes: 15 additions & 8 deletions lib/namespace.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}

Expand All @@ -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);
}

Expand All @@ -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);
}

Expand Down Expand Up @@ -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
);
}

/**
Expand Down Expand Up @@ -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);
}

Expand All @@ -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;
}

Expand All @@ -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;
}

Expand All @@ -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();
}

Expand Down
2 changes: 1 addition & 1 deletion lib/parent-namespace.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 8 additions & 6 deletions lib/socket.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}

Expand All @@ -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);
}

Expand All @@ -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);
}

Expand Down Expand Up @@ -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();
}

Expand All @@ -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;
}

Expand Down Expand Up @@ -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(
Expand Down