Web UI: add and fix missing commands support

[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 805bda20dbd704744ce8503a77116895d8874af6..092742b718c6e294f44b5e83165f9633182d9292 100644 (file)
--- a/src/charging-station/ui-server/ui-services/AbstractUIService.ts
+++ b/src/charging-station/ui-server/ui-services/AbstractUIService.ts
@@ -1,6 +1,7 @@
 import { RawData } from 'ws';
 
 import BaseError from '../../../exception/BaseError';
+import { Bootstrap } from '../../../internal';
 import { JsonType } from '../../../types/JsonType';
 import {
   ProcedureName,
@@ -13,10 +14,8 @@ import {
   ResponseStatus,
 } from '../../../types/UIProtocol';
 import logger from '../../../utils/Logger';
-import Utils from '../../../utils/Utils';
-import Bootstrap from '../../Bootstrap';
-import WorkerBroadcastChannel from '../../WorkerBroadcastChannel';
-import { AbstractUIServer } from '../AbstractUIServer';
+import UIServiceWorkerBroadcastChannel from '../../UIServiceWorkerBroadcastChannel';
+import type { AbstractUIServer } from '../AbstractUIServer';
 
 const moduleName = 'AbstractUIService';
 
@@ -24,7 +23,7 @@ export default abstract class AbstractUIService {
   protected readonly version: ProtocolVersion;
   protected readonly uiServer: AbstractUIServer;
   protected readonly requestHandlers: Map<ProcedureName, ProtocolRequestHandler>;
-  protected workerBroadcastChannel: WorkerBroadcastChannel;
+  protected uiServiceWorkerBroadcastChannel: UIServiceWorkerBroadcastChannel;
 
   constructor(uiServer: AbstractUIServer, version: ProtocolVersion) {
     this.version = version;
@@ -34,13 +33,13 @@ export default abstract class AbstractUIService {
       [ProcedureName.START_SIMULATOR, this.handleStartSimulator.bind(this)],
       [ProcedureName.STOP_SIMULATOR, this.handleStopSimulator.bind(this)],
     ]);
-    this.workerBroadcastChannel = new WorkerBroadcastChannel();
+    this.uiServiceWorkerBroadcastChannel = new UIServiceWorkerBroadcastChannel(this);
   }
 
   public async requestHandler(request: RawData): Promise<void> {
     let messageId: string;
     let command: ProcedureName;
-    let requestPayload: RequestPayload;
+    let requestPayload: RequestPayload | undefined;
     let responsePayload: ResponsePayload;
     try {
       [messageId, command, requestPayload] = this.requestValidation(request);
@@ -55,41 +54,56 @@ export default abstract class AbstractUIService {
         );
       }
 
-      // Call the message handler to build the response payload
+      // 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 buildProtocolRequest(
+  public logPrefix(modName: string, methodName: string): string {
+    return this.uiServer.logPrefix(modName, methodName);
+  }
+
+  private buildProtocolRequest(
     messageId: string,
     procedureName: ProcedureName,
-    payload: RequestPayload
+    requestPayload: RequestPayload
   ): string {
-    return JSON.stringify([messageId, procedureName, payload] as ProtocolRequest);
+    return JSON.stringify([messageId, procedureName, requestPayload] as ProtocolRequest);
   }
 
-  protected buildProtocolResponse(messageId: string, payload: ResponsePayload): string {
-    return JSON.stringify([messageId, payload] as ProtocolResponse);
+  private buildProtocolResponse(messageId: string, responsePayload: ResponsePayload): string {
+    return JSON.stringify([messageId, responsePayload] as ProtocolResponse);
   }
 
   // Validate the raw data received from the WebSocket
@@ -104,8 +118,8 @@ export default abstract class AbstractUIService {
 
     const data = JSON.parse(rawData.toString()) as JsonType[];
 
-    if (Utils.isIterable(data) === false) {
-      throw new BaseError('UI protocol request is not iterable');
+    if (Array.isArray(data) === false) {
+      throw new BaseError('UI protocol request is not an array');
     }
 
     if (data.length !== 3) {