Commit | Line | Data |
---|---|---|
268a74bb | 1 | import { BaseError, type OCPPError } from '../../../exception'; |
675fa8e3 | 2 | import { |
268a74bb JB |
3 | BroadcastChannelProcedureName, |
4 | type BroadcastChannelRequestPayload, | |
32de5a57 | 5 | ProcedureName, |
976d11ec JB |
6 | type ProtocolRequest, |
7 | type ProtocolRequestHandler, | |
8 | type ProtocolVersion, | |
9 | type RequestPayload, | |
10 | type ResponsePayload, | |
32de5a57 | 11 | ResponseStatus, |
268a74bb JB |
12 | } from '../../../types'; |
13 | import { logger } from '../../../utils/Logger'; | |
14 | import { Utils } from '../../../utils/Utils'; | |
2896e06d | 15 | import { type AbstractUIServer, Bootstrap, UIServiceWorkerBroadcastChannel } from '../../internal'; |
4198ad5c | 16 | |
32de5a57 LM |
17 | const moduleName = 'AbstractUIService'; |
18 | ||
268a74bb | 19 | export abstract class AbstractUIService { |
d56ea27c | 20 | protected static readonly ProcedureNameToBroadCastChannelProcedureNameMap: Omit< |
976d11ec | 21 | Record<ProcedureName, BroadcastChannelProcedureName>, |
17e9e8ce JB |
22 | | ProcedureName.START_SIMULATOR |
23 | | ProcedureName.STOP_SIMULATOR | |
24 | | ProcedureName.LIST_CHARGING_STATIONS | |
976d11ec JB |
25 | > = { |
26 | [ProcedureName.START_CHARGING_STATION]: BroadcastChannelProcedureName.START_CHARGING_STATION, | |
27 | [ProcedureName.STOP_CHARGING_STATION]: BroadcastChannelProcedureName.STOP_CHARGING_STATION, | |
28 | [ProcedureName.CLOSE_CONNECTION]: BroadcastChannelProcedureName.CLOSE_CONNECTION, | |
29 | [ProcedureName.OPEN_CONNECTION]: BroadcastChannelProcedureName.OPEN_CONNECTION, | |
30 | [ProcedureName.START_AUTOMATIC_TRANSACTION_GENERATOR]: | |
31 | BroadcastChannelProcedureName.START_AUTOMATIC_TRANSACTION_GENERATOR, | |
32 | [ProcedureName.STOP_AUTOMATIC_TRANSACTION_GENERATOR]: | |
33 | BroadcastChannelProcedureName.STOP_AUTOMATIC_TRANSACTION_GENERATOR, | |
34 | [ProcedureName.START_TRANSACTION]: BroadcastChannelProcedureName.START_TRANSACTION, | |
35 | [ProcedureName.STOP_TRANSACTION]: BroadcastChannelProcedureName.STOP_TRANSACTION, | |
36 | [ProcedureName.AUTHORIZE]: BroadcastChannelProcedureName.AUTHORIZE, | |
8bfbc743 | 37 | [ProcedureName.BOOT_NOTIFICATION]: BroadcastChannelProcedureName.BOOT_NOTIFICATION, |
976d11ec JB |
38 | [ProcedureName.STATUS_NOTIFICATION]: BroadcastChannelProcedureName.STATUS_NOTIFICATION, |
39 | [ProcedureName.HEARTBEAT]: BroadcastChannelProcedureName.HEARTBEAT, | |
40 | [ProcedureName.METER_VALUES]: BroadcastChannelProcedureName.METER_VALUES, | |
91a7d3ea | 41 | [ProcedureName.DATA_TRANSFER]: BroadcastChannelProcedureName.DATA_TRANSFER, |
c9a4f9ea JB |
42 | [ProcedureName.DIAGNOSTICS_STATUS_NOTIFICATION]: |
43 | BroadcastChannelProcedureName.DIAGNOSTICS_STATUS_NOTIFICATION, | |
44 | [ProcedureName.FIRMWARE_STATUS_NOTIFICATION]: | |
45 | BroadcastChannelProcedureName.FIRMWARE_STATUS_NOTIFICATION, | |
976d11ec JB |
46 | }; |
47 | ||
02a6943a | 48 | protected readonly requestHandlers: Map<ProcedureName, ProtocolRequestHandler>; |
53870cff JB |
49 | private readonly version: ProtocolVersion; |
50 | private readonly uiServer: AbstractUIServer; | |
51 | private readonly uiServiceWorkerBroadcastChannel: UIServiceWorkerBroadcastChannel; | |
0d2cec76 | 52 | private readonly broadcastChannelRequests: Map<string, number>; |
4198ad5c | 53 | |
33cea517 | 54 | constructor(uiServer: AbstractUIServer, version: ProtocolVersion) { |
675fa8e3 | 55 | this.uiServer = uiServer; |
976d11ec | 56 | this.version = version; |
02a6943a | 57 | this.requestHandlers = new Map<ProcedureName, ProtocolRequestHandler>([ |
32de5a57 LM |
58 | [ProcedureName.LIST_CHARGING_STATIONS, this.handleListChargingStations.bind(this)], |
59 | [ProcedureName.START_SIMULATOR, this.handleStartSimulator.bind(this)], | |
60 | [ProcedureName.STOP_SIMULATOR, this.handleStopSimulator.bind(this)], | |
4198ad5c | 61 | ]); |
6812b4e1 | 62 | this.uiServiceWorkerBroadcastChannel = new UIServiceWorkerBroadcastChannel(this); |
0d2cec76 | 63 | this.broadcastChannelRequests = new Map<string, number>(); |
4198ad5c JB |
64 | } |
65 | ||
5e3cb728 | 66 | public async requestHandler(request: ProtocolRequest): Promise<void> { |
98a5256a | 67 | let messageId: string; |
32de5a57 | 68 | let command: ProcedureName; |
6c8f5d90 | 69 | let requestPayload: RequestPayload | undefined; |
32de5a57 LM |
70 | let responsePayload: ResponsePayload; |
71 | try { | |
5e3cb728 | 72 | [messageId, command, requestPayload] = request; |
32de5a57 | 73 | |
02a6943a | 74 | if (this.requestHandlers.has(command) === false) { |
32de5a57 LM |
75 | throw new BaseError( |
76 | `${command} is not implemented to handle message payload ${JSON.stringify( | |
77 | requestPayload, | |
78 | null, | |
79 | 2 | |
80 | )}` | |
81 | ); | |
4198ad5c | 82 | } |
89b7a234 | 83 | |
6c8f5d90 | 84 | // Call the request handler to build the response payload |
5e8e29f4 | 85 | responsePayload = await this.requestHandlers.get(command)(messageId, command, requestPayload); |
32de5a57 LM |
86 | } catch (error) { |
87 | // Log | |
1f7fa4de | 88 | logger.error(`${this.logPrefix(moduleName, 'messageHandler')} Handle request error:`, error); |
6c8f5d90 | 89 | responsePayload = { |
551e477c | 90 | hashIds: requestPayload?.hashIds, |
6c8f5d90 JB |
91 | status: ResponseStatus.FAILURE, |
92 | command, | |
93 | requestPayload, | |
94 | responsePayload, | |
95 | errorMessage: (error as Error).message, | |
96 | errorStack: (error as Error).stack, | |
9d73266c | 97 | errorDetails: (error as OCPPError).details, |
6c8f5d90 | 98 | }; |
623b39b5 JB |
99 | } finally { |
100 | // Send response for payload not forwarded to broadcast channel | |
101 | if (responsePayload !== undefined) { | |
d3195f0a | 102 | this.sendResponse(messageId, responsePayload); |
623b39b5 | 103 | } |
4198ad5c | 104 | } |
6c8f5d90 JB |
105 | } |
106 | ||
107 | public sendRequest( | |
108 | messageId: string, | |
109 | procedureName: ProcedureName, | |
110 | requestPayload: RequestPayload | |
111 | ): void { | |
852a4c5f JB |
112 | this.uiServer.sendRequest( |
113 | this.uiServer.buildProtocolRequest(messageId, procedureName, requestPayload) | |
114 | ); | |
6c8f5d90 | 115 | } |
32de5a57 | 116 | |
6c8f5d90 | 117 | public sendResponse(messageId: string, responsePayload: ResponsePayload): void { |
852a4c5f | 118 | this.uiServer.sendResponse(this.uiServer.buildProtocolResponse(messageId, responsePayload)); |
4198ad5c JB |
119 | } |
120 | ||
8b7072dc | 121 | public logPrefix = (modName: string, methodName: string): string => { |
0d2cec76 | 122 | return this.uiServer.logPrefix(modName, methodName, this.version); |
8b7072dc | 123 | }; |
0d2cec76 JB |
124 | |
125 | public deleteBroadcastChannelRequest(uuid: string): void { | |
126 | this.broadcastChannelRequests.delete(uuid); | |
127 | } | |
128 | ||
129 | public getBroadcastChannelExpectedResponses(uuid: string): number { | |
130 | return this.broadcastChannelRequests.get(uuid) ?? 0; | |
131 | } | |
132 | ||
2a3cf7fc JB |
133 | protected handleProtocolRequest( |
134 | uuid: string, | |
135 | procedureName: ProcedureName, | |
136 | payload: RequestPayload | |
137 | ): void { | |
138 | this.sendBroadcastChannelRequest( | |
139 | uuid, | |
140 | AbstractUIService.ProcedureNameToBroadCastChannelProcedureNameMap[ | |
141 | procedureName | |
142 | ] as BroadcastChannelProcedureName, | |
143 | payload | |
144 | ); | |
145 | } | |
146 | ||
147 | private sendBroadcastChannelRequest( | |
0d2cec76 JB |
148 | uuid: string, |
149 | procedureName: BroadcastChannelProcedureName, | |
150 | payload: BroadcastChannelRequestPayload | |
151 | ): void { | |
53ac516c | 152 | if (Utils.isNotEmptyArray(payload.hashIds)) { |
0d2cec76 | 153 | payload.hashIds = payload.hashIds |
3ce0201e | 154 | .filter((hashId) => hashId !== undefined) |
72092cfc | 155 | .map((hashId) => { |
0d2cec76 JB |
156 | if (this.uiServer.chargingStations.has(hashId) === true) { |
157 | return hashId; | |
158 | } | |
159 | logger.warn( | |
160 | `${this.logPrefix( | |
161 | moduleName, | |
162 | 'sendBroadcastChannelRequest' | |
163 | )} Charging station with hashId '${hashId}' not found` | |
164 | ); | |
3ce0201e | 165 | }); |
0d2cec76 | 166 | } |
53ac516c | 167 | const expectedNumberOfResponses = Utils.isNotEmptyArray(payload.hashIds) |
0d2cec76 JB |
168 | ? payload.hashIds.length |
169 | : this.uiServer.chargingStations.size; | |
0d2cec76 | 170 | this.uiServiceWorkerBroadcastChannel.sendRequest([uuid, procedureName, payload]); |
853ed24a | 171 | this.broadcastChannelRequests.set(uuid, expectedNumberOfResponses); |
6c8f5d90 JB |
172 | } |
173 | ||
89b7a234 | 174 | private handleListChargingStations(): ResponsePayload { |
32de5a57 LM |
175 | return { |
176 | status: ResponseStatus.SUCCESS, | |
5e3cb728 JB |
177 | chargingStations: [...this.uiServer.chargingStations.values()], |
178 | } as ResponsePayload; | |
32de5a57 LM |
179 | } |
180 | ||
181 | private async handleStartSimulator(): Promise<ResponsePayload> { | |
4ec634b7 JB |
182 | try { |
183 | await Bootstrap.getInstance().start(); | |
184 | return { status: ResponseStatus.SUCCESS }; | |
185 | } catch (error) { | |
186 | return { status: ResponseStatus.FAILURE }; | |
187 | } | |
32de5a57 LM |
188 | } |
189 | ||
190 | private async handleStopSimulator(): Promise<ResponsePayload> { | |
4ec634b7 JB |
191 | try { |
192 | await Bootstrap.getInstance().stop(); | |
193 | return { status: ResponseStatus.SUCCESS }; | |
194 | } catch (error) { | |
195 | return { status: ResponseStatus.FAILURE }; | |
196 | } | |
4198ad5c JB |
197 | } |
198 | } |