X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Fui-server%2Fui-services%2FAbstractUIService.ts;h=71b057abe4a2f7369c1376d97ffcc55046eb0e89;hb=7671fa0be211e944f027ebd83f3a0ad64c2ef2d6;hp=356e908ca30d5688de229af443028eff56ef4e1d;hpb=5e8e29f4f47246cdc49449aa6ca472c64393f7e8;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 356e908c..71b057ab 100644 --- a/src/charging-station/ui-server/ui-services/AbstractUIService.ts +++ b/src/charging-station/ui-server/ui-services/AbstractUIService.ts @@ -1,27 +1,52 @@ -import BaseError from '../../../exception/BaseError'; -import type OCPPError from '../../../exception/OCPPError'; -import { Bootstrap } from '../../../internal'; +import { BaseError, type OCPPError } from '../../../exception'; import { + BroadcastChannelProcedureName, + type BroadcastChannelRequestPayload, ProcedureName, - ProtocolRequest, - ProtocolRequestHandler, - ProtocolVersion, - RequestPayload, - ResponsePayload, + type ProtocolRequest, + type ProtocolRequestHandler, + type ProtocolVersion, + type RequestPayload, + type ResponsePayload, ResponseStatus, -} from '../../../types/UIProtocol'; -import type { - BroadcastChannelProcedureName, - BroadcastChannelRequestPayload, -} from '../../../types/WorkerBroadcastChannel'; -import logger from '../../../utils/Logger'; -import Utils from '../../../utils/Utils'; -import UIServiceWorkerBroadcastChannel from '../../UIServiceWorkerBroadcastChannel'; +} from '../../../types'; +import { Utils, 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 { +export abstract class AbstractUIService { + 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.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; @@ -29,8 +54,8 @@ export default abstract class AbstractUIService { private readonly broadcastChannelRequests: Map; constructor(uiServer: AbstractUIServer, version: ProtocolVersion) { - this.version = version; 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)], @@ -64,7 +89,7 @@ export default abstract class AbstractUIService { // Log logger.error(`${this.logPrefix(moduleName, 'messageHandler')} Handle request error:`, error); responsePayload = { - hashIds: requestPayload.hashIds, + hashIds: requestPayload?.hashIds, status: ResponseStatus.FAILURE, command, requestPayload, @@ -73,10 +98,11 @@ export default abstract class AbstractUIService { errorStack: (error as Error).stack, errorDetails: (error as OCPPError).details, }; - } - // Send response for payload not forwarded to broadcast channel - if (responsePayload !== undefined) { - this.sendResponse(messageId ?? 'error', responsePayload); + } finally { + // Send response for payload not forwarded to broadcast channel + if (!Utils.isNullOrUndefined(responsePayload)) { + this.sendResponse(messageId, responsePayload); + } } } @@ -94,9 +120,9 @@ export default abstract class AbstractUIService { this.uiServer.sendResponse(this.uiServer.buildProtocolResponse(messageId, responsePayload)); } - public logPrefix(modName: string, methodName: string): string { + public logPrefix = (modName: string, methodName: string): string => { return this.uiServer.logPrefix(modName, methodName, this.version); - } + }; public deleteBroadcastChannelRequest(uuid: string): void { this.broadcastChannelRequests.delete(uuid); @@ -106,13 +132,28 @@ export default abstract class AbstractUIService { return this.broadcastChannelRequests.get(uuid) ?? 0; } - protected sendBroadcastChannelRequest( + 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)) { + if (Utils.isNotEmptyArray(payload.hashIds)) { payload.hashIds = payload.hashIds + .filter((hashId) => !Utils.isNullOrUndefined(hashId)) .map((hashId) => { if (this.uiServer.chargingStations.has(hashId) === true) { return hashId; @@ -123,10 +164,9 @@ export default abstract class AbstractUIService { 'sendBroadcastChannelRequest' )} Charging station with hashId '${hashId}' not found` ); - }) - .filter((hashId) => hashId !== undefined); + }); } - const expectedNumberOfResponses = !Utils.isEmptyArray(payload.hashIds) + const expectedNumberOfResponses = Utils.isNotEmptyArray(payload.hashIds) ? payload.hashIds.length : this.uiServer.chargingStations.size; this.uiServiceWorkerBroadcastChannel.sendRequest([uuid, procedureName, payload]); @@ -141,12 +181,20 @@ export default abstract class AbstractUIService { } private async handleStartSimulator(): Promise { - await Bootstrap.getInstance().start(); - return { status: ResponseStatus.SUCCESS }; + try { + await Bootstrap.getInstance().start(); + return { status: ResponseStatus.SUCCESS }; + } catch (error) { + 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 (error) { + return { status: ResponseStatus.FAILURE }; + } } }