X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Fui-server%2Fui-services%2FAbstractUIService.ts;h=20531c6f37ce4002d48ac5fe255628086ab5c0e2;hb=44ebef4c21047693fbc194aa9b7f90578465e29a;hp=2e35299cace8ca77d8bf5c04ec102a155e84343d;hpb=4e3ff94d15f16cbeb7f65d14525bca7af3c551fd;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 2e35299c..20531c6f 100644 --- a/src/charging-station/ui-server/ui-services/AbstractUIService.ts +++ b/src/charging-station/ui-server/ui-services/AbstractUIService.ts @@ -1,127 +1,209 @@ -import { RawData } from 'ws'; - -import BaseError from '../../../exception/BaseError'; -import { JsonType } from '../../../types/JsonType'; +import { BaseError, type OCPPError } from '../../../exception'; import { + BroadcastChannelProcedureName, + type BroadcastChannelRequestPayload, ProcedureName, - ProtocolRequest, - ProtocolRequestHandler, - ProtocolResponse, - ProtocolVersion, - RequestPayload, - ResponsePayload, + type ProtocolRequest, + type ProtocolRequestHandler, + type ProtocolResponse, + type ProtocolVersion, + type RequestPayload, + type ResponsePayload, ResponseStatus, -} from '../../../types/UIProtocol'; -import logger from '../../../utils/Logger'; -import Utils from '../../../utils/Utils'; -import Bootstrap from '../../Bootstrap'; -import WorkerBroadcastChannel from '../../WorkerBroadcastChannel'; -import { AbstractUIServer } from '../AbstractUIServer'; +} from '../../../types'; +import { isNotEmptyArray, isNullOrUndefined, logger } from '../../../utils'; +import { Bootstrap } from '../../Bootstrap'; +import { UIServiceWorkerBroadcastChannel } from '../../broadcast-channel/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 workerBroadcastChannel: WorkerBroadcastChannel; +export abstract class AbstractUIService { + protected static readonly ProcedureNameToBroadCastChannelProcedureNameMapping = new Map< + ProcedureName, + BroadcastChannelProcedureName + >([ + [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.SET_SUPERVISION_URL, BroadcastChannelProcedureName.SET_SUPERVISION_URL], + [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([ + 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.workerBroadcastChannel = new WorkerBroadcastChannel(); + this.uiServiceWorkerBroadcastChannel = new UIServiceWorkerBroadcastChannel(this); + this.broadcastChannelRequests = new Map(); } - public async messageHandler(request: RawData): Promise { - let messageId: string; - let command: ProcedureName; - let requestPayload: RequestPayload; - let responsePayload: ResponsePayload; + public async requestHandler(request: ProtocolRequest): Promise { + let messageId: string | undefined; + let command: ProcedureName | undefined; + let requestPayload: RequestPayload | undefined; + let responsePayload: ResponsePayload | undefined; try { - [messageId, command, requestPayload] = this.dataValidation(request); + [messageId, command, requestPayload] = request; - if (this.messageHandlers.has(command) === false) { + if (this.requestHandlers.has(command) === false) { throw new BaseError( `${command} is not implemented to handle message payload ${JSON.stringify( requestPayload, - null, - 2 - )}` + undefined, + 2, + )}`, ); } - // Call the message handler to build the response payload - responsePayload = await this.messageHandlers.get(command)(messageId, requestPayload); + // Call the request handler to build the response payload + responsePayload = await this.requestHandlers.get(command)!( + messageId, + command, + requestPayload, + ); } catch (error) { // Log - logger.error( - `${this.uiServer.logPrefix(moduleName, 'messageHandler')} Handle message error:`, - error - ); - // Send the message response failure - this.uiServer.sendResponse( - this.buildProtocolResponse(messageId ?? 'error', { - status: ResponseStatus.FAILURE, - command, - requestPayload, - errorMessage: (error as Error).message, - errorStack: (error as Error).stack, - }) - ); - throw error; + logger.error(`${this.logPrefix(moduleName, 'requestHandler')} 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, + }; + } + if (!isNullOrUndefined(responsePayload)) { + return this.uiServer.buildProtocolResponse(messageId!, responsePayload!); } - - // Send the message response success - this.uiServer.sendResponse(this.buildProtocolResponse(messageId, responsePayload)); } - protected buildProtocolResponse(messageId: string, payload: ResponsePayload): string { - return JSON.stringify([messageId, payload] as ProtocolResponse); + // public sendRequest( + // messageId: string, + // procedureName: ProcedureName, + // requestPayload: RequestPayload, + // ): void { + // this.uiServer.sendRequest( + // this.uiServer.buildProtocolRequest(messageId, procedureName, requestPayload), + // ); + // } + + public sendResponse(messageId: string, responsePayload: ResponsePayload): void { + if (this.uiServer.hasResponseHandler(messageId)) { + this.uiServer.sendResponse(this.uiServer.buildProtocolResponse(messageId, responsePayload)); + } } - // Validate the raw data received from the WebSocket - // TODO: should probably be moved to the ws verify clients callback - private dataValidation(rawData: RawData): ProtocolRequest { - // logger.debug( - // `${this.uiServer.logPrefix( - // moduleName, - // 'dataValidation' - // )} Raw data received: ${rawData.toString()}` - // ); + public logPrefix = (modName: string, methodName: string): string => { + return this.uiServer.logPrefix(modName, methodName, this.version); + }; - const data = JSON.parse(rawData.toString()) as JsonType[]; + public deleteBroadcastChannelRequest(uuid: string): void { + this.broadcastChannelRequests.delete(uuid); + } - if (Utils.isIterable(data) === false) { - throw new BaseError('UI protocol request is not iterable'); - } + public getBroadcastChannelExpectedResponses(uuid: string): number { + return this.broadcastChannelRequests.get(uuid) ?? 0; + } - if (data.length !== 3) { - throw new BaseError('UI protocol request is malformed'); - } + protected handleProtocolRequest( + uuid: string, + procedureName: ProcedureName, + payload: RequestPayload, + ): void { + this.sendBroadcastChannelRequest( + uuid, + AbstractUIService.ProcedureNameToBroadCastChannelProcedureNameMapping.get(procedureName)!, + payload, + ); + } - return data as ProtocolRequest; + private sendBroadcastChannelRequest( + uuid: string, + procedureName: BroadcastChannelProcedureName, + payload: BroadcastChannelRequestPayload, + ): void { + if (isNotEmptyArray(payload.hashIds)) { + payload.hashIds = payload.hashIds + ?.filter((hashId) => !isNullOrUndefined(hashId)) + ?.map((hashId) => { + if (this.uiServer.chargingStations.has(hashId) === true) { + return hashId; + } + logger.warn( + `${this.logPrefix( + moduleName, + 'sendBroadcastChannelRequest', + )} Charging station with hashId '${hashId}' not found`, + ); + }) as string[]; + } + const expectedNumberOfResponses = isNotEmptyArray(payload.hashIds) + ? payload.hashIds!.length + : this.uiServer.chargingStations.size; + this.uiServiceWorkerBroadcastChannel.sendRequest([uuid, procedureName, payload]); + this.broadcastChannelRequests.set(uuid, expectedNumberOfResponses); } private handleListChargingStations(): ResponsePayload { - // TODO: remove cast to unknown return { status: ResponseStatus.SUCCESS, - ...Array.from(this.uiServer.chargingStations.values()), - } as unknown as ResponsePayload; + chargingStations: [...this.uiServer.chargingStations.values()], + } as ResponsePayload; } private async handleStartSimulator(): Promise { - await Bootstrap.getInstance().start(); - return { status: ResponseStatus.SUCCESS }; + try { + await Bootstrap.getInstance().start(); + return { status: ResponseStatus.SUCCESS }; + } catch { + return { status: ResponseStatus.FAILURE }; + } } private async handleStopSimulator(): Promise { - await Bootstrap.getInstance().stop(); - return { status: ResponseStatus.SUCCESS }; + try { + await Bootstrap.getInstance().stop(); + return { status: ResponseStatus.SUCCESS }; + } catch { + return { status: ResponseStatus.FAILURE }; + } } }