UI Server: Improve error handling

[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 01c57800a293c5d3d9da411812ee6d0388e63f16..03cd184ddc81a106fb5a72c17ec35aabc7290014 100644 (file)
--- a/src/charging-station/ui-server/UIWebSocketServer.ts
+++ b/src/charging-station/ui-server/UIWebSocketServer.ts
@@ -1,17 +1,16 @@
-import { IncomingMessage, createServer } from 'http';
+import type { IncomingMessage } from 'http';
 import type internal from 'stream';
 
 import { StatusCodes } from 'http-status-codes';
-import WebSocket, { RawData, WebSocketServer } from 'ws';
+import * as uuid from 'uuid';
+import WebSocket, { type RawData, WebSocketServer } from 'ws';
 
-import BaseError from '../../exception/BaseError';
 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';
@@ -21,7 +20,6 @@ export default class UIWebSocketServer extends AbstractUIServer {
 
   public constructor(protected readonly uiServerConfiguration: UIServerConfiguration) {
     super(uiServerConfiguration);
-    this.httpServer = createServer();
     this.webSocketServer = new WebSocketServer({
       handleProtocols: UIServiceUtils.handleProtocols,
       noServer: true,
@@ -40,14 +38,18 @@ export default class UIWebSocketServer extends AbstractUIServer {
         );
         ws.close(WebSocketCloseEventStatusCode.CLOSE_PROTOCOL_ERROR);
       }
-      if (this.uiServices.has(version) === false) {
-        this.uiServices.set(version, UIServiceFactory.getUIServiceImplementation(version, this));
-      }
+      this.registerProtocolVersionUIService(version);
       ws.on('message', (rawData) => {
-        const [messageId, procedureName, payload] = this.validateRawDataRequest(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(this.buildProtocolRequest(messageId, procedureName, payload))
+          .requestHandler(request)
           .catch(() => {
             /* Error caught by AbstractUIService */
           });
@@ -86,17 +88,36 @@ export default class UIWebSocketServer extends AbstractUIServer {
     }
   }
 
-  public stop(): void {
-    this.chargingStations.clear();
-  }
-
   public sendRequest(request: ProtocolRequest): void {
     this.broadcastToClients(JSON.stringify(request));
   }
 
   public sendResponse(response: ProtocolResponse): void {
-    // TODO: send response only to the client that sent the request
-    this.broadcastToClients(JSON.stringify(response));
+    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));
+        }
+        this.responseHandlers.delete(responseId);
+      } 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
+      );
+    }
   }
 
   public logPrefix(modName?: string, methodName?: string, prefixSuffix?: string): string {
@@ -116,19 +137,7 @@ export default class UIWebSocketServer extends AbstractUIServer {
     }
   }
 
-  private authenticate(req: IncomingMessage, next: (err?: Error) => void): void {
-    if (this.isBasicAuthEnabled() === true) {
-      if (this.isValidBasicAuth(req) === false) {
-        next(new Error('Unauthorized'));
-      } else {
-        next();
-      }
-    } else {
-      next();
-    }
-  }
-
-  private validateRawDataRequest(rawData: RawData): ProtocolRequest {
+  private validateRawDataRequest(rawData: RawData): ProtocolRequest | false {
     // logger.debug(
     //   `${this.logPrefix(
     //     moduleName,
@@ -139,11 +148,33 @@ export default class UIWebSocketServer extends AbstractUIServer {
     const request = JSON.parse(rawData.toString()) as ProtocolRequest;
 
     if (Array.isArray(request) === false) {
-      throw new BaseError('UI protocol request is not an array');
+      logger.error(
+        `${this.logPrefix(
+          moduleName,
+          'validateRawDataRequest'
+        )} UI protocol request is not an array:`,
+        request
+      );
+      return false;
     }
 
     if (request.length !== 3) {
-      throw new BaseError('UI protocol request is malformed');
+      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;