Keep track of ATG running time
[e-mobility-charging-stations-simulator.git] / src / charging-station / AutomaticTransactionGenerator.ts
index f8183b8b41470a9135609b5cc08f23d63486be1d..6f77199ab850aaeaa991668d182d63001b799e26 100644 (file)
@@ -1,13 +1,18 @@
+// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
+
 import { AuthorizationStatus, AuthorizeResponse, StartTransactionResponse, StopTransactionReason, StopTransactionResponse } from '../types/ocpp/Transaction';
 
 import ChargingStation from './ChargingStation';
 import Constants from '../utils/Constants';
-import PerformanceStatistics from '../utils/PerformanceStatistics';
+import PerformanceStatistics from '../performance/PerformanceStatistics';
 import Utils from '../utils/Utils';
 import logger from '../utils/Logger';
 
 export default class AutomaticTransactionGenerator {
   public timeToStop: boolean;
+  private startDate!: Date;
+  private stopDate!: Date;
+  private runningDuration!: number;
   private chargingStation: ChargingStation;
 
   constructor(chargingStation: ChargingStation) {
@@ -15,29 +20,29 @@ export default class AutomaticTransactionGenerator {
     this.timeToStop = true;
   }
 
-  public async start(): Promise<void> {
+  public start(): void {
+    this.startDate = new Date();
+    this.stopDate = new Date(this.startDate.getTime()
+      + (this.chargingStation.stationInfo?.AutomaticTransactionGenerator?.stopAfterHours ?? Constants.CHARGING_STATION_ATG_DEFAULT_STOP_AFTER_HOURS) * 3600 * 1000
+      - (this.runningDuration ?? 0));
     this.timeToStop = false;
-    if (this.chargingStation.stationInfo.AutomaticTransactionGenerator.stopAfterHours &&
-      this.chargingStation.stationInfo.AutomaticTransactionGenerator.stopAfterHours > 0) {
-      // eslint-disable-next-line @typescript-eslint/no-misused-promises
-      setTimeout(async (): Promise<void> => {
-        await this.stop();
-      }, this.chargingStation.stationInfo.AutomaticTransactionGenerator.stopAfterHours * 3600 * 1000);
-    }
     for (const connector in this.chargingStation.connectors) {
       if (Utils.convertToInt(connector) > 0) {
-        await this.startConnector(Utils.convertToInt(connector));
+        // Avoid hogging the event loop with a busy loop
+        setImmediate(() => {
+          this.startOnConnector(Utils.convertToInt(connector)).catch(() => { /* This is intentional */ });
+        });
       }
     }
-    logger.info(this.logPrefix() + ' ATG started and will stop in ' + Utils.secondsToHHMMSS(this.chargingStation.stationInfo.AutomaticTransactionGenerator.stopAfterHours * 3600));
+    logger.info(this.logPrefix() + ' started and will run for ' + Utils.formatDurationMilliSeconds(this.stopDate.getTime() - this.startDate.getTime()));
   }
 
   public async stop(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> {
-    logger.info(this.logPrefix() + ' ATG OVER => STOPPING ALL TRANSACTIONS');
+    logger.info(`${this.logPrefix()} over and lasted for ${Utils.formatDurationMilliSeconds(this.runningDuration ?? 0)}. Stopping all transactions`);
     for (const connector in this.chargingStation.connectors) {
       const transactionId = this.chargingStation.getConnector(Utils.convertToInt(connector)).transactionId;
       if (this.chargingStation.getConnector(Utils.convertToInt(connector)).transactionStarted) {
-        logger.info(this.logPrefix(Utils.convertToInt(connector)) + ' ATG OVER. Stop transaction ' + transactionId.toString());
+        logger.info(this.logPrefix(Utils.convertToInt(connector)) + ' over. Stop transaction ' + transactionId.toString());
         await this.chargingStation.ocppRequestService.sendStopTransaction(transactionId, this.chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId),
           this.chargingStation.getTransactionIdTag(transactionId), reason);
       }
@@ -45,10 +50,13 @@ export default class AutomaticTransactionGenerator {
     this.timeToStop = true;
   }
 
-  private async startConnector(connectorId: number): Promise<void> {
-    do {
-      if (this.timeToStop) {
-        logger.error(this.logPrefix(connectorId) + ' Entered in transaction loop while a request to stop it was made');
+  private async startOnConnector(connectorId: number): Promise<void> {
+    logger.info(this.logPrefix(connectorId) + ' started on connector');
+    let transactionSkip = 0;
+    let totalTransactionSkip = 0;
+    while (!this.timeToStop) {
+      if ((new Date()) > this.stopDate) {
+        await this.stop();
         break;
       }
       if (!this.chargingStation.isRegistered()) {
@@ -72,19 +80,13 @@ export default class AutomaticTransactionGenerator {
       }
       const wait = Utils.getRandomInt(this.chargingStation.stationInfo.AutomaticTransactionGenerator.maxDelayBetweenTwoTransactions,
         this.chargingStation.stationInfo.AutomaticTransactionGenerator.minDelayBetweenTwoTransactions) * 1000;
-      logger.info(this.logPrefix(connectorId) + ' wait for ' + Utils.milliSecondsToHHMMSS(wait));
+      logger.info(this.logPrefix(connectorId) + ' waiting for ' + Utils.formatDurationMilliSeconds(wait));
       await Utils.sleep(wait);
-      const start = Math.random();
-      let skip = 0;
+      const start = Utils.secureRandom();
       if (start < this.chargingStation.stationInfo.AutomaticTransactionGenerator.probabilityOfStart) {
+        transactionSkip = 0;
         // Start transaction
-        let startATGTransaction: (connectorId: number, self: AutomaticTransactionGenerator) => Promise<StartTransactionResponse | AuthorizeResponse>;
-        if (this.chargingStation.getEnableStatistics()) {
-          startATGTransaction = PerformanceStatistics.timedFunction(this.startATGTransaction.bind(this));
-        } else {
-          startATGTransaction = this.startATGTransaction.bind(this);
-        }
-        const startResponse = await startATGTransaction(connectorId, this);
+        const startResponse = await this.startTransaction(connectorId);
         if (startResponse?.idTagInfo?.status !== AuthorizationStatus.ACCEPTED) {
           logger.warn(this.logPrefix(connectorId) + ' transaction rejected');
           await Utils.sleep(Constants.CHARGING_STATION_ATG_WAIT_TIME);
@@ -92,55 +94,63 @@ export default class AutomaticTransactionGenerator {
           // Wait until end of transaction
           const waitTrxEnd = Utils.getRandomInt(this.chargingStation.stationInfo.AutomaticTransactionGenerator.maxDuration,
             this.chargingStation.stationInfo.AutomaticTransactionGenerator.minDuration) * 1000;
-          logger.info(this.logPrefix(connectorId) + ' transaction ' + this.chargingStation.getConnector(connectorId).transactionId.toString() + ' will stop in ' + Utils.milliSecondsToHHMMSS(waitTrxEnd));
+          logger.info(this.logPrefix(connectorId) + ' transaction ' + this.chargingStation.getConnector(connectorId).transactionId.toString() + ' will stop in ' + Utils.formatDurationMilliSeconds(waitTrxEnd));
           await Utils.sleep(waitTrxEnd);
           // Stop transaction
           if (this.chargingStation.getConnector(connectorId)?.transactionStarted) {
             logger.info(this.logPrefix(connectorId) + ' stop transaction ' + this.chargingStation.getConnector(connectorId).transactionId.toString());
-            let stopATGTransaction: (connectorId: number, self: AutomaticTransactionGenerator) => Promise<StopTransactionResponse>;
-            if (this.chargingStation.getEnableStatistics()) {
-              stopATGTransaction = PerformanceStatistics.timedFunction(this.stopATGTransaction.bind(this));
-            } else {
-              stopATGTransaction = this.stopATGTransaction.bind(this);
-            }
-            await stopATGTransaction(connectorId, this);
+            await this.stopTransaction(connectorId);
           }
         }
       } else {
-        skip++;
-        logger.info(this.logPrefix(connectorId) + ' transaction skipped ' + skip.toString());
+        transactionSkip++;
+        totalTransactionSkip++;
+        logger.info(this.logPrefix(connectorId) + ' skipped transaction ' + transactionSkip.toString() + '/' + totalTransactionSkip.toString());
       }
-    } while (!this.timeToStop);
-    logger.info(this.logPrefix(connectorId) + ' ATG STOPPED on the connector');
+      this.runningDuration = (new Date()).getTime() - this.startDate.getTime();
+    }
+    logger.info(this.logPrefix(connectorId) + ' stopped on connector');
   }
 
-  // eslint-disable-next-line consistent-this
-  private async startATGTransaction(connectorId: number, self: AutomaticTransactionGenerator): Promise<StartTransactionResponse | AuthorizeResponse> {
-    if (self.chargingStation.hasAuthorizedTags()) {
-      const tagId = self.chargingStation.getRandomTagId();
-      if (self.chargingStation.getAutomaticTransactionGeneratorRequireAuthorize()) {
+  private async startTransaction(connectorId: number): Promise<StartTransactionResponse | AuthorizeResponse> {
+    const measureId = 'StartTransaction with ATG';
+    const beginId = PerformanceStatistics.beginMeasure(measureId);
+    let startResponse: StartTransactionResponse;
+    if (this.chargingStation.hasAuthorizedTags()) {
+      const tagId = this.chargingStation.getRandomTagId();
+      if (this.chargingStation.getAutomaticTransactionGeneratorRequireAuthorize()) {
         // Authorize tagId
-        const authorizeResponse = await self.chargingStation.ocppRequestService.sendAuthorize(connectorId, tagId);
+        const authorizeResponse = await this.chargingStation.ocppRequestService.sendAuthorize(connectorId, tagId);
         if (authorizeResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
-          logger.info(self.logPrefix(connectorId) + ' start transaction for tagID ' + tagId);
+          logger.info(this.logPrefix(connectorId) + ' start transaction for tagID ' + tagId);
           // Start transaction
-          return self.chargingStation.ocppRequestService.sendStartTransaction(connectorId, tagId);
+          startResponse = await this.chargingStation.ocppRequestService.sendStartTransaction(connectorId, tagId);
+          PerformanceStatistics.endMeasure(measureId, beginId);
+          return startResponse;
         }
+        PerformanceStatistics.endMeasure(measureId, beginId);
         return authorizeResponse;
       }
-      logger.info(self.logPrefix(connectorId) + ' start transaction for tagID ' + tagId);
+      logger.info(this.logPrefix(connectorId) + ' start transaction for tagID ' + tagId);
       // Start transaction
-      return self.chargingStation.ocppRequestService.sendStartTransaction(connectorId, tagId);
+      startResponse = await this.chargingStation.ocppRequestService.sendStartTransaction(connectorId, tagId);
+      PerformanceStatistics.endMeasure(measureId, beginId);
+      return startResponse;
     }
-    logger.info(self.logPrefix(connectorId) + ' start transaction without a tagID');
-    return self.chargingStation.ocppRequestService.sendStartTransaction(connectorId);
+    logger.info(this.logPrefix(connectorId) + ' start transaction without a tagID');
+    startResponse = await this.chargingStation.ocppRequestService.sendStartTransaction(connectorId);
+    PerformanceStatistics.endMeasure(measureId, beginId);
+    return startResponse;
   }
 
-  // eslint-disable-next-line consistent-this
-  private async stopATGTransaction(connectorId: number, self: AutomaticTransactionGenerator): Promise<StopTransactionResponse> {
-    const transactionId = self.chargingStation.getConnector(connectorId).transactionId;
-    return self.chargingStation.ocppRequestService.sendStopTransaction(transactionId, self.chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId),
-      self.chargingStation.getTransactionIdTag(transactionId));
+  private async stopTransaction(connectorId: number): Promise<StopTransactionResponse> {
+    const measureId = 'StopTransaction with ATG';
+    const beginId = PerformanceStatistics.beginMeasure(measureId);
+    const transactionId = this.chargingStation.getConnector(connectorId).transactionId;
+    const stopResponse = this.chargingStation.ocppRequestService.sendStopTransaction(transactionId,
+      this.chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId), this.chargingStation.getTransactionIdTag(transactionId));
+    PerformanceStatistics.endMeasure(measureId, beginId);
+    return stopResponse;
   }
 
   private logPrefix(connectorId?: number): string {