fix: ensure proper status in add charging stations op response

[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 8617c7ab4051f375d1a7717185b2e753bf7c9976..ffdc256583adccd581d72c99496e3bfe726333e2 100644 (file)
--- a/src/charging-station/ui-server/ui-services/AbstractUIService.ts
+++ b/src/charging-station/ui-server/ui-services/AbstractUIService.ts
@@ -2,7 +2,10 @@ import { BaseError, type OCPPError } from '../../../exception/index.js'
 import {
   BroadcastChannelProcedureName,
   type BroadcastChannelRequestPayload,
+  type ChargingStationInfo,
+  type ChargingStationOptions,
   ConfigurationSection,
+  type JsonObject,
   type JsonType,
   ProcedureName,
   type ProtocolRequest,
@@ -21,6 +24,12 @@ import type { AbstractUIServer } from '../AbstractUIServer.js'
 
 const moduleName = 'AbstractUIService'
 
+interface AddChargingStationsRequestPayload extends RequestPayload {
+  template: string
+  numberOfStations: number
+  options?: ChargingStationOptions
+}
+
 export abstract class AbstractUIService {
   protected static readonly ProcedureNameToBroadCastChannelProcedureNameMapping = new Map<
   ProcedureName,
@@ -28,6 +37,10 @@ export abstract class AbstractUIService {
   >([
     [ProcedureName.START_CHARGING_STATION, BroadcastChannelProcedureName.START_CHARGING_STATION],
     [ProcedureName.STOP_CHARGING_STATION, BroadcastChannelProcedureName.STOP_CHARGING_STATION],
+    [
+      ProcedureName.DELETE_CHARGING_STATIONS,
+      BroadcastChannelProcedureName.DELETE_CHARGING_STATIONS
+    ],
     [ProcedureName.CLOSE_CONNECTION, BroadcastChannelProcedureName.CLOSE_CONNECTION],
     [ProcedureName.OPEN_CONNECTION, BroadcastChannelProcedureName.OPEN_CONNECTION],
     [
@@ -61,7 +74,10 @@ export abstract class AbstractUIService {
   private readonly version: ProtocolVersion
   private readonly uiServer: AbstractUIServer
   private readonly uiServiceWorkerBroadcastChannel: UIServiceWorkerBroadcastChannel
-  private readonly broadcastChannelRequests: Map<string, number>
+  private readonly broadcastChannelRequests: Map<
+    `${string}-${string}-${string}-${string}-${string}`,
+  number
+  >
 
   constructor (uiServer: AbstractUIServer, version: ProtocolVersion) {
     this.uiServer = uiServer
@@ -71,24 +87,33 @@ export abstract class AbstractUIService {
       [ProcedureName.LIST_CHARGING_STATIONS, this.handleListChargingStations.bind(this)],
       [ProcedureName.ADD_CHARGING_STATIONS, this.handleAddChargingStations.bind(this)],
       [ProcedureName.PERFORMANCE_STATISTICS, this.handlePerformanceStatistics.bind(this)],
+      [ProcedureName.SIMULATOR_STATE, this.handleSimulatorState.bind(this)],
       [ProcedureName.START_SIMULATOR, this.handleStartSimulator.bind(this)],
       [ProcedureName.STOP_SIMULATOR, this.handleStopSimulator.bind(this)]
     ])
     this.uiServiceWorkerBroadcastChannel = new UIServiceWorkerBroadcastChannel(this)
-    this.broadcastChannelRequests = new Map<string, number>()
+    this.broadcastChannelRequests = new Map<
+      `${string}-${string}-${string}-${string}-${string}`,
+    number
+    >()
+  }
+
+  public stop (): void {
+    this.broadcastChannelRequests.clear()
+    this.uiServiceWorkerBroadcastChannel.close()
   }
 
   public async requestHandler (request: ProtocolRequest): Promise<ProtocolResponse | undefined> {
-    let messageId: string | undefined
+    let uuid: `${string}-${string}-${string}-${string}-${string}` | undefined
     let command: ProcedureName | undefined
     let requestPayload: RequestPayload | undefined
     let responsePayload: ResponsePayload | undefined
     try {
-      [messageId, command, requestPayload] = request
+      [uuid, command, requestPayload] = request
 
       if (!this.requestHandlers.has(command)) {
         throw new BaseError(
-          `${command} is not implemented to handle message payload ${JSON.stringify(
+          `'${command}' is not implemented to handle message payload ${JSON.stringify(
             requestPayload,
             undefined,
             2
@@ -100,7 +125,7 @@ export abstract class AbstractUIService {
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       const requestHandler = this.requestHandlers.get(command)!
       if (isAsyncFunction(requestHandler)) {
-        responsePayload = await requestHandler(messageId, command, requestPayload)
+        responsePayload = await requestHandler(uuid, command, requestPayload)
       } else {
         responsePayload = (
           requestHandler as (
@@ -108,7 +133,7 @@ export abstract class AbstractUIService {
             procedureName?: ProcedureName,
             payload?: RequestPayload
           ) => undefined | ResponsePayload
-        )(messageId, command, requestPayload)
+        )(uuid, command, requestPayload)
       }
     } catch (error) {
       // Log
@@ -126,23 +151,26 @@ export abstract class AbstractUIService {
     }
     if (responsePayload != null) {
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-      return this.uiServer.buildProtocolResponse(messageId!, responsePayload)
+      return this.uiServer.buildProtocolResponse(uuid!, responsePayload)
     }
   }
 
   // public sendRequest (
-  //   messageId: string,
+  //   uuid: `${string}-${string}-${string}-${string}-${string}`,
   //   procedureName: ProcedureName,
   //   requestPayload: RequestPayload
   // ): void {
   //   this.uiServer.sendRequest(
-  //     this.uiServer.buildProtocolRequest(messageId, procedureName, requestPayload)
+  //     this.uiServer.buildProtocolRequest(uuid, procedureName, requestPayload)
   //   )
   // }
 
-  public sendResponse (messageId: string, responsePayload: ResponsePayload): void {
-    if (this.uiServer.hasResponseHandler(messageId)) {
-      this.uiServer.sendResponse(this.uiServer.buildProtocolResponse(messageId, responsePayload))
+  public sendResponse (
+    uuid: `${string}-${string}-${string}-${string}-${string}`,
+    responsePayload: ResponsePayload
+  ): void {
+    if (this.uiServer.hasResponseHandler(uuid)) {
+      this.uiServer.sendResponse(this.uiServer.buildProtocolResponse(uuid, responsePayload))
     }
   }
 
@@ -150,17 +178,21 @@ export abstract class AbstractUIService {
     return this.uiServer.logPrefix(modName, methodName, this.version)
   }
 
-  public deleteBroadcastChannelRequest (uuid: string): void {
+  public deleteBroadcastChannelRequest (
+    uuid: `${string}-${string}-${string}-${string}-${string}`
+  ): void {
     this.broadcastChannelRequests.delete(uuid)
   }
 
-  public getBroadcastChannelExpectedResponses (uuid: string): number {
+  public getBroadcastChannelExpectedResponses (
+    uuid: `${string}-${string}-${string}-${string}-${string}`
+  ): number {
     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     return this.broadcastChannelRequests.get(uuid)!
   }
 
   protected handleProtocolRequest (
-    uuid: string,
+    uuid: `${string}-${string}-${string}-${string}-${string}`,
     procedureName: ProcedureName,
     payload: RequestPayload
   ): void {
@@ -173,7 +205,7 @@ export abstract class AbstractUIService {
   }
 
   private sendBroadcastChannelRequest (
-    uuid: string,
+    uuid: `${string}-${string}-${string}-${string}-${string}`,
     procedureName: BroadcastChannelProcedureName,
     payload: BroadcastChannelRequestPayload
   ): void {
@@ -222,13 +254,24 @@ export abstract class AbstractUIService {
   }
 
   private async handleAddChargingStations (
-    messageId?: string,
-    procedureName?: ProcedureName,
+    _uuid?: `${string}-${string}-${string}-${string}-${string}`,
+    _procedureName?: ProcedureName,
     requestPayload?: RequestPayload
   ): Promise<ResponsePayload> {
-    const { template, numberOfStations } = requestPayload as {
-      template: string
-      numberOfStations: number
+    const { template, numberOfStations, options } =
+      requestPayload as AddChargingStationsRequestPayload
+    if (!Bootstrap.getInstance().getState().started) {
+      return {
+        status: ResponseStatus.FAILURE,
+        errorMessage:
+          'Cannot add charging station(s) while the charging stations simulator is not started'
+      } satisfies ResponsePayload
+    }
+    if (typeof template !== 'string' || typeof numberOfStations !== 'number') {
+      return {
+        status: ResponseStatus.FAILURE,
+        errorMessage: 'Invalid request payload'
+      } satisfies ResponsePayload
     }
     if (!this.uiServer.chargingStationTemplates.has(template)) {
       return {
@@ -236,23 +279,37 @@ export abstract class AbstractUIService {
         errorMessage: `Template '${template}' not found`
       } satisfies ResponsePayload
     }
+    const succeededStationInfos: ChargingStationInfo[] = []
+    const failedStationInfos: ChargingStationInfo[] = []
+    let err: Error | undefined
     for (let i = 0; i < numberOfStations; i++) {
+      let stationInfo: ChargingStationInfo | undefined
       try {
-        await Bootstrap.getInstance().addChargingStation(
+        stationInfo = await Bootstrap.getInstance().addChargingStation(
           Bootstrap.getInstance().getLastIndex(template) + 1,
-          `${template}.json`
+          `${template}.json`,
+          options
         )
+        if (stationInfo != null) {
+          succeededStationInfos.push(stationInfo)
+        }
       } catch (error) {
-        return {
-          status: ResponseStatus.FAILURE,
-          errorMessage: (error as Error).message,
-          errorStack: (error as Error).stack
-        } satisfies ResponsePayload
+        err = error as Error
+        if (stationInfo != null) {
+          failedStationInfos.push(stationInfo)
+        }
       }
     }
     return {
-      status: ResponseStatus.SUCCESS
-    }
+      status: err != null ? ResponseStatus.FAILURE : ResponseStatus.SUCCESS,
+      ...(succeededStationInfos.length > 0 && {
+        hashIdsSucceeded: succeededStationInfos.map(stationInfo => stationInfo.hashId)
+      }),
+      ...(failedStationInfos.length > 0 && {
+        hashIdsFailed: failedStationInfos.map(stationInfo => stationInfo.hashId)
+      }),
+      ...(err != null && { errorMessage: err.message, errorStack: err.stack })
+    } satisfies ResponsePayload
   }
 
   private handlePerformanceStatistics (): ResponsePayload {
@@ -273,7 +330,22 @@ export abstract class AbstractUIService {
           // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
           ...Bootstrap.getInstance().getPerformanceStatistics()!
         ] as JsonType[]
-      }
+      } satisfies ResponsePayload
+    } catch (error) {
+      return {
+        status: ResponseStatus.FAILURE,
+        errorMessage: (error as Error).message,
+        errorStack: (error as Error).stack
+      } satisfies ResponsePayload
+    }
+  }
+
+  private handleSimulatorState (): ResponsePayload {
+    try {
+      return {
+        status: ResponseStatus.SUCCESS,
+        state: Bootstrap.getInstance().getState() as unknown as JsonObject
+      } satisfies ResponsePayload
     } catch (error) {
       return {
         status: ResponseStatus.FAILURE,