X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Fui-server%2FUIWebSocketServer.ts;h=e322ef8db9901889344e41f9b97d41d1616c7bb3;hb=0b0ca54f0a74240531646827584b7c2738aa7ea1;hp=fcfc309708811f88eeef7857c6dfec13639f0ce4;hpb=b153c0fd46bdc1dc8006e4dac4d4dfa739ff7707;p=e-mobility-charging-stations-simulator.git

diff --git a/src/charging-station/ui-server/UIWebSocketServer.ts b/src/charging-station/ui-server/UIWebSocketServer.ts
index fcfc3097..e322ef8d 100644
--- a/src/charging-station/ui-server/UIWebSocketServer.ts
+++ b/src/charging-station/ui-server/UIWebSocketServer.ts
@@ -1,61 +1,219 @@
-import { Protocol, ProtocolVersion } from '../../types/UIProtocol';
-import WebSocket, { OPEN, Server } from 'ws';
+import type { IncomingMessage } from 'node:http';
+import type { Duplex } from 'node:stream';
+
+import { StatusCodes } from 'http-status-codes';
+import { type RawData, WebSocket, WebSocketServer } from 'ws';
 
 import { AbstractUIServer } from './AbstractUIServer';
-import Configuration from '../../utils/Configuration';
-import { IncomingMessage } from 'http';
-import { ServerOptions } from '../../types/ConfigurationData';
-import UIServiceFactory from './ui-services/UIServiceFactory';
-import Utils from '../../utils/Utils';
-import logger from '../../utils/Logger';
-
-export default class UIWebSocketServer extends AbstractUIServer {
-  public constructor(options?: ServerOptions) {
-    super();
-    this.uiServer = new Server(options ?? Configuration.getUIServer().options);
+import { UIServerUtils } from './UIServerUtils';
+import {
+  type ProtocolRequest,
+  type ProtocolResponse,
+  type UIServerConfiguration,
+  WebSocketCloseEventStatusCode,
+} from '../../types';
+import {
+  Constants,
+  getWebSocketCloseEventStatusString,
+  isNotEmptyString,
+  isNullOrUndefined,
+  logPrefix,
+  logger,
+  validateUUID,
+} from '../../utils';
+
+const moduleName = 'UIWebSocketServer';
+
+export class UIWebSocketServer extends AbstractUIServer {
+  private readonly webSocketServer: WebSocketServer;
+
+  public constructor(protected readonly uiServerConfiguration: UIServerConfiguration) {
+    super(uiServerConfiguration);
+    this.webSocketServer = new WebSocketServer({
+      handleProtocols: UIServerUtils.handleProtocols,
+      noServer: true,
+    });
   }
 
   public start(): void {
-    this.uiServer.on('connection', (socket: WebSocket, request: IncomingMessage): void => {
-      const protocolIndex = socket.protocol.indexOf(Protocol.UI);
-      const version = socket.protocol.substring(
-        protocolIndex + Protocol.UI.length
-      ) as ProtocolVersion;
-      if (!this.uiServices.has(version)) {
-        this.uiServices.set(version, UIServiceFactory.getUIServiceImplementation(version, this));
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    this.webSocketServer.on('connection', (ws: WebSocket, req: IncomingMessage): void => {
+      if (UIServerUtils.isProtocolAndVersionSupported(ws.protocol) === false) {
+        logger.error(
+          `${this.logPrefix(
+            moduleName,
+            'start.server.onconnection',
+          )} Unsupported UI protocol version: '${ws.protocol}'`,
+        );
+        ws.close(WebSocketCloseEventStatusCode.CLOSE_PROTOCOL_ERROR);
       }
-      // FIXME: check connection validity
-      socket.on('message', (messageData) => {
+      const [, version] = UIServerUtils.getProtocolAndVersion(ws.protocol);
+      this.registerProtocolVersionUIService(version);
+      ws.on('message', (rawData) => {
+        const request = this.validateRawDataRequest(rawData);
+        if (request === false) {
+          ws.close(WebSocketCloseEventStatusCode.CLOSE_INVALID_PAYLOAD);
+          return;
+        }
+        const [requestId] = request as ProtocolRequest;
+        this.responseHandlers.set(requestId, ws);
         this.uiServices
           .get(version)
-          .messageHandler(messageData)
-          .catch(() => {
-            logger.error(`${this.logPrefix()} Error while handling message data: %j`, messageData);
-          });
+          ?.requestHandler(request)
+          .then((protocolResponse?: ProtocolResponse) => {
+            if (!isNullOrUndefined(protocolResponse)) {
+              this.sendResponse(protocolResponse!);
+            }
+          })
+          .catch(Constants.EMPTY_FUNCTION);
+      });
+      ws.on('error', (error) => {
+        logger.error(`${this.logPrefix(moduleName, 'start.ws.onerror')} WebSocket error:`, error);
       });
-      socket.on('error', (error) => {
-        logger.error(`${this.logPrefix()} Error on WebSocket: %j`, error);
+      ws.on('close', (code, reason) => {
+        logger.debug(
+          `${this.logPrefix(
+            moduleName,
+            'start.ws.onclose',
+          )} WebSocket closed: '${getWebSocketCloseEventStatusString(
+            code,
+          )}' - '${reason.toString()}'`,
+        );
       });
     });
+    // 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);
+          });
+        } catch (error) {
+          logger.error(
+            `${this.logPrefix(
+              moduleName,
+              'start.httpServer.on.upgrade',
+            )} Error at handling connection upgrade:`,
+            error,
+          );
+        }
+      });
+    });
+    this.startHttpServer();
   }
 
-  public stop(): void {
-    this.uiServer.close();
+  public sendRequest(request: ProtocolRequest): void {
+    this.broadcastToClients(JSON.stringify(request));
   }
 
-  public sendResponse(message: string): void {
-    this.broadcastToClients(message);
+  public sendResponse(response: ProtocolResponse): void {
+    const responseId = response?.[0];
+    try {
+      if (this.hasResponseHandler(responseId)) {
+        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}`,
+          );
+        }
+      } else {
+        logger.error(
+          `${this.logPrefix(
+            moduleName,
+            'sendResponse',
+          )} Response for unknown request id: ${responseId}`,
+        );
+      }
+    } catch (error) {
+      logger.error(
+        `${this.logPrefix(
+          moduleName,
+          'sendResponse',
+        )} Error at sending response id '${responseId}':`,
+        error,
+      );
+    } finally {
+      this.responseHandlers.delete(responseId);
+    }
   }
 
-  public logPrefix(): string {
-    return Utils.logPrefix(' UI WebSocket Server:');
-  }
+  public logPrefix = (modName?: string, methodName?: string, prefixSuffix?: string): string => {
+    const logMsgPrefix = prefixSuffix
+      ? `UI WebSocket Server ${prefixSuffix}`
+      : 'UI WebSocket Server';
+    const logMsg =
+      isNotEmptyString(modName) && isNotEmptyString(methodName)
+        ? ` ${logMsgPrefix} | ${modName}.${methodName}:`
+        : ` ${logMsgPrefix} |`;
+    return logPrefix(logMsg);
+  };
 
   private broadcastToClients(message: string): void {
-    for (const client of (this.uiServer as Server).clients) {
-      if (client?.readyState === OPEN) {
+    for (const client of this.webSocketServer.clients) {
+      if (client?.readyState === WebSocket.OPEN) {
         client.send(message);
       }
     }
   }
+
+  private validateRawDataRequest(rawData: RawData): ProtocolRequest | false {
+    // logger.debug(
+    //   `${this.logPrefix(
+    //     moduleName,
+    //     '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',
+        )} UI protocol request is not an array:`,
+        request,
+      );
+      return false;
+    }
+
+    if (request.length !== 3) {
+      logger.error(
+        `${this.logPrefix(moduleName, 'validateRawDataRequest')} UI protocol request is malformed:`,
+        request,
+      );
+      return false;
+    }
+
+    if (validateUUID(request?.[0]) === false) {
+      logger.error(
+        `${this.logPrefix(
+          moduleName,
+          'validateRawDataRequest',
+        )} UI protocol request UUID field is invalid:`,
+        request,
+      );
+      return false;
+    }
+
+    return request;
+  }
 }