X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Fui-server%2FUIWebSocketServer.ts;h=4ac5d23561abcdd9e25a29a8fd12d22d37ba18d8;hb=7cb5b17fac198fe3ecd009ac4c692c0d88dd051e;hp=be2961c522584172560a9736b15f6703f10599da;hpb=5a010bf00a68ca47e0cb610f70ad3e0c16c5fe5e;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 be2961c5..4ac5d235 100644
--- a/src/charging-station/ui-server/UIWebSocketServer.ts
+++ b/src/charging-station/ui-server/UIWebSocketServer.ts
@@ -1,76 +1,190 @@
-import { IncomingMessage } from 'http';
+import type { IncomingMessage } from 'http';
+import type internal from 'stream';
 
-import WebSocket from 'ws';
+import { StatusCodes } from 'http-status-codes';
+import * as uuid from 'uuid';
+import WebSocket, { type RawData, WebSocketServer } from 'ws';
 
-import { ServerOptions } from '../../types/ConfigurationData';
-import { Protocol, ProtocolVersion } from '../../types/UIProtocol';
-import Configuration from '../../utils/Configuration';
+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 UIServiceFactory from './ui-services/UIServiceFactory';
+import { UIServiceUtils } from './ui-services/UIServiceUtils';
 
 const moduleName = 'UIWebSocketServer';
 
 export default class UIWebSocketServer extends AbstractUIServer {
-  public constructor(options?: ServerOptions) {
-    super();
-    this.server = new WebSocket.Server(options ?? Configuration.getUIServer().options);
+  private readonly webSocketServer: WebSocketServer;
+
+  public constructor(protected readonly uiServerConfiguration: UIServerConfiguration) {
+    super(uiServerConfiguration);
+    this.webSocketServer = new WebSocketServer({
+      handleProtocols: UIServiceUtils.handleProtocols,
+      noServer: true,
+    });
   }
 
   public start(): void {
-    this.server.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));
+    this.webSocketServer.on('connection', (ws: WebSocket, req: IncomingMessage): void => {
+      if (UIServiceUtils.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', (rawData) => {
+      const [, version] = UIServiceUtils.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)
-          .requestHandler(rawData)
+          .requestHandler(request)
           .catch(() => {
             /* Error caught by AbstractUIService */
           });
       });
-      socket.on('error', (error) => {
-        logger.error(
-          `${this.logPrefix(moduleName, 'start.socket.onerror')} Error on WebSocket:`,
-          error
+      ws.on('error', (error) => {
+        logger.error(`${this.logPrefix(moduleName, 'start.ws.onerror')} WebSocket error:`, error);
+      });
+      ws.on('close', (code, reason) => {
+        logger.debug(
+          `${this.logPrefix(
+            moduleName,
+            'start.ws.onclose'
+          )} WebSocket closed: '${Utils.getWebSocketCloseEventStatusString(
+            code
+          )}' - '${reason.toString()}'`
         );
       });
     });
+    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;
+          }
+          this.webSocketServer.handleUpgrade(req, socket, head, (ws: WebSocket) => {
+            this.webSocketServer.emit('connection', ws, req);
+          });
+        });
+      }
+    );
+    this.startHttpServer();
   }
 
-  public stop(): void {
-    this.chargingStations.clear();
-  }
-
-  public sendRequest(request: string): void {
-    this.broadcastToClients(request);
+  public sendRequest(request: ProtocolRequest): void {
+    this.broadcastToClients(JSON.stringify(request));
   }
 
-  public sendResponse(response: string): void {
-    // TODO: send response only to the client that sent the request
-    this.broadcastToClients(response);
+  public sendResponse(response: ProtocolResponse): void {
+    const responseId = response[0];
+    try {
+      if (this.responseHandlers.has(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(modName?: string, methodName?: 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
-        ? ` UI WebSocket Server | ${modName}.${methodName}:`
-        : ' UI WebSocket Server |';
+      modName && methodName ? ` ${logMsgPrefix} | ${modName}.${methodName}:` : ` ${logMsgPrefix} |`;
     return Utils.logPrefix(logMsg);
   }
 
   private broadcastToClients(message: string): void {
-    for (const client of (this.server as WebSocket.Server).clients) {
+    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'
+    //   )} Raw data received in string format: ${rawData.toString()}`
+    // );
+
+    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 (uuid.validate(request[0]) === false) {
+      logger.error(
+        `${this.logPrefix(
+          moduleName,
+          'validateRawDataRequest'
+        )} UI protocol request UUID field is invalid:`,
+        request
+      );
+      return false;
+    }
+
+    return request;
+  }
 }