-import type { RawData } from 'ws';
-
-import BaseError from '../../../exception/BaseError';
-import { Bootstrap } from '../../../internal';
-import type { JsonType } from '../../../types/JsonType';
+import { BaseError, type OCPPError } from '../../../exception';
import {
+ BroadcastChannelProcedureName,
+ type BroadcastChannelRequestPayload,
ProcedureName,
- ProtocolRequest,
- ProtocolRequestHandler,
- ProtocolVersion,
- RequestPayload,
- ResponsePayload,
+ type ProtocolRequest,
+ type ProtocolRequestHandler,
+ type ProtocolVersion,
+ type RequestPayload,
+ type ResponsePayload,
ResponseStatus,
-} from '../../../types/UIProtocol';
-import type {
- BroadcastChannelProcedureName,
- BroadcastChannelRequestPayload,
-} from '../../../types/WorkerBroadcastChannel';
-import logger from '../../../utils/Logger';
-import Utils from '../../../utils/Utils';
-import UIServiceWorkerBroadcastChannel from '../../UIServiceWorkerBroadcastChannel';
+} from '../../../types';
+import { Utils, logger } from '../../../utils';
+import { Bootstrap } from '../../Bootstrap';
+import { UIServiceWorkerBroadcastChannel } from '../../broadcast-channel/UIServiceWorkerBroadcastChannel';
import type { AbstractUIServer } from '../AbstractUIServer';
const moduleName = 'AbstractUIService';
-export default abstract class AbstractUIService {
+export abstract class AbstractUIService {
+ protected 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.SET_SUPERVISION_URL]: BroadcastChannelProcedureName.SET_SUPERVISION_URL,
+ [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,
+ [ProcedureName.DATA_TRANSFER]: BroadcastChannelProcedureName.DATA_TRANSFER,
+ [ProcedureName.DIAGNOSTICS_STATUS_NOTIFICATION]:
+ BroadcastChannelProcedureName.DIAGNOSTICS_STATUS_NOTIFICATION,
+ [ProcedureName.FIRMWARE_STATUS_NOTIFICATION]:
+ BroadcastChannelProcedureName.FIRMWARE_STATUS_NOTIFICATION,
+ };
+
protected readonly requestHandlers: Map<ProcedureName, ProtocolRequestHandler>;
private readonly version: ProtocolVersion;
private readonly uiServer: AbstractUIServer;
private readonly broadcastChannelRequests: Map<string, number>;
constructor(uiServer: AbstractUIServer, version: ProtocolVersion) {
- this.version = version;
this.uiServer = uiServer;
+ this.version = version;
this.requestHandlers = new Map<ProcedureName, ProtocolRequestHandler>([
[ProcedureName.LIST_CHARGING_STATIONS, this.handleListChargingStations.bind(this)],
[ProcedureName.START_SIMULATOR, this.handleStartSimulator.bind(this)],
this.broadcastChannelRequests = new Map<string, number>();
}
- public async requestHandler(request: RawData | JsonType): Promise<void> {
+ public async requestHandler(request: ProtocolRequest): Promise<void> {
let messageId: string;
let command: ProcedureName;
let requestPayload: RequestPayload | undefined;
let responsePayload: ResponsePayload;
try {
- [messageId, command, requestPayload] = this.requestValidation(request);
+ [messageId, command, requestPayload] = request;
if (this.requestHandlers.has(command) === false) {
throw new BaseError(
}
// Call the request handler to build the response payload
- responsePayload = await this.requestHandlers.get(command)(messageId, requestPayload);
+ responsePayload = await this.requestHandlers.get(command)(messageId, command, requestPayload);
} catch (error) {
// Log
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,
};
- }
- // Send response for payload not forwarded to broadcast channel
- if (responsePayload !== undefined) {
- this.sendResponse(messageId ?? 'error', responsePayload);
+ } finally {
+ // Send response for payload not forwarded to broadcast channel
+ if (!Utils.isNullOrUndefined(responsePayload)) {
+ this.sendResponse(messageId, responsePayload);
+ }
}
}
this.uiServer.sendResponse(this.uiServer.buildProtocolResponse(messageId, responsePayload));
}
- public logPrefix(modName: string, methodName: string): string {
+ public logPrefix = (modName: string, methodName: string): string => {
return this.uiServer.logPrefix(modName, methodName, this.version);
- }
+ };
public deleteBroadcastChannelRequest(uuid: string): void {
this.broadcastChannelRequests.delete(uuid);
return this.broadcastChannelRequests.get(uuid) ?? 0;
}
- protected sendBroadcastChannelRequest(
+ 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)) {
+ if (Utils.isNotEmptyArray(payload.hashIds)) {
payload.hashIds = payload.hashIds
+ .filter((hashId) => !Utils.isNullOrUndefined(hashId))
.map((hashId) => {
if (this.uiServer.chargingStations.has(hashId) === true) {
return hashId;
'sendBroadcastChannelRequest'
)} Charging station with hashId '${hashId}' not found`
);
- })
- .filter((hashId) => hashId !== undefined);
+ });
}
- const expectedNumberOfResponses = !Utils.isEmptyArray(payload.hashIds)
+ const expectedNumberOfResponses = Utils.isNotEmptyArray(payload.hashIds)
? payload.hashIds.length
: this.uiServer.chargingStations.size;
this.uiServiceWorkerBroadcastChannel.sendRequest([uuid, procedureName, payload]);
this.broadcastChannelRequests.set(uuid, expectedNumberOfResponses);
}
- // 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 (Array.isArray(data) === false) {
- throw new BaseError('UI protocol request is not an array');
- }
-
- if (data.length !== 3) {
- throw new BaseError('UI protocol request is malformed');
- }
-
- return data as ProtocolRequest;
- }
-
private handleListChargingStations(): ResponsePayload {
- // TODO: remove cast to unknown
return {
status: ResponseStatus.SUCCESS,
- ...[...this.uiServer.chargingStations.values()],
- } as unknown as ResponsePayload;
+ chargingStations: [...this.uiServer.chargingStations.values()],
+ } as ResponsePayload;
}
private async handleStartSimulator(): Promise<ResponsePayload> {
- await Bootstrap.getInstance().start();
- return { status: ResponseStatus.SUCCESS };
+ try {
+ await Bootstrap.getInstance().start();
+ return { status: ResponseStatus.SUCCESS };
+ } catch (error) {
+ return { status: ResponseStatus.FAILURE };
+ }
}
private async handleStopSimulator(): Promise<ResponsePayload> {
- await Bootstrap.getInstance().stop();
- return { status: ResponseStatus.SUCCESS };
+ try {
+ await Bootstrap.getInstance().stop();
+ return { status: ResponseStatus.SUCCESS };
+ } catch (error) {
+ return { status: ResponseStatus.FAILURE };
+ }
}
}