src/charging-station/AutomaticTransactionGenerator.ts

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