src/charging-station/ui-server/ui-services/AbstractUIService.ts

   1 import { BaseError, type OCPPError } from '../../../exception';
   2 import {
   3   BroadcastChannelProcedureName,
   4   type BroadcastChannelRequestPayload,
   5   ProcedureName,
   6   type ProtocolRequest,
   7   type ProtocolRequestHandler,
   8   type ProtocolResponse,
   9   type ProtocolVersion,
  10   type RequestPayload,
  11   type ResponsePayload,
  12   ResponseStatus,
  13 } from '../../../types';
  14 import { isNotEmptyArray, isNullOrUndefined, logger } from '../../../utils';
  15 import { Bootstrap } from '../../Bootstrap';
  16 import { UIServiceWorkerBroadcastChannel } from '../../broadcast-channel/UIServiceWorkerBroadcastChannel';
  17 import type { AbstractUIServer } from '../AbstractUIServer';
  18
  19 const moduleName = 'AbstractUIService';
  20
  21 export abstract class AbstractUIService {
  22   protected static readonly ProcedureNameToBroadCastChannelProcedureNameMapping: Omit<
  23     Record<ProcedureName, BroadcastChannelProcedureName>,
  24     | ProcedureName.START_SIMULATOR
  25     | ProcedureName.STOP_SIMULATOR
  26     | ProcedureName.LIST_CHARGING_STATIONS
  27   > = {
  28     [ProcedureName.START_CHARGING_STATION]: BroadcastChannelProcedureName.START_CHARGING_STATION,
  29     [ProcedureName.STOP_CHARGING_STATION]: BroadcastChannelProcedureName.STOP_CHARGING_STATION,
  30     [ProcedureName.CLOSE_CONNECTION]: BroadcastChannelProcedureName.CLOSE_CONNECTION,
  31     [ProcedureName.OPEN_CONNECTION]: BroadcastChannelProcedureName.OPEN_CONNECTION,
  32     [ProcedureName.START_AUTOMATIC_TRANSACTION_GENERATOR]:
  33       BroadcastChannelProcedureName.START_AUTOMATIC_TRANSACTION_GENERATOR,
  34     [ProcedureName.STOP_AUTOMATIC_TRANSACTION_GENERATOR]:
  35       BroadcastChannelProcedureName.STOP_AUTOMATIC_TRANSACTION_GENERATOR,
  36     [ProcedureName.SET_SUPERVISION_URL]: BroadcastChannelProcedureName.SET_SUPERVISION_URL,
  37     [ProcedureName.START_TRANSACTION]: BroadcastChannelProcedureName.START_TRANSACTION,
  38     [ProcedureName.STOP_TRANSACTION]: BroadcastChannelProcedureName.STOP_TRANSACTION,
  39     [ProcedureName.AUTHORIZE]: BroadcastChannelProcedureName.AUTHORIZE,
  40     [ProcedureName.BOOT_NOTIFICATION]: BroadcastChannelProcedureName.BOOT_NOTIFICATION,
  41     [ProcedureName.STATUS_NOTIFICATION]: BroadcastChannelProcedureName.STATUS_NOTIFICATION,
  42     [ProcedureName.HEARTBEAT]: BroadcastChannelProcedureName.HEARTBEAT,
  43     [ProcedureName.METER_VALUES]: BroadcastChannelProcedureName.METER_VALUES,
  44     [ProcedureName.DATA_TRANSFER]: BroadcastChannelProcedureName.DATA_TRANSFER,
  45     [ProcedureName.DIAGNOSTICS_STATUS_NOTIFICATION]:
  46       BroadcastChannelProcedureName.DIAGNOSTICS_STATUS_NOTIFICATION,
  47     [ProcedureName.FIRMWARE_STATUS_NOTIFICATION]:
  48       BroadcastChannelProcedureName.FIRMWARE_STATUS_NOTIFICATION,
  49   };
  50
  51   protected readonly requestHandlers: Map<ProcedureName, ProtocolRequestHandler>;
  52   private readonly version: ProtocolVersion;
  53   private readonly uiServer: AbstractUIServer;
  54   private readonly uiServiceWorkerBroadcastChannel: UIServiceWorkerBroadcastChannel;
  55   private readonly broadcastChannelRequests: Map<string, number>;
  56
  57   constructor(uiServer: AbstractUIServer, version: ProtocolVersion) {
  58     this.uiServer = uiServer;
  59     this.version = version;
  60     this.requestHandlers = new Map<ProcedureName, ProtocolRequestHandler>([
  61       [ProcedureName.LIST_CHARGING_STATIONS, this.handleListChargingStations.bind(this)],
  62       [ProcedureName.START_SIMULATOR, this.handleStartSimulator.bind(this)],
  63       [ProcedureName.STOP_SIMULATOR, this.handleStopSimulator.bind(this)],
  64     ]);
  65     this.uiServiceWorkerBroadcastChannel = new UIServiceWorkerBroadcastChannel(this);
  66     this.broadcastChannelRequests = new Map<string, number>();
  67   }
  68
  69   public async requestHandler(request: ProtocolRequest): Promise<ProtocolResponse | undefined> {
  70     let messageId: string | undefined;
  71     let command: ProcedureName | undefined;
  72     let requestPayload: RequestPayload | undefined;
  73     let responsePayload: ResponsePayload | undefined;
  74     try {
  75       [messageId, command, requestPayload] = request;
  76
  77       if (this.requestHandlers.has(command) === false) {
  78         throw new BaseError(
  79           `${command} is not implemented to handle message payload ${JSON.stringify(
  80             requestPayload,
  81             null,
  82             2,
  83           )}`,
  84         );
  85       }
  86
  87       // Call the request handler to build the response payload
  88       responsePayload = await this.requestHandlers.get(command)!(
  89         messageId,
  90         command,
  91         requestPayload,
  92       );
  93     } catch (error) {
  94       // Log
  95       logger.error(`${this.logPrefix(moduleName, 'requestHandler')} Handle request error:`, error);
  96       responsePayload = {
  97         hashIds: requestPayload?.hashIds,
  98         status: ResponseStatus.FAILURE,
  99         command,
 100         requestPayload,
 101         responsePayload,
 102         errorMessage: (error as Error).message,
 103         errorStack: (error as Error).stack,
 104         errorDetails: (error as OCPPError).details,
 105       };
 106     }
 107     if (!isNullOrUndefined(responsePayload)) {
 108       return this.uiServer.buildProtocolResponse(messageId!, responsePayload!);
 109     }
 110   }
 111
 112   // public sendRequest(
 113   //   messageId: string,
 114   //   procedureName: ProcedureName,
 115   //   requestPayload: RequestPayload
 116   // ): void {
 117   //   this.uiServer.sendRequest(
 118   //     this.uiServer.buildProtocolRequest(messageId, procedureName, requestPayload)
 119   //   );
 120   // }
 121
 122   public sendResponse(messageId: string, responsePayload: ResponsePayload): void {
 123     if (this.uiServer.hasResponseHandler(messageId)) {
 124       this.uiServer.sendResponse(this.uiServer.buildProtocolResponse(messageId, responsePayload));
 125     }
 126   }
 127
 128   public logPrefix = (modName: string, methodName: string): string => {
 129     return this.uiServer.logPrefix(modName, methodName, this.version);
 130   };
 131
 132   public deleteBroadcastChannelRequest(uuid: string): void {
 133     this.broadcastChannelRequests.delete(uuid);
 134   }
 135
 136   public getBroadcastChannelExpectedResponses(uuid: string): number {
 137     return this.broadcastChannelRequests.get(uuid) ?? 0;
 138   }
 139
 140   protected handleProtocolRequest(
 141     uuid: string,
 142     procedureName: ProcedureName,
 143     payload: RequestPayload,
 144   ): void {
 145     this.sendBroadcastChannelRequest(
 146       uuid,
 147       AbstractUIService.ProcedureNameToBroadCastChannelProcedureNameMapping[
 148         procedureName
 149       ] as BroadcastChannelProcedureName,
 150       payload,
 151     );
 152   }
 153
 154   private sendBroadcastChannelRequest(
 155     uuid: string,
 156     procedureName: BroadcastChannelProcedureName,
 157     payload: BroadcastChannelRequestPayload,
 158   ): void {
 159     if (isNotEmptyArray(payload.hashIds)) {
 160       payload.hashIds = payload.hashIds
 161         ?.filter((hashId) => !isNullOrUndefined(hashId))
 162         ?.map((hashId) => {
 163           if (this.uiServer.chargingStations.has(hashId) === true) {
 164             return hashId;
 165           }
 166           logger.warn(
 167             `${this.logPrefix(
 168               moduleName,
 169               'sendBroadcastChannelRequest',
 170             )} Charging station with hashId '${hashId}' not found`,
 171           );
 172         }) as string[];
 173     }
 174     const expectedNumberOfResponses = isNotEmptyArray(payload.hashIds)
 175       ? payload.hashIds!.length
 176       : this.uiServer.chargingStations.size;
 177     this.uiServiceWorkerBroadcastChannel.sendRequest([uuid, procedureName, payload]);
 178     this.broadcastChannelRequests.set(uuid, expectedNumberOfResponses);
 179   }
 180
 181   private handleListChargingStations(): ResponsePayload {
 182     return {
 183       status: ResponseStatus.SUCCESS,
 184       chargingStations: [...this.uiServer.chargingStations.values()],
 185     } as ResponsePayload;
 186   }
 187
 188   private async handleStartSimulator(): Promise<ResponsePayload> {
 189     try {
 190       await Bootstrap.getInstance().start();
 191       return { status: ResponseStatus.SUCCESS };
 192     } catch (error) {
 193       return { status: ResponseStatus.FAILURE };
 194     }
 195   }
 196
 197   private async handleStopSimulator(): Promise<ResponsePayload> {
 198     try {
 199       await Bootstrap.getInstance().stop();
 200       return { status: ResponseStatus.SUCCESS };
 201     } catch (error) {
 202       return { status: ResponseStatus.FAILURE };
 203     }
 204   }
 205 }