X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Fui-server%2Fui-services%2FAbstractUIService.ts;h=e72af5c0549fa1feb2f4c9bfd66225f53fe76e27;hb=6c1761d470507ea23d186be61b94ca7375c5144a;hp=30ad449a33775b4ed49d970cf2a419c5ee23a458;hpb=02a6943a30a9a6c93e5dcbdb79aa8d9746ae368e;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 30ad449a..e72af5c0 100644 --- a/src/charging-station/ui-server/ui-services/AbstractUIService.ts +++ b/src/charging-station/ui-server/ui-services/AbstractUIService.ts @@ -1,22 +1,20 @@ -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'; @@ -24,7 +22,7 @@ export default abstract class AbstractUIService { protected readonly version: ProtocolVersion; protected readonly uiServer: AbstractUIServer; protected readonly requestHandlers: Map; - protected workerBroadcastChannel: WorkerBroadcastChannel; + protected uiServiceWorkerBroadcastChannel: UIServiceWorkerBroadcastChannel; constructor(uiServer: AbstractUIServer, version: ProtocolVersion) { this.version = version; @@ -34,16 +32,16 @@ export default abstract class AbstractUIService { [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 requestHandler(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.requestHandlers.has(command) === false) { throw new BaseError( @@ -55,57 +53,58 @@ export default abstract class AbstractUIService { ); } - // Call the message handler to build the response payload + // 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 buildProtocolRequest( + public sendRequest( messageId: string, procedureName: ProcedureName, - payload: RequestPayload - ): string { - return JSON.stringify([messageId, procedureName, payload] as ProtocolRequest); + 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)); } - 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); } - // Validate the raw data received from the WebSocket - // TODO: should probably be moved to the ws verify clients callback - private dataValidation(rawData: RawData): ProtocolRequest { + // Validate the raw data received from the UI server + private requestValidation(rawData: RawData | JsonType): ProtocolRequest { // logger.debug( - // `${this.uiServer.logPrefix( + // `${this.logPrefix( // moduleName, - // 'dataValidation' - // )} Raw data received: ${rawData.toString()}` + // '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) {