refactor: change to an custom WS class that other services can leverage WS as well

Author: dastine0308

packages/server/src/controllers/BackendController/BackendController.ts

@@ -4,30 +4,32 @@ import type { BackendControllerTypes } from "@/controllers/BackendController/Bac
 import { LapController } from "@/controllers/LapController/LapController";
 
 import DynamoDB from "@/datasources/DynamoDB/DynamoDB";
-import { GrafanaWebSocket } from "@/datasources/GrafanaWebSocket/GrafanaWebSocket";
 import { SocketIO } from "@/datasources/SocketIO/SocketIO";
 import { SolarMQTTClient } from "@/datasources/SolarMQTTClient/SolarMQTTClient";
 import { options } from "@/datasources/SolarMQTTClient/SolarMQTTClient.types";
+import { NativeWebSocket } from "@/datasources/WebSocket/WebSocket";
 
 import { DatabaseManager } from "@/database/DatabaseManager";
 import { logger } from "@/index";
 import { type ITelemetryData } from "@shared/helios-types";
 
+const grafanaWsPath = process.env.GRAFANA_WS_PATH ?? "/grafana-ws";
+
 //getDriverInfo
 export class BackendController implements BackendControllerTypes {
   public dynamoDB: DynamoDB;
   public socketIO: SocketIO;
   public lapController: LapController;
   public mqtt: SolarMQTTClient;
-  public grafanaWebSocket: GrafanaWebSocket;
+  public webSocket: NativeWebSocket;
   public databaseManager: DatabaseManager;
   public carLatency: number;
   constructor(
     httpsServer: Server<typeof IncomingMessage, typeof ServerResponse>,
   ) {
     this.dynamoDB = new DynamoDB(this);
     this.socketIO = new SocketIO(httpsServer, this);
-    this.grafanaWebSocket = new GrafanaWebSocket(httpsServer, this);
+    this.webSocket = new NativeWebSocket(grafanaWsPath, httpsServer, this);
     this.mqtt = new SolarMQTTClient(options, this);
     this.lapController = new LapController(this);
     this.databaseManager = DatabaseManager.getInstance();
@@ -69,8 +71,8 @@ export class BackendController implements BackendControllerTypes {
     // Broadcast the packet to the frontend
     this.socketIO.broadcastPacket(message);
 
-    // Broadcast the packet to the grafana web socket
-    // this.grafanaWebSocket.broadcastPacket(message); // only send the ILapData through WS for now
+    // Broadcast the packet to the native web socket
+    // this.webSocket.broadcastPacket(message); // only send the ILapData through WS for now
 
     // Handle the packet in the lap controller
     await this.lapController.handlePacket(message);

packages/server/src/controllers/BackendController/BackendController.types.ts

@@ -1,9 +1,9 @@
 import type { LapController } from "@/controllers/LapController/LapController";
 
 import DynamoDB from "@/datasources/DynamoDB/DynamoDB";
-import type { GrafanaWebSocket } from "@/datasources/GrafanaWebSocket/GrafanaWebSocket";
 import type { SocketIO } from "@/datasources/SocketIO/SocketIO";
 import type { SolarMQTTClient } from "@/datasources/SolarMQTTClient/SolarMQTTClient";
+import type { NativeWebSocket } from "@/datasources/WebSocket/WebSocket";
 
 import type { ITelemetryData } from "@shared/helios-types";
 
@@ -15,5 +15,5 @@ export interface BackendControllerTypes {
   lapController: LapController;
   mqtt: SolarMQTTClient;
   socketIO: SocketIO;
-  grafanaWebSocket: GrafanaWebSocket;
+  webSocket: NativeWebSocket;
 }

packages/server/src/controllers/LapController/LapController.ts

@@ -158,7 +158,7 @@ export class LapController implements LapControllerType {
   // this function is for calling when lap completes via lap digital being true
   public async handleLapData(lapData: ILapData) {
     await this.backendController.socketIO.broadcastLapData(lapData);
-    await this.backendController.grafanaWebSocket.broadcastLapData(lapData);
+    await this.backendController.webSocket.broadcastLapData(lapData);
     await this.backendController.dynamoDB.insertLapData(lapData);
   }
 

packages/server/src/datasources/GrafanaWebSocket/GrafanaWebSocket.ts renamed to packages/server/src/datasources/WebSocket/WebSocket.ts

@@ -3,20 +3,19 @@ import { type WebSocket, WebSocketServer } from "ws";
 
 import { type BackendController } from "@/controllers/BackendController/BackendController";
 
-import { type GrafanaWebSocketType } from "@/datasources/GrafanaWebSocket/GrafanaWebSocket.types";
+import { type WebSocketType } from "@/datasources/WebSocket/WebSocket.types";
 
 import { createLightweightApplicationLogger } from "@/utils/logger";
 
 import type { ILapData, ITelemetryData } from "@shared/helios-types";
 
-const logger = createLightweightApplicationLogger("GrafanaWebSocket.ts");
+const logger = createLightweightApplicationLogger("WebSocket.ts");
 
-const wsPath = process.env.GRAFANA_WS_PATH ?? "/grafana-ws";
-
-export class GrafanaWebSocket implements GrafanaWebSocketType {
+export class NativeWebSocket implements WebSocketType {
   wss: WebSocketServer;
   backendController: BackendController;
   constructor(
+    wsPath: string,
     httpsServer: Server<typeof IncomingMessage, typeof ServerResponse>,
     backendController: BackendController,
   ) {
@@ -28,7 +27,7 @@ export class GrafanaWebSocket implements GrafanaWebSocketType {
 
     this.wss.on("connection", (ws: WebSocket, req: IncomingMessage) => {
       logger.info(
-        `Grafana WebSocket client connected from ${req.socket.remoteAddress}`,
+        `WebSocket client connected from ${req.socket.remoteAddress}`,
       );
       this.initializeWebSocketListeners(ws);
       ws.send(
@@ -42,9 +41,7 @@ export class GrafanaWebSocket implements GrafanaWebSocketType {
 
   public broadcastPacket(packet: ITelemetryData): void {
     if (this.wss.clients.size === 0) {
-      logger.debug(
-        "No Grafana WebSocket clients connected, skipping broadcast",
-      );
+      logger.debug("No WebSocket clients connected, skipping broadcast");
       return;
     }
     const message = {
@@ -55,19 +52,14 @@ export class GrafanaWebSocket implements GrafanaWebSocketType {
       try {
         ws.send(JSON.stringify(message));
       } catch (error) {
-        logger.error(
-          "Error broadcasting telemetry packet to Grafana WS",
-          error,
-        );
+        logger.error("Error broadcasting telemetry packet to WS", error);
       }
     });
   }
 
   public broadcastLapData(lapData: ILapData): void {
     if (this.wss.clients.size === 0) {
-      logger.debug(
-        "No Grafana WebSocket clients connected, skipping broadcast",
-      );
+      logger.debug("No WebSocket clients connected, skipping broadcast");
       return;
     }
 
@@ -79,20 +71,20 @@ export class GrafanaWebSocket implements GrafanaWebSocketType {
       try {
         ws.send(JSON.stringify(message));
       } catch (error) {
-        logger.error("Error broadcasting lap data to Grafana WS", error);
+        logger.error("Error broadcasting lap data to WS", error);
       }
     });
   }
 
   public initializeWebSocketListeners(ws: WebSocket): void {
     ws.on("close", () => {
-      logger.info("Grafana WebSocket client disconnected");
+      logger.info("WebSocket client disconnected");
     });
 
     ws.on("error", (error: Error) => {
-      logger.error("Grafana WebSocket error:", error);
+      logger.error("WebSocket error:", error);
     });
   }
 }
 
-export default GrafanaWebSocket;
+export default WebSocket;

packages/server/src/datasources/GrafanaWebSocket/GrafanaWebSocket.types.ts renamed to packages/server/src/datasources/WebSocket/WebSocket.types.ts

@@ -2,7 +2,7 @@ import type { WebSocketServer } from "ws";
 
 import type { ILapData, ITelemetryData } from "@shared/helios-types";
 
-export interface GrafanaWebSocketType {
+export interface WebSocketType {
   broadcastLapData(lapData: ILapData): void;
   broadcastPacket(packet: ITelemetryData): void;
   wss: WebSocketServer;