X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Fcharging-station%2Fui-server%2Fui-services%2FAbstractUIService.ts;h=1e0f2a92e0a9f3189f969428c6eb8fda59a7837a;hb=92403944ed5cdbdd07faaa2da783682e1ea9a9dd;hp=070119bb2642f4c0658c7d4e163ac48ea8c0e7f6;hpb=89b7a234c161f2c68b6a9499ff698488e1a35c6b;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 070119bb..1e0f2a92 100644 --- a/src/charging-station/ui-server/ui-services/AbstractUIService.ts +++ b/src/charging-station/ui-server/ui-services/AbstractUIService.ts @@ -1,51 +1,49 @@ -import { RawData } from 'ws'; +import type { RawData } from 'ws'; import BaseError from '../../../exception/BaseError'; -import { JsonType } from '../../../types/JsonType'; +import { Bootstrap } from '../../../internal'; +import type { JsonType } from '../../../types/JsonType'; import { ProcedureName, ProtocolRequest, ProtocolRequestHandler, - ProtocolResponse, ProtocolVersion, RequestPayload, ResponsePayload, 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 | JsonType): 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,48 +53,58 @@ export default abstract class AbstractUIService { ); } - // Call the message handler to build the response payload - responsePayload = await this.messageHandlers.get(command)(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:`, - 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; + 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 the message response success - this.uiServer.sendResponse(this.buildProtocolResponse(messageId, responsePayload)); + if (responsePayload !== undefined) { + // Send the response + this.sendResponse(messageId ?? 'error', responsePayload); + } } - protected buildProtocolResponse(messageId: string, payload: ResponsePayload): string { - return JSON.stringify([messageId, payload] as ProtocolResponse); + public sendRequest( + messageId: string, + procedureName: ProcedureName, + requestPayload: RequestPayload + ): void { + this.uiServer.sendRequest( + this.uiServer.buildProtocolRequest(messageId, procedureName, requestPayload) + ); } - // Validate the raw data received from the WebSocket - // TODO: should probably be moved to the ws verify clients callback - private dataValidation(rawData: RawData): ProtocolRequest { - logger.debug( - `${this.uiServer.logPrefix( - moduleName, - 'dataValidation' - )} Raw data received: ${rawData.toString()}` - ); + 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); + } + + // 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()}` + // ); + 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) { @@ -110,7 +118,7 @@ export default abstract class AbstractUIService { // TODO: remove cast to unknown return { status: ResponseStatus.SUCCESS, - ...Array.from(this.uiServer.chargingStations.values()), + ...[...this.uiServer.chargingStations.values()], } as unknown as ResponsePayload; }