refactor: make ATG wait busy loop test first
[e-mobility-charging-stations-simulator.git] / src / charging-station / AutomaticTransactionGenerator.ts
index 3c2a2c38c80abf3b4eb7e32df83c453ec10bc8b0..3d1e8b1ccf2319dd694831d3792b337e60b7333d 100644 (file)
@@ -2,15 +2,16 @@
 
 import { AsyncResource } from 'node:async_hooks';
 
+import { hoursToMilliseconds, secondsToMilliseconds } from 'date-fns';
+
 import type { ChargingStation } from './ChargingStation';
-import { checkChargingStation } from './ChargingStationUtils';
+import { checkChargingStation } from './Helpers';
 import { IdTagsCache } from './IdTagsCache';
+import { OCPPServiceUtils } from './ocpp';
 import { BaseError } from '../exception';
 import { PerformanceStatistics } from '../performance';
 import {
   AuthorizationStatus,
-  type AuthorizeRequest,
-  type AuthorizeResponse,
   ConnectorStatusEnum,
   RequestCommand,
   type StartTransactionRequest,
@@ -56,12 +57,12 @@ export class AutomaticTransactionGenerator extends AsyncResource {
   }
 
   public static getInstance(
-    chargingStation: ChargingStation
+    chargingStation: ChargingStation,
   ): AutomaticTransactionGenerator | undefined {
     if (AutomaticTransactionGenerator.instances.has(chargingStation.stationInfo.hashId) === false) {
       AutomaticTransactionGenerator.instances.set(
         chargingStation.stationInfo.hashId,
-        new AutomaticTransactionGenerator(chargingStation)
+        new AutomaticTransactionGenerator(chargingStation),
       );
     }
     return AutomaticTransactionGenerator.instances.get(chargingStation.stationInfo.hashId);
@@ -112,10 +113,10 @@ export class AutomaticTransactionGenerator extends AsyncResource {
       this.runInAsyncScope(
         this.internalStartConnector.bind(this) as (
           this: AutomaticTransactionGenerator,
-          ...args: any[]
+          ...args: unknown[]
         ) => Promise<void>,
         this,
-        connectorId
+        connectorId,
       ).catch(Constants.EMPTY_FUNCTION);
     } else if (this.connectorsStatus.get(connectorId)?.start === true) {
       logger.warn(`${this.logPrefix(connectorId)} is already started on connector`);
@@ -128,7 +129,7 @@ export class AutomaticTransactionGenerator extends AsyncResource {
       throw new BaseError(`Connector ${connectorId} does not exist`);
     }
     if (this.connectorsStatus.get(connectorId)?.start === true) {
-      this.connectorsStatus.get(connectorId).start = false;
+      this.connectorsStatus.get(connectorId)!.start = false;
     } else if (this.connectorsStatus.get(connectorId)?.start === false) {
       logger.warn(`${this.logPrefix(connectorId)} is already stopped on connector`);
     }
@@ -181,73 +182,28 @@ export class AutomaticTransactionGenerator extends AsyncResource {
     this.setStartConnectorStatus(connectorId);
     logger.info(
       `${this.logPrefix(
-        connectorId
+        connectorId,
       )} started on connector and will run for ${formatDurationMilliSeconds(
-        this.connectorsStatus.get(connectorId).stopDate.getTime() -
-          this.connectorsStatus.get(connectorId).startDate.getTime()
-      )}`
+        this.connectorsStatus.get(connectorId)!.stopDate!.getTime() -
+          this.connectorsStatus.get(connectorId)!.startDate!.getTime(),
+      )}`,
     );
     while (this.connectorsStatus.get(connectorId)?.start === true) {
-      if (new Date() > this.connectorsStatus.get(connectorId).stopDate) {
-        this.stopConnector(connectorId);
-        break;
-      }
-      if (this.chargingStation.inAcceptedState() === false) {
-        logger.error(
-          `${this.logPrefix(
-            connectorId
-          )} entered in transaction loop while the charging station is not in accepted state`
-        );
-        this.stopConnector(connectorId);
-        break;
-      }
-      if (this.chargingStation.isChargingStationAvailable() === false) {
-        logger.info(
-          `${this.logPrefix(
-            connectorId
-          )} entered in transaction loop while the charging station is unavailable`
-        );
-        this.stopConnector(connectorId);
-        break;
-      }
-      if (this.chargingStation.isConnectorAvailable(connectorId) === false) {
-        logger.info(
-          `${this.logPrefix(
-            connectorId
-          )} entered in transaction loop while the connector ${connectorId} is unavailable`
-        );
+      await this.waitChargingStationServiceInitialization(connectorId);
+      await this.waitChargingStationAvailable(connectorId);
+      await this.waitConnectorAvailable(connectorId);
+      if (!this.canStartConnector(connectorId)) {
         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(
-            connectorId
-          )} transaction loop waiting for charging station service to be initialized`
-        );
-        do {
-          await sleep(Constants.CHARGING_STATION_ATG_INITIALIZATION_TIME);
-        } while (!this.chargingStation?.ocppRequestService);
-      }
-      const wait =
+      const wait = secondsToMilliseconds(
         getRandomInteger(
           this.chargingStation.getAutomaticTransactionGeneratorConfiguration()
             .maxDelayBetweenTwoTransactions,
           this.chargingStation.getAutomaticTransactionGeneratorConfiguration()
-            .minDelayBetweenTwoTransactions
-        ) * 1000;
+            .minDelayBetweenTwoTransactions,
+        ),
+      );
       logger.info(`${this.logPrefix(connectorId)} waiting for ${formatDurationMilliSeconds(wait)}`);
       await sleep(wait);
       const start = secureRandom();
@@ -255,77 +211,157 @@ export class AutomaticTransactionGenerator extends AsyncResource {
         start <
         this.chargingStation.getAutomaticTransactionGeneratorConfiguration().probabilityOfStart
       ) {
-        this.connectorsStatus.get(connectorId).skippedConsecutiveTransactions = 0;
+        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 =
+          const waitTrxEnd = secondsToMilliseconds(
             getRandomInteger(
               this.chargingStation.getAutomaticTransactionGeneratorConfiguration().maxDuration,
-              this.chargingStation.getAutomaticTransactionGeneratorConfiguration().minDuration
-            ) * 1000;
-          logger.info(
-            `${this.logPrefix(connectorId)} transaction started with id ${this.chargingStation
-              .getConnectorStatus(connectorId)
-              ?.transactionId?.toString()} and will stop in ${formatDurationMilliSeconds(
-              waitTrxEnd
-            )}`
+              this.chargingStation.getAutomaticTransactionGeneratorConfiguration().minDuration,
+            ),
           );
-          await sleep(waitTrxEnd);
-          // Stop transaction
           logger.info(
-            `${this.logPrefix(connectorId)} stop transaction with id ${this.chargingStation
-              .getConnectorStatus(connectorId)
-              ?.transactionId?.toString()}`
+            `${this.logPrefix(
+              connectorId,
+            )} transaction started with id ${this.chargingStation.getConnectorStatus(connectorId)
+              ?.transactionId} and will stop in ${formatDurationMilliSeconds(waitTrxEnd)}`,
           );
+          await sleep(waitTrxEnd);
           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)
-            ?.skippedConsecutiveTransactions?.toString()}/${this.connectorsStatus
-            .get(connectorId)
-            ?.skippedTransactions?.toString()} transaction(s)`
+          `${this.logPrefix(connectorId)} skipped consecutively ${this.connectorsStatus.get(
+            connectorId,
+          )?.skippedConsecutiveTransactions}/${this.connectorsStatus.get(connectorId)
+            ?.skippedTransactions} transaction(s)`,
         );
       }
-      this.connectorsStatus.get(connectorId).lastRunDate = new Date();
+      this.connectorsStatus.get(connectorId)!.lastRunDate = new Date();
     }
-    this.connectorsStatus.get(connectorId).stoppedDate = new Date();
+    this.connectorsStatus.get(connectorId)!.stoppedDate = new Date();
     logger.info(
       `${this.logPrefix(
-        connectorId
+        connectorId,
       )} stopped on connector and lasted for ${formatDurationMilliSeconds(
-        this.connectorsStatus.get(connectorId).stoppedDate.getTime() -
-          this.connectorsStatus.get(connectorId).startDate.getTime()
-      )}`
+        this.connectorsStatus.get(connectorId)!.stoppedDate!.getTime() -
+          this.connectorsStatus.get(connectorId)!.startDate!.getTime(),
+      )}`,
     );
     logger.debug(
       `${this.logPrefix(connectorId)} connector status: %j`,
-      this.connectorsStatus.get(connectorId)
+      this.connectorsStatus.get(connectorId),
     );
   }
 
   private setStartConnectorStatus(connectorId: number): void {
-    this.connectorsStatus.get(connectorId).skippedConsecutiveTransactions = 0;
+    this.connectorsStatus.get(connectorId)!.skippedConsecutiveTransactions = 0;
     const previousRunDuration =
       this.connectorsStatus.get(connectorId)?.startDate &&
       this.connectorsStatus.get(connectorId)?.lastRunDate
-        ? this.connectorsStatus.get(connectorId).lastRunDate.getTime() -
-          this.connectorsStatus.get(connectorId).startDate.getTime()
+        ? this.connectorsStatus.get(connectorId)!.lastRunDate!.getTime() -
+          this.connectorsStatus.get(connectorId)!.startDate!.getTime()
         : 0;
-    this.connectorsStatus.get(connectorId).startDate = new Date();
-    this.connectorsStatus.get(connectorId).stopDate = new Date(
-      this.connectorsStatus.get(connectorId).startDate.getTime() +
-        this.chargingStation.getAutomaticTransactionGeneratorConfiguration().stopAfterHours *
-          3600 *
-          1000 -
-        previousRunDuration
+    this.connectorsStatus.get(connectorId)!.startDate = new Date();
+    this.connectorsStatus.get(connectorId)!.stopDate = new Date(
+      this.connectorsStatus.get(connectorId)!.startDate!.getTime() +
+        hoursToMilliseconds(
+          this.chargingStation.getAutomaticTransactionGeneratorConfiguration().stopAfterHours,
+        ) -
+        previousRunDuration,
     );
-    this.connectorsStatus.get(connectorId).start = true;
+    this.connectorsStatus.get(connectorId)!.start = true;
+  }
+
+  private canStartConnector(connectorId: number): boolean {
+    if (new Date() > this.connectorsStatus.get(connectorId)!.stopDate!) {
+      return false;
+    }
+    if (this.chargingStation.inAcceptedState() === false) {
+      logger.error(
+        `${this.logPrefix(
+          connectorId,
+        )} entered in transaction loop while the charging station is not in accepted state`,
+      );
+      return false;
+    }
+    if (this.chargingStation.isChargingStationAvailable() === false) {
+      logger.info(
+        `${this.logPrefix(
+          connectorId,
+        )} entered in transaction loop while the charging station is unavailable`,
+      );
+      return false;
+    }
+    if (this.chargingStation.isConnectorAvailable(connectorId) === false) {
+      logger.info(
+        `${this.logPrefix(
+          connectorId,
+        )} entered in transaction loop while the connector ${connectorId} is unavailable`,
+      );
+      return false;
+    }
+    if (
+      this.chargingStation.getConnectorStatus(connectorId)?.status ===
+      ConnectorStatusEnum.Unavailable
+    ) {
+      logger.info(
+        `${this.logPrefix(
+          connectorId,
+        )} entered in transaction loop while the connector ${connectorId} status is unavailable`,
+      );
+      return false;
+    }
+    return true;
+  }
+
+  private async waitChargingStationServiceInitialization(connectorId: number): Promise<void> {
+    let logged = false;
+    while (!this.chargingStation?.ocppRequestService) {
+      if (!logged) {
+        logger.info(
+          `${this.logPrefix(
+            connectorId,
+          )} transaction loop waiting for charging station service to be initialized`,
+        );
+        logged = true;
+      }
+      await sleep(Constants.CHARGING_STATION_ATG_INITIALIZATION_TIME);
+    }
+  }
+
+  private async waitChargingStationAvailable(connectorId: number): Promise<void> {
+    let logged = false;
+    while (!this.chargingStation.isChargingStationAvailable()) {
+      if (!logged) {
+        logger.info(
+          `${this.logPrefix(
+            connectorId,
+          )} transaction loop waiting for charging station to be available`,
+        );
+        logged = true;
+      }
+      await sleep(Constants.CHARGING_STATION_ATG_AVAILABILITY_TIME);
+    }
+  }
+
+  private async waitConnectorAvailable(connectorId: number): Promise<void> {
+    let logged = false;
+    while (!this.chargingStation.isConnectorAvailable(connectorId)) {
+      if (!logged) {
+        logger.info(
+          `${this.logPrefix(
+            connectorId,
+          )} transaction loop waiting for connector ${connectorId} to be available`,
+        );
+        logged = true;
+      }
+      await sleep(Constants.CHARGING_STATION_ATG_AVAILABILITY_TIME);
+    }
   }
 
   private initializeConnectorsStatus(): void {
@@ -347,13 +383,14 @@ export class AutomaticTransactionGenerator extends AsyncResource {
   }
 
   private getConnectorStatus(connectorId: number): Status {
-    const connectorStatus = cloneObject(
-      this.chargingStation.getAutomaticTransactionGeneratorStatuses()
-    )[connectorId];
-    delete connectorStatus?.startDate;
-    delete connectorStatus?.lastRunDate;
-    delete connectorStatus?.stopDate;
-    delete connectorStatus?.stoppedDate;
+    const connectorStatus = this.chargingStation.getAutomaticTransactionGeneratorStatuses()?.[
+      connectorId
+    ]
+      ? cloneObject<Status>(
+          this.chargingStation.getAutomaticTransactionGeneratorStatuses()![connectorId],
+        )
+      : undefined;
+    this.resetConnectorStatus(connectorStatus);
     return (
       connectorStatus ?? {
         start: false,
@@ -372,34 +409,39 @@ export class AutomaticTransactionGenerator extends AsyncResource {
     );
   }
 
+  private resetConnectorStatus(connectorStatus: Status | undefined): void {
+    delete connectorStatus?.startDate;
+    delete connectorStatus?.lastRunDate;
+    delete connectorStatus?.stopDate;
+    delete connectorStatus?.stoppedDate;
+    if (
+      !this.started &&
+      (connectorStatus?.start === true ||
+        this.chargingStation.getAutomaticTransactionGeneratorConfiguration().enable === false)
+    ) {
+      connectorStatus!.start = false;
+    }
+  }
+
   private async startTransaction(
-    connectorId: number
+    connectorId: number,
   ): Promise<StartTransactionResponse | undefined> {
     const measureId = 'StartTransaction with ATG';
     const beginId = PerformanceStatistics.beginMeasure(measureId);
-    let startResponse: StartTransactionResponse;
+    let startResponse: StartTransactionResponse | undefined;
     if (this.chargingStation.hasIdTags()) {
       const idTag = IdTagsCache.getInstance().getIdTag(
-        this.chargingStation.getAutomaticTransactionGeneratorConfiguration()?.idTagDistribution,
+        this.chargingStation.getAutomaticTransactionGeneratorConfiguration().idTagDistribution!,
         this.chargingStation,
-        connectorId
+        connectorId,
       );
       const startTransactionLogMsg = `${this.logPrefix(
-        connectorId
+        connectorId,
       )} start transaction with an idTag '${idTag}'`;
       if (this.getRequireAuthorize()) {
-        this.chargingStation.getConnectorStatus(connectorId).authorizeIdTag = idTag;
-        // Authorize idTag
-        const authorizeResponse: AuthorizeResponse =
-          await this.chargingStation.ocppRequestService.requestHandler<
-            AuthorizeRequest,
-            AuthorizeResponse
-          >(this.chargingStation, RequestCommand.AUTHORIZE, {
-            idTag,
-          });
-        ++this.connectorsStatus.get(connectorId).authorizeRequests;
-        if (authorizeResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
-          ++this.connectorsStatus.get(connectorId).acceptedAuthorizeRequests;
+        ++this.connectorsStatus.get(connectorId)!.authorizeRequests!;
+        if (await OCPPServiceUtils.isIdTagAuthorized(this.chargingStation, connectorId, idTag)) {
+          ++this.connectorsStatus.get(connectorId)!.acceptedAuthorizeRequests!;
           logger.info(startTransactionLogMsg);
           // Start transaction
           startResponse = await this.chargingStation.ocppRequestService.requestHandler<
@@ -413,7 +455,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;
       }
@@ -442,25 +484,31 @@ export class AutomaticTransactionGenerator extends AsyncResource {
 
   private async stopTransaction(
     connectorId: number,
-    reason: StopTransactionReason = StopTransactionReason.LOCAL
-  ): Promise<StopTransactionResponse> {
+    reason = StopTransactionReason.LOCAL,
+  ): Promise<StopTransactionResponse | undefined> {
     const measureId = 'StopTransaction with ATG';
     const beginId = PerformanceStatistics.beginMeasure(measureId);
-    let stopResponse: StopTransactionResponse;
+    let stopResponse: StopTransactionResponse | undefined;
     if (this.chargingStation.getConnectorStatus(connectorId)?.transactionStarted === true) {
+      logger.info(
+        `${this.logPrefix(
+          connectorId,
+        )} stop transaction with id ${this.chargingStation.getConnectorStatus(connectorId)
+          ?.transactionId}`,
+      );
       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(
+      logger.debug(
         `${this.logPrefix(connectorId)} stopping a not started transaction${
-          !isNullOrUndefined(transactionId) ? ` with id ${transactionId?.toString()}` : ''
-        }`
+          !isNullOrUndefined(transactionId) ? ` with id ${transactionId}` : ''
+        }`,
       );
     }
     PerformanceStatistics.endMeasure(measureId, beginId);
@@ -476,21 +524,21 @@ export class AutomaticTransactionGenerator extends AsyncResource {
   private logPrefix = (connectorId?: number): string => {
     return logPrefix(
       ` ${this.chargingStation.stationInfo.chargingStationId} | ATG${
-        !isNullOrUndefined(connectorId) ? ` on connector #${connectorId.toString()}` : ''
-      }:`
+        !isNullOrUndefined(connectorId) ? ` on connector #${connectorId}` : ''
+      }:`,
     );
   };
 
   private handleStartTransactionResponse(
     connectorId: number,
-    startResponse: StartTransactionResponse
+    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;
+      ++this.connectorsStatus.get(connectorId)!.rejectedStartTransactionRequests!;
     }
   }
 }