X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Fui-server%2Fui-services%2FAbstractUIService.ts;h=1dd0ee274da3adb320134e66a4f3798dfe932ace;hb=551e477c2cc2461de8dcc2b263a35c0c50240bbf;hp=b2805ba668b70651c45a6eb19310d4f54fc088a5;hpb=6ebe395c0b807c5bedd4a9130caf8d88bdb10968;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ui-server/ui-services/AbstractUIService.ts b/src/charging-station/ui-server/ui-services/AbstractUIService.ts index b2805ba6..1dd0ee27 100644 --- a/src/charging-station/ui-server/ui-services/AbstractUIService.ts +++ b/src/charging-station/ui-server/ui-services/AbstractUIService.ts @@ -1,77 +1,195 @@ -import { RawData } from 'ws'; - import BaseError from '../../../exception/BaseError'; -import { JsonType } from '../../../types/JsonType'; +import type OCPPError from '../../../exception/OCPPError'; +import { Bootstrap } from '../../../internal'; import { - ProtocolCommand, - ProtocolRequest, - ProtocolRequestHandler, - ProtocolVersion, + ProcedureName, + type ProtocolRequest, + type ProtocolRequestHandler, + type ProtocolVersion, + type RequestPayload, + type ResponsePayload, + ResponseStatus, } from '../../../types/UIProtocol'; +import { + BroadcastChannelProcedureName, + type BroadcastChannelRequestPayload, +} from '../../../types/WorkerBroadcastChannel'; import logger from '../../../utils/Logger'; import Utils from '../../../utils/Utils'; -import { AbstractUIServer } from '../AbstractUIServer'; +import UIServiceWorkerBroadcastChannel from '../../UIServiceWorkerBroadcastChannel'; +import type { AbstractUIServer } from '../AbstractUIServer'; + +const moduleName = 'AbstractUIService'; export default abstract class AbstractUIService { - protected readonly version: ProtocolVersion; - protected readonly uiServer: AbstractUIServer; - protected readonly messageHandlers: Map; + protected static readonly ProcedureNameToBroadCastChannelProcedureNameMap: Omit< + Record, + | ProcedureName.START_SIMULATOR + | ProcedureName.STOP_SIMULATOR + | ProcedureName.LIST_CHARGING_STATIONS + > = { + [ProcedureName.START_CHARGING_STATION]: BroadcastChannelProcedureName.START_CHARGING_STATION, + [ProcedureName.STOP_CHARGING_STATION]: BroadcastChannelProcedureName.STOP_CHARGING_STATION, + [ProcedureName.CLOSE_CONNECTION]: BroadcastChannelProcedureName.CLOSE_CONNECTION, + [ProcedureName.OPEN_CONNECTION]: BroadcastChannelProcedureName.OPEN_CONNECTION, + [ProcedureName.START_AUTOMATIC_TRANSACTION_GENERATOR]: + BroadcastChannelProcedureName.START_AUTOMATIC_TRANSACTION_GENERATOR, + [ProcedureName.STOP_AUTOMATIC_TRANSACTION_GENERATOR]: + BroadcastChannelProcedureName.STOP_AUTOMATIC_TRANSACTION_GENERATOR, + [ProcedureName.START_TRANSACTION]: BroadcastChannelProcedureName.START_TRANSACTION, + [ProcedureName.STOP_TRANSACTION]: BroadcastChannelProcedureName.STOP_TRANSACTION, + [ProcedureName.AUTHORIZE]: BroadcastChannelProcedureName.AUTHORIZE, + [ProcedureName.BOOT_NOTIFICATION]: BroadcastChannelProcedureName.BOOT_NOTIFICATION, + [ProcedureName.STATUS_NOTIFICATION]: BroadcastChannelProcedureName.STATUS_NOTIFICATION, + [ProcedureName.HEARTBEAT]: BroadcastChannelProcedureName.HEARTBEAT, + [ProcedureName.METER_VALUES]: BroadcastChannelProcedureName.METER_VALUES, + [ProcedureName.DATA_TRANSFER]: BroadcastChannelProcedureName.DATA_TRANSFER, + [ProcedureName.DIAGNOSTICS_STATUS_NOTIFICATION]: + BroadcastChannelProcedureName.DIAGNOSTICS_STATUS_NOTIFICATION, + [ProcedureName.FIRMWARE_STATUS_NOTIFICATION]: + BroadcastChannelProcedureName.FIRMWARE_STATUS_NOTIFICATION, + }; + + protected readonly requestHandlers: Map; + private readonly version: ProtocolVersion; + private readonly uiServer: AbstractUIServer; + private readonly uiServiceWorkerBroadcastChannel: UIServiceWorkerBroadcastChannel; + private readonly broadcastChannelRequests: Map; constructor(uiServer: AbstractUIServer, version: ProtocolVersion) { - this.version = version; this.uiServer = uiServer; - this.messageHandlers = new Map([ - [ProtocolCommand.LIST_CHARGING_STATIONS, this.handleListChargingStations.bind(this)], + this.version = version; + this.requestHandlers = new Map([ + [ProcedureName.LIST_CHARGING_STATIONS, this.handleListChargingStations.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(); } - public async messageHandler(request: RawData): Promise { + public async requestHandler(request: ProtocolRequest): Promise { let messageId: string; - let command: ProtocolCommand; - let payload: JsonType; - const protocolRequest = JSON.parse(request.toString()) as ProtocolRequest; - if (Utils.isIterable(protocolRequest)) { - [messageId, command, payload] = protocolRequest; - } else { - throw new BaseError('UI protocol request is not iterable'); - } - // TODO: should probably be moved to the ws verify clients callback - if (protocolRequest.length !== 3) { - throw new BaseError('UI protocol request is malformed'); - } - let messageResponse: JsonType; - if (this.messageHandlers.has(command)) { - try { - // Call the message handler to build the message response - messageResponse = (await this.messageHandlers.get(command)(payload)) as JsonType; - } catch (error) { - // Log - logger.error(this.uiServer.logPrefix() + ' Handle message error: %j', error); - throw error; + let command: ProcedureName; + let requestPayload: RequestPayload | undefined; + let responsePayload: ResponsePayload; + try { + [messageId, command, requestPayload] = request; + + if (this.requestHandlers.has(command) === false) { + throw new BaseError( + `${command} is not implemented to handle message payload ${JSON.stringify( + requestPayload, + null, + 2 + )}` + ); + } + + // Call the request handler to build the response payload + responsePayload = await this.requestHandlers.get(command)(messageId, command, requestPayload); + } catch (error) { + // Log + logger.error(`${this.logPrefix(moduleName, 'messageHandler')} Handle request error:`, error); + responsePayload = { + hashIds: requestPayload?.hashIds, + status: ResponseStatus.FAILURE, + command, + requestPayload, + responsePayload, + errorMessage: (error as Error).message, + errorStack: (error as Error).stack, + errorDetails: (error as OCPPError).details, + }; + } finally { + // Send response for payload not forwarded to broadcast channel + if (responsePayload !== undefined) { + this.sendResponse(messageId, responsePayload); } - } else { - // Throw exception - throw new BaseError( - `${command} is not implemented to handle message payload ${JSON.stringify( - payload, - null, - 2 - )}` - ); } - // Send the message response - this.uiServer.sendResponse(this.buildProtocolMessage(messageId, command, messageResponse)); } - protected buildProtocolMessage( + public sendRequest( messageId: string, - command: ProtocolCommand, - payload: JsonType - ): string { - return JSON.stringify([messageId, command, payload]); + procedureName: ProcedureName, + requestPayload: RequestPayload + ): void { + this.uiServer.sendRequest( + this.uiServer.buildProtocolRequest(messageId, procedureName, requestPayload) + ); + } + + public sendResponse(messageId: string, responsePayload: ResponsePayload): void { + this.uiServer.sendResponse(this.uiServer.buildProtocolResponse(messageId, responsePayload)); + } + + public logPrefix(modName: string, methodName: string): string { + return this.uiServer.logPrefix(modName, methodName, this.version); + } + + public deleteBroadcastChannelRequest(uuid: string): void { + this.broadcastChannelRequests.delete(uuid); + } + + public getBroadcastChannelExpectedResponses(uuid: string): number { + return this.broadcastChannelRequests.get(uuid) ?? 0; + } + + protected handleProtocolRequest( + uuid: string, + procedureName: ProcedureName, + payload: RequestPayload + ): void { + this.sendBroadcastChannelRequest( + uuid, + AbstractUIService.ProcedureNameToBroadCastChannelProcedureNameMap[ + procedureName + ] as BroadcastChannelProcedureName, + payload + ); + } + + private sendBroadcastChannelRequest( + uuid: string, + procedureName: BroadcastChannelProcedureName, + payload: BroadcastChannelRequestPayload + ): void { + if (!Utils.isEmptyArray(payload.hashIds)) { + payload.hashIds = payload.hashIds + .map((hashId) => { + if (this.uiServer.chargingStations.has(hashId) === true) { + return hashId; + } + logger.warn( + `${this.logPrefix( + moduleName, + 'sendBroadcastChannelRequest' + )} Charging station with hashId '${hashId}' not found` + ); + }) + .filter((hashId) => hashId !== undefined); + } + const expectedNumberOfResponses = !Utils.isEmptyArray(payload.hashIds) + ? payload.hashIds.length + : this.uiServer.chargingStations.size; + this.uiServiceWorkerBroadcastChannel.sendRequest([uuid, procedureName, payload]); + this.broadcastChannelRequests.set(uuid, expectedNumberOfResponses); + } + + private handleListChargingStations(): ResponsePayload { + return { + status: ResponseStatus.SUCCESS, + chargingStations: [...this.uiServer.chargingStations.values()], + } as ResponsePayload; + } + + private async handleStartSimulator(): Promise { + await Bootstrap.getInstance().start(); + return { status: ResponseStatus.SUCCESS }; } - private handleListChargingStations(): JsonType { - return Array.from(this.uiServer.chargingStations); + private async handleStopSimulator(): Promise { + await Bootstrap.getInstance().stop(); + return { status: ResponseStatus.SUCCESS }; } }