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     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 266     if (!isValidTime(this.connectorsStatus.get(connectorId)!.stopDate)) {
 267       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 268       this.connectorsStatus.get(connectorId)!.stopDate = new Date(
 269         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 270         this.connectorsStatus.get(connectorId)!.startDate!.getTime() +
 271           hoursToMilliseconds(
 272             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 273             this.chargingStation.getAutomaticTransactionGeneratorConfiguration()!.stopAfterHours
 274           )
 275       )
 276     }
 277     delete this.connectorsStatus.get(connectorId)?.stoppedDate
 278     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 279     this.connectorsStatus.get(connectorId)!.skippedConsecutiveTransactions = 0
 280     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 281     this.connectorsStatus.get(connectorId)!.start = true
 282   }
 283
 284   private canStartConnector (connectorId: number): boolean {
 285     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 286     if (new Date() > this.connectorsStatus.get(connectorId)!.stopDate!) {
 287       logger.info(
 288         `${this.logPrefix(
 289           connectorId
 290         )} entered in transaction loop while the ATG stop date has been reached`
 291       )
 292       return false
 293     }
 294     if (!this.chargingStation.inAcceptedState()) {
 295       logger.error(
 296         `${this.logPrefix(
 297           connectorId
 298         )} entered in transaction loop while the charging station is not in accepted state`
 299       )
 300       return false
 301     }
 302     if (!this.chargingStation.isChargingStationAvailable()) {
 303       logger.info(
 304         `${this.logPrefix(
 305           connectorId
 306         )} entered in transaction loop while the charging station is unavailable`
 307       )
 308       return false
 309     }
 310     if (!this.chargingStation.isConnectorAvailable(connectorId)) {
 311       logger.info(
 312         `${this.logPrefix(
 313           connectorId
 314         )} entered in transaction loop while the connector ${connectorId} is unavailable`
 315       )
 316       return false
 317     }
 318     return true
 319   }
 320
 321   private async waitChargingStationAvailable (connectorId: number): Promise<void> {
 322     let logged = false
 323     while (!this.chargingStation.isChargingStationAvailable()) {
 324       if (!logged) {
 325         logger.info(
 326           `${this.logPrefix(
 327             connectorId
 328           )} transaction loop waiting for charging station to be available`
 329         )
 330         logged = true
 331       }
 332       await sleep(Constants.CHARGING_STATION_ATG_AVAILABILITY_TIME)
 333     }
 334   }
 335
 336   private async waitConnectorAvailable (connectorId: number): Promise<void> {
 337     let logged = false
 338     while (!this.chargingStation.isConnectorAvailable(connectorId)) {
 339       if (!logged) {
 340         logger.info(
 341           `${this.logPrefix(
 342             connectorId
 343           )} transaction loop waiting for connector ${connectorId} to be available`
 344         )
 345         logged = true
 346       }
 347       await sleep(Constants.CHARGING_STATION_ATG_AVAILABILITY_TIME)
 348     }
 349   }
 350
 351   private initializeConnectorsStatus (): void {
 352     if (this.chargingStation.hasEvses) {
 353       for (const [evseId, evseStatus] of this.chargingStation.evses) {
 354         if (evseId > 0) {
 355           for (const connectorId of evseStatus.connectors.keys()) {
 356             this.connectorsStatus.set(connectorId, this.getConnectorStatus(connectorId))
 357           }
 358         }
 359       }
 360     } else {
 361       for (const connectorId of this.chargingStation.connectors.keys()) {
 362         if (connectorId > 0) {
 363           this.connectorsStatus.set(connectorId, this.getConnectorStatus(connectorId))
 364         }
 365       }
 366     }
 367   }
 368
 369   private getConnectorStatus (connectorId: number): Status {
 370     const connectorStatus =
 371       this.chargingStation.getAutomaticTransactionGeneratorStatuses()?.[connectorId - 1] != null
 372         ? cloneObject<Status>(
 373           // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 374           this.chargingStation.getAutomaticTransactionGeneratorStatuses()![connectorId - 1]
 375         )
 376         : undefined
 377     if (connectorStatus != null) {
 378       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 379       connectorStatus.startDate = convertToDate(connectorStatus.startDate)!
 380       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 381       connectorStatus.lastRunDate = convertToDate(connectorStatus.lastRunDate)!
 382       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 383       connectorStatus.stopDate = convertToDate(connectorStatus.stopDate)!
 384       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 385       connectorStatus.stoppedDate = convertToDate(connectorStatus.stoppedDate)!
 386       if (
 387         !this.started &&
 388         (connectorStatus.start ||
 389           this.chargingStation.getAutomaticTransactionGeneratorConfiguration()?.enable !== true)
 390       ) {
 391         connectorStatus.start = false
 392       }
 393     }
 394     return (
 395       connectorStatus ?? {
 396         start: false,
 397         authorizeRequests: 0,
 398         acceptedAuthorizeRequests: 0,
 399         rejectedAuthorizeRequests: 0,
 400         startTransactionRequests: 0,
 401         acceptedStartTransactionRequests: 0,
 402         rejectedStartTransactionRequests: 0,
 403         stopTransactionRequests: 0,
 404         acceptedStopTransactionRequests: 0,
 405         rejectedStopTransactionRequests: 0,
 406         skippedConsecutiveTransactions: 0,
 407         skippedTransactions: 0
 408       }
 409     )
 410   }
 411
 412   private async startTransaction (
 413     connectorId: number
 414   ): Promise<StartTransactionResponse | undefined> {
 415     const measureId = 'StartTransaction with ATG'
 416     const beginId = PerformanceStatistics.beginMeasure(measureId)
 417     let startResponse: StartTransactionResponse | undefined
 418     if (this.chargingStation.hasIdTags()) {
 419       const idTag = IdTagsCache.getInstance().getIdTag(
 420         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 421         this.chargingStation.getAutomaticTransactionGeneratorConfiguration()!.idTagDistribution!,
 422         this.chargingStation,
 423         connectorId
 424       )
 425       const startTransactionLogMsg = `${this.logPrefix(
 426         connectorId
 427       )} start transaction with an idTag '${idTag}'`
 428       if (this.getRequireAuthorize()) {
 429         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 430         ++this.connectorsStatus.get(connectorId)!.authorizeRequests
 431         if (await isIdTagAuthorized(this.chargingStation, connectorId, idTag)) {
 432           // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 433           ++this.connectorsStatus.get(connectorId)!.acceptedAuthorizeRequests
 434           logger.info(startTransactionLogMsg)
 435           // Start transaction
 436           startResponse = await this.chargingStation.ocppRequestService.requestHandler<
 437           StartTransactionRequest,
 438           StartTransactionResponse
 439           >(this.chargingStation, RequestCommand.START_TRANSACTION, {
 440             connectorId,
 441             idTag
 442           })
 443           this.handleStartTransactionResponse(connectorId, startResponse)
 444           PerformanceStatistics.endMeasure(measureId, beginId)
 445           return startResponse
 446         }
 447         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 448         ++this.connectorsStatus.get(connectorId)!.rejectedAuthorizeRequests
 449         PerformanceStatistics.endMeasure(measureId, beginId)
 450         return startResponse
 451       }
 452       logger.info(startTransactionLogMsg)
 453       // Start transaction
 454       startResponse = await this.chargingStation.ocppRequestService.requestHandler<
 455       StartTransactionRequest,
 456       StartTransactionResponse
 457       >(this.chargingStation, RequestCommand.START_TRANSACTION, {
 458         connectorId,
 459         idTag
 460       })
 461       this.handleStartTransactionResponse(connectorId, startResponse)
 462       PerformanceStatistics.endMeasure(measureId, beginId)
 463       return startResponse
 464     }
 465     logger.info(`${this.logPrefix(connectorId)} start transaction without an idTag`)
 466     startResponse = await this.chargingStation.ocppRequestService.requestHandler<
 467     StartTransactionRequest,
 468     StartTransactionResponse
 469     >(this.chargingStation, RequestCommand.START_TRANSACTION, { connectorId })
 470     this.handleStartTransactionResponse(connectorId, startResponse)
 471     PerformanceStatistics.endMeasure(measureId, beginId)
 472     return startResponse
 473   }
 474
 475   private async stopTransaction (
 476     connectorId: number,
 477     reason = StopTransactionReason.LOCAL
 478   ): Promise<StopTransactionResponse | undefined> {
 479     const measureId = 'StopTransaction with ATG'
 480     const beginId = PerformanceStatistics.beginMeasure(measureId)
 481     let stopResponse: StopTransactionResponse | undefined
 482     if (this.chargingStation.getConnectorStatus(connectorId)?.transactionStarted === true) {
 483       logger.info(
 484         `${this.logPrefix(
 485           connectorId
 486         )} stop transaction with id ${this.chargingStation.getConnectorStatus(connectorId)
 487           ?.transactionId}`
 488       )
 489       stopResponse = await this.chargingStation.stopTransactionOnConnector(connectorId, reason)
 490       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 491       ++this.connectorsStatus.get(connectorId)!.stopTransactionRequests
 492       if (stopResponse.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
 493         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 494         ++this.connectorsStatus.get(connectorId)!.acceptedStopTransactionRequests
 495       } else {
 496         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 497         ++this.connectorsStatus.get(connectorId)!.rejectedStopTransactionRequests
 498       }
 499     } else {
 500       const transactionId = this.chargingStation.getConnectorStatus(connectorId)?.transactionId
 501       logger.debug(
 502         `${this.logPrefix(connectorId)} stopping a not started transaction${
 503           transactionId != null ? ` with id ${transactionId}` : ''
 504         }`
 505       )
 506     }
 507     PerformanceStatistics.endMeasure(measureId, beginId)
 508     return stopResponse
 509   }
 510
 511   private getRequireAuthorize (): boolean {
 512     return (
 513       this.chargingStation.getAutomaticTransactionGeneratorConfiguration()?.requireAuthorize ?? true
 514     )
 515   }
 516
 517   private readonly logPrefix = (connectorId?: number): string => {
 518     return logPrefix(
 519       ` ${this.chargingStation.stationInfo?.chargingStationId} | ATG${
 520         connectorId != null ? ` on connector #${connectorId}` : ''
 521       }:`
 522     )
 523   }
 524
 525   private handleStartTransactionResponse (
 526     connectorId: number,
 527     startResponse: StartTransactionResponse
 528   ): void {
 529     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 530     ++this.connectorsStatus.get(connectorId)!.startTransactionRequests
 531     if (startResponse.idTagInfo.status === AuthorizationStatus.ACCEPTED) {
 532       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 533       ++this.connectorsStatus.get(connectorId)!.acceptedStartTransactionRequests
 534     } else {
 535       logger.warn(`${this.logPrefix(connectorId)} start transaction rejected`)
 536       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 537       ++this.connectorsStatus.get(connectorId)!.rejectedStartTransactionRequests
 538     }
 539   }
 540 }