Ensure the ATG will stop on unavaible connector
[e-mobility-charging-stations-simulator.git] / src / charging-station / AutomaticTransactionGenerator.ts
index 6e9d263cc3c6c6b84eea4e45ef802d607a565a46..b32e794885326c6c768dbdf2857ba4d65a7e1693 100644 (file)
-import { PerformanceObserver, performance } from 'perf_hooks';
+// 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 '../performance/PerformanceStatistics';
 import Utils from '../utils/Utils';
 import logger from '../utils/Logger';
 
 export default class AutomaticTransactionGenerator {
-  private _chargingStation: ChargingStation;
-  private _timeToStop: boolean;
-  private _performanceObserver: PerformanceObserver;
+  public started: boolean;
+  private chargingStation: ChargingStation;
+  private connectorsStartStatus: Record<number, boolean>;
+  private startDate!: Date;
+  private lastRunDate!: Date;
+  private stopDate!: Date;
 
   constructor(chargingStation: ChargingStation) {
-    this._chargingStation = chargingStation;
-    this._timeToStop = true;
-    if (this._chargingStation.getEnableStatistics()) {
-      this._performanceObserver = new PerformanceObserver((list) => {
-        const entry = list.getEntries()[0];
-        this._chargingStation.statistics.logPerformance(entry, 'AutomaticTransactionGenerator');
-        this._performanceObserver.disconnect();
-      });
-    }
+    this.chargingStation = chargingStation;
+    this.connectorsStartStatus = {} as Record<number, boolean>;
+    this.stopConnectors();
+    this.started = false;
   }
 
-  get timeToStop(): boolean {
-    return this._timeToStop;
+  public start(): void {
+    if (this.started) {
+      logger.error(`${this.logPrefix()} trying to start while already started`);
+      return;
+    }
+    const previousRunDuration = (this?.startDate && this?.lastRunDate) ? (this.lastRunDate.getTime() - this.startDate.getTime()) : 0;
+    this.startDate = new Date();
+    this.lastRunDate = this.startDate;
+    this.stopDate = new Date(this.startDate.getTime()
+      + (this.chargingStation.stationInfo?.AutomaticTransactionGenerator?.stopAfterHours ?? Constants.CHARGING_STATION_ATG_DEFAULT_STOP_AFTER_HOURS) * 3600 * 1000
+      - previousRunDuration);
+    this.startConnectors();
+    this.started = true;
+    logger.info(this.logPrefix() + ' started and will run for ' + Utils.formatDurationMilliSeconds(this.stopDate.getTime() - this.startDate.getTime()));
   }
 
-  _logPrefix(connectorId: number = null): string {
-    if (connectorId) {
-      return Utils.logPrefix(' ' + this._chargingStation.stationInfo.name + ' ATG on connector #' + connectorId + ':');
+  public stop(): void {
+    if (!this.started) {
+      logger.error(`${this.logPrefix()} trying to stop while not started`);
+      return;
     }
-    return Utils.logPrefix(' ' + this._chargingStation.stationInfo.name + ' ATG:');
+    this.stopConnectors();
+    this.started = false;
+    logger.info(`${this.logPrefix()} over and lasted for ${Utils.formatDurationMilliSeconds(this.lastRunDate.getTime() - this.startDate.getTime())}. Stopping all transactions`);
   }
 
-  start(): void {
-    this._timeToStop = false;
-    if (this._chargingStation.stationInfo.AutomaticTransactionGenerator.stopAfterHours &&
-      this._chargingStation.stationInfo.AutomaticTransactionGenerator.stopAfterHours > 0) {
-      setTimeout(() => {
-        this.stop();
-      }, this._chargingStation.stationInfo.AutomaticTransactionGenerator.stopAfterHours * 3600 * 1000);
-    }
-    for (const connector in this._chargingStation.connectors) {
-      if (Utils.convertToInt(connector) > 0) {
-        this.startConnector(Utils.convertToInt(connector));
+  private startConnectors(): void {
+    for (const connector in this.chargingStation.connectors) {
+      const connectorId = Utils.convertToInt(connector);
+      if (connectorId > 0) {
+        // Avoid hogging the event loop with a busy loop
+        setImmediate(() => {
+          this.startConnector(connectorId).catch(() => { /* This is intentional */ });
+        });
       }
     }
-    logger.info(this._logPrefix() + ' ATG started and will stop in ' + Utils.secondstoHHMMSS(this._chargingStation.stationInfo.AutomaticTransactionGenerator.stopAfterHours * 3600));
   }
 
-  async stop(reason = ''): Promise<void> {
-    logger.info(this._logPrefix() + ' ATG OVER => STOPPING ALL TRANSACTIONS');
-    for (const connector in this._chargingStation.connectors) {
-      if (this._chargingStation.getConnector(Utils.convertToInt(connector)).transactionStarted) {
-        logger.info(this._logPrefix(Utils.convertToInt(connector)) + ' ATG OVER. Stop transaction ' + this._chargingStation.getConnector(Utils.convertToInt(connector)).transactionId);
-        await this._chargingStation.sendStopTransaction(this._chargingStation.getConnector(Utils.convertToInt(connector)).transactionId, reason);
+  private stopConnectors(): void {
+    for (const connector in this.chargingStation.connectors) {
+      const connectorId = Utils.convertToInt(connector);
+      if (connectorId > 0) {
+        this.stopConnector(connectorId);
       }
     }
-    this._timeToStop = true;
   }
 
-  async startConnector(connectorId: number): Promise<void> {
-    do {
-      const wait = Utils.getRandomInt(this._chargingStation.stationInfo.AutomaticTransactionGenerator.maxDelayBetweenTwoTransactions,
-        this._chargingStation.stationInfo.AutomaticTransactionGenerator.minDelayBetweenTwoTransactions) * 1000;
-      logger.info(this._logPrefix(connectorId) + ' wait for ' + Utils.secondstoHHMMSS(wait / 1000));
-      await Utils.sleep(wait);
-      if (this._timeToStop) {
-        logger.debug(this._logPrefix(connectorId) + ' Entered in transaction loop while a request to stop it was made');
+  private async startConnector(connectorId: number): Promise<void> {
+    logger.info(this.logPrefix(connectorId) + ' started on connector');
+    let skippedTransactions = 0;
+    let skippedTransactionsTotal = 0;
+    this.connectorsStartStatus[connectorId] = true;
+    while (this.connectorsStartStatus[connectorId]) {
+      if ((new Date()) > this.stopDate) {
+        this.stop();
+        break;
+      }
+      if (!this.chargingStation.isRegistered()) {
+        logger.error(this.logPrefix(connectorId) + ' Entered in transaction loop while the charging station is not registered');
+        break;
+      }
+      if (!this.chargingStation.isChargingStationAvailable()) {
+        logger.info(this.logPrefix(connectorId) + ' Entered in transaction loop while the charging station is unavailable');
+        this.stop();
+        break;
+      }
+      if (!this.chargingStation.isConnectorAvailable(connectorId)) {
+        logger.info(`${this.logPrefix(connectorId)} Entered in transaction loop while the connector ${connectorId} is unavailable, stop it`);
+        this.stopConnector(connectorId);
         break;
       }
-      const start = Math.random();
-      let skip = 0;
-      if (start < this._chargingStation.stationInfo.AutomaticTransactionGenerator.probabilityOfStart) {
-        skip = 0;
+      if (!this.chargingStation?.ocppRequestService) {
+        logger.info(`${this.logPrefix(connectorId)} Transaction loop waiting for charging station service to be initialized`);
+        do {
+          await Utils.sleep(Constants.CHARGING_STATION_ATG_INITIALIZATION_TIME);
+        } while (!this.chargingStation?.ocppRequestService);
+      }
+      const wait = Utils.getRandomInteger(this.chargingStation.stationInfo.AutomaticTransactionGenerator.maxDelayBetweenTwoTransactions,
+        this.chargingStation.stationInfo.AutomaticTransactionGenerator.minDelayBetweenTwoTransactions) * 1000;
+      logger.info(this.logPrefix(connectorId) + ' waiting for ' + Utils.formatDurationMilliSeconds(wait));
+      await Utils.sleep(wait);
+      const start = Utils.secureRandom();
+      if (start < this.chargingStation.stationInfo.AutomaticTransactionGenerator.probabilityOfStart) {
+        skippedTransactions = 0;
         // Start transaction
-        let startResponse;
-        if (this._chargingStation.getEnableStatistics()) {
-          const startTransaction = performance.timerify(this.startTransaction);
-          this._performanceObserver.observe({ entryTypes: ['function'] });
-          startResponse = await startTransaction(connectorId);
-        } else {
-          startResponse = await this.startTransaction(connectorId);
-        }
-        if (startResponse.idTagInfo.status !== 'Accepted') {
-          logger.info(this._logPrefix(connectorId) + ' transaction rejected');
+        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);
         } else {
           // 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 + ' will stop in ' + Utils.secondstoHHMMSS(waitTrxEnd / 1000));
+          const waitTrxEnd = Utils.getRandomInteger(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.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);
-            if (this._chargingStation.getEnableStatistics()) {
-              const stopTransaction = performance.timerify(this.stopTransaction);
-              this._performanceObserver.observe({ entryTypes: ['function'] });
-              await stopTransaction(connectorId);
-            } else {
-              await this.stopTransaction(connectorId);
-            }
-          }
+          logger.info(this.logPrefix(connectorId) + ' stop transaction ' + this.chargingStation.getConnector(connectorId).transactionId.toString());
+          await this.stopTransaction(connectorId);
         }
       } else {
-        skip++;
-        logger.info(this._logPrefix(connectorId) + ' transaction skipped ' + skip);
+        skippedTransactions++;
+        skippedTransactionsTotal++;
+        logger.info(this.logPrefix(connectorId) + ' skipped transaction ' + skippedTransactions.toString() + '/' + skippedTransactionsTotal.toString());
+      }
+      this.lastRunDate = new Date();
+    }
+    await this.stopTransaction(connectorId);
+    logger.info(this.logPrefix(connectorId) + ' stopped on connector');
+  }
+
+  private stopConnector(connectorId: number): void {
+    this.connectorsStartStatus[connectorId] = false;
+  }
+
+  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 idTag = this.chargingStation.getRandomIdTag();
+      if (this.chargingStation.getAutomaticTransactionGeneratorRequireAuthorize()) {
+        // Authorize idTag
+        const authorizeResponse = await this.chargingStation.ocppRequestService.sendAuthorize(connectorId, idTag);
+        if (authorizeResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
+          logger.info(this.logPrefix(connectorId) + ' start transaction for idTag ' + idTag);
+          // Start transaction
+          startResponse = await this.chargingStation.ocppRequestService.sendStartTransaction(connectorId, idTag);
+          PerformanceStatistics.endMeasure(measureId, beginId);
+          return startResponse;
+        }
+        PerformanceStatistics.endMeasure(measureId, beginId);
+        return authorizeResponse;
       }
-    } while (!this._timeToStop);
-    logger.info(this._logPrefix(connectorId) + ' ATG STOPPED on the connector');
+      logger.info(this.logPrefix(connectorId) + ' start transaction for idTag ' + idTag);
+      // Start transaction
+      startResponse = await this.chargingStation.ocppRequestService.sendStartTransaction(connectorId, idTag);
+      PerformanceStatistics.endMeasure(measureId, beginId);
+      return startResponse;
+    }
+    logger.info(this.logPrefix(connectorId) + ' start transaction without an idTag');
+    startResponse = await this.chargingStation.ocppRequestService.sendStartTransaction(connectorId);
+    PerformanceStatistics.endMeasure(measureId, beginId);
+    return startResponse;
   }
 
-  async startTransaction(connectorId: number): Promise<unknown> {
-    if (this._chargingStation.hasAuthorizedTags()) {
-      const tagId = this._chargingStation.getRandomTagId();
-      logger.info(this._logPrefix(connectorId) + ' start transaction for tagID ' + tagId);
-      return this._chargingStation.sendStartTransaction(connectorId, tagId);
+  private async stopTransaction(connectorId: number, reason: StopTransactionReason = StopTransactionReason.NONE): Promise<StopTransactionResponse> {
+    const measureId = 'StopTransaction with ATG';
+    const beginId = PerformanceStatistics.beginMeasure(measureId);
+    let transactionId = 0;
+    let stopResponse: StopTransactionResponse;
+    if (this.chargingStation.getConnector(connectorId)?.transactionStarted) {
+      transactionId = this.chargingStation.getConnector(connectorId).transactionId;
+      stopResponse = await this.chargingStation.ocppRequestService.sendStopTransaction(transactionId,
+        this.chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId),
+        this.chargingStation.getTransactionIdTag(transactionId),
+        reason);
+    } else {
+      logger.warn(`${this.logPrefix(connectorId)} trying to stop a not started transaction${transactionId ? ' ' + transactionId.toString() : ''}`);
     }
-    logger.info(this._logPrefix(connectorId) + ' start transaction without a tagID');
-    return this._chargingStation.sendStartTransaction(connectorId);
+    PerformanceStatistics.endMeasure(measureId, beginId);
+    return stopResponse;
   }
 
-  async stopTransaction(connectorId: number): Promise<void> {
-    await this._chargingStation.sendStopTransaction(this._chargingStation.getConnector(connectorId).transactionId);
+  private logPrefix(connectorId?: number): string {
+    if (connectorId) {
+      return Utils.logPrefix(' ' + this.chargingStation.stationInfo.chargingStationId + ' | ATG on connector #' + connectorId.toString() + ':');
+    }
+    return Utils.logPrefix(' ' + this.chargingStation.stationInfo.chargingStationId + ' | ATG:');
   }
 }