X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Fui-server%2Fui-services%2FAbstractUIService.ts;h=6ba08807b3afcecc895428cab5911797f9cbf718;hb=2ea8735dffc06e2aa7442971134d2c0cd3100872;hp=24307992872011f53053977131a93b0b4cb826ad;hpb=49bc4b806d6320bfb011d3a2c7fee843fb5f7e9c;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 24307992..6ba08807 100644 --- a/src/charging-station/ui-server/ui-services/AbstractUIService.ts +++ b/src/charging-station/ui-server/ui-services/AbstractUIService.ts @@ -1,145 +1,383 @@ -import { RawData } from 'ws'; - -import BaseError from '../../../exception/BaseError'; -import { Bootstrap } from '../../../internal'; -import { JsonType } from '../../../types/JsonType'; +import { BaseError, type OCPPError } from '../../../exception/index.js' import { + BroadcastChannelProcedureName, + type BroadcastChannelRequestPayload, + type ChargingStationInfo, + type ChargingStationOptions, + ConfigurationSection, + type JsonObject, + type JsonType, 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 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 requestHandlers: Map; - protected uiServiceWorkerBroadcastChannel: UIServiceWorkerBroadcastChannel; - - constructor(uiServer: AbstractUIServer, version: ProtocolVersion) { - this.version = version; - this.uiServer = uiServer; + type StorageConfiguration +} from '../../../types/index.js' +import { Configuration, isAsyncFunction, 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' + +interface AddChargingStationsRequestPayload extends RequestPayload { + template: string + numberOfStations: number + options?: ChargingStationOptions +} + +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.DELETE_CHARGING_STATIONS, + BroadcastChannelProcedureName.DELETE_CHARGING_STATIONS + ], + [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< + `${string}-${string}-${string}-${string}-${string}`, + number + > + + constructor (uiServer: AbstractUIServer, version: ProtocolVersion) { + this.uiServer = uiServer + this.version = version this.requestHandlers = new Map([ + [ProcedureName.LIST_TEMPLATES, this.handleListTemplates.bind(this)], [ProcedureName.LIST_CHARGING_STATIONS, this.handleListChargingStations.bind(this)], + [ProcedureName.ADD_CHARGING_STATIONS, this.handleAddChargingStations.bind(this)], + [ProcedureName.PERFORMANCE_STATISTICS, this.handlePerformanceStatistics.bind(this)], + [ProcedureName.SIMULATOR_STATE, this.handleSimulatorState.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< + `${string}-${string}-${string}-${string}-${string}`, + number + >() } - public async requestHandler(request: RawData | JsonType): Promise { - let messageId: string; - let command: ProcedureName; - let requestPayload: RequestPayload | undefined; - let responsePayload: ResponsePayload; + public stop (): void { + this.broadcastChannelRequests.clear() + this.uiServiceWorkerBroadcastChannel.close() + } + + public async requestHandler (request: ProtocolRequest): Promise { + let uuid: `${string}-${string}-${string}-${string}-${string}` | undefined + let command: ProcedureName | undefined + let requestPayload: RequestPayload | undefined + let responsePayload: ResponsePayload | undefined try { - [messageId, command, requestPayload] = this.requestValidation(request); + [uuid, 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( + `'${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 + const requestHandler = this.requestHandlers.get(command)! + if (isAsyncFunction(requestHandler)) { + responsePayload = await requestHandler(uuid, command, requestPayload) + } else { + responsePayload = ( + requestHandler as ( + uuid?: string, + procedureName?: ProcedureName, + payload?: RequestPayload + ) => undefined | ResponsePayload + )(uuid, command, requestPayload) + } } catch (error) { // Log - logger.error(`${this.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 + } satisfies ResponsePayload } - - if (responsePayload !== undefined) { - // Send the response - this.sendResponse(messageId ?? 'error', responsePayload); + if (responsePayload != null) { + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + return this.uiServer.buildProtocolResponse(uuid!, responsePayload) } } - public sendRequest( - messageId: string, - procedureName: ProcedureName, - requestPayload: RequestPayload + // public sendRequest ( + // uuid: `${string}-${string}-${string}-${string}-${string}`, + // procedureName: ProcedureName, + // requestPayload: RequestPayload + // ): void { + // this.uiServer.sendRequest( + // this.uiServer.buildProtocolRequest(uuid, procedureName, requestPayload) + // ) + // } + + public sendResponse ( + uuid: `${string}-${string}-${string}-${string}-${string}`, + responsePayload: ResponsePayload ): void { - this.uiServer.sendRequest(this.buildProtocolRequest(messageId, procedureName, requestPayload)); + if (this.uiServer.hasResponseHandler(uuid)) { + this.uiServer.sendResponse(this.uiServer.buildProtocolResponse(uuid, 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}-${string}-${string}-${string}-${string}` + ): void { + this.broadcastChannelRequests.delete(uuid) + } + + public getBroadcastChannelExpectedResponses ( + uuid: `${string}-${string}-${string}-${string}-${string}` + ): number { + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + return this.broadcastChannelRequests.get(uuid)! } - private buildProtocolRequest( - messageId: string, + protected handleProtocolRequest ( + uuid: `${string}-${string}-${string}-${string}-${string}`, procedureName: ProcedureName, - requestPayload: RequestPayload - ): string { - return JSON.stringify([messageId, procedureName, requestPayload] as ProtocolRequest); + payload: RequestPayload + ): void { + this.sendBroadcastChannelRequest( + uuid, + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + AbstractUIService.ProcedureNameToBroadCastChannelProcedureNameMapping.get(procedureName)!, + payload + ) } - private buildProtocolResponse(messageId: string, responsePayload: ResponsePayload): string { - return JSON.stringify([messageId, responsePayload] as ProtocolResponse); + private sendBroadcastChannelRequest ( + uuid: `${string}-${string}-${string}-${string}-${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 + } + 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' + ) + } + this.uiServiceWorkerBroadcastChannel.sendRequest([uuid, procedureName, payload]) + this.broadcastChannelRequests.set(uuid, expectedNumberOfResponses) } - // Validate the raw data received from the UI server - private requestValidation(rawData: RawData | JsonType): ProtocolRequest { - // logger.debug( - // `${this.logPrefix( - // moduleName, - // 'requestValidation' - // )} Data received in string format: ${rawData.toString()}` - // ); + private handleListTemplates (): ResponsePayload { + return { + status: ResponseStatus.SUCCESS, + templates: [...this.uiServer.chargingStationTemplates.values()] as JsonType[] + } satisfies ResponsePayload + } - const data = JSON.parse(rawData.toString()) as JsonType[]; + private handleListChargingStations (): ResponsePayload { + return { + status: ResponseStatus.SUCCESS, + chargingStations: [...this.uiServer.chargingStations.values()] as JsonType[] + } satisfies ResponsePayload + } - if (Array.isArray(data) === false) { - throw new BaseError('UI protocol request is not an array'); + private async handleAddChargingStations ( + _uuid?: `${string}-${string}-${string}-${string}-${string}`, + _procedureName?: ProcedureName, + requestPayload?: RequestPayload + ): Promise { + const { template, numberOfStations, options } = + requestPayload as AddChargingStationsRequestPayload + if (!Bootstrap.getInstance().getState().started) { + return { + status: ResponseStatus.FAILURE, + errorMessage: + 'Cannot add charging station(s) while the charging stations simulator is not started' + } satisfies ResponsePayload } - - if (data.length !== 3) { - throw new BaseError('UI protocol request is malformed'); + if (typeof template !== 'string' || typeof numberOfStations !== 'number') { + return { + status: ResponseStatus.FAILURE, + errorMessage: 'Invalid request payload' + } satisfies ResponsePayload + } + if (!this.uiServer.chargingStationTemplates.has(template)) { + return { + status: ResponseStatus.FAILURE, + errorMessage: `Template '${template}' not found` + } satisfies ResponsePayload + } + const succeededStationInfos: ChargingStationInfo[] = [] + const failedStationInfos: ChargingStationInfo[] = [] + let err: Error | undefined + for (let i = 0; i < numberOfStations; i++) { + let stationInfo: ChargingStationInfo | undefined + try { + stationInfo = await Bootstrap.getInstance().addChargingStation( + Bootstrap.getInstance().getLastIndex(template) + 1, + `${template}.json`, + options + ) + if (stationInfo != null) { + succeededStationInfos.push(stationInfo) + } + } catch (error) { + err = error as Error + if (stationInfo != null) { + failedStationInfos.push(stationInfo) + } + } } + return { + status: failedStationInfos.length > 0 ? ResponseStatus.FAILURE : ResponseStatus.SUCCESS, + ...(succeededStationInfos.length > 0 && { + hashIdsSucceeded: succeededStationInfos.map(stationInfo => stationInfo.hashId) + }), + ...(failedStationInfos.length > 0 && { + hashIdsFailed: failedStationInfos.map(stationInfo => stationInfo.hashId) + }), + ...(err != null && { errorMessage: err.message, errorStack: err.stack }) + } satisfies ResponsePayload + } - return data as ProtocolRequest; + private handlePerformanceStatistics (): ResponsePayload { + if ( + Configuration.getConfigurationSection( + ConfigurationSection.performanceStorage + ).enabled !== true + ) { + return { + status: ResponseStatus.FAILURE, + errorMessage: 'Performance statistics storage is not enabled' + } satisfies ResponsePayload + } + try { + return { + status: ResponseStatus.SUCCESS, + performanceStatistics: [ + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + ...Bootstrap.getInstance().getPerformanceStatistics()! + ] as JsonType[] + } satisfies ResponsePayload + } catch (error) { + return { + status: ResponseStatus.FAILURE, + errorMessage: (error as Error).message, + errorStack: (error as Error).stack + } satisfies ResponsePayload + } } - private handleListChargingStations(): ResponsePayload { - // TODO: remove cast to unknown - return { - status: ResponseStatus.SUCCESS, - ...Array.from(this.uiServer.chargingStations.values()), - } as unknown as ResponsePayload; + private handleSimulatorState (): ResponsePayload { + try { + return { + status: ResponseStatus.SUCCESS, + state: Bootstrap.getInstance().getState() as unknown as JsonObject + } satisfies ResponsePayload + } catch (error) { + return { + status: ResponseStatus.FAILURE, + errorMessage: (error as Error).message, + errorStack: (error as Error).stack + } 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 (error) { + return { + status: ResponseStatus.FAILURE, + errorMessage: (error as Error).message, + errorStack: (error as Error).stack + } satisfies ResponsePayload + } } - 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 (error) { + return { + status: ResponseStatus.FAILURE, + errorMessage: (error as Error).message, + errorStack: (error as Error).stack + } satisfies ResponsePayload + } } }