src/charging-station/AutomaticTransactionGenerator.ts

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