X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=src%2Fcharging-station%2Fui-server%2Fui-services%2FAbstractUIService.ts;h=092742b718c6e294f44b5e83165f9633182d9292;hb=5a010bf00a68ca47e0cb610f70ad3e0c16c5fe5e;hp=2e35299cace8ca77d8bf5c04ec102a155e84343d;hpb=4e3ff94d15f16cbeb7f65d14525bca7af3c551fd;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 2e35299c..092742b7 100644 --- a/src/charging-station/ui-server/ui-services/AbstractUIService.ts +++ b/src/charging-station/ui-server/ui-services/AbstractUIService.ts @@ -1,6 +1,7 @@ import { RawData } from 'ws'; import BaseError from '../../../exception/BaseError'; +import { Bootstrap } from '../../../internal'; import { JsonType } from '../../../types/JsonType'; import { ProcedureName, @@ -13,39 +14,37 @@ import { ResponseStatus, } from '../../../types/UIProtocol'; import logger from '../../../utils/Logger'; -import Utils from '../../../utils/Utils'; -import Bootstrap from '../../Bootstrap'; -import WorkerBroadcastChannel from '../../WorkerBroadcastChannel'; -import { AbstractUIServer } from '../AbstractUIServer'; +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 messageHandlers: Map; - protected workerBroadcastChannel: WorkerBroadcastChannel; + protected readonly requestHandlers: Map; + protected uiServiceWorkerBroadcastChannel: UIServiceWorkerBroadcastChannel; constructor(uiServer: AbstractUIServer, version: ProtocolVersion) { this.version = version; this.uiServer = uiServer; - this.messageHandlers = new Map([ + 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.workerBroadcastChannel = new WorkerBroadcastChannel(); + this.uiServiceWorkerBroadcastChannel = new UIServiceWorkerBroadcastChannel(this); } - public async messageHandler(request: RawData): Promise { + public async requestHandler(request: RawData): Promise { let messageId: string; let command: ProcedureName; - let requestPayload: RequestPayload; + let requestPayload: RequestPayload | undefined; let responsePayload: ResponsePayload; try { - [messageId, command, requestPayload] = this.dataValidation(request); + [messageId, command, requestPayload] = this.requestValidation(request); - if (this.messageHandlers.has(command) === false) { + if (this.requestHandlers.has(command) === false) { throw new BaseError( `${command} is not implemented to handle message payload ${JSON.stringify( requestPayload, @@ -55,38 +54,61 @@ export default abstract class AbstractUIService { ); } - // Call the message handler to build the response payload - responsePayload = await this.messageHandlers.get(command)(messageId, requestPayload); + // Call the request handler to build the response payload + responsePayload = await this.requestHandlers.get(command)(messageId, requestPayload); } catch (error) { // Log logger.error( - `${this.uiServer.logPrefix(moduleName, 'messageHandler')} Handle message error:`, + `${this.uiServer.logPrefix(moduleName, 'messageHandler')} Handle request error:`, error ); - // Send the message response failure - this.uiServer.sendResponse( - this.buildProtocolResponse(messageId ?? 'error', { - status: ResponseStatus.FAILURE, - command, - requestPayload, - errorMessage: (error as Error).message, - errorStack: (error as Error).stack, - }) - ); - throw error; + responsePayload = { + status: ResponseStatus.FAILURE, + command, + requestPayload, + responsePayload, + errorMessage: (error as Error).message, + errorStack: (error as Error).stack, + }; + } + + if (responsePayload !== undefined) { + // Send the response + this.uiServer.sendResponse(this.buildProtocolResponse(messageId ?? 'error', responsePayload)); } + } + + public sendRequest( + messageId: string, + procedureName: ProcedureName, + requestPayload: RequestPayload + ): void { + this.uiServer.sendRequest(this.buildProtocolRequest(messageId, procedureName, requestPayload)); + } - // Send the message response success + public sendResponse(messageId: string, responsePayload: ResponsePayload): void { this.uiServer.sendResponse(this.buildProtocolResponse(messageId, responsePayload)); } - protected buildProtocolResponse(messageId: string, payload: ResponsePayload): string { - return JSON.stringify([messageId, payload] as ProtocolResponse); + public logPrefix(modName: string, methodName: string): string { + return this.uiServer.logPrefix(modName, methodName); + } + + private buildProtocolRequest( + messageId: string, + procedureName: ProcedureName, + requestPayload: RequestPayload + ): string { + return JSON.stringify([messageId, procedureName, requestPayload] as ProtocolRequest); + } + + private buildProtocolResponse(messageId: string, responsePayload: ResponsePayload): string { + return JSON.stringify([messageId, responsePayload] as ProtocolResponse); } // Validate the raw data received from the WebSocket // TODO: should probably be moved to the ws verify clients callback - private dataValidation(rawData: RawData): ProtocolRequest { + private requestValidation(rawData: RawData): ProtocolRequest { // logger.debug( // `${this.uiServer.logPrefix( // moduleName, @@ -96,8 +118,8 @@ export default abstract class AbstractUIService { const data = JSON.parse(rawData.toString()) as JsonType[]; - if (Utils.isIterable(data) === false) { - throw new BaseError('UI protocol request is not iterable'); + if (Array.isArray(data) === false) { + throw new BaseError('UI protocol request is not an array'); } if (data.length !== 3) {