From ec1cddcf3affef2f324bf6132ec82c725788c937 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Karol=20S=C3=B3jko?= <karolsojko@gmail.com>
Date: Tue, 5 Dec 2023 12:20:36 +0100
Subject: [PATCH] chore: add websocket heartbeat to keep the connection alive
 (#2681)

---
 .../src/Domain/Api/WebsocketsService.ts       | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/packages/services/src/Domain/Api/WebsocketsService.ts b/packages/services/src/Domain/Api/WebsocketsService.ts
index 3c2f844dd..d3146ac01 100644
--- a/packages/services/src/Domain/Api/WebsocketsService.ts
+++ b/packages/services/src/Domain/Api/WebsocketsService.ts
@@ -10,7 +10,10 @@ import { Result } from '@standardnotes/domain-core'
 
 export class WebSocketsService extends AbstractService<WebSocketsServiceEvent, DomainEventInterface> {
   private CLOSE_CONNECTION_CODE = 3123
+  private HEARTBEAT_DELAY = 360_000
+
   private webSocket?: WebSocket
+  private webSocketHeartbeatInterval?: NodeJS.Timer
 
   constructor(
     private storageService: StorageServiceInterface,
@@ -52,6 +55,7 @@ export class WebSocketsService extends AbstractService<WebSocketsServiceEvent, D
       this.webSocket = new WebSocket(`${this.webSocketUrl}?authToken=${webSocketConectionToken}`)
       this.webSocket.onmessage = this.onWebSocketMessage.bind(this)
       this.webSocket.onclose = this.onWebSocketClose.bind(this)
+      this.webSocket.onopen = this.beginWebSocketHeartbeat.bind(this)
 
       return Result.ok()
     } catch (error) {
@@ -67,6 +71,16 @@ export class WebSocketsService extends AbstractService<WebSocketsServiceEvent, D
     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) {
     const eventData = JSON.parse(messageEvent.data)
     switch (eventData.type) {
@@ -91,6 +105,11 @@ export class WebSocketsService extends AbstractService<WebSocketsServiceEvent, D
   }
 
   private onWebSocketClose(event: CloseEvent) {
+    if (this.webSocketHeartbeatInterval) {
+      clearInterval(this.webSocketHeartbeatInterval)
+    }
+    this.webSocketHeartbeatInterval = undefined
+
     const closedByApplication = event.code === this.CLOSE_CONNECTION_CODE
     if (closedByApplication) {
       this.webSocket = undefined