UI Protocol: add Authorize command support

[e-mobility-charging-stations-simulator.git] / src / charging-station / ChargingStationWorkerBroadcastChannel.ts

diff --git a/src/charging-station/ChargingStationWorkerBroadcastChannel.ts b/src/charging-station/ChargingStationWorkerBroadcastChannel.ts
index 6ab170e5ba3a49c125236518f46577b3300dc0da..154e1afb14bbb8631fdb570c3a95c2888e4516f2 100644 (file)
--- a/src/charging-station/ChargingStationWorkerBroadcastChannel.ts
+++ b/src/charging-station/ChargingStationWorkerBroadcastChannel.ts
@@ -8,6 +8,8 @@ import {
 import type { HeartbeatResponse, StatusNotificationResponse } from '../types/ocpp/Responses';
 import {
   AuthorizationStatus,
+  AuthorizeRequest,
+  AuthorizeResponse,
   StartTransactionRequest,
   StartTransactionResponse,
   StopTransactionRequest,
@@ -31,14 +33,92 @@ const moduleName = 'ChargingStationWorkerBroadcastChannel';
 type CommandResponse =
   | StartTransactionResponse
   | StopTransactionResponse
+  | AuthorizeResponse
   | StatusNotificationResponse
   | HeartbeatResponse;
 
+type CommandHandler = (
+  requestPayload?: BroadcastChannelRequestPayload
+) => Promise<CommandResponse | void> | void;
+
 export default class ChargingStationWorkerBroadcastChannel extends WorkerBroadcastChannel {
+  private readonly commandHandlers: Map<BroadcastChannelProcedureName, CommandHandler>;
+
   private readonly chargingStation: ChargingStation;
 
   constructor(chargingStation: ChargingStation) {
     super();
+    this.commandHandlers = new Map<BroadcastChannelProcedureName, CommandHandler>([
+      [BroadcastChannelProcedureName.START_CHARGING_STATION, () => this.chargingStation.start()],
+      [
+        BroadcastChannelProcedureName.STOP_CHARGING_STATION,
+        async () => this.chargingStation.stop(),
+      ],
+      [
+        BroadcastChannelProcedureName.OPEN_CONNECTION,
+        () => this.chargingStation.openWSConnection(),
+      ],
+      [
+        BroadcastChannelProcedureName.CLOSE_CONNECTION,
+        () => this.chargingStation.closeWSConnection(),
+      ],
+      [
+        BroadcastChannelProcedureName.START_TRANSACTION,
+        async (requestPayload?: BroadcastChannelRequestPayload) =>
+          this.chargingStation.ocppRequestService.requestHandler<
+            StartTransactionRequest,
+            StartTransactionResponse
+          >(this.chargingStation, RequestCommand.START_TRANSACTION, requestPayload),
+      ],
+      [
+        BroadcastChannelProcedureName.STOP_TRANSACTION,
+        async (requestPayload?: BroadcastChannelRequestPayload) =>
+          this.chargingStation.ocppRequestService.requestHandler<
+            StopTransactionRequest,
+            StartTransactionResponse
+          >(this.chargingStation, RequestCommand.STOP_TRANSACTION, {
+            ...requestPayload,
+            meterStop: this.chargingStation.getEnergyActiveImportRegisterByTransactionId(
+              requestPayload.transactionId,
+              true
+            ),
+          }),
+      ],
+      [
+        BroadcastChannelProcedureName.START_AUTOMATIC_TRANSACTION_GENERATOR,
+        (requestPayload?: BroadcastChannelRequestPayload) =>
+          this.chargingStation.startAutomaticTransactionGenerator(requestPayload.connectorIds),
+      ],
+      [
+        BroadcastChannelProcedureName.STOP_AUTOMATIC_TRANSACTION_GENERATOR,
+        (requestPayload?: BroadcastChannelRequestPayload) =>
+          this.chargingStation.stopAutomaticTransactionGenerator(requestPayload.connectorIds),
+      ],
+      [
+        BroadcastChannelProcedureName.AUTHORIZE,
+        async (requestPayload?: BroadcastChannelRequestPayload) =>
+          this.chargingStation.ocppRequestService.requestHandler<
+            AuthorizeRequest,
+            AuthorizeResponse
+          >(this.chargingStation, RequestCommand.AUTHORIZE, requestPayload),
+      ],
+      [
+        BroadcastChannelProcedureName.STATUS_NOTIFICATION,
+        async (requestPayload?: BroadcastChannelRequestPayload) =>
+          this.chargingStation.ocppRequestService.requestHandler<
+            StatusNotificationRequest,
+            StatusNotificationResponse
+          >(this.chargingStation, RequestCommand.STATUS_NOTIFICATION, requestPayload),
+      ],
+      [
+        BroadcastChannelProcedureName.HEARTBEAT,
+        async (requestPayload?: BroadcastChannelRequestPayload) =>
+          this.chargingStation.ocppRequestService.requestHandler<
+            HeartbeatRequest,
+            HeartbeatResponse
+          >(this.chargingStation, RequestCommand.HEARTBEAT, requestPayload),
+      ],
+    ]);
     this.chargingStation = chargingStation;
     this.onmessage = this.requestHandler.bind(this) as (message: MessageEvent) => void;
     this.onmessageerror = this.messageErrorHandler.bind(this) as (message: MessageEvent) => void;
@@ -68,19 +148,33 @@ export default class ChargingStationWorkerBroadcastChannel extends WorkerBroadca
     }
 
     let responsePayload: BroadcastChannelResponsePayload;
-    let commandResponse: CommandResponse;
+    let commandResponse: CommandResponse | void;
     try {
       commandResponse = await this.commandHandler(command, requestPayload);
-      if (commandResponse === undefined) {
+      if (commandResponse === undefined || commandResponse === null) {
         responsePayload = {
           hashId: this.chargingStation.stationInfo.hashId,
           status: ResponseStatus.SUCCESS,
         };
       } else {
-        responsePayload = {
-          hashId: this.chargingStation.stationInfo.hashId,
-          status: this.commandResponseToResponseStatus(command, commandResponse),
-        };
+        const responseStatus = this.commandResponseToResponseStatus(
+          command,
+          commandResponse as CommandResponse
+        );
+        if (responseStatus === ResponseStatus.SUCCESS) {
+          responsePayload = {
+            hashId: this.chargingStation.stationInfo.hashId,
+            status: responseStatus,
+          };
+        } else {
+          responsePayload = {
+            hashId: this.chargingStation.stationInfo.hashId,
+            status: responseStatus,
+            command,
+            requestPayload,
+            commandResponse: commandResponse as CommandResponse,
+          };
+        }
       }
     } catch (error) {
       logger.error(
@@ -92,7 +186,7 @@ export default class ChargingStationWorkerBroadcastChannel extends WorkerBroadca
         status: ResponseStatus.FAILURE,
         command,
         requestPayload,
-        commandResponse,
+        commandResponse: commandResponse as CommandResponse,
         errorMessage: (error as Error).message,
         errorStack: (error as Error).stack,
         errorDetails: (error as OCPPError).details,
@@ -111,74 +205,24 @@ export default class ChargingStationWorkerBroadcastChannel extends WorkerBroadca
   private async commandHandler(
     command: BroadcastChannelProcedureName,
     requestPayload: BroadcastChannelRequestPayload
-  ): Promise<CommandResponse | undefined> {
-    switch (command) {
-      case BroadcastChannelProcedureName.START_CHARGING_STATION:
-        this.chargingStation.start();
-        break;
-      case BroadcastChannelProcedureName.STOP_CHARGING_STATION:
-        await this.chargingStation.stop();
-        break;
-      case BroadcastChannelProcedureName.OPEN_CONNECTION:
-        this.chargingStation.openWSConnection();
-        break;
-      case BroadcastChannelProcedureName.CLOSE_CONNECTION:
-        this.chargingStation.closeWSConnection();
-        break;
-      case BroadcastChannelProcedureName.START_TRANSACTION:
-        return this.chargingStation.ocppRequestService.requestHandler<
-          StartTransactionRequest,
-          StartTransactionResponse
-        >(this.chargingStation, RequestCommand.START_TRANSACTION, {
-          connectorId: requestPayload.connectorId,
-          idTag: requestPayload.idTag,
-        });
-      case BroadcastChannelProcedureName.STOP_TRANSACTION:
-        return this.chargingStation.ocppRequestService.requestHandler<
-          StopTransactionRequest,
-          StopTransactionResponse
-        >(this.chargingStation, RequestCommand.STOP_TRANSACTION, {
-          transactionId: requestPayload.transactionId,
-          meterStop: this.chargingStation.getEnergyActiveImportRegisterByTransactionId(
-            requestPayload.transactionId,
-            true
-          ),
-          idTag: requestPayload.idTag,
-          reason: requestPayload.reason,
-        });
-      case BroadcastChannelProcedureName.START_AUTOMATIC_TRANSACTION_GENERATOR:
-        this.chargingStation.startAutomaticTransactionGenerator(requestPayload.connectorIds);
-        break;
-      case BroadcastChannelProcedureName.STOP_AUTOMATIC_TRANSACTION_GENERATOR:
-        this.chargingStation.stopAutomaticTransactionGenerator(requestPayload.connectorIds);
-        break;
-      case BroadcastChannelProcedureName.STATUS_NOTIFICATION:
-        return this.chargingStation.ocppRequestService.requestHandler<
-          StatusNotificationRequest,
-          StatusNotificationResponse
-        >(this.chargingStation, RequestCommand.STATUS_NOTIFICATION, {
-          connectorId: requestPayload.connectorId,
-          errorCode: requestPayload.errorCode,
-          status: requestPayload.status,
-          ...(requestPayload.info && { info: requestPayload.info }),
-          ...(requestPayload.timestamp && { timestamp: requestPayload.timestamp }),
-          ...(requestPayload.vendorId && { vendorId: requestPayload.vendorId }),
-          ...(requestPayload.vendorErrorCode && {
-            vendorErrorCode: requestPayload.vendorErrorCode,
-          }),
-        });
-      case BroadcastChannelProcedureName.HEARTBEAT:
-        delete requestPayload.hashId;
-        delete requestPayload.hashIds;
-        delete requestPayload.connectorIds;
-        return this.chargingStation.ocppRequestService.requestHandler<
-          HeartbeatRequest,
-          HeartbeatResponse
-        >(this.chargingStation, RequestCommand.HEARTBEAT, requestPayload);
-      default:
-        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-        throw new BaseError(`Unknown worker broadcast channel command: ${command}`);
+  ): Promise<CommandResponse | void> {
+    if (this.commandHandlers.has(command) === true) {
+      this.cleanRequestPayload(command, requestPayload);
+      return this.commandHandlers.get(command)(requestPayload);
     }
+    throw new BaseError(`Unknown worker broadcast channel command: ${command}`);
+  }
+
+  private cleanRequestPayload(
+    command: BroadcastChannelProcedureName,
+    requestPayload: BroadcastChannelRequestPayload
+  ): void {
+    delete requestPayload.hashId;
+    delete requestPayload.hashIds;
+    [
+      BroadcastChannelProcedureName.START_AUTOMATIC_TRANSACTION_GENERATOR,
+      BroadcastChannelProcedureName.STOP_AUTOMATIC_TRANSACTION_GENERATOR,
+    ].includes(command) === false && delete requestPayload.connectorIds;
   }
 
   private commandResponseToResponseStatus(
@@ -188,9 +232,14 @@ export default class ChargingStationWorkerBroadcastChannel extends WorkerBroadca
     switch (command) {
       case BroadcastChannelProcedureName.START_TRANSACTION:
       case BroadcastChannelProcedureName.STOP_TRANSACTION:
+      case BroadcastChannelProcedureName.AUTHORIZE:
         if (
-          (commandResponse as StartTransactionResponse | StopTransactionResponse)?.idTagInfo
-            ?.status === AuthorizationStatus.ACCEPTED
+          (
+            commandResponse as
+              | StartTransactionResponse
+              | StopTransactionResponse
+              | AuthorizeResponse
+          )?.idTagInfo?.status === AuthorizationStatus.ACCEPTED
         ) {
           return ResponseStatus.SUCCESS;
         }