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