refactor: revert internal exports

[e-mobility-charging-stations-simulator.git] / src / charging-station / ui-server / UIWebSocketServer.ts

diff --git a/src/charging-station/ui-server/UIWebSocketServer.ts b/src/charging-station/ui-server/UIWebSocketServer.ts
index 03cd184ddc81a106fb5a72c17ec35aabc7290014..cc00db13f233af42975062331f054992135ce510 100644 (file)
--- a/src/charging-station/ui-server/UIWebSocketServer.ts
+++ b/src/charging-station/ui-server/UIWebSocketServer.ts
@@ -1,43 +1,45 @@
-import type { IncomingMessage } from 'http';
-import type internal from 'stream';
+import type { IncomingMessage } from 'node:http';
+import type { Duplex } from 'node:stream';
 
 import { StatusCodes } from 'http-status-codes';
-import * as uuid from 'uuid';
 import WebSocket, { type RawData, WebSocketServer } from 'ws';
 
-import type { UIServerConfiguration } from '../../types/ConfigurationData';
-import type { ProtocolRequest, ProtocolResponse } from '../../types/UIProtocol';
-import { WebSocketCloseEventStatusCode } from '../../types/WebSocket';
-import logger from '../../utils/Logger';
-import Utils from '../../utils/Utils';
 import { AbstractUIServer } from './AbstractUIServer';
-import { UIServiceUtils } from './ui-services/UIServiceUtils';
+import { UIServerUtils } from './UIServerUtils';
+import {
+  type ProtocolRequest,
+  type ProtocolResponse,
+  type UIServerConfiguration,
+  WebSocketCloseEventStatusCode,
+} from '../../types';
+import { Constants, Utils, logger } from '../../utils';
 
 const moduleName = 'UIWebSocketServer';
 
-export default class UIWebSocketServer extends AbstractUIServer {
+export class UIWebSocketServer extends AbstractUIServer {
   private readonly webSocketServer: WebSocketServer;
 
   public constructor(protected readonly uiServerConfiguration: UIServerConfiguration) {
     super(uiServerConfiguration);
     this.webSocketServer = new WebSocketServer({
-      handleProtocols: UIServiceUtils.handleProtocols,
+      handleProtocols: UIServerUtils.handleProtocols,
       noServer: true,
     });
   }
 
   public start(): void {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     this.webSocketServer.on('connection', (ws: WebSocket, req: IncomingMessage): void => {
-      const [protocol, version] = UIServiceUtils.getProtocolAndVersion(ws.protocol);
-      if (UIServiceUtils.isProtocolAndVersionSupported(protocol, version) === false) {
+      if (UIServerUtils.isProtocolAndVersionSupported(ws.protocol) === false) {
         logger.error(
           `${this.logPrefix(
             moduleName,
             'start.server.onconnection'
-          )} Unsupported UI protocol version: '${protocol}${version}'`
+          )} Unsupported UI protocol version: '${ws.protocol}'`
         );
         ws.close(WebSocketCloseEventStatusCode.CLOSE_PROTOCOL_ERROR);
       }
+      const [, version] = UIServerUtils.getProtocolAndVersion(ws.protocol);
       this.registerProtocolVersionUIService(version);
       ws.on('message', (rawData) => {
         const request = this.validateRawDataRequest(rawData);
@@ -47,12 +49,7 @@ export default class UIWebSocketServer extends AbstractUIServer {
         }
         const [requestId] = request as ProtocolRequest;
         this.responseHandlers.set(requestId, ws);
-        this.uiServices
-          .get(version)
-          .requestHandler(request)
-          .catch(() => {
-            /* Error caught by AbstractUIService */
-          });
+        this.uiServices.get(version)?.requestHandler(request).catch(Constants.EMPTY_FUNCTION);
       });
       ws.on('error', (error) => {
         logger.error(`${this.logPrefix(moduleName, 'start.ws.onerror')} WebSocket error:`, error);
@@ -68,24 +65,36 @@ export default class UIWebSocketServer extends AbstractUIServer {
         );
       });
     });
-    this.httpServer.on(
-      'upgrade',
-      (req: IncomingMessage, socket: internal.Duplex, head: Buffer): void => {
-        this.authenticate(req, (err) => {
-          if (err) {
-            socket.write(`HTTP/1.1 ${StatusCodes.UNAUTHORIZED} Unauthorized\r\n\r\n`);
-            socket.destroy();
-            return;
-          }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    this.httpServer.on('connect', (req: IncomingMessage, socket: Duplex, head: Buffer) => {
+      if (req.headers?.connection !== 'Upgrade' || req.headers?.upgrade !== 'websocket') {
+        socket.write(`HTTP/1.1 ${StatusCodes.BAD_REQUEST} Bad Request\r\n\r\n`);
+        socket.destroy();
+      }
+    });
+    this.httpServer.on('upgrade', (req: IncomingMessage, socket: Duplex, head: Buffer): void => {
+      this.authenticate(req, (err) => {
+        if (err) {
+          socket.write(`HTTP/1.1 ${StatusCodes.UNAUTHORIZED} Unauthorized\r\n\r\n`);
+          socket.destroy();
+          return;
+        }
+        try {
           this.webSocketServer.handleUpgrade(req, socket, head, (ws: WebSocket) => {
             this.webSocketServer.emit('connection', ws, req);
           });
-        });
-      }
-    );
-    if (this.httpServer.listening === false) {
-      this.httpServer.listen(this.uiServerConfiguration.options);
-    }
+        } catch (error) {
+          logger.error(
+            `${this.logPrefix(
+              moduleName,
+              'start.httpServer.on.upgrade'
+            )} Error at handling connection upgrade:`,
+            error
+          );
+        }
+      });
+    });
+    this.startHttpServer();
   }
 
   public sendRequest(request: ProtocolRequest): void {
@@ -99,8 +108,16 @@ export default class UIWebSocketServer extends AbstractUIServer {
         const ws = this.responseHandlers.get(responseId) as WebSocket;
         if (ws?.readyState === WebSocket.OPEN) {
           ws.send(JSON.stringify(response));
+        } else {
+          logger.error(
+            `${this.logPrefix(
+              moduleName,
+              'sendResponse'
+            )} Error at sending response id '${responseId}', WebSocket is not open: ${
+              ws?.readyState
+            }`
+          );
         }
-        this.responseHandlers.delete(responseId);
       } else {
         logger.error(
           `${this.logPrefix(
@@ -117,17 +134,21 @@ export default class UIWebSocketServer extends AbstractUIServer {
         )} Error at sending response id '${responseId}':`,
         error
       );
+    } finally {
+      this.responseHandlers.delete(responseId);
     }
   }
 
-  public logPrefix(modName?: string, methodName?: string, prefixSuffix?: string): string {
+  public logPrefix = (modName?: string, methodName?: string, prefixSuffix?: string): string => {
     const logMsgPrefix = prefixSuffix
       ? `UI WebSocket Server ${prefixSuffix}`
       : 'UI WebSocket Server';
     const logMsg =
-      modName && methodName ? ` ${logMsgPrefix} | ${modName}.${methodName}:` : ` ${logMsgPrefix} |`;
+      Utils.isNotEmptyString(modName) && Utils.isNotEmptyString(methodName)
+        ? ` ${logMsgPrefix} | ${modName}.${methodName}:`
+        : ` ${logMsgPrefix} |`;
     return Utils.logPrefix(logMsg);
-  }
+  };
 
   private broadcastToClients(message: string): void {
     for (const client of this.webSocketServer.clients) {
@@ -166,7 +187,7 @@ export default class UIWebSocketServer extends AbstractUIServer {
       return false;
     }
 
-    if (uuid.validate(request[0]) === false) {
+    if (Utils.validateUUID(request[0]) === false) {
       logger.error(
         `${this.logPrefix(
           moduleName,