-import { RawData } from 'ws';
-
import BaseError from '../../../exception/BaseError';
-import { JsonType } from '../../../types/JsonType';
+import type OCPPError from '../../../exception/OCPPError';
+import { Bootstrap } from '../../../internal';
import {
ProcedureName,
- ProtocolRequest,
- ProtocolRequestHandler,
- ProtocolResponse,
- ProtocolVersion,
- ResponsePayload,
+ type ProtocolRequest,
+ type ProtocolRequestHandler,
+ type ProtocolVersion,
+ type RequestPayload,
+ type ResponsePayload,
ResponseStatus,
} from '../../../types/UIProtocol';
+import {
+ BroadcastChannelProcedureName,
+ type BroadcastChannelRequestPayload,
+} from '../../../types/WorkerBroadcastChannel';
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<ProcedureName, ProtocolRequestHandler>;
- protected workerBroadcastChannel: WorkerBroadcastChannel;
+ private static readonly ProcedureNameToBroadCastChannelProcedureNameMap: Omit<
+ Record<ProcedureName, BroadcastChannelProcedureName>,
+ | ProcedureName.START_SIMULATOR
+ | ProcedureName.STOP_SIMULATOR
+ | ProcedureName.LIST_CHARGING_STATIONS
+ > = {
+ [ProcedureName.START_CHARGING_STATION]: BroadcastChannelProcedureName.START_CHARGING_STATION,
+ [ProcedureName.STOP_CHARGING_STATION]: BroadcastChannelProcedureName.STOP_CHARGING_STATION,
+ [ProcedureName.CLOSE_CONNECTION]: BroadcastChannelProcedureName.CLOSE_CONNECTION,
+ [ProcedureName.OPEN_CONNECTION]: BroadcastChannelProcedureName.OPEN_CONNECTION,
+ [ProcedureName.START_AUTOMATIC_TRANSACTION_GENERATOR]:
+ BroadcastChannelProcedureName.START_AUTOMATIC_TRANSACTION_GENERATOR,
+ [ProcedureName.STOP_AUTOMATIC_TRANSACTION_GENERATOR]:
+ BroadcastChannelProcedureName.STOP_AUTOMATIC_TRANSACTION_GENERATOR,
+ [ProcedureName.START_TRANSACTION]: BroadcastChannelProcedureName.START_TRANSACTION,
+ [ProcedureName.STOP_TRANSACTION]: BroadcastChannelProcedureName.STOP_TRANSACTION,
+ [ProcedureName.AUTHORIZE]: BroadcastChannelProcedureName.AUTHORIZE,
+ [ProcedureName.BOOT_NOTIFICATION]: BroadcastChannelProcedureName.BOOT_NOTIFICATION,
+ [ProcedureName.STATUS_NOTIFICATION]: BroadcastChannelProcedureName.STATUS_NOTIFICATION,
+ [ProcedureName.HEARTBEAT]: BroadcastChannelProcedureName.HEARTBEAT,
+ [ProcedureName.METER_VALUES]: BroadcastChannelProcedureName.METER_VALUES,
+ };
+
+ protected readonly requestHandlers: Map<ProcedureName, ProtocolRequestHandler>;
+ private readonly version: ProtocolVersion;
+ private readonly uiServer: AbstractUIServer;
+ private readonly uiServiceWorkerBroadcastChannel: UIServiceWorkerBroadcastChannel;
+ private readonly broadcastChannelRequests: Map<string, number>;
constructor(uiServer: AbstractUIServer, version: ProtocolVersion) {
- this.version = version;
this.uiServer = uiServer;
- this.messageHandlers = new Map<ProcedureName, ProtocolRequestHandler>([
+ this.version = version;
+ this.requestHandlers = new Map<ProcedureName, ProtocolRequestHandler>([
[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);
+ this.broadcastChannelRequests = new Map<string, number>();
}
- public async messageHandler(request: RawData): Promise<void> {
+ public async requestHandler(request: ProtocolRequest): Promise<void> {
let messageId: string;
let command: ProcedureName;
- let requestPayload: JsonType;
+ let requestPayload: RequestPayload | undefined;
let responsePayload: ResponsePayload;
try {
- [messageId, command, requestPayload] = this.dataValidation(request);
+ [messageId, command, requestPayload] = request;
- if (this.messageHandlers.has(command) === false) {
- // Throw exception
+ if (this.requestHandlers.has(command) === false) {
throw new BaseError(
`${command} is not implemented to handle message payload ${JSON.stringify(
requestPayload,
)}`
);
}
- // Call the message handler to build the response payload
- responsePayload = (await this.messageHandlers.get(command)(
- requestPayload
- )) as ResponsePayload;
+
+ // Call the request handler to build the response payload
+ responsePayload = await this.requestHandlers.get(command)(messageId, command, 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 = {
+ hashIds: requestPayload.hashIds,
+ status: ResponseStatus.FAILURE,
+ command,
+ requestPayload,
+ responsePayload,
+ errorMessage: (error as Error).message,
+ errorStack: (error as Error).stack,
+ errorDetails: (error as OCPPError).details,
+ };
+ } finally {
+ // Send response for payload not forwarded to broadcast channel
+ if (responsePayload !== undefined) {
+ this.sendResponse(messageId, responsePayload);
+ }
}
+ }
- // Send the message response success
- this.uiServer.sendResponse(this.buildProtocolResponse(messageId, responsePayload));
+ public sendRequest(
+ messageId: string,
+ procedureName: ProcedureName,
+ requestPayload: RequestPayload
+ ): void {
+ this.uiServer.sendRequest(
+ this.uiServer.buildProtocolRequest(messageId, procedureName, requestPayload)
+ );
}
- protected buildProtocolResponse(messageId: string, payload: ResponsePayload): string {
- return JSON.stringify([messageId, payload] as ProtocolResponse);
+ public sendResponse(messageId: string, responsePayload: ResponsePayload): void {
+ this.uiServer.sendResponse(this.uiServer.buildProtocolResponse(messageId, responsePayload));
}
- // 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()}`
- );
- const data = JSON.parse(rawData.toString()) as JsonType[];
+ public logPrefix(modName: string, methodName: string): string {
+ return this.uiServer.logPrefix(modName, methodName, this.version);
+ }
- if (Utils.isIterable(data) === false) {
- throw new BaseError('UI protocol request is not iterable');
- }
+ public deleteBroadcastChannelRequest(uuid: string): void {
+ this.broadcastChannelRequests.delete(uuid);
+ }
- if (data.length !== 3) {
- throw new BaseError('UI protocol request is malformed');
- }
+ public getBroadcastChannelExpectedResponses(uuid: string): number {
+ return this.broadcastChannelRequests.get(uuid) ?? 0;
+ }
- return data as ProtocolRequest;
+ protected handleProtocolRequest(
+ uuid: string,
+ procedureName: ProcedureName,
+ payload: RequestPayload
+ ): void {
+ this.sendBroadcastChannelRequest(
+ uuid,
+ AbstractUIService.ProcedureNameToBroadCastChannelProcedureNameMap[
+ procedureName
+ ] as BroadcastChannelProcedureName,
+ payload
+ );
+ }
+
+ private 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(): JsonType {
+ private handleListChargingStations(): ResponsePayload {
return {
status: ResponseStatus.SUCCESS,
- ...Array.from(this.uiServer.chargingStations.values()),
- } as JsonType;
+ chargingStations: [...this.uiServer.chargingStations.values()],
+ } as ResponsePayload;
}
private async handleStartSimulator(): Promise<ResponsePayload> {
repositories / e-mobility-charging-stations-simulator.git / blobdiff