X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Fcharging-station%2Fui-server%2FUIWebSocketServer.ts;h=bf0a6c444749201fe06d2cdcc6f24b10fa09582a;hb=276e05aec38f4e8b4a8d5ebd8cbbcb30592b414d;hp=ad3847790149823eb9859474b165ab0e878aa389;hpb=8114d10e3893e96bb725ce2fca9744429ee4b75b;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 ad384779..bf0a6c44 100644
--- a/src/charging-station/ui-server/UIWebSocketServer.ts
+++ b/src/charging-station/ui-server/UIWebSocketServer.ts
@@ -1,62 +1,247 @@
-import { IncomingMessage } from 'http';
-
-import WebSocket from 'ws';
-
-import { ServerOptions } from '../../types/ConfigurationData';
-import { Protocol, ProtocolVersion } from '../../types/UIProtocol';
-import Configuration from '../../utils/Configuration';
-import logger from '../../utils/Logger';
-import Utils from '../../utils/Utils';
-import { AbstractUIServer } from './AbstractUIServer';
-import UIServiceFactory from './ui-services/UIServiceFactory';
-
-export default class UIWebSocketServer extends AbstractUIServer {
-  public constructor(options?: ServerOptions) {
-    super();
-    this.server = new WebSocket.Server(options ?? Configuration.getUIServer().options);
+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 {
+  MapStringifyFormat,
+  type ProtocolRequest,
+  type ProtocolResponse,
+  type UIServerConfiguration,
+  WebSocketCloseEventStatusCode
+} from '../../types/index.js'
+import {
+  Constants,
+  getWebSocketCloseEventStatusString,
+  isNotEmptyString,
+  JSONStringify,
+  logger,
+  logPrefix,
+  validateUUID
+} from '../../utils/index.js'
+import { AbstractUIServer } from './AbstractUIServer.js'
+import {
+  getProtocolAndVersion,
+  handleProtocols,
+  isProtocolAndVersionSupported
+} from './UIServerUtils.js'
+
+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,
+      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));
+  public start (): void {
+    this.webSocketServer.on('connection', (ws: WebSocket, _req: IncomingMessage): void => {
+      if (!isProtocolAndVersionSupported(ws.protocol)) {
+        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] = 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
+        this.responseHandlers.set(requestId, ws)
         this.uiServices
           .get(version)
-          .messageHandler(messageData)
-          .catch(() => {
-            logger.error(`${this.logPrefix()} Error while handling message data: %j`, messageData);
-          });
-      });
-      socket.on('error', (error) => {
-        logger.error(`${this.logPrefix()} Error on WebSocket: %j`, error);
-      });
-    });
+          ?.requestHandler(request)
+          .then((protocolResponse?: ProtocolResponse) => {
+            if (protocolResponse != null) {
+              this.sendResponse(protocolResponse)
+            }
+          })
+          .catch(Constants.EMPTY_FUNCTION)
+      })
+      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: '${getWebSocketCloseEventStatusString(
+            code
+          )}' - '${reason.toString()}'`
+        )
+      })
+    })
+    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 => {
+      const onSocketError = (error: Error): void => {
+        logger.error(
+          `${this.logPrefix(
+            moduleName,
+            'start.httpServer.on.upgrade'
+          )} Socket error at connection upgrade event handling:`,
+          error
+        )
+      }
+      socket.on('error', onSocketError)
+      this.authenticate(req, err => {
+        if (err != null) {
+          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 connection upgrade event handling:`,
+            error
+          )
+        }
+      })
+      socket.removeListener('error', onSocketError)
+    })
+    this.startHttpServer()
   }
 
-  public stop(): void {
-    this.server.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(JSONStringify(response, undefined, MapStringifyFormat.object))
+        } 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 != null ? `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.server as WebSocket.Server).clients) {
-      if (client?.readyState === WebSocket.OPEN) {
-        client.send(message);
+  private broadcastToClients (message: string): void {
+    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()}`
+    // )
+
+    let request: ProtocolRequest
+    try {
+      // eslint-disable-next-line @typescript-eslint/no-base-to-string
+      request = JSON.parse(rawData.toString()) as ProtocolRequest
+    } catch (error) {
+      logger.error(
+        `${this.logPrefix(
+          moduleName,
+          'validateRawDataRequest'
+          // eslint-disable-next-line @typescript-eslint/no-base-to-string
+        )} UI protocol request is not valid JSON: ${rawData.toString()}`
+      )
+      return false
+    }
+
+    if (!Array.isArray(request)) {
+      logger.error(
+        `${this.logPrefix(
+          moduleName,
+          'validateRawDataRequest'
+        )} UI protocol request is not an array:`,
+        request
+      )
+      return false
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    if (request.length !== 3) {
+      logger.error(
+        `${this.logPrefix(moduleName, 'validateRawDataRequest')} UI protocol request is malformed:`,
+        request
+      )
+      return false
+    }
+
+    if (!validateUUID(request[0])) {
+      logger.error(
+        `${this.logPrefix(
+          moduleName,
+          'validateRawDataRequest'
+        )} UI protocol request UUID field is invalid:`,
+        request
+      )
+      return false
+    }
+
+    return request
+  }
 }