lbehm/workadventure
1
0
Fork 0
Code Issues Pull requests Releases Activity

Merge pull request #328 from thecodingmachine/ping

Browse source 
The server now sends regular ping requests to keep connections alive
This commit is contained in:
David Négrier 2020-10-15 14:12:12 +02:00 committed by GitHub
parent 49a0125f88 d098a1b8db
commit 3ba3b24647
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 35 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
back/src/Controller/IoSocketController.ts
View file

@ -60,6 +60,26 @@ function emitInBatch(socket: ExSocketInterface, payload: SubMessage): void {
socket.batchTimeout = null; socket.batchTimeout = null;
}, 100); }, 100);
} }
// If we send a message, we don't need to keep the connection alive
resetPing(socket);
}
/**
* Schedule a ping to keep the connection open.
* If a ping is already set, the timeout of the ping is reset.
*/
function resetPing(ws: ExSocketInterface): void {
if (ws.pingTimeout) {
clearTimeout(ws.pingTimeout);
}
ws.pingTimeout = setTimeout(() => {
if (ws.disconnecting) {
return;
}
ws.ping();
resetPing(ws);
}, 29000);
} }
export class IoSocketController { export class IoSocketController {
@ -232,6 +252,8 @@ export class IoSocketController {
// Let's join the room // Let's join the room
this.handleJoinRoom(client, client.position, client.viewport); this.handleJoinRoom(client, client.position, client.viewport);
resetPing(client);
}, },
message: (ws, arrayBuffer, isBinary): void => { message: (ws, arrayBuffer, isBinary): void => {
const client = ws as ExSocketInterface; const client = ws as ExSocketInterface;
@ -555,19 +577,19 @@ export class IoSocketController {
} }
} }
} }
private async getOrCreateRoom(roomId: string): Promise<GameRoom> { private async getOrCreateRoom(roomId: string): Promise<GameRoom> {
//check and create new world for a room //check and create new world for a room
let world = this.Worlds.get(roomId) let world = this.Worlds.get(roomId)
if(world === undefined){ if(world === undefined){
world = new GameRoom( world = new GameRoom(
roomId, roomId,
(user: User, group: Group) => this.joinWebRtcRoom(user, group), (user: User, group: Group) => this.joinWebRtcRoom(user, group),
(user: User, group: Group) => this.disConnectedUser(user, group), (user: User, group: Group) => this.disConnectedUser(user, group),
MINIMUM_DISTANCE, MINIMUM_DISTANCE,
GROUP_RADIUS, GROUP_RADIUS,
(thing: Movable, listener: User) => this.onRoomEnter(thing, listener), (thing: Movable, listener: User) => this.onRoomEnter(thing, listener),
(thing: Movable, position:PositionInterface, listener:User) => this.onClientMove(thing, position, listener), (thing: Movable, position:PositionInterface, listener:User) => this.onClientMove(thing, position, listener),
(thing: Movable, listener:User) => this.onClientLeave(thing, listener) (thing: Movable, listener:User) => this.onClientLeave(thing, listener)
); );
if (!world.anonymous) { if (!world.anonymous) {
@ -586,7 +608,7 @@ export class IoSocketController {
//join user in room //join user in room
this.nbClientsPerRoomGauge.inc({ room: roomId }); this.nbClientsPerRoomGauge.inc({ room: roomId });
client.position = position; client.position = position;
const world = this.Worlds.get(roomId) const world = this.Worlds.get(roomId)
if(world === undefined){ if(world === undefined){
throw new Error('Could not find room for ID: '+client.roomId) throw new Error('Could not find room for ID: '+client.roomId)
@ -600,7 +622,7 @@ export class IoSocketController {
world.join(client, client.position); world.join(client, client.position);
return world; return world;
} }
private onRoomEnter(thing: Movable, listener: User) { private onRoomEnter(thing: Movable, listener: User) {
const clientListener = this.searchClientByIdOrFail(listener.id); const clientListener = this.searchClientByIdOrFail(listener.id);
if (thing instanceof User) { if (thing instanceof User) {
@ -625,7 +647,7 @@ export class IoSocketController {
console.error('Unexpected type for Movable.'); console.error('Unexpected type for Movable.');
} }
} }
private onClientMove(thing: Movable, position:PositionInterface, listener:User): void { private onClientMove(thing: Movable, position:PositionInterface, listener:User): void {
const clientListener = this.searchClientByIdOrFail(listener.id); const clientListener = this.searchClientByIdOrFail(listener.id);
if (thing instanceof User) { if (thing instanceof User) {
@ -646,7 +668,7 @@ export class IoSocketController {
console.error('Unexpected type for Movable.'); console.error('Unexpected type for Movable.');
} }
} }
private onClientLeave(thing: Movable, listener:User) { private onClientLeave(thing: Movable, listener:User) {
const clientListener = this.searchClientByIdOrFail(listener.id); const clientListener = this.searchClientByIdOrFail(listener.id);
if (thing instanceof User) { if (thing instanceof User) {

1
back/src/Model/Websocket/ExSocketInterface.ts
View file

@ -19,6 +19,7 @@ export interface ExSocketInterface extends WebSocket, Identificable {
emitInBatch: (payload: SubMessage) => void; emitInBatch: (payload: SubMessage) => void;
batchedMessages: BatchMessage; batchedMessages: BatchMessage;
batchTimeout: NodeJS.Timeout|null; batchTimeout: NodeJS.Timeout|null;
pingTimeout: NodeJS.Timeout|null;
disconnecting: boolean, disconnecting: boolean,
tags: string[] tags: string[]
} }