Commit | Line | Data |
---|---|---|
e7aeea18 | 1 | import { |
e7aeea18 JB |
2 | IncomingRequestCommand, |
3 | RequestCommand, | |
4 | ResponseType, | |
5 | SendParams, | |
6 | } from '../../types/ocpp/Requests'; | |
c0560973 | 7 | |
9f2e3130 | 8 | import type ChargingStation from '../ChargingStation'; |
c0560973 | 9 | import Constants from '../../utils/Constants'; |
47086c3a | 10 | import { EmptyObject } from '../../types/EmptyObject'; |
c0560973 | 11 | import { ErrorType } from '../../types/ocpp/ErrorType'; |
e0a50bcd | 12 | import { HandleErrorParams } from '../../types/Error'; |
d1888640 | 13 | import { JsonType } from '../../types/JsonType'; |
c0560973 | 14 | import { MessageType } from '../../types/ocpp/MessageType'; |
e58068fd | 15 | import OCPPError from '../../exception/OCPPError'; |
9f2e3130 | 16 | import type OCPPResponseService from './OCPPResponseService'; |
a6b3c6c3 | 17 | import PerformanceStatistics from '../../performance/PerformanceStatistics'; |
6d9abcc2 | 18 | import Utils from '../../utils/Utils'; |
9f2e3130 | 19 | import logger from '../../utils/Logger'; |
c0560973 JB |
20 | |
21 | export default abstract class OCPPRequestService { | |
e7aeea18 JB |
22 | private static readonly instances: Map<string, OCPPRequestService> = new Map< |
23 | string, | |
24 | OCPPRequestService | |
25 | >(); | |
10068088 | 26 | |
9f2e3130 JB |
27 | protected readonly chargingStation: ChargingStation; |
28 | private readonly ocppResponseService: OCPPResponseService; | |
c0560973 | 29 | |
e7aeea18 JB |
30 | protected constructor( |
31 | chargingStation: ChargingStation, | |
32 | ocppResponseService: OCPPResponseService | |
33 | ) { | |
c0560973 JB |
34 | this.chargingStation = chargingStation; |
35 | this.ocppResponseService = ocppResponseService; | |
94a464f9 | 36 | this.sendMessageHandler.bind(this); |
c0560973 JB |
37 | } |
38 | ||
e7aeea18 JB |
39 | public static getInstance<T extends OCPPRequestService>( |
40 | this: new (chargingStation: ChargingStation, ocppResponseService: OCPPResponseService) => T, | |
41 | chargingStation: ChargingStation, | |
42 | ocppResponseService: OCPPResponseService | |
43 | ): T { | |
9f2e3130 | 44 | if (!OCPPRequestService.instances.has(chargingStation.id)) { |
e7aeea18 JB |
45 | OCPPRequestService.instances.set( |
46 | chargingStation.id, | |
47 | new this(chargingStation, ocppResponseService) | |
48 | ); | |
9f2e3130 JB |
49 | } |
50 | return OCPPRequestService.instances.get(chargingStation.id) as T; | |
51 | } | |
52 | ||
e7aeea18 JB |
53 | public async sendResult( |
54 | messageId: string, | |
55 | messagePayload: JsonType, | |
56 | commandName: IncomingRequestCommand | |
57 | ): Promise<ResponseType> { | |
5e0c67e8 JB |
58 | try { |
59 | // Send result message | |
e7aeea18 JB |
60 | return await this.internalSendMessage( |
61 | messageId, | |
62 | messagePayload, | |
63 | MessageType.CALL_RESULT_MESSAGE, | |
64 | commandName | |
65 | ); | |
5e0c67e8 JB |
66 | } catch (error) { |
67 | this.handleRequestError(commandName, error as Error); | |
68 | } | |
69 | } | |
70 | ||
e7aeea18 JB |
71 | public async sendError( |
72 | messageId: string, | |
73 | ocppError: OCPPError, | |
74 | commandName: IncomingRequestCommand | |
75 | ): Promise<ResponseType> { | |
5e0c67e8 JB |
76 | try { |
77 | // Send error message | |
e7aeea18 JB |
78 | return await this.internalSendMessage( |
79 | messageId, | |
80 | ocppError, | |
81 | MessageType.CALL_ERROR_MESSAGE, | |
82 | commandName | |
83 | ); | |
5e0c67e8 JB |
84 | } catch (error) { |
85 | this.handleRequestError(commandName, error as Error); | |
86 | } | |
87 | } | |
88 | ||
e7aeea18 JB |
89 | protected async sendMessage( |
90 | messageId: string, | |
91 | messagePayload: JsonType, | |
92 | commandName: RequestCommand, | |
93 | params: SendParams = { | |
94 | skipBufferingOnError: false, | |
95 | triggerMessage: false, | |
96 | } | |
97 | ): Promise<ResponseType> { | |
5e0c67e8 | 98 | try { |
e7aeea18 JB |
99 | return await this.internalSendMessage( |
100 | messageId, | |
101 | messagePayload, | |
102 | MessageType.CALL_MESSAGE, | |
103 | commandName, | |
104 | params | |
105 | ); | |
5e0c67e8 | 106 | } catch (error) { |
e0a50bcd | 107 | this.handleRequestError(commandName, error as Error, { throwError: false }); |
5e0c67e8 JB |
108 | } |
109 | } | |
110 | ||
e7aeea18 JB |
111 | private async internalSendMessage( |
112 | messageId: string, | |
113 | messagePayload: JsonType | OCPPError, | |
114 | messageType: MessageType, | |
115 | commandName?: RequestCommand | IncomingRequestCommand, | |
116 | params: SendParams = { | |
117 | skipBufferingOnError: false, | |
118 | triggerMessage: false, | |
119 | } | |
120 | ): Promise<ResponseType> { | |
121 | if ( | |
122 | (this.chargingStation.isInUnknownState() && | |
123 | commandName === RequestCommand.BOOT_NOTIFICATION) || | |
124 | (!this.chargingStation.getOcppStrictCompliance() && | |
125 | this.chargingStation.isInUnknownState()) || | |
126 | this.chargingStation.isInAcceptedState() || | |
127 | (this.chargingStation.isInPendingState() && params.triggerMessage) | |
128 | ) { | |
caad9d6b JB |
129 | // eslint-disable-next-line @typescript-eslint/no-this-alias |
130 | const self = this; | |
131 | // Send a message through wsConnection | |
e7aeea18 JB |
132 | return Utils.promiseWithTimeout( |
133 | new Promise((resolve, reject) => { | |
134 | const messageToSend = this.buildMessageToSend( | |
135 | messageId, | |
136 | messagePayload, | |
137 | messageType, | |
138 | commandName, | |
139 | responseCallback, | |
140 | rejectCallback | |
141 | ); | |
142 | if (this.chargingStation.getEnableStatistics()) { | |
143 | this.chargingStation.performanceStatistics.addRequestStatistic( | |
144 | commandName, | |
145 | messageType | |
146 | ); | |
caad9d6b | 147 | } |
e7aeea18 JB |
148 | // Check if wsConnection opened |
149 | if (this.chargingStation.isWebSocketConnectionOpened()) { | |
150 | // Yes: Send Message | |
151 | const beginId = PerformanceStatistics.beginMeasure(commandName); | |
152 | // FIXME: Handle sending error | |
153 | this.chargingStation.wsConnection.send(messageToSend); | |
154 | PerformanceStatistics.endMeasure(commandName, beginId); | |
155 | } else if (!params.skipBufferingOnError) { | |
156 | // Buffer it | |
157 | this.chargingStation.bufferMessage(messageToSend); | |
158 | const ocppError = new OCPPError( | |
159 | ErrorType.GENERIC_ERROR, | |
160 | `WebSocket closed for buffered message id '${messageId}' with content '${messageToSend}'`, | |
161 | commandName, | |
162 | (messagePayload?.details as JsonType) ?? {} | |
163 | ); | |
164 | if (messageType === MessageType.CALL_MESSAGE) { | |
165 | // Reject it but keep the request in the cache | |
166 | return reject(ocppError); | |
167 | } | |
168 | return rejectCallback(ocppError, false); | |
169 | } else { | |
170 | // Reject it | |
171 | return rejectCallback( | |
172 | new OCPPError( | |
173 | ErrorType.GENERIC_ERROR, | |
174 | `WebSocket closed for non buffered message id '${messageId}' with content '${messageToSend}'`, | |
175 | commandName, | |
176 | (messagePayload?.details as JsonType) ?? {} | |
177 | ), | |
178 | false | |
179 | ); | |
caad9d6b | 180 | } |
e7aeea18 JB |
181 | // Response? |
182 | if (messageType !== MessageType.CALL_MESSAGE) { | |
183 | // Yes: send Ok | |
184 | return resolve(messagePayload); | |
185 | } | |
186 | ||
187 | /** | |
188 | * Function that will receive the request's response | |
189 | * | |
190 | * @param payload | |
191 | * @param requestPayload | |
192 | */ | |
193 | async function responseCallback( | |
194 | payload: JsonType | string, | |
195 | requestPayload: JsonType | |
196 | ): Promise<void> { | |
197 | if (self.chargingStation.getEnableStatistics()) { | |
198 | self.chargingStation.performanceStatistics.addRequestStatistic( | |
199 | commandName, | |
200 | MessageType.CALL_RESULT_MESSAGE | |
201 | ); | |
202 | } | |
203 | // Handle the request's response | |
204 | try { | |
205 | await self.ocppResponseService.handleResponse( | |
206 | commandName as RequestCommand, | |
207 | payload, | |
208 | requestPayload | |
209 | ); | |
210 | resolve(payload); | |
211 | } catch (error) { | |
212 | reject(error); | |
213 | throw error; | |
214 | } finally { | |
215 | self.chargingStation.requests.delete(messageId); | |
216 | } | |
caad9d6b | 217 | } |
caad9d6b | 218 | |
e7aeea18 JB |
219 | /** |
220 | * Function that will receive the request's error response | |
221 | * | |
222 | * @param error | |
223 | * @param requestStatistic | |
224 | */ | |
225 | function rejectCallback(error: OCPPError, requestStatistic = true): void { | |
226 | if (requestStatistic && self.chargingStation.getEnableStatistics()) { | |
227 | self.chargingStation.performanceStatistics.addRequestStatistic( | |
228 | commandName, | |
229 | MessageType.CALL_ERROR_MESSAGE | |
230 | ); | |
231 | } | |
232 | logger.error( | |
233 | `${self.chargingStation.logPrefix()} Error %j occurred when calling command %s with message data %j`, | |
234 | error, | |
235 | commandName, | |
236 | messagePayload | |
237 | ); | |
238 | self.chargingStation.requests.delete(messageId); | |
239 | reject(error); | |
caad9d6b | 240 | } |
e7aeea18 JB |
241 | }), |
242 | Constants.OCPP_WEBSOCKET_TIMEOUT, | |
243 | new OCPPError( | |
244 | ErrorType.GENERIC_ERROR, | |
245 | `Timeout for message id '${messageId}'`, | |
246 | commandName, | |
247 | (messagePayload?.details as JsonType) ?? {} | |
248 | ), | |
249 | () => { | |
250 | messageType === MessageType.CALL_MESSAGE && | |
251 | this.chargingStation.requests.delete(messageId); | |
caad9d6b | 252 | } |
e7aeea18 | 253 | ); |
caad9d6b | 254 | } |
e7aeea18 JB |
255 | throw new OCPPError( |
256 | ErrorType.SECURITY_ERROR, | |
257 | `Cannot send command ${commandName} payload when the charging station is in ${this.chargingStation.getRegistrationStatus()} state on the central server`, | |
258 | commandName | |
259 | ); | |
c0560973 JB |
260 | } |
261 | ||
e7aeea18 JB |
262 | private buildMessageToSend( |
263 | messageId: string, | |
264 | messagePayload: JsonType | OCPPError, | |
265 | messageType: MessageType, | |
266 | commandName?: RequestCommand | IncomingRequestCommand, | |
267 | responseCallback?: (payload: JsonType | string, requestPayload: JsonType) => Promise<void>, | |
268 | rejectCallback?: (error: OCPPError, requestStatistic?: boolean) => void | |
269 | ): string { | |
e7accadb JB |
270 | let messageToSend: string; |
271 | // Type of message | |
272 | switch (messageType) { | |
273 | // Request | |
274 | case MessageType.CALL_MESSAGE: | |
275 | // Build request | |
e7aeea18 JB |
276 | this.chargingStation.requests.set(messageId, [ |
277 | responseCallback, | |
278 | rejectCallback, | |
279 | commandName, | |
280 | messagePayload, | |
281 | ]); | |
5e0c67e8 | 282 | messageToSend = JSON.stringify([messageType, messageId, commandName, messagePayload]); |
e7accadb JB |
283 | break; |
284 | // Response | |
285 | case MessageType.CALL_RESULT_MESSAGE: | |
286 | // Build response | |
5e0c67e8 | 287 | messageToSend = JSON.stringify([messageType, messageId, messagePayload]); |
e7accadb JB |
288 | break; |
289 | // Error Message | |
290 | case MessageType.CALL_ERROR_MESSAGE: | |
291 | // Build Error Message | |
e7aeea18 JB |
292 | messageToSend = JSON.stringify([ |
293 | messageType, | |
294 | messageId, | |
295 | messagePayload?.code ?? ErrorType.GENERIC_ERROR, | |
296 | messagePayload?.message ?? '', | |
297 | messagePayload?.details ?? { commandName }, | |
298 | ]); | |
e7accadb JB |
299 | break; |
300 | } | |
301 | return messageToSend; | |
302 | } | |
303 | ||
e7aeea18 JB |
304 | private handleRequestError( |
305 | commandName: RequestCommand | IncomingRequestCommand, | |
306 | error: Error, | |
307 | params: HandleErrorParams<EmptyObject> = { throwError: true } | |
308 | ): void { | |
309 | logger.error( | |
310 | this.chargingStation.logPrefix() + ' Request command %s error: %j', | |
311 | commandName, | |
312 | error | |
313 | ); | |
e0a50bcd JB |
314 | if (params?.throwError) { |
315 | throw error; | |
316 | } | |
5e0c67e8 JB |
317 | } |
318 | ||
94a464f9 JB |
319 | public abstract sendMessageHandler( |
320 | commandName: RequestCommand, | |
321 | commandParams?: JsonType, | |
322 | params?: SendParams | |
323 | ): Promise<ResponseType>; | |
c0560973 | 324 | } |