X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Fui-server%2Fui-services%2FAbstractUIService.ts;h=e72af5c0549fa1feb2f4c9bfd66225f53fe76e27;hb=6c1761d470507ea23d186be61b94ca7375c5144a;hp=ba8aa80c374583e22c3101b517d0a27c52c0225b;hpb=33cea51772832a15a2fae0a0ee076fd306a634b3;p=e-mobility-charging-stations-simulator.git

diff --git a/src/charging-station/ui-server/ui-services/AbstractUIService.ts b/src/charging-station/ui-server/ui-services/AbstractUIService.ts
index ba8aa80c..e72af5c0 100644
--- a/src/charging-station/ui-server/ui-services/AbstractUIService.ts
+++ b/src/charging-station/ui-server/ui-services/AbstractUIService.ts
@@ -1,68 +1,134 @@
-import { RawData } from 'ws';
+import type { RawData } from 'ws';
 
 import BaseError from '../../../exception/BaseError';
-import { JsonType } from '../../../types/JsonType';
+import { Bootstrap } from '../../../internal';
+import type { JsonType } from '../../../types/JsonType';
 import {
-  ProtocolCommand,
+  ProcedureName,
   ProtocolRequest,
   ProtocolRequestHandler,
   ProtocolVersion,
+  RequestPayload,
+  ResponsePayload,
+  ResponseStatus,
 } from '../../../types/UIProtocol';
 import logger from '../../../utils/Logger';
-import Utils from '../../../utils/Utils';
-import { AbstractUIServer } from '../AbstractUIServer';
+import UIServiceWorkerBroadcastChannel from '../../UIServiceWorkerBroadcastChannel';
+import type { AbstractUIServer } from '../AbstractUIServer';
+
+const moduleName = 'AbstractUIService';
 
 export default abstract class AbstractUIService {
   protected readonly version: ProtocolVersion;
   protected readonly uiServer: AbstractUIServer;
-  protected readonly messageHandlers: Map<ProtocolCommand, ProtocolRequestHandler>;
+  protected readonly requestHandlers: Map<ProcedureName, ProtocolRequestHandler>;
+  protected uiServiceWorkerBroadcastChannel: UIServiceWorkerBroadcastChannel;
 
   constructor(uiServer: AbstractUIServer, version: ProtocolVersion) {
     this.version = version;
     this.uiServer = uiServer;
-    this.messageHandlers = new Map<ProtocolCommand, ProtocolRequestHandler>([
-      [ProtocolCommand.LIST_CHARGING_STATIONS, this.handleListChargingStations.bind(this)],
+    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.uiServiceWorkerBroadcastChannel = new UIServiceWorkerBroadcastChannel(this);
   }
 
-  public async messageHandler(request: RawData): Promise<void> {
-    let command: ProtocolCommand;
-    let payload: JsonType;
-    const protocolRequest = JSON.parse(request.toString()) as ProtocolRequest;
-    if (Utils.isIterable(protocolRequest)) {
-      [command, payload] = protocolRequest;
-    } else {
-      throw new BaseError('UI protocol request is not iterable');
-    }
-    let messageResponse: JsonType;
-    if (this.messageHandlers.has(command)) {
-      try {
-        // Call the message handler to build the message response
-        messageResponse = (await this.messageHandlers.get(command)(payload)) as JsonType;
-      } catch (error) {
-        // Log
-        logger.error(this.uiServer.logPrefix() + ' Handle message error: %j', error);
-        throw error;
+  public async requestHandler(request: RawData | JsonType): Promise<void> {
+    let messageId: string;
+    let command: ProcedureName;
+    let requestPayload: RequestPayload | undefined;
+    let responsePayload: ResponsePayload;
+    try {
+      [messageId, command, requestPayload] = this.requestValidation(request);
+
+      if (this.requestHandlers.has(command) === false) {
+        throw new BaseError(
+          `${command} is not implemented to handle message payload ${JSON.stringify(
+            requestPayload,
+            null,
+            2
+          )}`
+        );
       }
-    } else {
-      // Throw exception
-      throw new BaseError(
-        `${command} is not implemented to handle message payload ${JSON.stringify(
-          payload,
-          null,
-          2
-        )}`
-      );
+
+      // Call the request handler to build the response payload
+      responsePayload = await this.requestHandlers.get(command)(messageId, requestPayload);
+    } catch (error) {
+      // Log
+      logger.error(`${this.logPrefix(moduleName, 'messageHandler')} Handle request error:`, 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.sendResponse(messageId ?? 'error', responsePayload);
+    }
+  }
+
+  public sendRequest(
+    messageId: string,
+    procedureName: ProcedureName,
+    requestPayload: RequestPayload
+  ): void {
+    this.uiServer.sendRequest(
+      this.uiServer.buildProtocolRequest(messageId, procedureName, requestPayload)
+    );
+  }
+
+  public sendResponse(messageId: string, responsePayload: ResponsePayload): void {
+    this.uiServer.sendResponse(this.uiServer.buildProtocolResponse(messageId, responsePayload));
+  }
+
+  public logPrefix(modName: string, methodName: string): string {
+    return this.uiServer.logPrefix(modName, methodName);
+  }
+
+  // Validate the raw data received from the UI server
+  private requestValidation(rawData: RawData | JsonType): ProtocolRequest {
+    // logger.debug(
+    //   `${this.logPrefix(
+    //     moduleName,
+    //     'requestValidation'
+    //   )} Data received in string format: ${rawData.toString()}`
+    // );
+
+    const data = JSON.parse(rawData.toString()) as JsonType[];
+
+    if (Array.isArray(data) === false) {
+      throw new BaseError('UI protocol request is not an array');
     }
-    // Send the message response
-    this.uiServer.sendResponse(this.buildProtocolMessage(command, messageResponse));
+
+    if (data.length !== 3) {
+      throw new BaseError('UI protocol request is malformed');
+    }
+
+    return data as ProtocolRequest;
+  }
+
+  private handleListChargingStations(): ResponsePayload {
+    // TODO: remove cast to unknown
+    return {
+      status: ResponseStatus.SUCCESS,
+      ...Array.from(this.uiServer.chargingStations.values()),
+    } as unknown as ResponsePayload;
   }
 
-  protected buildProtocolMessage(command: ProtocolCommand, payload: JsonType): string {
-    return JSON.stringify([command, payload]);
+  private async handleStartSimulator(): Promise<ResponsePayload> {
+    await Bootstrap.getInstance().start();
+    return { status: ResponseStatus.SUCCESS };
   }
 
-  private handleListChargingStations(): JsonType {
-    return Array.from(this.uiServer.chargingStations);
+  private async handleStopSimulator(): Promise<ResponsePayload> {
+    await Bootstrap.getInstance().stop();
+    return { status: ResponseStatus.SUCCESS };
   }
 }