Add new message types, request and handle server health check

simularium · Nov 28, 2023 · 07c2b8f · 07c2b8f
1 parent 075236e
commit 07c2b8f
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 0 deletions.
diff --git a/src/simularium/RemoteSimulator.ts b/src/simularium/RemoteSimulator.ts
@@ -29,6 +29,7 @@ export class RemoteSimulator implements ISimulator {
     protected lastRequestedFile: string;
     public handleError: (error: FrontEndError) => void | (() => void);
     protected useOctopus: boolean;
+    protected serverHealthy: boolean;
 
     public constructor(
         webSocketClient: WebsocketClient,
@@ -43,6 +44,7 @@ export class RemoteSimulator implements ISimulator {
             (() => {
                 /* do nothing */
             });
+        this.serverHealthy = false;
 
         this.logger = jsLogger.get("netconnection");
         this.logger.setLevel(jsLogger.DEBUG);
@@ -55,6 +57,7 @@ export class RemoteSimulator implements ISimulator {
         this.onTrajectoryDataArrive = () => {
             /* do nothing */
         };
+        this.requestServerHealthCheck();
     }
 
     public setTrajectoryFileInfoHandler(
@@ -134,6 +137,10 @@ export class RemoteSimulator implements ISimulator {
         // TODO: implement callback
     }
 
+    public onHealthCheckResponse(): void {
+        this.serverHealthy = true;
+    }
+
     private registerBinaryMessageHandlers(): void {
         this.webSocketClient.addBinaryMessageHandler(
             NetMessageEnum.ID_VIS_DATA_ARRIVE,
@@ -171,6 +178,11 @@ export class RemoteSimulator implements ISimulator {
             NetMessageEnum.ID_MODEL_DEFINITION,
             (_msg) => this.onModelDefinitionArrive()
         );
+
+        this.webSocketClient.addJsonMessageHandler(
+            NetMessageEnum.ID_SERVER_HEALTHY_RESPONSE,
+            (_msg) => this.onHealthCheckResponse()
+        );
     }
 
     /**
@@ -190,6 +202,10 @@ export class RemoteSimulator implements ISimulator {
         return this.webSocketClient.connectToRemoteServer();
     }
 
+    public isServerHealthy(): boolean {
+        return this.serverHealthy;
+    }
+
     /**
      * Websocket Update Parameters
      */
@@ -412,4 +428,19 @@ export class RemoteSimulator implements ISimulator {
             "Convert trajectory output to simularium file format"
         );
     }
+
+    public requestServerHealthCheck(): Promise<void> {
+        return this.connectToRemoteServer()
+            .then(() => {
+                this.webSocketClient.sendWebSocketRequest(
+                    {
+                        msgType: NetMessageEnum.ID_CHECK_HEALTH_REQUEST,
+                    },
+                    "Request server health check"
+                );
+            })
+            .catch((e) => {
+                throw new FrontEndError(e.message, ErrorLevel.ERROR);
+            });
+    }
 }
diff --git a/src/simularium/WebsocketClient.ts b/src/simularium/WebsocketClient.ts
@@ -47,6 +47,9 @@ export const enum NetMessageEnum {
     ID_AVAILABLE_METRICS_RESPONSE = 18,
     ID_PLOT_DATA_REQUEST = 19,
     ID_PLOT_DATA_RESPONSE = 20,
+    ID_ERROR_MSG = 21,
+    ID_CHECK_HEALTH_REQUEST = 22,
+    ID_SERVER_HEALTHY_RESPONSE = 23,
     // insert new values here before LENGTH
     LENGTH,
 }