1 import BaseError from
'../../../exception/BaseError';
2 import type OCPPError from
'../../../exception/OCPPError';
3 import { Bootstrap
} from
'../../../internal';
7 type ProtocolRequestHandler
,
12 } from
'../../../types/UIProtocol';
14 BroadcastChannelProcedureName
,
15 type BroadcastChannelRequestPayload
,
16 } from
'../../../types/WorkerBroadcastChannel';
17 import logger from
'../../../utils/Logger';
18 import Utils from
'../../../utils/Utils';
19 import UIServiceWorkerBroadcastChannel from
'../../UIServiceWorkerBroadcastChannel';
20 import type { AbstractUIServer
} from
'../AbstractUIServer';
22 const moduleName
= 'AbstractUIService';
24 export default abstract class AbstractUIService
{
25 protected static readonly ProcedureNameToBroadCastChannelProcedureNameMap
: Omit
<
26 Record
<ProcedureName
, BroadcastChannelProcedureName
>,
27 | ProcedureName
.START_SIMULATOR
28 | ProcedureName
.STOP_SIMULATOR
29 | ProcedureName
.LIST_CHARGING_STATIONS
31 [ProcedureName
.START_CHARGING_STATION
]: BroadcastChannelProcedureName
.START_CHARGING_STATION
,
32 [ProcedureName
.STOP_CHARGING_STATION
]: BroadcastChannelProcedureName
.STOP_CHARGING_STATION
,
33 [ProcedureName
.CLOSE_CONNECTION
]: BroadcastChannelProcedureName
.CLOSE_CONNECTION
,
34 [ProcedureName
.OPEN_CONNECTION
]: BroadcastChannelProcedureName
.OPEN_CONNECTION
,
35 [ProcedureName
.START_AUTOMATIC_TRANSACTION_GENERATOR
]:
36 BroadcastChannelProcedureName
.START_AUTOMATIC_TRANSACTION_GENERATOR
,
37 [ProcedureName
.STOP_AUTOMATIC_TRANSACTION_GENERATOR
]:
38 BroadcastChannelProcedureName
.STOP_AUTOMATIC_TRANSACTION_GENERATOR
,
39 [ProcedureName
.START_TRANSACTION
]: BroadcastChannelProcedureName
.START_TRANSACTION
,
40 [ProcedureName
.STOP_TRANSACTION
]: BroadcastChannelProcedureName
.STOP_TRANSACTION
,
41 [ProcedureName
.AUTHORIZE
]: BroadcastChannelProcedureName
.AUTHORIZE
,
42 [ProcedureName
.BOOT_NOTIFICATION
]: BroadcastChannelProcedureName
.BOOT_NOTIFICATION
,
43 [ProcedureName
.STATUS_NOTIFICATION
]: BroadcastChannelProcedureName
.STATUS_NOTIFICATION
,
44 [ProcedureName
.HEARTBEAT
]: BroadcastChannelProcedureName
.HEARTBEAT
,
45 [ProcedureName
.METER_VALUES
]: BroadcastChannelProcedureName
.METER_VALUES
,
46 [ProcedureName
.DATA_TRANSFER
]: BroadcastChannelProcedureName
.DATA_TRANSFER
,
47 [ProcedureName
.DIAGNOSTICS_STATUS_NOTIFICATION
]:
48 BroadcastChannelProcedureName
.DIAGNOSTICS_STATUS_NOTIFICATION
,
49 [ProcedureName
.FIRMWARE_STATUS_NOTIFICATION
]:
50 BroadcastChannelProcedureName
.FIRMWARE_STATUS_NOTIFICATION
,
53 protected readonly requestHandlers
: Map
<ProcedureName
, ProtocolRequestHandler
>;
54 private readonly version
: ProtocolVersion
;
55 private readonly uiServer
: AbstractUIServer
;
56 private readonly uiServiceWorkerBroadcastChannel
: UIServiceWorkerBroadcastChannel
;
57 private readonly broadcastChannelRequests
: Map
<string, number>;
59 constructor(uiServer
: AbstractUIServer
, version
: ProtocolVersion
) {
60 this.uiServer
= uiServer
;
61 this.version
= version
;
62 this.requestHandlers
= new Map
<ProcedureName
, ProtocolRequestHandler
>([
63 [ProcedureName
.LIST_CHARGING_STATIONS
, this.handleListChargingStations
.bind(this)],
64 [ProcedureName
.START_SIMULATOR
, this.handleStartSimulator
.bind(this)],
65 [ProcedureName
.STOP_SIMULATOR
, this.handleStopSimulator
.bind(this)],
67 this.uiServiceWorkerBroadcastChannel
= new UIServiceWorkerBroadcastChannel(this);
68 this.broadcastChannelRequests
= new Map
<string, number>();
71 public async requestHandler(request
: ProtocolRequest
): Promise
<void> {
72 let messageId
: string;
73 let command
: ProcedureName
;
74 let requestPayload
: RequestPayload
| undefined;
75 let responsePayload
: ResponsePayload
;
77 [messageId
, command
, requestPayload
] = request
;
79 if (this.requestHandlers
.has(command
) === false) {
81 `${command} is not implemented to handle message payload ${JSON.stringify(
89 // Call the request handler to build the response payload
90 responsePayload
= await this.requestHandlers
.get(command
)(messageId
, command
, requestPayload
);
93 logger
.error(`${this.logPrefix(moduleName, 'messageHandler')} Handle request error:`, error
);
95 hashIds
: requestPayload
?.hashIds
,
96 status: ResponseStatus
.FAILURE
,
100 errorMessage
: (error
as Error).message
,
101 errorStack
: (error
as Error).stack
,
102 errorDetails
: (error
as OCPPError
).details
,
105 // Send response for payload not forwarded to broadcast channel
106 if (responsePayload
!== undefined) {
107 this.sendResponse(messageId
, responsePayload
);
114 procedureName
: ProcedureName
,
115 requestPayload
: RequestPayload
117 this.uiServer
.sendRequest(
118 this.uiServer
.buildProtocolRequest(messageId
, procedureName
, requestPayload
)
122 public sendResponse(messageId
: string, responsePayload
: ResponsePayload
): void {
123 this.uiServer
.sendResponse(this.uiServer
.buildProtocolResponse(messageId
, responsePayload
));
126 public logPrefix(modName
: string, methodName
: string): string {
127 return this.uiServer
.logPrefix(modName
, methodName
, this.version
);
130 public deleteBroadcastChannelRequest(uuid
: string): void {
131 this.broadcastChannelRequests
.delete(uuid
);
134 public getBroadcastChannelExpectedResponses(uuid
: string): number {
135 return this.broadcastChannelRequests
.get(uuid
) ?? 0;
138 protected handleProtocolRequest(
140 procedureName
: ProcedureName
,
141 payload
: RequestPayload
143 this.sendBroadcastChannelRequest(
145 AbstractUIService
.ProcedureNameToBroadCastChannelProcedureNameMap
[
147 ] as BroadcastChannelProcedureName
,
152 private sendBroadcastChannelRequest(
154 procedureName
: BroadcastChannelProcedureName
,
155 payload
: BroadcastChannelRequestPayload
157 if (!Utils
.isEmptyArray(payload
.hashIds
)) {
158 payload
.hashIds
= payload
.hashIds
160 if (this.uiServer
.chargingStations
.has(hashId
) === true) {
166 'sendBroadcastChannelRequest'
167 )} Charging station with hashId '${hashId}' not found`
170 .filter((hashId
) => hashId
!== undefined);
172 const expectedNumberOfResponses
= !Utils
.isEmptyArray(payload
.hashIds
)
173 ? payload
.hashIds
.length
174 : this.uiServer
.chargingStations
.size
;
175 this.uiServiceWorkerBroadcastChannel
.sendRequest([uuid
, procedureName
, payload
]);
176 this.broadcastChannelRequests
.set(uuid
, expectedNumberOfResponses
);
179 private handleListChargingStations(): ResponsePayload
{
181 status: ResponseStatus
.SUCCESS
,
182 chargingStations
: [...this.uiServer
.chargingStations
.values()],
183 } as ResponsePayload
;
186 private async handleStartSimulator(): Promise
<ResponsePayload
> {
187 await Bootstrap
.getInstance().start();
188 return { status: ResponseStatus
.SUCCESS
};
191 private async handleStopSimulator(): Promise
<ResponsePayload
> {
192 await Bootstrap
.getInstance().stop();
193 return { status: ResponseStatus
.SUCCESS
};