X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Fui-server%2Fui-services%2FAbstractUIService.ts;h=7d4f69d0a784b1183883e66f04606f5584a2335e;hb=10db00b2276f4cc7a88dd18e8f6f80593d6458b3;hp=151cff336ce33b012a21b8e20d51cd2c9e7b2277;hpb=fe94fce08a020e0c35e354c2282ec0587a605f4e;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 151cff33..7d4f69d0 100644 --- a/src/charging-station/ui-server/ui-services/AbstractUIService.ts +++ b/src/charging-station/ui-server/ui-services/AbstractUIService.ts @@ -1,65 +1,149 @@ +import BaseError from '../../../exception/BaseError'; +import { Bootstrap } from '../../../internal'; import { - ProtocolCommand, + ProcedureName, ProtocolRequest, ProtocolRequestHandler, + ProtocolVersion, + RequestPayload, + ResponsePayload, + ResponseStatus, } from '../../../types/UIProtocol'; - -import { AbstractUIServer } from '../AbstractUIServer'; -import BaseError from '../../../exception/BaseError'; -import { JsonType } from '../../../types/JsonType'; -import { RawData } from 'ws'; -import Utils from '../../../utils/Utils'; +import type { + BroadcastChannelProcedureName, + BroadcastChannelRequestPayload, +} from '../../../types/WorkerBroadcastChannel'; import logger from '../../../utils/Logger'; +import Utils from '../../../utils/Utils'; +import UIServiceWorkerBroadcastChannel from '../../UIServiceWorkerBroadcastChannel'; +import type { AbstractUIServer } from '../AbstractUIServer'; + +const moduleName = 'AbstractUIService'; export default abstract class AbstractUIService { - protected readonly uiServer: AbstractUIServer; - protected readonly messageHandlers: Map; + protected readonly requestHandlers: Map; + private readonly version: ProtocolVersion; + private readonly uiServer: AbstractUIServer; + private readonly uiServiceWorkerBroadcastChannel: UIServiceWorkerBroadcastChannel; + private readonly broadcastChannelRequests: Map; - constructor(uiServer: AbstractUIServer) { + constructor(uiServer: AbstractUIServer, version: ProtocolVersion) { + this.version = version; this.uiServer = uiServer; - this.messageHandlers = new Map([ - [ProtocolCommand.LIST_CHARGING_STATIONS, this.handleListChargingStations.bind(this)], + 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); + this.broadcastChannelRequests = new Map(); } - public async messageHandler(request: RawData): Promise { - let command: ProtocolCommand; - let payload: JsonType; - const protocolRequest = JSON.parse(request.toString()) as ProtocolRequest; - if (Utils.isIterable(protocolRequest)) { - [command, payload] = protocolRequest; - } else { - throw new BaseError('UI protocol request is not iterable'); - } - let messageResponse: JsonType; - if (this.messageHandlers.has(command)) { - try { - // Call the message handler to build the message response - messageResponse = (await this.messageHandlers.get(command)(payload)) as JsonType; - } catch (error) { - // Log - logger.error(this.uiServer.logPrefix() + ' Handle message error: %j', error); - throw error; + public async requestHandler(request: ProtocolRequest): Promise { + let messageId: string; + let command: ProcedureName; + let requestPayload: RequestPayload | undefined; + let responsePayload: ResponsePayload; + try { + [messageId, command, requestPayload] = request; + + if (this.requestHandlers.has(command) === false) { + throw new BaseError( + `${command} is not implemented to handle message payload ${JSON.stringify( + requestPayload, + null, + 2 + )}` + ); } - } else { - // Throw exception - throw new BaseError( - `${command} is not implemented to handle message payload ${JSON.stringify( - payload, - null, - 2 - )}` - ); + + // Call the request handler to build the response payload + responsePayload = await this.requestHandlers.get(command)(messageId, requestPayload); + } catch (error) { + // Log + logger.error(`${this.logPrefix(moduleName, 'messageHandler')} Handle request error:`, error); + responsePayload = { + status: ResponseStatus.FAILURE, + command, + requestPayload, + responsePayload, + errorMessage: (error as Error).message, + errorStack: (error as Error).stack, + }; + } + // Send response for payload not forwarded to broadcast channel + if (responsePayload !== undefined) { + this.sendResponse(messageId ?? 'error', responsePayload); } - // Send the message response - this.uiServer.sendResponse(this.buildProtocolMessage(command, messageResponse)); } - protected buildProtocolMessage(command: ProtocolCommand, payload: JsonType): string { - return JSON.stringify([command, payload]); + 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)); + } + + public logPrefix(modName: string, methodName: string): string { + return this.uiServer.logPrefix(modName, methodName, this.version); + } + + public deleteBroadcastChannelRequest(uuid: string): void { + this.broadcastChannelRequests.delete(uuid); + } + + public getBroadcastChannelExpectedResponses(uuid: string): number { + return this.broadcastChannelRequests.get(uuid) ?? 0; + } + + protected sendBroadcastChannelRequest( + uuid: string, + procedureName: BroadcastChannelProcedureName, + payload: BroadcastChannelRequestPayload + ): void { + if (!Utils.isEmptyArray(payload.hashIds)) { + payload.hashIds = payload.hashIds + .map((hashId) => { + if (this.uiServer.chargingStations.has(hashId) === true) { + return hashId; + } + logger.warn( + `${this.logPrefix( + moduleName, + 'sendBroadcastChannelRequest' + )} Charging station with hashId '${hashId}' not found` + ); + }) + .filter((hashId) => hashId !== undefined); + } + const expectedNumberOfResponses = !Utils.isEmptyArray(payload.hashIds) + ? payload.hashIds.length + : this.uiServer.chargingStations.size; + this.uiServiceWorkerBroadcastChannel.sendRequest([uuid, procedureName, payload]); + this.broadcastChannelRequests.set(uuid, expectedNumberOfResponses); + } + + private handleListChargingStations(): ResponsePayload { + return { + status: ResponseStatus.SUCCESS, + chargingStations: [...this.uiServer.chargingStations.values()], + } as ResponsePayload; + } + + private async handleStartSimulator(): Promise { + await Bootstrap.getInstance().start(); + return { status: ResponseStatus.SUCCESS }; } - private handleListChargingStations(): JsonType { - return Array.from(this.uiServer.chargingStations); + private async handleStopSimulator(): Promise { + await Bootstrap.getInstance().stop(); + return { status: ResponseStatus.SUCCESS }; } }