40b7c7818a7731c3ea56dac4d81986a689ddc6b9
[e-mobility-charging-stations-simulator.git] / src / charging-station / AutomaticTransactionGenerator.ts
1 // Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved.
2
3 import { hoursToMilliseconds, secondsToMilliseconds } from 'date-fns'
4
5 import { BaseError } from '../exception/index.js'
6 import { PerformanceStatistics } from '../performance/index.js'
7 import {
8 AuthorizationStatus,
9 RequestCommand,
10 type StartTransactionRequest,
11 type StartTransactionResponse,
12 type Status,
13 StopTransactionReason,
14 type StopTransactionResponse
15 } from '../types/index.js'
16 import {
17 clone,
18 Constants,
19 convertToDate,
20 formatDurationMilliSeconds,
21 getRandomInteger,
22 isValidDate,
23 logger,
24 logPrefix,
25 secureRandom,
26 sleep
27 } from '../utils/index.js'
28 import type { ChargingStation } from './ChargingStation.js'
29 import { checkChargingStation } from './Helpers.js'
30 import { IdTagsCache } from './IdTagsCache.js'
31 import { isIdTagAuthorized } from './ocpp/index.js'
32
33 export class AutomaticTransactionGenerator {
34 private static readonly instances: Map<string, AutomaticTransactionGenerator> = new Map<
35 string,
36 AutomaticTransactionGenerator
37 >()
38
39 public readonly connectorsStatus: Map<number, Status>
40 public started: boolean
41 private starting: boolean
42 private stopping: boolean
43 private readonly chargingStation: ChargingStation
44
45 private constructor (chargingStation: ChargingStation) {
46 this.started = false
47 this.starting = false
48 this.stopping = false
49 this.chargingStation = chargingStation
50 this.connectorsStatus = new Map<number, Status>()
51 this.initializeConnectorsStatus()
52 }
53
54 public static getInstance (
55 chargingStation: ChargingStation
56 ): AutomaticTransactionGenerator | undefined {
57 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
58 if (!AutomaticTransactionGenerator.instances.has(chargingStation.stationInfo!.hashId)) {
59 AutomaticTransactionGenerator.instances.set(
60 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
61 chargingStation.stationInfo!.hashId,
62 new AutomaticTransactionGenerator(chargingStation)
63 )
64 }
65 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
66 return AutomaticTransactionGenerator.instances.get(chargingStation.stationInfo!.hashId)
67 }
68
69 public static deleteInstance (chargingStation: ChargingStation): boolean {
70 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
71 return AutomaticTransactionGenerator.instances.delete(chargingStation.stationInfo!.hashId)
72 }
73
74 public start (stopAbsoluteDuration?: boolean): void {
75 if (!checkChargingStation(this.chargingStation, this.logPrefix())) {
76 return
77 }
78 if (this.started) {
79 logger.warn(`${this.logPrefix()} is already started`)
80 return
81 }
82 if (this.starting) {
83 logger.warn(`${this.logPrefix()} is already starting`)
84 return
85 }
86 this.starting = true
87 this.startConnectors(stopAbsoluteDuration)
88 this.started = true
89 this.starting = false
90 }
91
92 public stop (): void {
93 if (!this.started) {
94 logger.warn(`${this.logPrefix()} is already stopped`)
95 return
96 }
97 if (this.stopping) {
98 logger.warn(`${this.logPrefix()} is already stopping`)
99 return
100 }
101 this.stopping = true
102 this.stopConnectors()
103 this.started = false
104 this.stopping = false
105 }
106
107 public startConnector (connectorId: number, stopAbsoluteDuration?: boolean): void {
108 if (!checkChargingStation(this.chargingStation, this.logPrefix(connectorId))) {
109 return
110 }
111 if (!this.connectorsStatus.has(connectorId)) {
112 logger.error(`${this.logPrefix(connectorId)} starting on non existing connector`)
113 throw new BaseError(`Connector ${connectorId} does not exist`)
114 }
115 if (this.connectorsStatus.get(connectorId)?.start === false) {
116 this.internalStartConnector(connectorId, stopAbsoluteDuration).catch(Constants.EMPTY_FUNCTION)
117 } else if (this.connectorsStatus.get(connectorId)?.start === true) {
118 logger.warn(`${this.logPrefix(connectorId)} is already started on connector`)
119 }
120 }
121
122 public stopConnector (connectorId: number): void {
123 if (!this.connectorsStatus.has(connectorId)) {
124 logger.error(`${this.logPrefix(connectorId)} stopping on non existing connector`)
125 throw new BaseError(`Connector ${connectorId} does not exist`)
126 }
127 if (this.connectorsStatus.get(connectorId)?.start === true) {
128 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
129 this.connectorsStatus.get(connectorId)!.start = false
130 } else if (this.connectorsStatus.get(connectorId)?.start === false) {
131 logger.warn(`${this.logPrefix(connectorId)} is already stopped on connector`)
132 }
133 }
134
135 private startConnectors (stopAbsoluteDuration?: boolean): void {
136 if (
137 this.connectorsStatus.size > 0 &&
138 this.connectorsStatus.size !== this.chargingStation.getNumberOfConnectors()
139 ) {
140 this.connectorsStatus.clear()
141 this.initializeConnectorsStatus()
142 }
143 if (this.chargingStation.hasEvses) {
144 for (const [evseId, evseStatus] of this.chargingStation.evses) {
145 if (evseId > 0) {
146 for (const connectorId of evseStatus.connectors.keys()) {
147 this.startConnector(connectorId, stopAbsoluteDuration)
148 }
149 }
150 }
151 } else {
152 for (const connectorId of this.chargingStation.connectors.keys()) {
153 if (connectorId > 0) {
154 this.startConnector(connectorId, stopAbsoluteDuration)
155 }
156 }
157 }
158 }
159
160 private stopConnectors (): void {
161 if (this.chargingStation.hasEvses) {
162 for (const [evseId, evseStatus] of this.chargingStation.evses) {
163 if (evseId > 0) {
164 for (const connectorId of evseStatus.connectors.keys()) {
165 this.stopConnector(connectorId)
166 }
167 }
168 }
169 } else {
170 for (const connectorId of this.chargingStation.connectors.keys()) {
171 if (connectorId > 0) {
172 this.stopConnector(connectorId)
173 }
174 }
175 }
176 }
177
178 private async internalStartConnector (
179 connectorId: number,
180 stopAbsoluteDuration?: boolean
181 ): Promise<void> {
182 this.setStartConnectorStatus(connectorId, stopAbsoluteDuration)
183 logger.info(
184 `${this.logPrefix(
185 connectorId
186 )} started on connector and will run for ${formatDurationMilliSeconds(
187 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
188 this.connectorsStatus.get(connectorId)!.stopDate!.getTime() -
189 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
190 this.connectorsStatus.get(connectorId)!.startDate!.getTime()
191 )}`
192 )
193 while (this.connectorsStatus.get(connectorId)?.start === true) {
194 await this.waitChargingStationAvailable(connectorId)
195 await this.waitConnectorAvailable(connectorId)
196 await this.waitRunningTransactionStopped(connectorId)
197 if (!this.canStartConnector(connectorId)) {
198 this.stopConnector(connectorId)
199 break
200 }
201 const wait = secondsToMilliseconds(
202 getRandomInteger(
203 this.chargingStation.getAutomaticTransactionGeneratorConfiguration()
204 ?.maxDelayBetweenTwoTransactions,
205 this.chargingStation.getAutomaticTransactionGeneratorConfiguration()
206 ?.minDelayBetweenTwoTransactions
207 )
208 )
209 logger.info(`${this.logPrefix(connectorId)} waiting for ${formatDurationMilliSeconds(wait)}`)
210 await sleep(wait)
211 const start = secureRandom()
212 if (
213 start <
214 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
215 this.chargingStation.getAutomaticTransactionGeneratorConfiguration()!.probabilityOfStart
216 ) {
217 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
218 this.connectorsStatus.get(connectorId)!.skippedConsecutiveTransactions = 0
219 // Start transaction
220 const startResponse = await this.startTransaction(connectorId)
221 if (startResponse?.idTagInfo.status === AuthorizationStatus.ACCEPTED) {
222 // Wait until end of transaction
223 const waitTrxEnd = secondsToMilliseconds(
224 getRandomInteger(
225 this.chargingStation.getAutomaticTransactionGeneratorConfiguration()?.maxDuration,
226 this.chargingStation.getAutomaticTransactionGeneratorConfiguration()?.minDuration
227 )
228 )
229 logger.info(
230 `${this.logPrefix(connectorId)} transaction started with id ${
231 this.chargingStation.getConnectorStatus(connectorId)?.transactionId
232 } and will stop in ${formatDurationMilliSeconds(waitTrxEnd)}`
233 )
234 await sleep(waitTrxEnd)
235 await this.stopTransaction(connectorId)
236 }
237 } else {
238 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
239 ++this.connectorsStatus.get(connectorId)!.skippedConsecutiveTransactions
240 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
241 ++this.connectorsStatus.get(connectorId)!.skippedTransactions
242 logger.info(
243 `${this.logPrefix(connectorId)} skipped consecutively ${
244 this.connectorsStatus.get(connectorId)?.skippedConsecutiveTransactions
245 }/${this.connectorsStatus.get(connectorId)?.skippedTransactions} transaction(s)`
246 )
247 }
248 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
249 this.connectorsStatus.get(connectorId)!.lastRunDate = new Date()
250 }
251 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
252 this.connectorsStatus.get(connectorId)!.stoppedDate = new Date()
253 logger.info(
254 `${this.logPrefix(
255 connectorId
256 )} stopped on connector and lasted for ${formatDurationMilliSeconds(
257 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
258 this.connectorsStatus.get(connectorId)!.stoppedDate!.getTime() -
259 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
260 this.connectorsStatus.get(connectorId)!.startDate!.getTime()
261 )}`
262 )
263 logger.debug(
264 `${this.logPrefix(connectorId)} connector status: %j`,
265 this.connectorsStatus.get(connectorId)
266 )
267 }
268
269 private setStartConnectorStatus (
270 connectorId: number,
271 stopAbsoluteDuration = this.chargingStation.getAutomaticTransactionGeneratorConfiguration()
272 ?.stopAbsoluteDuration
273 ): void {
274 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
275 this.connectorsStatus.get(connectorId)!.startDate = new Date()
276 if (
277 stopAbsoluteDuration === false ||
278 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
279 !isValidDate(this.connectorsStatus.get(connectorId)!.stopDate)
280 ) {
281 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
282 this.connectorsStatus.get(connectorId)!.stopDate = new Date(
283 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
284 this.connectorsStatus.get(connectorId)!.startDate!.getTime() +
285 hoursToMilliseconds(
286 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
287 this.chargingStation.getAutomaticTransactionGeneratorConfiguration()!.stopAfterHours
288 )
289 )
290 }
291 delete this.connectorsStatus.get(connectorId)?.stoppedDate
292 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
293 this.connectorsStatus.get(connectorId)!.skippedConsecutiveTransactions = 0
294 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
295 this.connectorsStatus.get(connectorId)!.start = true
296 }
297
298 private canStartConnector (connectorId: number): boolean {
299 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
300 if (new Date() > this.connectorsStatus.get(connectorId)!.stopDate!) {
301 logger.info(
302 `${this.logPrefix(
303 connectorId
304 )} entered in transaction loop while the ATG stop date has been reached`
305 )
306 return false
307 }
308 if (!this.chargingStation.inAcceptedState()) {
309 logger.error(
310 `${this.logPrefix(
311 connectorId
312 )} entered in transaction loop while the charging station is not in accepted state`
313 )
314 return false
315 }
316 if (!this.chargingStation.isChargingStationAvailable()) {
317 logger.info(
318 `${this.logPrefix(
319 connectorId
320 )} entered in transaction loop while the charging station is unavailable`
321 )
322 return false
323 }
324 if (!this.chargingStation.isConnectorAvailable(connectorId)) {
325 logger.info(
326 `${this.logPrefix(
327 connectorId
328 )} entered in transaction loop while the connector ${connectorId} is unavailable`
329 )
330 return false
331 }
332 const connectorStatus = this.chargingStation.getConnectorStatus(connectorId)
333 if (connectorStatus?.transactionStarted === true) {
334 logger.info(
335 `${this.logPrefix(
336 connectorId
337 )} entered in transaction loop while a transaction ${connectorStatus.transactionId} is already started on connector ${connectorId}`
338 )
339 return false
340 }
341 return true
342 }
343
344 private async waitChargingStationAvailable (connectorId: number): Promise<void> {
345 let logged = false
346 while (!this.chargingStation.isChargingStationAvailable()) {
347 if (!logged) {
348 logger.info(
349 `${this.logPrefix(
350 connectorId
351 )} transaction loop waiting for charging station to be available`
352 )
353 logged = true
354 }
355 await sleep(Constants.DEFAULT_ATG_WAIT_TIME)
356 }
357 }
358
359 private async waitConnectorAvailable (connectorId: number): Promise<void> {
360 let logged = false
361 while (!this.chargingStation.isConnectorAvailable(connectorId)) {
362 if (!logged) {
363 logger.info(
364 `${this.logPrefix(
365 connectorId
366 )} transaction loop waiting for connector ${connectorId} to be available`
367 )
368 logged = true
369 }
370 await sleep(Constants.DEFAULT_ATG_WAIT_TIME)
371 }
372 }
373
374 private async waitRunningTransactionStopped (connectorId: number): Promise<void> {
375 const connectorStatus = this.chargingStation.getConnectorStatus(connectorId)
376 let logged = false
377 while (connectorStatus?.transactionStarted === true) {
378 if (!logged) {
379 logger.info(
380 `${this.logPrefix(
381 connectorId
382 )} transaction loop waiting for started transaction ${connectorStatus.transactionId} on connector ${connectorId} to be stopped`
383 )
384 logged = true
385 }
386 await sleep(Constants.DEFAULT_ATG_WAIT_TIME)
387 }
388 }
389
390 private initializeConnectorsStatus (): void {
391 if (this.chargingStation.hasEvses) {
392 for (const [evseId, evseStatus] of this.chargingStation.evses) {
393 if (evseId > 0) {
394 for (const connectorId of evseStatus.connectors.keys()) {
395 this.connectorsStatus.set(connectorId, this.getConnectorStatus(connectorId))
396 }
397 }
398 }
399 } else {
400 for (const connectorId of this.chargingStation.connectors.keys()) {
401 if (connectorId > 0) {
402 this.connectorsStatus.set(connectorId, this.getConnectorStatus(connectorId))
403 }
404 }
405 }
406 }
407
408 private getConnectorStatus (connectorId: number): Status {
409 const statusIndex = connectorId - 1
410 let connectorStatus: Status | undefined
411 if (this.chargingStation.getAutomaticTransactionGeneratorStatuses()?.[statusIndex] != null) {
412 connectorStatus = clone<Status>(
413 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
414 this.chargingStation.getAutomaticTransactionGeneratorStatuses()![statusIndex]
415 )
416 } else if (this.chargingStation.getAutomaticTransactionGeneratorStatuses() != null) {
417 logger.warn(
418 `${this.logPrefix(connectorId)} no status found for connector #${connectorId} in charging station configuration file. New status will be created`
419 )
420 }
421 if (connectorStatus != null) {
422 connectorStatus.startDate = convertToDate(connectorStatus.startDate)
423 connectorStatus.lastRunDate = convertToDate(connectorStatus.lastRunDate)
424 connectorStatus.stopDate = convertToDate(connectorStatus.stopDate)
425 connectorStatus.stoppedDate = convertToDate(connectorStatus.stoppedDate)
426 if (
427 !this.started &&
428 (connectorStatus.start ||
429 this.chargingStation.getAutomaticTransactionGeneratorConfiguration()?.enable !== true)
430 ) {
431 connectorStatus.start = false
432 }
433 }
434 return (
435 connectorStatus ?? {
436 start: false,
437 authorizeRequests: 0,
438 acceptedAuthorizeRequests: 0,
439 rejectedAuthorizeRequests: 0,
440 startTransactionRequests: 0,
441 acceptedStartTransactionRequests: 0,
442 rejectedStartTransactionRequests: 0,
443 stopTransactionRequests: 0,
444 acceptedStopTransactionRequests: 0,
445 rejectedStopTransactionRequests: 0,
446 skippedConsecutiveTransactions: 0,
447 skippedTransactions: 0
448 }
449 )
450 }
451
452 private async startTransaction (
453 connectorId: number
454 ): Promise<StartTransactionResponse | undefined> {
455 const measureId = 'StartTransaction with ATG'
456 const beginId = PerformanceStatistics.beginMeasure(measureId)
457 let startResponse: StartTransactionResponse | undefined
458 if (this.chargingStation.hasIdTags()) {
459 const idTag = IdTagsCache.getInstance().getIdTag(
460 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
461 this.chargingStation.getAutomaticTransactionGeneratorConfiguration()!.idTagDistribution!,
462 this.chargingStation,
463 connectorId
464 )
465 const startTransactionLogMsg = `${this.logPrefix(
466 connectorId
467 )} start transaction with an idTag '${idTag}'`
468 if (this.getRequireAuthorize()) {
469 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
470 ++this.connectorsStatus.get(connectorId)!.authorizeRequests
471 if (await isIdTagAuthorized(this.chargingStation, connectorId, idTag)) {
472 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
473 ++this.connectorsStatus.get(connectorId)!.acceptedAuthorizeRequests
474 logger.info(startTransactionLogMsg)
475 // Start transaction
476 startResponse = await this.chargingStation.ocppRequestService.requestHandler<
477 StartTransactionRequest,
478 StartTransactionResponse
479 >(this.chargingStation, RequestCommand.START_TRANSACTION, {
480 connectorId,
481 idTag
482 })
483 this.handleStartTransactionResponse(connectorId, startResponse)
484 PerformanceStatistics.endMeasure(measureId, beginId)
485 return startResponse
486 }
487 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
488 ++this.connectorsStatus.get(connectorId)!.rejectedAuthorizeRequests
489 PerformanceStatistics.endMeasure(measureId, beginId)
490 return startResponse
491 }
492 logger.info(startTransactionLogMsg)
493 // Start transaction
494 startResponse = await this.chargingStation.ocppRequestService.requestHandler<
495 StartTransactionRequest,
496 StartTransactionResponse
497 >(this.chargingStation, RequestCommand.START_TRANSACTION, {
498 connectorId,
499 idTag
500 })
501 this.handleStartTransactionResponse(connectorId, startResponse)
502 PerformanceStatistics.endMeasure(measureId, beginId)
503 return startResponse
504 }
505 logger.info(`${this.logPrefix(connectorId)} start transaction without an idTag`)
506 startResponse = await this.chargingStation.ocppRequestService.requestHandler<
507 StartTransactionRequest,
508 StartTransactionResponse
509 >(this.chargingStation, RequestCommand.START_TRANSACTION, { connectorId })
510 this.handleStartTransactionResponse(connectorId, startResponse)
511 PerformanceStatistics.endMeasure(measureId, beginId)
512 return startResponse
513 }
514
515 private async stopTransaction (
516 connectorId: number,
517 reason = StopTransactionReason.LOCAL
518 ): Promise<StopTransactionResponse | undefined> {
519 const measureId = 'StopTransaction with ATG'
520 const beginId = PerformanceStatistics.beginMeasure(measureId)
521 let stopResponse: StopTransactionResponse | undefined
522 if (this.chargingStation.getConnectorStatus(connectorId)?.transactionStarted === true) {
523 logger.info(
524 `${this.logPrefix(connectorId)} stop transaction with id ${
525 this.chargingStation.getConnectorStatus(connectorId)?.transactionId
526 }`
527 )
528 stopResponse = await this.chargingStation.stopTransactionOnConnector(connectorId, reason)
529 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
530 ++this.connectorsStatus.get(connectorId)!.stopTransactionRequests
531 if (stopResponse.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
532 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
533 ++this.connectorsStatus.get(connectorId)!.acceptedStopTransactionRequests
534 } else {
535 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
536 ++this.connectorsStatus.get(connectorId)!.rejectedStopTransactionRequests
537 }
538 } else {
539 const transactionId = this.chargingStation.getConnectorStatus(connectorId)?.transactionId
540 logger.debug(
541 `${this.logPrefix(connectorId)} stopping a not started transaction${
542 transactionId != null ? ` with id ${transactionId}` : ''
543 }`
544 )
545 }
546 PerformanceStatistics.endMeasure(measureId, beginId)
547 return stopResponse
548 }
549
550 private getRequireAuthorize (): boolean {
551 return (
552 this.chargingStation.getAutomaticTransactionGeneratorConfiguration()?.requireAuthorize ?? true
553 )
554 }
555
556 private readonly logPrefix = (connectorId?: number): string => {
557 return logPrefix(
558 ` ${this.chargingStation.stationInfo?.chargingStationId} | ATG${
559 connectorId != null ? ` on connector #${connectorId}` : ''
560 }:`
561 )
562 }
563
564 private handleStartTransactionResponse (
565 connectorId: number,
566 startResponse: StartTransactionResponse
567 ): void {
568 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
569 ++this.connectorsStatus.get(connectorId)!.startTransactionRequests
570 if (startResponse.idTagInfo.status === AuthorizationStatus.ACCEPTED) {
571 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
572 ++this.connectorsStatus.get(connectorId)!.acceptedStartTransactionRequests
573 } else {
574 logger.warn(`${this.logPrefix(connectorId)} start transaction rejected`)
575 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
576 ++this.connectorsStatus.get(connectorId)!.rejectedStartTransactionRequests
577 }
578 }
579 }