-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';
protected readonly version: ProtocolVersion;
protected readonly uiServer: AbstractUIServer;
protected readonly requestHandlers: Map<ProcedureName, ProtocolRequestHandler>;
- protected workerBroadcastChannel: WorkerBroadcastChannel;
+ protected uiServiceWorkerBroadcastChannel: UIServiceWorkerBroadcastChannel;
constructor(uiServer: AbstractUIServer, version: ProtocolVersion) {
this.version = version;
[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<void> {
+ public async requestHandler(request: RawData | JsonType): Promise<void> {
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(
);
}
- // 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) {
// TODO: remove cast to unknown
return {
status: ResponseStatus.SUCCESS,
- ...Array.from(this.uiServer.chargingStations.values()),
+ ...[...this.uiServer.chargingStations.values()],
} as unknown as ResponsePayload;
}