Vue UI + UI server

[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 b2805ba668b70651c45a6eb19310d4f54fc088a5..dcfd82447de4f20f498e293016fde4d232f96fd4 100644 (file)
--- a/src/charging-station/ui-server/ui-services/AbstractUIService.ts
+++ b/src/charging-station/ui-server/ui-services/AbstractUIService.ts
@@ -3,75 +3,124 @@ import { RawData } from 'ws';
 import BaseError from '../../../exception/BaseError';
 import { JsonType } from '../../../types/JsonType';
 import {
-  ProtocolCommand,
+  ProcedureName,
   ProtocolRequest,
   ProtocolRequestHandler,
+  ProtocolResponse,
   ProtocolVersion,
+  ResponsePayload,
+  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';
 
+const moduleName = 'AbstractUIService';
+
 export default abstract class AbstractUIService {
   protected readonly version: ProtocolVersion;
   protected readonly uiServer: AbstractUIServer;
-  protected readonly messageHandlers: Map<ProtocolCommand, ProtocolRequestHandler>;
+  protected readonly messageHandlers: Map<ProcedureName, ProtocolRequestHandler>;
+  protected workerBroadcastChannel: WorkerBroadcastChannel;
 
   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.messageHandlers = 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();
   }
 
   public async messageHandler(request: RawData): Promise<void> {
     let messageId: string;
-    let command: ProtocolCommand;
-    let payload: JsonType;
-    const protocolRequest = JSON.parse(request.toString()) as ProtocolRequest;
-    if (Utils.isIterable(protocolRequest)) {
-      [messageId, command, payload] = protocolRequest;
-    } else {
-      throw new BaseError('UI protocol request is not iterable');
-    }
-    // TODO: should probably be moved to the ws verify clients callback
-    if (protocolRequest.length !== 3) {
-      throw new BaseError('UI protocol request is malformed');
-    }
-    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;
+    let command: ProcedureName;
+    let requestPayload: JsonType;
+    let responsePayload: ResponsePayload;
+    try {
+      [messageId, command, requestPayload] = this.dataValidation(request);
+
+      if (this.messageHandlers.has(command) === false) {
+        // Throw exception
+        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 message handler to build the response payload
+      responsePayload = (await this.messageHandlers.get(command)(
+        requestPayload
+      )) as ResponsePayload;
+    } catch (error) {
+      // Log
+      logger.error(
+        `${this.uiServer.logPrefix(moduleName, 'messageHandler')} Handle message 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;
     }
-    // Send the message response
-    this.uiServer.sendResponse(this.buildProtocolMessage(messageId, command, messageResponse));
+
+    // Send the message response success
+    this.uiServer.sendResponse(this.buildProtocolResponse(messageId, responsePayload));
   }
 
-  protected buildProtocolMessage(
-    messageId: string,
-    command: ProtocolCommand,
-    payload: JsonType
-  ): string {
-    return JSON.stringify([messageId, command, payload]);
+  protected buildProtocolResponse(messageId: string, payload: ResponsePayload): string {
+    return JSON.stringify([messageId, payload] 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()}`
+    );
+    const data = JSON.parse(rawData.toString()) as JsonType[];
+
+    if (Utils.isIterable(data) === false) {
+      throw new BaseError('UI protocol request is not iterable');
+    }
+
+    if (data.length !== 3) {
+      throw new BaseError('UI protocol request is malformed');
+    }
+
+    return data as ProtocolRequest;
   }
 
   private handleListChargingStations(): JsonType {
-    return Array.from(this.uiServer.chargingStations);
+    return {
+      status: ResponseStatus.SUCCESS,
+      ...Array.from(this.uiServer.chargingStations.values()),
+    } as JsonType;
+  }
+
+  private async handleStartSimulator(): Promise<ResponsePayload> {
+    await Bootstrap.getInstance().start();
+    return { status: ResponseStatus.SUCCESS };
+  }
+
+  private async handleStopSimulator(): Promise<ResponsePayload> {
+    await Bootstrap.getInstance().stop();
+    return { status: ResponseStatus.SUCCESS };
   }
 }