rmorawski/standardnotes-app-web
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: add websocket heartbeat to keep the connection alive (#2681)

Browse Source
This commit is contained in:
Karol Sójko
2023-12-05 12:20:36 +01:00
committed by GitHub
parent cb10750078
commit ec1cddcf3a
1 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
packages/services/src/Domain/Api/WebsocketsService.ts
View File

@@ -10,7 +10,10 @@ import { Result } from '@standardnotes/domain-core'
export class WebSocketsService extends AbstractService<WebSocketsServiceEvent, DomainEventInterface> { export class WebSocketsService extends AbstractService<WebSocketsServiceEvent, DomainEventInterface> {
private CLOSE_CONNECTION_CODE = 3123 private CLOSE_CONNECTION_CODE = 3123
private HEARTBEAT_DELAY = 360_000
private webSocket?: WebSocket private webSocket?: WebSocket
private webSocketHeartbeatInterval?: NodeJS.Timer
constructor( constructor(
private storageService: StorageServiceInterface, private storageService: StorageServiceInterface,
@@ -52,6 +55,7 @@ export class WebSocketsService extends AbstractService<WebSocketsServiceEvent, D
this.webSocket = new WebSocket(`${this.webSocketUrl}?authToken=${webSocketConectionToken}`) this.webSocket = new WebSocket(`${this.webSocketUrl}?authToken=${webSocketConectionToken}`)
this.webSocket.onmessage = this.onWebSocketMessage.bind(this) this.webSocket.onmessage = this.onWebSocketMessage.bind(this)
this.webSocket.onclose = this.onWebSocketClose.bind(this) this.webSocket.onclose = this.onWebSocketClose.bind(this)
this.webSocket.onopen = this.beginWebSocketHeartbeat.bind(this)
return Result.ok() return Result.ok()
} catch (error) { } catch (error) {
@@ -67,6 +71,16 @@ export class WebSocketsService extends AbstractService<WebSocketsServiceEvent, D
this.webSocket?.close(this.CLOSE_CONNECTION_CODE, 'Closing application') this.webSocket?.close(this.CLOSE_CONNECTION_CODE, 'Closing application')
} }
private beginWebSocketHeartbeat(): void {
this.webSocketHeartbeatInterval = setInterval(this.websocketHeartbeat.bind(this), this.HEARTBEAT_DELAY)
}
private websocketHeartbeat(): void {
if (this.webSocket?.readyState === WebSocket.OPEN) {
this.webSocket.send('ping')
}
}
private onWebSocketMessage(messageEvent: MessageEvent) { private onWebSocketMessage(messageEvent: MessageEvent) {
const eventData = JSON.parse(messageEvent.data) const eventData = JSON.parse(messageEvent.data)
switch (eventData.type) { switch (eventData.type) {
@@ -91,6 +105,11 @@ export class WebSocketsService extends AbstractService<WebSocketsServiceEvent, D
} }
private onWebSocketClose(event: CloseEvent) { private onWebSocketClose(event: CloseEvent) {
if (this.webSocketHeartbeatInterval) {
clearInterval(this.webSocketHeartbeatInterval)
}
this.webSocketHeartbeatInterval = undefined
const closedByApplication = event.code === this.CLOSE_CONNECTION_CODE const closedByApplication = event.code === this.CLOSE_CONNECTION_CODE
if (closedByApplication) { if (closedByApplication) {
this.webSocket = undefined this.webSocket = undefined