src/charging-station/ChargingStationWorkerBroadcastChannel.ts

   1 import BaseError from '../exception/BaseError';
   2 import { RequestCommand } from '../types/ocpp/Requests';
   3 import {
   4   AuthorizationStatus,
   5   StartTransactionRequest,
   6   StartTransactionResponse,
   7   StopTransactionReason,
   8   StopTransactionRequest,
   9   StopTransactionResponse,
  10 } from '../types/ocpp/Transaction';
  11 import {
  12   BroadcastChannelProcedureName,
  13   BroadcastChannelRequest,
  14   BroadcastChannelRequestPayload,
  15   BroadcastChannelResponsePayload,
  16   MessageEvent,
  17 } from '../types/WorkerBroadcastChannel';
  18 import { ResponseStatus } from '../ui/web/src/types/UIProtocol';
  19 import logger from '../utils/Logger';
  20 import type ChargingStation from './ChargingStation';
  21 import WorkerBroadcastChannel from './WorkerBroadcastChannel';
  22
  23 const moduleName = 'ChargingStationWorkerBroadcastChannel';
  24
  25 type CommandResponse = StartTransactionResponse | StopTransactionResponse;
  26
  27 export default class ChargingStationWorkerBroadcastChannel extends WorkerBroadcastChannel {
  28   private readonly chargingStation: ChargingStation;
  29
  30   constructor(chargingStation: ChargingStation) {
  31     super();
  32     this.chargingStation = chargingStation;
  33     this.onmessage = this.requestHandler.bind(this) as (message: MessageEvent) => void;
  34     this.onmessageerror = this.messageErrorHandler.bind(this) as (message: MessageEvent) => void;
  35   }
  36
  37   private async requestHandler(messageEvent: MessageEvent): Promise<void> {
  38     if (this.isResponse(messageEvent.data)) {
  39       return;
  40     }
  41     this.validateMessageEvent(messageEvent);
  42
  43     const [uuid, command, requestPayload] = messageEvent.data as BroadcastChannelRequest;
  44
  45     if (
  46       requestPayload?.hashId === undefined &&
  47       requestPayload?.hashIds?.includes(this.chargingStation.stationInfo.hashId) === false
  48     ) {
  49       return;
  50     }
  51     if (
  52       requestPayload?.hashIds === undefined &&
  53       requestPayload?.hashId !== this.chargingStation.stationInfo.hashId
  54     ) {
  55       return;
  56     }
  57     if (requestPayload?.hashId !== undefined) {
  58       logger.warn(
  59         `${this.chargingStation.logPrefix()} ${moduleName}.requestHandler: 'hashId' field usage in PDU is deprecated, use 'hashIds' instead`
  60       );
  61     }
  62
  63     let responsePayload: BroadcastChannelResponsePayload;
  64     let commandResponse: CommandResponse;
  65     try {
  66       commandResponse = await this.commandHandler(command, requestPayload);
  67       if (commandResponse === undefined) {
  68         responsePayload = {
  69           hashId: this.chargingStation.stationInfo.hashId,
  70           status: ResponseStatus.SUCCESS,
  71         };
  72       } else {
  73         responsePayload = {
  74           hashId: this.chargingStation.stationInfo.hashId,
  75           status: this.commandResponseToResponseStatus(commandResponse),
  76         };
  77       }
  78     } catch (error) {
  79       logger.error(
  80         `${this.chargingStation.logPrefix()} ${moduleName}.requestHandler: Handle request error:`,
  81         error
  82       );
  83       responsePayload = {
  84         hashId: this.chargingStation.stationInfo.hashId,
  85         status: ResponseStatus.FAILURE,
  86         command,
  87         requestPayload,
  88         commandResponse,
  89         errorMessage: (error as Error).message,
  90         errorStack: (error as Error).stack,
  91       };
  92     }
  93     this.sendResponse([uuid, responsePayload]);
  94   }
  95
  96   private messageErrorHandler(messageEvent: MessageEvent): void {
  97     logger.error(
  98       `${this.chargingStation.logPrefix()} ${moduleName}.messageErrorHandler: Error at handling message:`,
  99       { messageEvent, messageEventData: messageEvent.data }
 100     );
 101   }
 102
 103   private async commandHandler(
 104     command: BroadcastChannelProcedureName,
 105     requestPayload: BroadcastChannelRequestPayload
 106   ): Promise<CommandResponse | undefined> {
 107     switch (command) {
 108       case BroadcastChannelProcedureName.START_CHARGING_STATION:
 109         this.chargingStation.start();
 110         break;
 111       case BroadcastChannelProcedureName.STOP_CHARGING_STATION:
 112         await this.chargingStation.stop();
 113         break;
 114       case BroadcastChannelProcedureName.OPEN_CONNECTION:
 115         this.chargingStation.openWSConnection();
 116         break;
 117       case BroadcastChannelProcedureName.CLOSE_CONNECTION:
 118         this.chargingStation.closeWSConnection();
 119         break;
 120       case BroadcastChannelProcedureName.START_TRANSACTION:
 121         return this.chargingStation.ocppRequestService.requestHandler<
 122           StartTransactionRequest,
 123           StartTransactionResponse
 124         >(this.chargingStation, RequestCommand.START_TRANSACTION, {
 125           connectorId: requestPayload.connectorId,
 126           idTag: requestPayload.idTag,
 127         });
 128       case BroadcastChannelProcedureName.STOP_TRANSACTION:
 129         return this.chargingStation.ocppRequestService.requestHandler<
 130           StopTransactionRequest,
 131           StopTransactionResponse
 132         >(this.chargingStation, RequestCommand.STOP_TRANSACTION, {
 133           transactionId: requestPayload.transactionId,
 134           meterStop: this.chargingStation.getEnergyActiveImportRegisterByTransactionId(
 135             requestPayload.transactionId,
 136             true
 137           ),
 138           idTag: this.chargingStation.getTransactionIdTag(requestPayload.transactionId),
 139           reason: StopTransactionReason.NONE,
 140         });
 141       case BroadcastChannelProcedureName.START_AUTOMATIC_TRANSACTION_GENERATOR:
 142         this.chargingStation.startAutomaticTransactionGenerator(requestPayload.connectorIds);
 143         break;
 144       case BroadcastChannelProcedureName.STOP_AUTOMATIC_TRANSACTION_GENERATOR:
 145         this.chargingStation.stopAutomaticTransactionGenerator(requestPayload.connectorIds);
 146         break;
 147       default:
 148         // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
 149         throw new BaseError(`Unknown worker broadcast channel command: ${command}`);
 150     }
 151   }
 152
 153   private commandResponseToResponseStatus(commandResponse: CommandResponse): ResponseStatus {
 154     if (commandResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
 155       return ResponseStatus.SUCCESS;
 156     }
 157     return ResponseStatus.FAILURE;
 158   }
 159 }