X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Fui-server%2Fui-services%2FAbstractUIService.ts;h=a393986e8f3b2ae7f9db6f741382440183810ad0;hb=9d73266c8bb85d7e2bc1fab9954a76910fd689eb;hp=db9a036d183054b7fd77cb98dda7ac0e3eb7626f;hpb=f4531dfe1f65b86be9ddce151bd2ee4fddfefb3e;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 db9a036d..a393986e 100644
--- a/src/charging-station/ui-server/ui-services/AbstractUIService.ts
+++ b/src/charging-station/ui-server/ui-services/AbstractUIService.ts
@@ -1,30 +1,32 @@
-import { RawData } from 'ws';
-
 import BaseError from '../../../exception/BaseError';
-import { JsonType } from '../../../types/JsonType';
+import type OCPPError from '../../../exception/OCPPError';
+import { Bootstrap } from '../../../internal';
 import {
   ProcedureName,
   ProtocolRequest,
   ProtocolRequestHandler,
-  ProtocolResponse,
   ProtocolVersion,
   RequestPayload,
   ResponsePayload,
   ResponseStatus,
 } from '../../../types/UIProtocol';
+import type {
+  BroadcastChannelProcedureName,
+  BroadcastChannelRequestPayload,
+} from '../../../types/WorkerBroadcastChannel';
 import logger from '../../../utils/Logger';
 import Utils from '../../../utils/Utils';
-import Bootstrap from '../../Bootstrap';
 import UIServiceWorkerBroadcastChannel from '../../UIServiceWorkerBroadcastChannel';
-import { AbstractUIServer } from '../AbstractUIServer';
+import type { AbstractUIServer } from '../AbstractUIServer';
 
 const moduleName = 'AbstractUIService';
 
 export default abstract class AbstractUIService {
-  protected readonly version: ProtocolVersion;
-  protected readonly uiServer: AbstractUIServer;
   protected readonly requestHandlers: Map<ProcedureName, ProtocolRequestHandler>;
-  protected uiServiceWorkerBroadcastChannel: UIServiceWorkerBroadcastChannel;
+  private readonly version: ProtocolVersion;
+  private readonly uiServer: AbstractUIServer;
+  private readonly uiServiceWorkerBroadcastChannel: UIServiceWorkerBroadcastChannel;
+  private readonly broadcastChannelRequests: Map<string, number>;
 
   constructor(uiServer: AbstractUIServer, version: ProtocolVersion) {
     this.version = version;
@@ -35,15 +37,16 @@ export default abstract class AbstractUIService {
       [ProcedureName.STOP_SIMULATOR, this.handleStopSimulator.bind(this)],
     ]);
     this.uiServiceWorkerBroadcastChannel = new UIServiceWorkerBroadcastChannel(this);
+    this.broadcastChannelRequests = new Map<string, number>();
   }
 
-  public async requestHandler(request: RawData): Promise<void> {
+  public async requestHandler(request: ProtocolRequest): Promise<void> {
     let messageId: string;
     let command: ProcedureName;
     let requestPayload: RequestPayload | undefined;
     let responsePayload: ResponsePayload;
     try {
-      [messageId, command, requestPayload] = this.requestValidation(request);
+      [messageId, command, requestPayload] = request;
 
       if (this.requestHandlers.has(command) === false) {
         throw new BaseError(
@@ -59,23 +62,21 @@ export default abstract class AbstractUIService {
       responsePayload = await this.requestHandlers.get(command)(messageId, requestPayload);
     } catch (error) {
       // Log
-      logger.error(
-        `${this.uiServer.logPrefix(moduleName, 'messageHandler')} Handle request error:`,
-        error
-      );
+      logger.error(`${this.logPrefix(moduleName, 'messageHandler')} Handle request error:`, error);
       responsePayload = {
+        hashIds: requestPayload.hashIds,
         status: ResponseStatus.FAILURE,
         command,
         requestPayload,
         responsePayload,
         errorMessage: (error as Error).message,
         errorStack: (error as Error).stack,
+        errorDetails: (error as OCPPError).details,
       };
     }
-
+    // Send response for payload not forwarded to broadcast channel
     if (responsePayload !== undefined) {
-      // Send the response
-      this.uiServer.sendResponse(this.buildProtocolResponse(messageId ?? 'error', responsePayload));
+      this.sendResponse(messageId ?? 'error', responsePayload);
     }
   }
 
@@ -84,58 +85,59 @@ export default abstract class AbstractUIService {
     procedureName: ProcedureName,
     requestPayload: RequestPayload
   ): void {
-    this.uiServer.sendRequest(this.buildProtocolRequest(messageId, procedureName, requestPayload));
+    this.uiServer.sendRequest(
+      this.uiServer.buildProtocolRequest(messageId, procedureName, requestPayload)
+    );
   }
 
   public sendResponse(messageId: string, responsePayload: ResponsePayload): void {
-    this.uiServer.sendResponse(this.buildProtocolResponse(messageId, responsePayload));
+    this.uiServer.sendResponse(this.uiServer.buildProtocolResponse(messageId, responsePayload));
   }
 
   public logPrefix(modName: string, methodName: string): string {
-    return this.uiServer.logPrefix(modName, methodName);
+    return this.uiServer.logPrefix(modName, methodName, this.version);
   }
 
-  private buildProtocolRequest(
-    messageId: string,
-    procedureName: ProcedureName,
-    requestPayload: RequestPayload
-  ): string {
-    return JSON.stringify([messageId, procedureName, requestPayload] as ProtocolRequest);
+  public deleteBroadcastChannelRequest(uuid: string): void {
+    this.broadcastChannelRequests.delete(uuid);
   }
 
-  private buildProtocolResponse(messageId: string, responsePayload: ResponsePayload): string {
-    return JSON.stringify([messageId, responsePayload] as ProtocolResponse);
+  public getBroadcastChannelExpectedResponses(uuid: string): number {
+    return this.broadcastChannelRequests.get(uuid) ?? 0;
   }
 
-  // Validate the raw data received from the WebSocket
-  // TODO: should probably be moved to the ws verify clients callback
-  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) {
-      throw new BaseError('UI protocol request is not iterable');
-    }
-
-    if (data.length !== 3) {
-      throw new BaseError('UI protocol request is malformed');
+  protected sendBroadcastChannelRequest(
+    uuid: string,
+    procedureName: BroadcastChannelProcedureName,
+    payload: BroadcastChannelRequestPayload
+  ): void {
+    if (!Utils.isEmptyArray(payload.hashIds)) {
+      payload.hashIds = payload.hashIds
+        .map((hashId) => {
+          if (this.uiServer.chargingStations.has(hashId) === true) {
+            return hashId;
+          }
+          logger.warn(
+            `${this.logPrefix(
+              moduleName,
+              'sendBroadcastChannelRequest'
+            )} Charging station with hashId '${hashId}' not found`
+          );
+        })
+        .filter((hashId) => hashId !== undefined);
     }
-
-    return data as ProtocolRequest;
+    const expectedNumberOfResponses = !Utils.isEmptyArray(payload.hashIds)
+      ? payload.hashIds.length
+      : this.uiServer.chargingStations.size;
+    this.uiServiceWorkerBroadcastChannel.sendRequest([uuid, procedureName, payload]);
+    this.broadcastChannelRequests.set(uuid, expectedNumberOfResponses);
   }
 
   private handleListChargingStations(): ResponsePayload {
-    // TODO: remove cast to unknown
     return {
       status: ResponseStatus.SUCCESS,
-      ...Array.from(this.uiServer.chargingStations.values()),
-    } as unknown as ResponsePayload;
+      chargingStations: [...this.uiServer.chargingStations.values()],
+    } as ResponsePayload;
   }
 
   private async handleStartSimulator(): Promise<ResponsePayload> {