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 { Utils, 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 ProcedureNameToBroadCastChannelProcedureNameMap: 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;
  71     let command: ProcedureName;
  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)(messageId, command, requestPayload);
  89     } catch (error) {
  90       // Log
  91       logger.error(`${this.logPrefix(moduleName, 'requestHandler')} Handle request error:`, error);
  92       responsePayload = {
  93         hashIds: requestPayload?.hashIds,
  94         status: ResponseStatus.FAILURE,
  95         command,
  96         requestPayload,
  97         responsePayload,
  98         errorMessage: (error as Error).message,
  99         errorStack: (error as Error).stack,
 100         errorDetails: (error as OCPPError).details,
 101       };
 102     }
 103     // Send response
 104     if (!Utils.isNullOrUndefined(responsePayload)) {
 105       this.sendResponse(messageId, responsePayload);
 106       return this.uiServer.buildProtocolResponse(messageId, responsePayload);
 107     }
 108   }
 109
 110   public sendRequest(
 111     messageId: string,
 112     procedureName: ProcedureName,
 113     requestPayload: RequestPayload
 114   ): void {
 115     this.uiServer.sendRequest(
 116       this.uiServer.buildProtocolRequest(messageId, procedureName, requestPayload)
 117     );
 118   }
 119
 120   public sendResponse(messageId: string, responsePayload: ResponsePayload): void {
 121     this.uiServer.sendResponse(this.uiServer.buildProtocolResponse(messageId, responsePayload));
 122   }
 123
 124   public logPrefix = (modName: string, methodName: string): string => {
 125     return this.uiServer.logPrefix(modName, methodName, this.version);
 126   };
 127
 128   public deleteBroadcastChannelRequest(uuid: string): void {
 129     this.broadcastChannelRequests.delete(uuid);
 130   }
 131
 132   public getBroadcastChannelExpectedResponses(uuid: string): number {
 133     return this.broadcastChannelRequests.get(uuid) ?? 0;
 134   }
 135
 136   protected handleProtocolRequest(
 137     uuid: string,
 138     procedureName: ProcedureName,
 139     payload: RequestPayload
 140   ): void {
 141     this.sendBroadcastChannelRequest(
 142       uuid,
 143       AbstractUIService.ProcedureNameToBroadCastChannelProcedureNameMap[
 144         procedureName
 145       ] as BroadcastChannelProcedureName,
 146       payload
 147     );
 148   }
 149
 150   private sendBroadcastChannelRequest(
 151     uuid: string,
 152     procedureName: BroadcastChannelProcedureName,
 153     payload: BroadcastChannelRequestPayload
 154   ): void {
 155     if (Utils.isNotEmptyArray(payload.hashIds)) {
 156       payload.hashIds = payload.hashIds
 157         .filter((hashId) => !Utils.isNullOrUndefined(hashId))
 158         .map((hashId) => {
 159           if (this.uiServer.chargingStations.has(hashId) === true) {
 160             return hashId;
 161           }
 162           logger.warn(
 163             `${this.logPrefix(
 164               moduleName,
 165               'sendBroadcastChannelRequest'
 166             )} Charging station with hashId '${hashId}' not found`
 167           );
 168         });
 169     }
 170     const expectedNumberOfResponses = Utils.isNotEmptyArray(payload.hashIds)
 171       ? payload.hashIds.length
 172       : this.uiServer.chargingStations.size;
 173     this.uiServiceWorkerBroadcastChannel.sendRequest([uuid, procedureName, payload]);
 174     this.broadcastChannelRequests.set(uuid, expectedNumberOfResponses);
 175   }
 176
 177   private handleListChargingStations(): ResponsePayload {
 178     return {
 179       status: ResponseStatus.SUCCESS,
 180       chargingStations: [...this.uiServer.chargingStations.values()],
 181     } as ResponsePayload;
 182   }
 183
 184   private async handleStartSimulator(): Promise<ResponsePayload> {
 185     try {
 186       await Bootstrap.getInstance().start();
 187       return { status: ResponseStatus.SUCCESS };
 188     } catch (error) {
 189       return { status: ResponseStatus.FAILURE };
 190     }
 191   }
 192
 193   private async handleStopSimulator(): Promise<ResponsePayload> {
 194     try {
 195       await Bootstrap.getInstance().stop();
 196       return { status: ResponseStatus.SUCCESS };
 197     } catch (error) {
 198       return { status: ResponseStatus.FAILURE };
 199     }
 200   }
 201 }