refactor: split Utils static methods class into functions
[e-mobility-charging-stations-simulator.git] / src / charging-station / AutomaticTransactionGenerator.ts
index 26b3a2a22357c6d6ae5afce2db6ae3ae347a9608..233f2519dcb4c8b120fe20d74293505af9c38761 100644 (file)
@@ -2,16 +2,16 @@
 
 import { AsyncResource } from 'node:async_hooks';
 
-import { type ChargingStation, ChargingStationUtils } from './internal';
+import type { ChargingStation } from './ChargingStation';
+import { ChargingStationUtils } from './ChargingStationUtils';
+import { IdTagsCache } from './IdTagsCache';
 import { BaseError } from '../exception';
-// import { PerformanceStatistics } from '../performance';
-import { PerformanceStatistics } from '../performance/PerformanceStatistics';
+import { PerformanceStatistics } from '../performance';
 import {
   AuthorizationStatus,
   type AuthorizeRequest,
   type AuthorizeResponse,
-  type AutomaticTransactionGeneratorConfiguration,
-  IdTagDistribution,
+  ConnectorStatusEnum,
   RequestCommand,
   type StartTransactionRequest,
   type StartTransactionResponse,
@@ -19,7 +19,17 @@ import {
   StopTransactionReason,
   type StopTransactionResponse,
 } from '../types';
-import { Constants, Utils, logger } from '../utils';
+import {
+  Constants,
+  cloneObject,
+  formatDurationMilliSeconds,
+  getRandomInteger,
+  isNullOrUndefined,
+  logPrefix,
+  logger,
+  secureRandom,
+  sleep,
+} from '../utils';
 
 const moduleName = 'AutomaticTransactionGenerator';
 
@@ -30,50 +40,51 @@ export class AutomaticTransactionGenerator extends AsyncResource {
   >();
 
   public readonly connectorsStatus: Map<number, Status>;
-  public readonly configuration: AutomaticTransactionGeneratorConfiguration;
   public started: boolean;
+  private starting: boolean;
+  private stopping: boolean;
   private readonly chargingStation: ChargingStation;
-  private idTagIndex: number;
 
-  private constructor(
-    automaticTransactionGeneratorConfiguration: AutomaticTransactionGeneratorConfiguration,
-    chargingStation: ChargingStation
-  ) {
+  private constructor(chargingStation: ChargingStation) {
     super(moduleName);
     this.started = false;
-    this.configuration = automaticTransactionGeneratorConfiguration;
+    this.starting = false;
+    this.stopping = false;
     this.chargingStation = chargingStation;
-    this.idTagIndex = 0;
     this.connectorsStatus = new Map<number, Status>();
     this.initializeConnectorsStatus();
   }
 
   public static getInstance(
-    automaticTransactionGeneratorConfiguration: AutomaticTransactionGeneratorConfiguration,
     chargingStation: ChargingStation
   ): AutomaticTransactionGenerator | undefined {
     if (AutomaticTransactionGenerator.instances.has(chargingStation.stationInfo.hashId) === false) {
       AutomaticTransactionGenerator.instances.set(
         chargingStation.stationInfo.hashId,
-        new AutomaticTransactionGenerator(
-          automaticTransactionGeneratorConfiguration,
-          chargingStation
-        )
+        new AutomaticTransactionGenerator(chargingStation)
       );
     }
     return AutomaticTransactionGenerator.instances.get(chargingStation.stationInfo.hashId);
   }
 
   public start(): void {
-    if (this.checkChargingStation() === false) {
+    if (
+      ChargingStationUtils.checkChargingStation(this.chargingStation, this.logPrefix()) === false
+    ) {
       return;
     }
     if (this.started === true) {
       logger.warn(`${this.logPrefix()} is already started`);
       return;
     }
+    if (this.starting === true) {
+      logger.warn(`${this.logPrefix()} is already starting`);
+      return;
+    }
+    this.starting = true;
     this.startConnectors();
     this.started = true;
+    this.starting = false;
   }
 
   public stop(): void {
@@ -81,12 +92,23 @@ export class AutomaticTransactionGenerator extends AsyncResource {
       logger.warn(`${this.logPrefix()} is already stopped`);
       return;
     }
+    if (this.stopping === true) {
+      logger.warn(`${this.logPrefix()} is already stopping`);
+      return;
+    }
+    this.stopping = true;
     this.stopConnectors();
     this.started = false;
+    this.stopping = false;
   }
 
   public startConnector(connectorId: number): void {
-    if (this.checkChargingStation(connectorId) === false) {
+    if (
+      ChargingStationUtils.checkChargingStation(
+        this.chargingStation,
+        this.logPrefix(connectorId)
+      ) === false
+    ) {
       return;
     }
     if (this.connectorsStatus.has(connectorId) === false) {
@@ -101,9 +123,7 @@ export class AutomaticTransactionGenerator extends AsyncResource {
         ) => Promise<void>,
         this,
         connectorId
-      ).catch(() => {
-        /* This is intentional */
-      });
+      ).catch(Constants.EMPTY_FUNCTION);
     } else if (this.connectorsStatus.get(connectorId)?.start === true) {
       logger.warn(`${this.logPrefix(connectorId)} is already started on connector`);
     }
@@ -129,17 +149,37 @@ export class AutomaticTransactionGenerator extends AsyncResource {
       this.connectorsStatus.clear();
       this.initializeConnectorsStatus();
     }
-    for (const connectorId of this.chargingStation.connectors.keys()) {
-      if (connectorId > 0) {
-        this.startConnector(connectorId);
+    if (this.chargingStation.hasEvses) {
+      for (const [evseId, evseStatus] of this.chargingStation.evses) {
+        if (evseId > 0) {
+          for (const connectorId of evseStatus.connectors.keys()) {
+            this.startConnector(connectorId);
+          }
+        }
+      }
+    } else {
+      for (const connectorId of this.chargingStation.connectors.keys()) {
+        if (connectorId > 0) {
+          this.startConnector(connectorId);
+        }
       }
     }
   }
 
   private stopConnectors(): void {
-    for (const connectorId of this.chargingStation.connectors.keys()) {
-      if (connectorId > 0) {
-        this.stopConnector(connectorId);
+    if (this.chargingStation.hasEvses) {
+      for (const [evseId, evseStatus] of this.chargingStation.evses) {
+        if (evseId > 0) {
+          for (const connectorId of evseStatus.connectors.keys()) {
+            this.stopConnector(connectorId);
+          }
+        }
+      }
+    } else {
+      for (const connectorId of this.chargingStation.connectors.keys()) {
+        if (connectorId > 0) {
+          this.stopConnector(connectorId);
+        }
       }
     }
   }
@@ -149,7 +189,7 @@ export class AutomaticTransactionGenerator extends AsyncResource {
     logger.info(
       `${this.logPrefix(
         connectorId
-      )} started on connector and will run for ${Utils.formatDurationMilliSeconds(
+      )} started on connector and will run for ${formatDurationMilliSeconds(
         this.connectorsStatus.get(connectorId).stopDate.getTime() -
           this.connectorsStatus.get(connectorId).startDate.getTime()
       )}`
@@ -159,7 +199,7 @@ export class AutomaticTransactionGenerator extends AsyncResource {
         this.stopConnector(connectorId);
         break;
       }
-      if (this.chargingStation.isInAcceptedState() === false) {
+      if (this.chargingStation.inAcceptedState() === false) {
         logger.error(
           `${this.logPrefix(
             connectorId
@@ -186,6 +226,18 @@ export class AutomaticTransactionGenerator extends AsyncResource {
         this.stopConnector(connectorId);
         break;
       }
+      if (
+        this.chargingStation.getConnectorStatus(connectorId)?.status ===
+        ConnectorStatusEnum.Unavailable
+      ) {
+        logger.info(
+          `${this.logPrefix(
+            connectorId
+          )} entered in transaction loop while the connector ${connectorId} status is unavailable`
+        );
+        this.stopConnector(connectorId);
+        break;
+      }
       if (!this.chargingStation?.ocppRequestService) {
         logger.info(
           `${this.logPrefix(
@@ -193,47 +245,52 @@ export class AutomaticTransactionGenerator extends AsyncResource {
           )} transaction loop waiting for charging station service to be initialized`
         );
         do {
-          await Utils.sleep(Constants.CHARGING_STATION_ATG_INITIALIZATION_TIME);
+          await sleep(Constants.CHARGING_STATION_ATG_INITIALIZATION_TIME);
         } while (!this.chargingStation?.ocppRequestService);
       }
       const wait =
-        Utils.getRandomInteger(
-          this.configuration.maxDelayBetweenTwoTransactions,
-          this.configuration.minDelayBetweenTwoTransactions
+        getRandomInteger(
+          this.chargingStation.getAutomaticTransactionGeneratorConfiguration()
+            .maxDelayBetweenTwoTransactions,
+          this.chargingStation.getAutomaticTransactionGeneratorConfiguration()
+            .minDelayBetweenTwoTransactions
         ) * 1000;
-      logger.info(
-        `${this.logPrefix(connectorId)} waiting for ${Utils.formatDurationMilliSeconds(wait)}`
-      );
-      await Utils.sleep(wait);
-      const start = Utils.secureRandom();
-      if (start < this.configuration.probabilityOfStart) {
+      logger.info(`${this.logPrefix(connectorId)} waiting for ${formatDurationMilliSeconds(wait)}`);
+      await sleep(wait);
+      const start = secureRandom();
+      if (
+        start <
+        this.chargingStation.getAutomaticTransactionGeneratorConfiguration().probabilityOfStart
+      ) {
         this.connectorsStatus.get(connectorId).skippedConsecutiveTransactions = 0;
         // Start transaction
         const startResponse = await this.startTransaction(connectorId);
         if (startResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
           // Wait until end of transaction
           const waitTrxEnd =
-            Utils.getRandomInteger(this.configuration.maxDuration, this.configuration.minDuration) *
-            1000;
+            getRandomInteger(
+              this.chargingStation.getAutomaticTransactionGeneratorConfiguration().maxDuration,
+              this.chargingStation.getAutomaticTransactionGeneratorConfiguration().minDuration
+            ) * 1000;
           logger.info(
-            `${this.logPrefix(connectorId)} transaction ${this.chargingStation
+            `${this.logPrefix(connectorId)} transaction started with id ${this.chargingStation
               .getConnectorStatus(connectorId)
-              ?.transactionId?.toString()} started and will stop in ${Utils.formatDurationMilliSeconds(
+              ?.transactionId?.toString()} and will stop in ${formatDurationMilliSeconds(
               waitTrxEnd
             )}`
           );
-          await Utils.sleep(waitTrxEnd);
+          await sleep(waitTrxEnd);
           // Stop transaction
           logger.info(
-            `${this.logPrefix(connectorId)} stop transaction ${this.chargingStation
+            `${this.logPrefix(connectorId)} stop transaction with id ${this.chargingStation
               .getConnectorStatus(connectorId)
               ?.transactionId?.toString()}`
           );
           await this.stopTransaction(connectorId);
         }
       } else {
-        this.connectorsStatus.get(connectorId).skippedConsecutiveTransactions++;
-        this.connectorsStatus.get(connectorId).skippedTransactions++;
+        ++this.connectorsStatus.get(connectorId).skippedConsecutiveTransactions;
+        ++this.connectorsStatus.get(connectorId).skippedTransactions;
         logger.info(
           `${this.logPrefix(connectorId)} skipped consecutively ${this.connectorsStatus
             .get(connectorId)
@@ -248,7 +305,7 @@ export class AutomaticTransactionGenerator extends AsyncResource {
     logger.info(
       `${this.logPrefix(
         connectorId
-      )} stopped on connector and lasted for ${Utils.formatDurationMilliSeconds(
+      )} stopped on connector and lasted for ${formatDurationMilliSeconds(
         this.connectorsStatus.get(connectorId).stoppedDate.getTime() -
           this.connectorsStatus.get(connectorId).startDate.getTime()
       )}`
@@ -270,8 +327,7 @@ export class AutomaticTransactionGenerator extends AsyncResource {
     this.connectorsStatus.get(connectorId).startDate = new Date();
     this.connectorsStatus.get(connectorId).stopDate = new Date(
       this.connectorsStatus.get(connectorId).startDate.getTime() +
-        (this.configuration.stopAfterHours ??
-          Constants.CHARGING_STATION_ATG_DEFAULT_STOP_AFTER_HOURS) *
+        this.chargingStation.getAutomaticTransactionGeneratorConfiguration().stopAfterHours *
           3600 *
           1000 -
         previousRunDuration
@@ -280,34 +336,61 @@ export class AutomaticTransactionGenerator extends AsyncResource {
   }
 
   private initializeConnectorsStatus(): void {
-    for (const connectorId of this.chargingStation.connectors.keys()) {
-      if (connectorId > 0) {
-        this.connectorsStatus.set(connectorId, {
-          start: false,
-          authorizeRequests: 0,
-          acceptedAuthorizeRequests: 0,
-          rejectedAuthorizeRequests: 0,
-          startTransactionRequests: 0,
-          acceptedStartTransactionRequests: 0,
-          rejectedStartTransactionRequests: 0,
-          stopTransactionRequests: 0,
-          acceptedStopTransactionRequests: 0,
-          rejectedStopTransactionRequests: 0,
-          skippedConsecutiveTransactions: 0,
-          skippedTransactions: 0,
-        });
+    if (this.chargingStation.hasEvses) {
+      for (const [evseId, evseStatus] of this.chargingStation.evses) {
+        if (evseId > 0) {
+          for (const connectorId of evseStatus.connectors.keys()) {
+            this.connectorsStatus.set(connectorId, this.getConnectorStatus(connectorId));
+          }
+        }
+      }
+    } else {
+      for (const connectorId of this.chargingStation.connectors.keys()) {
+        if (connectorId > 0) {
+          this.connectorsStatus.set(connectorId, this.getConnectorStatus(connectorId));
+        }
       }
     }
   }
 
+  private getConnectorStatus(connectorId: number): Status {
+    const connectorStatus = cloneObject(
+      this.chargingStation.getAutomaticTransactionGeneratorStatuses()
+    )[connectorId];
+    delete connectorStatus?.startDate;
+    delete connectorStatus?.lastRunDate;
+    delete connectorStatus?.stopDate;
+    delete connectorStatus?.stoppedDate;
+    return (
+      connectorStatus ?? {
+        start: false,
+        authorizeRequests: 0,
+        acceptedAuthorizeRequests: 0,
+        rejectedAuthorizeRequests: 0,
+        startTransactionRequests: 0,
+        acceptedStartTransactionRequests: 0,
+        rejectedStartTransactionRequests: 0,
+        stopTransactionRequests: 0,
+        acceptedStopTransactionRequests: 0,
+        rejectedStopTransactionRequests: 0,
+        skippedConsecutiveTransactions: 0,
+        skippedTransactions: 0,
+      }
+    );
+  }
+
   private async startTransaction(
     connectorId: number
   ): Promise<StartTransactionResponse | undefined> {
     const measureId = 'StartTransaction with ATG';
     const beginId = PerformanceStatistics.beginMeasure(measureId);
     let startResponse: StartTransactionResponse;
-    if (this.chargingStation.hasAuthorizedTags()) {
-      const idTag = this.getIdTag(connectorId);
+    if (this.chargingStation.hasIdTags()) {
+      const idTag = IdTagsCache.getInstance().getIdTag(
+        this.chargingStation.getAutomaticTransactionGeneratorConfiguration()?.idTagDistribution,
+        this.chargingStation,
+        connectorId
+      );
       const startTransactionLogMsg = `${this.logPrefix(
         connectorId
       )} start transaction with an idTag '${idTag}'`;
@@ -321,9 +404,9 @@ export class AutomaticTransactionGenerator extends AsyncResource {
           >(this.chargingStation, RequestCommand.AUTHORIZE, {
             idTag,
           });
-        this.connectorsStatus.get(connectorId).authorizeRequests++;
+        ++this.connectorsStatus.get(connectorId).authorizeRequests;
         if (authorizeResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
-          this.connectorsStatus.get(connectorId).acceptedAuthorizeRequests++;
+          ++this.connectorsStatus.get(connectorId).acceptedAuthorizeRequests;
           logger.info(startTransactionLogMsg);
           // Start transaction
           startResponse = await this.chargingStation.ocppRequestService.requestHandler<
@@ -337,7 +420,7 @@ export class AutomaticTransactionGenerator extends AsyncResource {
           PerformanceStatistics.endMeasure(measureId, beginId);
           return startResponse;
         }
-        this.connectorsStatus.get(connectorId).rejectedAuthorizeRequests++;
+        ++this.connectorsStatus.get(connectorId).rejectedAuthorizeRequests;
         PerformanceStatistics.endMeasure(measureId, beginId);
         return startResponse;
       }
@@ -373,17 +456,17 @@ export class AutomaticTransactionGenerator extends AsyncResource {
     let stopResponse: StopTransactionResponse;
     if (this.chargingStation.getConnectorStatus(connectorId)?.transactionStarted === true) {
       stopResponse = await this.chargingStation.stopTransactionOnConnector(connectorId, reason);
-      this.connectorsStatus.get(connectorId).stopTransactionRequests++;
+      ++this.connectorsStatus.get(connectorId).stopTransactionRequests;
       if (stopResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
-        this.connectorsStatus.get(connectorId).acceptedStopTransactionRequests++;
+        ++this.connectorsStatus.get(connectorId).acceptedStopTransactionRequests;
       } else {
-        this.connectorsStatus.get(connectorId).rejectedStopTransactionRequests++;
+        ++this.connectorsStatus.get(connectorId).rejectedStopTransactionRequests;
       }
     } else {
       const transactionId = this.chargingStation.getConnectorStatus(connectorId)?.transactionId;
       logger.warn(
         `${this.logPrefix(connectorId)} stopping a not started transaction${
-          !Utils.isNullOrUndefined(transactionId) ? ` ${transactionId?.toString()}` : ''
+          !isNullOrUndefined(transactionId) ? ` with id ${transactionId?.toString()}` : ''
         }`
       );
     }
@@ -392,48 +475,15 @@ export class AutomaticTransactionGenerator extends AsyncResource {
   }
 
   private getRequireAuthorize(): boolean {
-    return this.configuration?.requireAuthorize ?? true;
-  }
-
-  private getRandomIdTag(authorizationFile: string): string {
-    const tags = this.chargingStation.authorizedTagsCache.getAuthorizedTags(authorizationFile);
-    this.idTagIndex = Math.floor(Utils.secureRandom() * tags.length);
-    return tags[this.idTagIndex];
-  }
-
-  private getRoundRobinIdTag(authorizationFile: string): string {
-    const tags = this.chargingStation.authorizedTagsCache.getAuthorizedTags(authorizationFile);
-    const idTag = tags[this.idTagIndex];
-    this.idTagIndex = this.idTagIndex === tags.length - 1 ? 0 : this.idTagIndex + 1;
-    return idTag;
-  }
-
-  private getConnectorAffinityIdTag(authorizationFile: string, connectorId: number): string {
-    const tags = this.chargingStation.authorizedTagsCache.getAuthorizedTags(authorizationFile);
-    this.idTagIndex = (this.chargingStation.index - 1 + (connectorId - 1)) % tags.length;
-    return tags[this.idTagIndex];
-  }
-
-  private getIdTag(connectorId: number): string {
-    const authorizationFile = ChargingStationUtils.getAuthorizationFile(
-      this.chargingStation.stationInfo
+    return (
+      this.chargingStation.getAutomaticTransactionGeneratorConfiguration()?.requireAuthorize ?? true
     );
-    switch (this.configuration?.idTagDistribution) {
-      case IdTagDistribution.RANDOM:
-        return this.getRandomIdTag(authorizationFile);
-      case IdTagDistribution.ROUND_ROBIN:
-        return this.getRoundRobinIdTag(authorizationFile);
-      case IdTagDistribution.CONNECTOR_AFFINITY:
-        return this.getConnectorAffinityIdTag(authorizationFile, connectorId);
-      default:
-        return this.getRoundRobinIdTag(authorizationFile);
-    }
   }
 
   private logPrefix = (connectorId?: number): string => {
-    return Utils.logPrefix(
+    return logPrefix(
       ` ${this.chargingStation.stationInfo.chargingStationId} | ATG${
-        connectorId !== undefined ? ` on connector #${connectorId.toString()}` : ''
+        !isNullOrUndefined(connectorId) ? ` on connector #${connectorId.toString()}` : ''
       }:`
     );
   };
@@ -442,20 +492,12 @@ export class AutomaticTransactionGenerator extends AsyncResource {
     connectorId: number,
     startResponse: StartTransactionResponse
   ): void {
-    this.connectorsStatus.get(connectorId).startTransactionRequests++;
+    ++this.connectorsStatus.get(connectorId).startTransactionRequests;
     if (startResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
-      this.connectorsStatus.get(connectorId).acceptedStartTransactionRequests++;
+      ++this.connectorsStatus.get(connectorId).acceptedStartTransactionRequests;
     } else {
       logger.warn(`${this.logPrefix(connectorId)} start transaction rejected`);
-      this.connectorsStatus.get(connectorId).rejectedStartTransactionRequests++;
-    }
-  }
-
-  private checkChargingStation(connectorId?: number): boolean {
-    if (this.chargingStation.started === false && this.chargingStation.starting === false) {
-      logger.warn(`${this.logPrefix(connectorId)} charging station is stopped, cannot proceed`);
-      return false;
+      ++this.connectorsStatus.get(connectorId).rejectedStartTransactionRequests;
     }
-    return true;
   }
 }