Hook the OCPP 2.0 stack into the main code
[e-mobility-charging-stations-simulator.git] / src / charging-station / AutomaticTransactionGenerator.ts
index ba5b3e652e09867be8afa9473c8109b5d1670211..80c9a5176937a035dccc699fc39e6e6b2859a88d 100644 (file)
@@ -1,9 +1,13 @@
-// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
+// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
 
+import { AsyncResource } from 'async_hooks';
+
+import BaseError from '../exception/BaseError';
 import PerformanceStatistics from '../performance/PerformanceStatistics';
-import type {
-  AutomaticTransactionGeneratorConfiguration,
-  Status,
+import {
+  type AutomaticTransactionGeneratorConfiguration,
+  IdTagDistribution,
+  type Status,
 } from '../types/AutomaticTransactionGenerator';
 import { RequestCommand } from '../types/ocpp/Requests';
 import {
@@ -19,8 +23,11 @@ import Constants from '../utils/Constants';
 import logger from '../utils/Logger';
 import Utils from '../utils/Utils';
 import type ChargingStation from './ChargingStation';
+import { ChargingStationUtils } from './ChargingStationUtils';
 
-export default class AutomaticTransactionGenerator {
+const moduleName = 'AutomaticTransactionGenerator';
+
+export default class AutomaticTransactionGenerator extends AsyncResource {
   private static readonly instances: Map<string, AutomaticTransactionGenerator> = new Map<
     string,
     AutomaticTransactionGenerator
@@ -30,15 +37,19 @@ export default class AutomaticTransactionGenerator {
   public readonly configuration: AutomaticTransactionGeneratorConfiguration;
   public started: boolean;
   private readonly chargingStation: ChargingStation;
+  private idTagIndex: number;
 
   private constructor(
     automaticTransactionGeneratorConfiguration: AutomaticTransactionGeneratorConfiguration,
     chargingStation: ChargingStation
   ) {
+    super(moduleName);
     this.started = false;
     this.configuration = automaticTransactionGeneratorConfiguration;
     this.chargingStation = chargingStation;
-    this.connectorsStatus = new Map<number, Status>(this.buildInitialConnectorsStatus());
+    this.idTagIndex = 0;
+    this.connectorsStatus = new Map<number, Status>();
+    this.initializeConnectorsStatus();
   }
 
   public static getInstance(
@@ -58,6 +69,9 @@ export default class AutomaticTransactionGenerator {
   }
 
   public start(): void {
+    if (this.checkChargingStation() === false) {
+      return;
+    }
     if (this.started === true) {
       logger.warn(`${this.logPrefix()} is already started`);
       return;
@@ -76,16 +90,23 @@ export default class AutomaticTransactionGenerator {
   }
 
   public startConnector(connectorId: number): void {
-    if (this.chargingStation.connectors.has(connectorId) === false) {
-      logger.warn(`${this.logPrefix(connectorId)} starting on non existing connector`);
+    if (this.checkChargingStation(connectorId) === false) {
       return;
     }
+    if (this.connectorsStatus.has(connectorId) === false) {
+      logger.error(`${this.logPrefix(connectorId)} starting on non existing connector`);
+      throw new BaseError(`Connector ${connectorId} does not exist`);
+    }
     if (this.connectorsStatus.get(connectorId)?.start === false) {
-      // Avoid hogging the event loop with a busy loop
-      setImmediate(() => {
-        this.internalStartConnector(connectorId).catch(() => {
-          /* This is intentional */
-        });
+      this.runInAsyncScope(
+        this.internalStartConnector.bind(this) as (
+          this: AutomaticTransactionGenerator,
+          ...args: any[]
+        ) => Promise<void>,
+        this,
+        connectorId
+      ).catch(() => {
+        /* This is intentional */
       });
     } else if (this.connectorsStatus.get(connectorId)?.start === true) {
       logger.warn(`${this.logPrefix(connectorId)} is already started on connector`);
@@ -93,15 +114,12 @@ export default class AutomaticTransactionGenerator {
   }
 
   public stopConnector(connectorId: number): void {
-    if (this.chargingStation.connectors.has(connectorId) === false) {
-      logger.warn(`${this.logPrefix(connectorId)} stopping on non existing connector`);
-      return;
+    if (this.connectorsStatus.has(connectorId) === false) {
+      logger.error(`${this.logPrefix(connectorId)} stopping on non existing connector`);
+      throw new BaseError(`Connector ${connectorId} does not exist`);
     }
     if (this.connectorsStatus.get(connectorId)?.start === true) {
-      this.connectorsStatus.set(connectorId, {
-        ...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`);
     }
@@ -113,6 +131,7 @@ export default class AutomaticTransactionGenerator {
       this.connectorsStatus.size !== this.chargingStation.getNumberOfConnectors()
     ) {
       this.connectorsStatus.clear();
+      this.initializeConnectorsStatus();
     }
     for (const connectorId of this.chargingStation.connectors.keys()) {
       if (connectorId > 0) {
@@ -130,8 +149,7 @@ export default class AutomaticTransactionGenerator {
   }
 
   private async internalStartConnector(connectorId: number): Promise<void> {
-    this.initializeConnectorStatus(connectorId);
-    this.connectorsStatus.get(connectorId).start = true;
+    this.setStartConnectorStatus(connectorId);
     logger.info(
       this.logPrefix(connectorId) +
         ' started on connector and will run for ' +
@@ -145,7 +163,7 @@ export default class AutomaticTransactionGenerator {
         this.stopConnector(connectorId);
         break;
       }
-      if (!this.chargingStation.isInAcceptedState()) {
+      if (this.chargingStation.isInAcceptedState() === false) {
         logger.error(
           this.logPrefix(connectorId) +
             ' entered in transaction loop while the charging station is not in accepted state'
@@ -153,7 +171,7 @@ export default class AutomaticTransactionGenerator {
         this.stopConnector(connectorId);
         break;
       }
-      if (!this.chargingStation.isChargingStationAvailable()) {
+      if (this.chargingStation.isChargingStationAvailable() === false) {
         logger.info(
           this.logPrefix(connectorId) +
             ' entered in transaction loop while the charging station is unavailable'
@@ -161,7 +179,7 @@ export default class AutomaticTransactionGenerator {
         this.stopConnector(connectorId);
         break;
       }
-      if (!this.chargingStation.isConnectorAvailable(connectorId)) {
+      if (this.chargingStation.isConnectorAvailable(connectorId) === false) {
         logger.info(
           `${this.logPrefix(
             connectorId
@@ -244,28 +262,8 @@ export default class AutomaticTransactionGenerator {
     );
   }
 
-  private initializeConnectorStatus(connectorId: number): void {
-    this.connectorsStatus.get(connectorId).authorizeRequests =
-      this?.connectorsStatus.get(connectorId)?.authorizeRequests ?? 0;
-    this.connectorsStatus.get(connectorId).acceptedAuthorizeRequests =
-      this?.connectorsStatus.get(connectorId)?.acceptedAuthorizeRequests ?? 0;
-    this.connectorsStatus.get(connectorId).rejectedAuthorizeRequests =
-      this?.connectorsStatus.get(connectorId)?.rejectedAuthorizeRequests ?? 0;
-    this.connectorsStatus.get(connectorId).startTransactionRequests =
-      this?.connectorsStatus.get(connectorId)?.startTransactionRequests ?? 0;
-    this.connectorsStatus.get(connectorId).acceptedStartTransactionRequests =
-      this?.connectorsStatus.get(connectorId)?.acceptedStartTransactionRequests ?? 0;
-    this.connectorsStatus.get(connectorId).rejectedStartTransactionRequests =
-      this?.connectorsStatus.get(connectorId)?.rejectedStartTransactionRequests ?? 0;
-    this.connectorsStatus.get(connectorId).stopTransactionRequests =
-      this?.connectorsStatus.get(connectorId)?.stopTransactionRequests ?? 0;
-    this.connectorsStatus.get(connectorId).acceptedStopTransactionRequests =
-      this?.connectorsStatus.get(connectorId)?.acceptedStopTransactionRequests ?? 0;
-    this.connectorsStatus.get(connectorId).rejectedStopTransactionRequests =
-      this?.connectorsStatus.get(connectorId)?.rejectedStopTransactionRequests ?? 0;
+  private setStartConnectorStatus(connectorId: number): void {
     this.connectorsStatus.get(connectorId).skippedConsecutiveTransactions = 0;
-    this.connectorsStatus.get(connectorId).skippedTransactions =
-      this?.connectorsStatus.get(connectorId)?.skippedTransactions ?? 0;
     const previousRunDuration =
       this?.connectorsStatus.get(connectorId)?.startDate &&
       this?.connectorsStatus.get(connectorId)?.lastRunDate
@@ -281,34 +279,28 @@ export default class AutomaticTransactionGenerator {
           1000 -
         previousRunDuration
     );
-    this.connectorsStatus.get(connectorId).start =
-      this?.connectorsStatus.get(connectorId)?.start ?? false;
+    this.connectorsStatus.get(connectorId).start = true;
   }
 
-  private buildInitialConnectorsStatus(): [number, Status][] {
-    const connectorsStatus: [number, Status][] = [];
+  private initializeConnectorsStatus(): void {
     for (const connectorId of this.chargingStation.connectors.keys()) {
       if (connectorId > 0) {
-        connectorsStatus.push([
-          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,
-          },
-        ]);
+        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,
+        });
       }
     }
-    return connectorsStatus;
   }
 
   private async startTransaction(
@@ -318,7 +310,7 @@ export default class AutomaticTransactionGenerator {
     const beginId = PerformanceStatistics.beginMeasure(measureId);
     let startResponse: StartTransactionResponse;
     if (this.chargingStation.hasAuthorizedTags()) {
-      const idTag = this.chargingStation.getRandomIdTag();
+      const idTag = this.getIdTag(connectorId);
       const startTransactionLogMsg = `${this.logPrefix(
         connectorId
       )} start transaction with an idTag '${idTag}'`;
@@ -406,6 +398,41 @@ export default class AutomaticTransactionGenerator {
     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
+    );
+    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(
       ` ${this.chargingStation.stationInfo.chargingStationId} | ATG${
@@ -426,4 +453,12 @@ export default class AutomaticTransactionGenerator {
       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;
+    }
+    return true;
+  }
 }