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(
 234               connectorId,
 235             )} transaction started with id ${this.chargingStation.getConnectorStatus(connectorId)
 236               ?.transactionId} and will stop in ${formatDurationMilliSeconds(waitTrxEnd)}`,
 237           );
 238           await sleep(waitTrxEnd);
 239           await this.stopTransaction(connectorId);
 240         }
 241       } else {
 242         ++this.connectorsStatus.get(connectorId)!.skippedConsecutiveTransactions!;
 243         ++this.connectorsStatus.get(connectorId)!.skippedTransactions!;
 244         logger.info(
 245           `${this.logPrefix(connectorId)} skipped consecutively ${this.connectorsStatus.get(
 246             connectorId,
 247           )?.skippedConsecutiveTransactions}/${this.connectorsStatus.get(connectorId)
 248             ?.skippedTransactions} transaction(s)`,
 249         );
 250       }
 251       this.connectorsStatus.get(connectorId)!.lastRunDate = new Date();
 252     }
 253     this.connectorsStatus.get(connectorId)!.stoppedDate = new Date();
 254     logger.info(
 255       `${this.logPrefix(
 256         connectorId,
 257       )} stopped on connector and lasted for ${formatDurationMilliSeconds(
 258         this.connectorsStatus.get(connectorId)!.stoppedDate!.getTime() -
 259           this.connectorsStatus.get(connectorId)!.startDate!.getTime(),
 260       )}`,
 261     );
 262     logger.debug(
 263       `${this.logPrefix(connectorId)} connector status: %j`,
 264       this.connectorsStatus.get(connectorId),
 265     );
 266   }
 267
 268   private setStartConnectorStatus(connectorId: number): void {
 269     this.connectorsStatus.get(connectorId)!.skippedConsecutiveTransactions = 0;
 270     const previousRunDuration =
 271       this.connectorsStatus.get(connectorId)?.startDate &&
 272       this.connectorsStatus.get(connectorId)?.lastRunDate
 273         ? this.connectorsStatus.get(connectorId)!.lastRunDate!.getTime() -
 274           this.connectorsStatus.get(connectorId)!.startDate!.getTime()
 275         : 0;
 276     this.connectorsStatus.get(connectorId)!.startDate = new Date();
 277     this.connectorsStatus.get(connectorId)!.stopDate = new Date(
 278       this.connectorsStatus.get(connectorId)!.startDate!.getTime() +
 279         hoursToMilliseconds(
 280           this.chargingStation.getAutomaticTransactionGeneratorConfiguration().stopAfterHours,
 281         ) -
 282         previousRunDuration,
 283     );
 284     this.connectorsStatus.get(connectorId)!.start = true;
 285   }
 286
 287   private canStartConnector(connectorId: number): boolean {
 288     if (new Date() > this.connectorsStatus.get(connectorId)!.stopDate!) {
 289       return false;
 290     }
 291     if (this.chargingStation.inAcceptedState() === false) {
 292       logger.error(
 293         `${this.logPrefix(
 294           connectorId,
 295         )} entered in transaction loop while the charging station is not in accepted state`,
 296       );
 297       return false;
 298     }
 299     if (this.chargingStation.isChargingStationAvailable() === false) {
 300       logger.info(
 301         `${this.logPrefix(
 302           connectorId,
 303         )} entered in transaction loop while the charging station is unavailable`,
 304       );
 305       return false;
 306     }
 307     if (this.chargingStation.isConnectorAvailable(connectorId) === false) {
 308       logger.info(
 309         `${this.logPrefix(
 310           connectorId,
 311         )} entered in transaction loop while the connector ${connectorId} is unavailable`,
 312       );
 313       return false;
 314     }
 315     if (
 316       this.chargingStation.getConnectorStatus(connectorId)?.status ===
 317       ConnectorStatusEnum.Unavailable
 318     ) {
 319       logger.info(
 320         `${this.logPrefix(
 321           connectorId,
 322         )} entered in transaction loop while the connector ${connectorId} status is unavailable`,
 323       );
 324       return false;
 325     }
 326     return true;
 327   }
 328
 329   private initializeConnectorsStatus(): void {
 330     if (this.chargingStation.hasEvses) {
 331       for (const [evseId, evseStatus] of this.chargingStation.evses) {
 332         if (evseId > 0) {
 333           for (const connectorId of evseStatus.connectors.keys()) {
 334             this.connectorsStatus.set(connectorId, this.getConnectorStatus(connectorId));
 335           }
 336         }
 337       }
 338     } else {
 339       for (const connectorId of this.chargingStation.connectors.keys()) {
 340         if (connectorId > 0) {
 341           this.connectorsStatus.set(connectorId, this.getConnectorStatus(connectorId));
 342         }
 343       }
 344     }
 345   }
 346
 347   private getConnectorStatus(connectorId: number): Status {
 348     const connectorStatus = this.chargingStation.getAutomaticTransactionGeneratorStatuses()?.[
 349       connectorId
 350     ]
 351       ? cloneObject<Status>(
 352           this.chargingStation.getAutomaticTransactionGeneratorStatuses()![connectorId],
 353         )
 354       : undefined;
 355     this.resetConnectorStatus(connectorStatus);
 356     return (
 357       connectorStatus ?? {
 358         start: false,
 359         authorizeRequests: 0,
 360         acceptedAuthorizeRequests: 0,
 361         rejectedAuthorizeRequests: 0,
 362         startTransactionRequests: 0,
 363         acceptedStartTransactionRequests: 0,
 364         rejectedStartTransactionRequests: 0,
 365         stopTransactionRequests: 0,
 366         acceptedStopTransactionRequests: 0,
 367         rejectedStopTransactionRequests: 0,
 368         skippedConsecutiveTransactions: 0,
 369         skippedTransactions: 0,
 370       }
 371     );
 372   }
 373
 374   private resetConnectorStatus(connectorStatus: Status | undefined): void {
 375     delete connectorStatus?.startDate;
 376     delete connectorStatus?.lastRunDate;
 377     delete connectorStatus?.stopDate;
 378     delete connectorStatus?.stoppedDate;
 379     if (
 380       !this.started &&
 381       (connectorStatus?.start === true ||
 382         this.chargingStation.getAutomaticTransactionGeneratorConfiguration().enable === false)
 383     ) {
 384       connectorStatus!.start = false;
 385     }
 386   }
 387
 388   private async startTransaction(
 389     connectorId: number,
 390   ): Promise<StartTransactionResponse | undefined> {
 391     const measureId = 'StartTransaction with ATG';
 392     const beginId = PerformanceStatistics.beginMeasure(measureId);
 393     let startResponse: StartTransactionResponse | undefined;
 394     if (this.chargingStation.hasIdTags()) {
 395       const idTag = IdTagsCache.getInstance().getIdTag(
 396         this.chargingStation.getAutomaticTransactionGeneratorConfiguration().idTagDistribution!,
 397         this.chargingStation,
 398         connectorId,
 399       );
 400       const startTransactionLogMsg = `${this.logPrefix(
 401         connectorId,
 402       )} start transaction with an idTag '${idTag}'`;
 403       if (this.getRequireAuthorize()) {
 404         ++this.connectorsStatus.get(connectorId)!.authorizeRequests!;
 405         if (await OCPPServiceUtils.isIdTagAuthorized(this.chargingStation, connectorId, idTag)) {
 406           ++this.connectorsStatus.get(connectorId)!.acceptedAuthorizeRequests!;
 407           logger.info(startTransactionLogMsg);
 408           // Start transaction
 409           startResponse = await this.chargingStation.ocppRequestService.requestHandler<
 410             StartTransactionRequest,
 411             StartTransactionResponse
 412           >(this.chargingStation, RequestCommand.START_TRANSACTION, {
 413             connectorId,
 414             idTag,
 415           });
 416           this.handleStartTransactionResponse(connectorId, startResponse);
 417           PerformanceStatistics.endMeasure(measureId, beginId);
 418           return startResponse;
 419         }
 420         ++this.connectorsStatus.get(connectorId)!.rejectedAuthorizeRequests!;
 421         PerformanceStatistics.endMeasure(measureId, beginId);
 422         return startResponse;
 423       }
 424       logger.info(startTransactionLogMsg);
 425       // Start transaction
 426       startResponse = await this.chargingStation.ocppRequestService.requestHandler<
 427         StartTransactionRequest,
 428         StartTransactionResponse
 429       >(this.chargingStation, RequestCommand.START_TRANSACTION, {
 430         connectorId,
 431         idTag,
 432       });
 433       this.handleStartTransactionResponse(connectorId, startResponse);
 434       PerformanceStatistics.endMeasure(measureId, beginId);
 435       return startResponse;
 436     }
 437     logger.info(`${this.logPrefix(connectorId)} start transaction without an idTag`);
 438     startResponse = await this.chargingStation.ocppRequestService.requestHandler<
 439       StartTransactionRequest,
 440       StartTransactionResponse
 441     >(this.chargingStation, RequestCommand.START_TRANSACTION, { connectorId });
 442     this.handleStartTransactionResponse(connectorId, startResponse);
 443     PerformanceStatistics.endMeasure(measureId, beginId);
 444     return startResponse;
 445   }
 446
 447   private async stopTransaction(
 448     connectorId: number,
 449     reason = StopTransactionReason.LOCAL,
 450   ): Promise<StopTransactionResponse | undefined> {
 451     const measureId = 'StopTransaction with ATG';
 452     const beginId = PerformanceStatistics.beginMeasure(measureId);
 453     let stopResponse: StopTransactionResponse | undefined;
 454     if (this.chargingStation.getConnectorStatus(connectorId)?.transactionStarted === true) {
 455       logger.info(
 456         `${this.logPrefix(
 457           connectorId,
 458         )} stop transaction with id ${this.chargingStation.getConnectorStatus(connectorId)
 459           ?.transactionId}`,
 460       );
 461       stopResponse = await this.chargingStation.stopTransactionOnConnector(connectorId, reason);
 462       ++this.connectorsStatus.get(connectorId)!.stopTransactionRequests!;
 463       if (stopResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
 464         ++this.connectorsStatus.get(connectorId)!.acceptedStopTransactionRequests!;
 465       } else {
 466         ++this.connectorsStatus.get(connectorId)!.rejectedStopTransactionRequests!;
 467       }
 468     } else {
 469       const transactionId = this.chargingStation.getConnectorStatus(connectorId)?.transactionId;
 470       logger.debug(
 471         `${this.logPrefix(connectorId)} stopping a not started transaction${
 472           !isNullOrUndefined(transactionId) ? ` with id ${transactionId}` : ''
 473         }`,
 474       );
 475     }
 476     PerformanceStatistics.endMeasure(measureId, beginId);
 477     return stopResponse;
 478   }
 479
 480   private getRequireAuthorize(): boolean {
 481     return (
 482       this.chargingStation.getAutomaticTransactionGeneratorConfiguration()?.requireAuthorize ?? true
 483     );
 484   }
 485
 486   private logPrefix = (connectorId?: number): string => {
 487     return logPrefix(
 488       ` ${this.chargingStation.stationInfo.chargingStationId} | ATG${
 489         !isNullOrUndefined(connectorId) ? ` on connector #${connectorId}` : ''
 490       }:`,
 491     );
 492   };
 493
 494   private handleStartTransactionResponse(
 495     connectorId: number,
 496     startResponse: StartTransactionResponse,
 497   ): void {
 498     ++this.connectorsStatus.get(connectorId)!.startTransactionRequests!;
 499     if (startResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
 500       ++this.connectorsStatus.get(connectorId)!.acceptedStartTransactionRequests!;
 501     } else {
 502       logger.warn(`${this.logPrefix(connectorId)} start transaction rejected`);
 503       ++this.connectorsStatus.get(connectorId)!.rejectedStartTransactionRequests!;
 504     }
 505   }
 506 }