Implement error handling and propagation in IPC and UI server code

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

diff --git a/src/charging-station/ui-server/ui-services/AbstractUIService.ts b/src/charging-station/ui-server/ui-services/AbstractUIService.ts
index dcfd82447de4f20f498e293016fde4d232f96fd4..9c1525dc0aa6df441c0a726d32c3fa09e4f84593 100644 (file)
--- a/src/charging-station/ui-server/ui-services/AbstractUIService.ts
+++ b/src/charging-station/ui-server/ui-services/AbstractUIService.ts
@@ -8,13 +8,14 @@ import {
   ProtocolRequestHandler,
   ProtocolResponse,
   ProtocolVersion,
+  RequestPayload,
   ResponsePayload,
   ResponseStatus,
 } from '../../../types/UIProtocol';
 import logger from '../../../utils/Logger';
 import Utils from '../../../utils/Utils';
 import Bootstrap from '../../Bootstrap';
-import WorkerBroadcastChannel from '../../WorkerBroadcastChannel';
+import UIServiceWorkerBroadcastChannel from '../../UIServiceWorkerBroadcastChannel';
 import { AbstractUIServer } from '../AbstractUIServer';
 
 const moduleName = 'AbstractUIService';
@@ -22,30 +23,29 @@ const moduleName = 'AbstractUIService';
 export default abstract class AbstractUIService {
   protected readonly version: ProtocolVersion;
   protected readonly uiServer: AbstractUIServer;
-  protected readonly messageHandlers: Map<ProcedureName, ProtocolRequestHandler>;
-  protected workerBroadcastChannel: WorkerBroadcastChannel;
+  protected readonly requestHandlers: Map<ProcedureName, ProtocolRequestHandler>;
+  protected workerBroadcastChannel: UIServiceWorkerBroadcastChannel;
 
   constructor(uiServer: AbstractUIServer, version: ProtocolVersion) {
     this.version = version;
     this.uiServer = uiServer;
-    this.messageHandlers = new Map<ProcedureName, ProtocolRequestHandler>([
+    this.requestHandlers = new Map<ProcedureName, ProtocolRequestHandler>([
       [ProcedureName.LIST_CHARGING_STATIONS, this.handleListChargingStations.bind(this)],
       [ProcedureName.START_SIMULATOR, this.handleStartSimulator.bind(this)],
       [ProcedureName.STOP_SIMULATOR, this.handleStopSimulator.bind(this)],
     ]);
-    this.workerBroadcastChannel = new WorkerBroadcastChannel();
+    this.workerBroadcastChannel = new UIServiceWorkerBroadcastChannel(this);
   }
 
-  public async messageHandler(request: RawData): Promise<void> {
+  public async requestHandler(request: RawData): Promise<void> {
     let messageId: string;
     let command: ProcedureName;
-    let requestPayload: JsonType;
+    let requestPayload: RequestPayload | undefined;
     let responsePayload: ResponsePayload;
     try {
-      [messageId, command, requestPayload] = this.dataValidation(request);
+      [messageId, command, requestPayload] = this.requestValidation(request);
 
-      if (this.messageHandlers.has(command) === false) {
-        // Throw exception
+      if (this.requestHandlers.has(command) === false) {
         throw new BaseError(
           `${command} is not implemented to handle message payload ${JSON.stringify(
             requestPayload,
@@ -54,46 +54,69 @@ export default abstract class AbstractUIService {
           )}`
         );
       }
-      // Call the message handler to build the response payload
-      responsePayload = (await this.messageHandlers.get(command)(
-        requestPayload
-      )) as ResponsePayload;
+
+      // Call the request handler to build the response payload
+      responsePayload = await this.requestHandlers.get(command)(messageId, requestPayload);
     } catch (error) {
       // Log
       logger.error(
-        `${this.uiServer.logPrefix(moduleName, 'messageHandler')} Handle message error:`,
+        `${this.uiServer.logPrefix(moduleName, 'messageHandler')} Handle request error:`,
         error
       );
-      // Send the message response failure
-      this.uiServer.sendResponse(
-        this.buildProtocolResponse(messageId ?? 'error', {
-          status: ResponseStatus.FAILURE,
-          command,
-          requestPayload,
-          errorMessage: (error as Error).message,
-          errorStack: (error as Error).stack,
-        })
-      );
-      throw error;
+      responsePayload = {
+        status: ResponseStatus.FAILURE,
+        command,
+        requestPayload,
+        responsePayload,
+        errorMessage: (error as Error).message,
+        errorStack: (error as Error).stack,
+      };
+    }
+
+    if (responsePayload !== undefined) {
+      // Send the response
+      this.uiServer.sendResponse(this.buildProtocolResponse(messageId ?? 'error', responsePayload));
     }
+  }
+
+  public sendRequest(
+    messageId: string,
+    procedureName: ProcedureName,
+    requestPayload: RequestPayload
+  ): void {
+    this.uiServer.sendRequest(this.buildProtocolRequest(messageId, procedureName, requestPayload));
+  }
 
-    // Send the message response success
+  public sendResponse(messageId: string, responsePayload: ResponsePayload): void {
     this.uiServer.sendResponse(this.buildProtocolResponse(messageId, responsePayload));
   }
 
-  protected buildProtocolResponse(messageId: string, payload: ResponsePayload): string {
-    return JSON.stringify([messageId, payload] as ProtocolResponse);
+  public logPrefix(modName: string, methodName: string): string {
+    return `${this.uiServer.logPrefix(modName, methodName)}`;
+  }
+
+  private buildProtocolRequest(
+    messageId: string,
+    procedureName: ProcedureName,
+    requestPayload: RequestPayload
+  ): string {
+    return JSON.stringify([messageId, procedureName, requestPayload] as ProtocolRequest);
+  }
+
+  private buildProtocolResponse(messageId: string, responsePayload: ResponsePayload): string {
+    return JSON.stringify([messageId, responsePayload] as ProtocolResponse);
   }
 
   // Validate the raw data received from the WebSocket
   // TODO: should probably be moved to the ws verify clients callback
-  private dataValidation(rawData: RawData): ProtocolRequest {
-    logger.debug(
-      `${this.uiServer.logPrefix(
-        moduleName,
-        'dataValidation'
-      )} Raw data received: ${rawData.toString()}`
-    );
+  private requestValidation(rawData: RawData): ProtocolRequest {
+    // logger.debug(
+    //   `${this.uiServer.logPrefix(
+    //     moduleName,
+    //     'dataValidation'
+    //   )} Raw data received: ${rawData.toString()}`
+    // );
+
     const data = JSON.parse(rawData.toString()) as JsonType[];
 
     if (Utils.isIterable(data) === false) {
@@ -107,11 +130,12 @@ export default abstract class AbstractUIService {
     return data as ProtocolRequest;
   }
 
-  private handleListChargingStations(): JsonType {
+  private handleListChargingStations(): ResponsePayload {
+    // TODO: remove cast to unknown
     return {
       status: ResponseStatus.SUCCESS,
       ...Array.from(this.uiServer.chargingStations.values()),
-    } as JsonType;
+    } as unknown as ResponsePayload;
   }
 
   private async handleStartSimulator(): Promise<ResponsePayload> {