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=6d285926e14593b1fb248fa09583b8e6dae5f0c5;hpb=623b39b56185797f9976508571ca38619518a975;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 6d285926..20531c6f 100644 --- a/src/charging-station/ui-server/ui-services/AbstractUIService.ts +++ b/src/charging-station/ui-server/ui-services/AbstractUIService.ts @@ -1,27 +1,59 @@ -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 ProtocolResponse, + 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 { 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 { +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; @@ -29,8 +61,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)], @@ -40,11 +72,11 @@ export default abstract class AbstractUIService { this.broadcastChannelRequests = new Map(); } - public async requestHandler(request: ProtocolRequest): Promise { - let messageId: string; - let command: ProcedureName; + public async requestHandler(request: ProtocolRequest): Promise { + let messageId: string | undefined; + let command: ProcedureName | undefined; let requestPayload: RequestPayload | undefined; - let responsePayload: ResponsePayload; + let responsePayload: ResponsePayload | undefined; try { [messageId, command, requestPayload] = request; @@ -52,19 +84,23 @@ export default abstract class AbstractUIService { throw new BaseError( `${command} is not implemented to handle message payload ${JSON.stringify( requestPayload, - null, - 2 - )}` + undefined, + 2, + )}`, ); } // Call the request handler to build the response payload - responsePayload = await this.requestHandlers.get(command)(messageId, command, requestPayload); + responsePayload = await this.requestHandlers.get(command)!( + messageId, + 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, + hashIds: requestPayload?.hashIds, status: ResponseStatus.FAILURE, command, requestPayload, @@ -73,31 +109,31 @@ export default abstract class AbstractUIService { 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 ?? 'error', responsePayload); - } + } + if (!isNullOrUndefined(responsePayload)) { + return this.uiServer.buildProtocolResponse(messageId!, responsePayload!); } } - public sendRequest( - messageId: string, - procedureName: ProcedureName, - requestPayload: RequestPayload - ): void { - this.uiServer.sendRequest( - this.uiServer.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 { - this.uiServer.sendResponse(this.uiServer.buildProtocolResponse(messageId, responsePayload)); + if (this.uiServer.hasResponseHandler(messageId)) { + 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); @@ -107,28 +143,40 @@ 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.ProcedureNameToBroadCastChannelProcedureNameMapping.get(procedureName)!, + payload, + ); + } + + private sendBroadcastChannelRequest( uuid: string, procedureName: BroadcastChannelProcedureName, - payload: BroadcastChannelRequestPayload + payload: BroadcastChannelRequestPayload, ): void { - if (!Utils.isEmptyArray(payload.hashIds)) { + if (isNotEmptyArray(payload.hashIds)) { payload.hashIds = payload.hashIds - .map((hashId) => { + ?.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` + 'sendBroadcastChannelRequest', + )} Charging station with hashId '${hashId}' not found`, ); - }) - .filter((hashId) => hashId !== undefined); + }) as string[]; } - const expectedNumberOfResponses = !Utils.isEmptyArray(payload.hashIds) - ? payload.hashIds.length + const expectedNumberOfResponses = isNotEmptyArray(payload.hashIds) + ? payload.hashIds!.length : this.uiServer.chargingStations.size; this.uiServiceWorkerBroadcastChannel.sendRequest([uuid, procedureName, payload]); this.broadcastChannelRequests.set(uuid, expectedNumberOfResponses); @@ -142,12 +190,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 { + 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 }; + } } }