refactor: cleanup default worker options handling
[e-mobility-charging-stations-simulator.git] / src / charging-station / ui-server / UIWebSocketServer.ts
index 5ddf0e5901109321606ac5607b6aa821a7956648..5651ab5a405f3d98c00f0688ff7f493ab7da8a71 100644 (file)
@@ -2,7 +2,7 @@ import type { IncomingMessage } from 'node:http';
 import type { Duplex } from 'node:stream';
 
 import { StatusCodes } from 'http-status-codes';
-import WebSocket, { type RawData, WebSocketServer } from 'ws';
+import { type RawData, WebSocket, WebSocketServer } from 'ws';
 
 import { AbstractUIServer } from './AbstractUIServer';
 import { UIServerUtils } from './UIServerUtils';
@@ -12,7 +12,15 @@ import {
   type UIServerConfiguration,
   WebSocketCloseEventStatusCode,
 } from '../../types';
-import { Constants, Utils, logger } from '../../utils';
+import {
+  Constants,
+  getWebSocketCloseEventStatusString,
+  isNotEmptyString,
+  isNullOrUndefined,
+  logPrefix,
+  logger,
+  validateUUID,
+} from '../../utils';
 
 const moduleName = 'UIWebSocketServer';
 
@@ -34,8 +42,8 @@ export class UIWebSocketServer extends AbstractUIServer {
         logger.error(
           `${this.logPrefix(
             moduleName,
-            'start.server.onconnection'
-          )} Unsupported UI protocol version: '${ws.protocol}'`
+            'start.server.onconnection',
+          )} Unsupported UI protocol version: '${ws.protocol}'`,
         );
         ws.close(WebSocketCloseEventStatusCode.CLOSE_PROTOCOL_ERROR);
       }
@@ -52,9 +60,9 @@ export class UIWebSocketServer extends AbstractUIServer {
         this.uiServices
           .get(version)
           ?.requestHandler(request)
-          .then((protocolResponse: ProtocolResponse) => {
-            if (!Utils.isNullOrUndefined(protocolResponse)) {
-              this.sendResponse(protocolResponse);
+          .then((protocolResponse?: ProtocolResponse) => {
+            if (!isNullOrUndefined(protocolResponse)) {
+              this.sendResponse(protocolResponse!);
             }
           })
           .catch(Constants.EMPTY_FUNCTION);
@@ -66,10 +74,10 @@ export class UIWebSocketServer extends AbstractUIServer {
         logger.debug(
           `${this.logPrefix(
             moduleName,
-            'start.ws.onclose'
-          )} WebSocket closed: '${Utils.getWebSocketCloseEventStatusString(
-            code
-          )}' - '${reason.toString()}'`
+            'start.ws.onclose',
+          )} WebSocket closed: '${getWebSocketCloseEventStatusString(
+            code,
+          )}' - '${reason.toString()}'`,
         );
       });
     });
@@ -95,9 +103,9 @@ export class UIWebSocketServer extends AbstractUIServer {
           logger.error(
             `${this.logPrefix(
               moduleName,
-              'start.httpServer.on.upgrade'
+              'start.httpServer.on.upgrade',
             )} Error at handling connection upgrade:`,
-            error
+            error,
           );
         }
       });
@@ -112,7 +120,7 @@ export class UIWebSocketServer extends AbstractUIServer {
   public sendResponse(response: ProtocolResponse): void {
     const responseId = response[0];
     try {
-      if (this.responseHandlers.has(responseId)) {
+      if (this.hasResponseHandler(responseId)) {
         const ws = this.responseHandlers.get(responseId) as WebSocket;
         if (ws?.readyState === WebSocket.OPEN) {
           ws.send(JSON.stringify(response));
@@ -120,27 +128,25 @@ export class UIWebSocketServer extends AbstractUIServer {
           logger.error(
             `${this.logPrefix(
               moduleName,
-              'sendResponse'
-            )} Error at sending response id '${responseId}', WebSocket is not open: ${
-              ws?.readyState
-            }`
+              'sendResponse',
+            )} Error at sending response id '${responseId}', WebSocket is not open: ${ws?.readyState}`,
           );
         }
       } else {
         logger.error(
           `${this.logPrefix(
             moduleName,
-            'sendResponse'
-          )} Response for unknown request id: ${responseId}`
+            'sendResponse',
+          )} Response for unknown request id: ${responseId}`,
         );
       }
     } catch (error) {
       logger.error(
         `${this.logPrefix(
           moduleName,
-          'sendResponse'
+          'sendResponse',
         )} Error at sending response id '${responseId}':`,
-        error
+        error,
       );
     } finally {
       this.responseHandlers.delete(responseId);
@@ -152,10 +158,10 @@ export class UIWebSocketServer extends AbstractUIServer {
       ? `UI WebSocket Server ${prefixSuffix}`
       : 'UI WebSocket Server';
     const logMsg =
-      Utils.isNotEmptyString(modName) && Utils.isNotEmptyString(methodName)
+      isNotEmptyString(modName) && isNotEmptyString(methodName)
         ? ` ${logMsgPrefix} | ${modName}.${methodName}:`
         : ` ${logMsgPrefix} |`;
-    return Utils.logPrefix(logMsg);
+    return logPrefix(logMsg);
   };
 
   private broadcastToClients(message: string): void {
@@ -170,19 +176,21 @@ export class UIWebSocketServer extends AbstractUIServer {
     // logger.debug(
     //   `${this.logPrefix(
     //     moduleName,
-    //     'validateRawDataRequest'
-    //   )} Raw data received in string format: ${rawData.toString()}`
+    //     'validateRawDataRequest',
+    //     // eslint-disable-next-line @typescript-eslint/no-base-to-string
+    //   )} Raw data received in string format: ${rawData.toString()}`,
     // );
 
+    // eslint-disable-next-line @typescript-eslint/no-base-to-string
     const request = JSON.parse(rawData.toString()) as ProtocolRequest;
 
     if (Array.isArray(request) === false) {
       logger.error(
         `${this.logPrefix(
           moduleName,
-          'validateRawDataRequest'
+          'validateRawDataRequest',
         )} UI protocol request is not an array:`,
-        request
+        request,
       );
       return false;
     }
@@ -190,18 +198,18 @@ export class UIWebSocketServer extends AbstractUIServer {
     if (request.length !== 3) {
       logger.error(
         `${this.logPrefix(moduleName, 'validateRawDataRequest')} UI protocol request is malformed:`,
-        request
+        request,
       );
       return false;
     }
 
-    if (Utils.validateUUID(request[0]) === false) {
+    if (validateUUID(request[0]) === false) {
       logger.error(
         `${this.logPrefix(
           moduleName,
-          'validateRawDataRequest'
+          'validateRawDataRequest',
         )} UI protocol request UUID field is invalid:`,
-        request
+        request,
       );
       return false;
     }