Improve and unify log messages
[e-mobility-charging-stations-simulator.git] / src / charging-station / AutomaticTransactionGenerator.ts
index 31f0716886aa57f74d615e758a7b0cf8a1570300..03297e4a8c99dafdd375f8714db9717d1e78ebbc 100644 (file)
@@ -1,28 +1,24 @@
 // Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
 
+import PerformanceStatistics from '../performance/PerformanceStatistics';
+import type {
+  AutomaticTransactionGeneratorConfiguration,
+  Status,
+} from '../types/AutomaticTransactionGenerator';
+import { RequestCommand } from '../types/ocpp/Requests';
 import {
   AuthorizationStatus,
-  AuthorizeRequest,
-  AuthorizeResponse,
-  StartTransactionRequest,
-  StartTransactionResponse,
+  type AuthorizeRequest,
+  type AuthorizeResponse,
+  type StartTransactionRequest,
+  type StartTransactionResponse,
   StopTransactionReason,
-  StopTransactionRequest,
-  StopTransactionResponse,
+  type StopTransactionResponse,
 } from '../types/ocpp/Transaction';
-import {
-  AutomaticTransactionGeneratorConfiguration,
-  Status,
-} from '../types/AutomaticTransactionGenerator';
-import { MeterValuesRequest, RequestCommand } from '../types/ocpp/Requests';
-
-import type ChargingStation from './ChargingStation';
 import Constants from '../utils/Constants';
-import { MeterValuesResponse } from '../types/ocpp/Responses';
-import { OCPP16ServiceUtils } from './ocpp/1.6/OCPP16ServiceUtils';
-import PerformanceStatistics from '../performance/PerformanceStatistics';
-import Utils from '../utils/Utils';
 import logger from '../utils/Logger';
+import Utils from '../utils/Utils';
+import type ChargingStation from './ChargingStation';
 
 export default class AutomaticTransactionGenerator {
   private static readonly instances: Map<string, AutomaticTransactionGenerator> = new Map<
@@ -30,41 +26,41 @@ export default class AutomaticTransactionGenerator {
     AutomaticTransactionGenerator
   >();
 
+  public readonly connectorsStatus: Map<number, Status>;
   public readonly configuration: AutomaticTransactionGeneratorConfiguration;
   public started: boolean;
   private readonly chargingStation: ChargingStation;
-  private readonly connectorsStatus: Map<number, Status>;
 
   private constructor(
     automaticTransactionGeneratorConfiguration: AutomaticTransactionGeneratorConfiguration,
     chargingStation: ChargingStation
   ) {
+    this.started = false;
     this.configuration = automaticTransactionGeneratorConfiguration;
     this.chargingStation = chargingStation;
     this.connectorsStatus = new Map<number, Status>();
     this.stopConnectors();
-    this.started = false;
   }
 
   public static getInstance(
     automaticTransactionGeneratorConfiguration: AutomaticTransactionGeneratorConfiguration,
     chargingStation: ChargingStation
   ): AutomaticTransactionGenerator {
-    if (!AutomaticTransactionGenerator.instances.has(chargingStation.hashId)) {
+    if (!AutomaticTransactionGenerator.instances.has(chargingStation.stationInfo.hashId)) {
       AutomaticTransactionGenerator.instances.set(
-        chargingStation.hashId,
+        chargingStation.stationInfo.hashId,
         new AutomaticTransactionGenerator(
           automaticTransactionGeneratorConfiguration,
           chargingStation
         )
       );
     }
-    return AutomaticTransactionGenerator.instances.get(chargingStation.hashId);
+    return AutomaticTransactionGenerator.instances.get(chargingStation.stationInfo.hashId);
   }
 
   public start(): void {
-    if (this.started) {
-      logger.error(`${this.logPrefix()} trying to start while already started`);
+    if (this.started === true) {
+      logger.warn(`${this.logPrefix()} is already started`);
       return;
     }
     this.startConnectors();
@@ -72,14 +68,46 @@ export default class AutomaticTransactionGenerator {
   }
 
   public stop(): void {
-    if (!this.started) {
-      logger.error(`${this.logPrefix()} trying to stop while not started`);
+    if (this.started === false) {
+      logger.warn(`${this.logPrefix()} is already stopped`);
       return;
     }
     this.stopConnectors();
     this.started = false;
   }
 
+  public startConnector(connectorId: number): void {
+    if (this.chargingStation.connectors.has(connectorId) === false) {
+      logger.warn(`${this.logPrefix(connectorId)} starting on non existing connector`);
+      return;
+    }
+    if (this.connectorsStatus.get(connectorId)?.start === false) {
+      // Avoid hogging the event loop with a busy loop
+      setImmediate(() => {
+        this.internalStartConnector(connectorId).catch(() => {
+          /* This is intentional */
+        });
+      });
+    } else if (this.connectorsStatus.get(connectorId)?.start === true) {
+      logger.warn(`${this.logPrefix(connectorId)} is already started on connector`);
+    }
+  }
+
+  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.get(connectorId)?.start === true) {
+      this.connectorsStatus.set(connectorId, {
+        ...this.connectorsStatus.get(connectorId),
+        start: false,
+      });
+    } else if (this.connectorsStatus.get(connectorId)?.start === false) {
+      logger.warn(`${this.logPrefix(connectorId)} is already stopped on connector`);
+    }
+  }
+
   private startConnectors(): void {
     if (
       this.connectorsStatus?.size > 0 &&
@@ -112,7 +140,7 @@ export default class AutomaticTransactionGenerator {
             this.connectorsStatus.get(connectorId).startDate.getTime()
         )
     );
-    while (this.connectorsStatus.get(connectorId).start) {
+    while (this.connectorsStatus.get(connectorId).start === true) {
       if (new Date() > this.connectorsStatus.get(connectorId).stopDate) {
         this.stopConnector(connectorId);
         break;
@@ -166,11 +194,7 @@ export default class AutomaticTransactionGenerator {
         this.connectorsStatus.get(connectorId).skippedConsecutiveTransactions = 0;
         // Start transaction
         const startResponse = await this.startTransaction(connectorId);
-        this.connectorsStatus.get(connectorId).startTransactionRequests++;
-        if (startResponse?.idTagInfo?.status !== AuthorizationStatus.ACCEPTED) {
-          logger.warn(this.logPrefix(connectorId) + ' start transaction rejected');
-          this.connectorsStatus.get(connectorId).rejectedStartTransactionRequests++;
-        } else {
+        if (startResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
           // Wait until end of transaction
           const waitTrxEnd =
             Utils.getRandomInteger(this.configuration.maxDuration, this.configuration.minDuration) *
@@ -182,7 +206,6 @@ export default class AutomaticTransactionGenerator {
               ' started and will stop in ' +
               Utils.formatDurationMilliSeconds(waitTrxEnd)
           );
-          this.connectorsStatus.get(connectorId).acceptedStartTransactionRequests++;
           await Utils.sleep(waitTrxEnd);
           // Stop transaction
           logger.info(
@@ -206,7 +229,6 @@ export default class AutomaticTransactionGenerator {
       }
       this.connectorsStatus.get(connectorId).lastRunDate = new Date();
     }
-    await this.stopTransaction(connectorId);
     this.connectorsStatus.get(connectorId).stoppedDate = new Date();
     logger.info(
       this.logPrefix(connectorId) +
@@ -217,27 +239,11 @@ export default class AutomaticTransactionGenerator {
         )
     );
     logger.debug(
-      `${this.logPrefix(connectorId)} connector status %j`,
+      `${this.logPrefix(connectorId)} connector status: %j`,
       this.connectorsStatus.get(connectorId)
     );
   }
 
-  private startConnector(connectorId: number): void {
-    // Avoid hogging the event loop with a busy loop
-    setImmediate(() => {
-      this.internalStartConnector(connectorId).catch(() => {
-        /* This is intentional */
-      });
-    });
-  }
-
-  private stopConnector(connectorId: number): void {
-    this.connectorsStatus.set(connectorId, {
-      ...this.connectorsStatus.get(connectorId),
-      start: false,
-    });
-  }
-
   private initializeConnectorStatus(connectorId: number): void {
     this.connectorsStatus.get(connectorId).authorizeRequests =
       this?.connectorsStatus.get(connectorId)?.authorizeRequests ?? 0;
@@ -253,6 +259,10 @@ export default class AutomaticTransactionGenerator {
       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;
     this.connectorsStatus.get(connectorId).skippedConsecutiveTransactions = 0;
     this.connectorsStatus.get(connectorId).skippedTransactions =
       this?.connectorsStatus.get(connectorId)?.skippedTransactions ?? 0;
@@ -276,12 +286,15 @@ export default class AutomaticTransactionGenerator {
 
   private async startTransaction(
     connectorId: number
-  ): Promise<StartTransactionResponse | AuthorizeResponse> {
+  ): Promise<StartTransactionResponse | undefined> {
     const measureId = 'StartTransaction with ATG';
     const beginId = PerformanceStatistics.beginMeasure(measureId);
     let startResponse: StartTransactionResponse;
     if (this.chargingStation.hasAuthorizedTags()) {
       const idTag = this.chargingStation.getRandomIdTag();
+      const startTransactionLogMsg = `${this.logPrefix(
+        connectorId
+      )} start transaction with an idTag '${idTag}'`;
       if (this.getRequireAuthorize()) {
         this.chargingStation.getConnectorStatus(connectorId).authorizeIdTag = idTag;
         // Authorize idTag
@@ -295,7 +308,7 @@ export default class AutomaticTransactionGenerator {
         this.connectorsStatus.get(connectorId).authorizeRequests++;
         if (authorizeResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
           this.connectorsStatus.get(connectorId).acceptedAuthorizeRequests++;
-          logger.info(this.logPrefix(connectorId) + ' start transaction for idTag ' + idTag);
+          logger.info(startTransactionLogMsg);
           // Start transaction
           startResponse = await this.chargingStation.ocppRequestService.requestHandler<
             StartTransactionRequest,
@@ -304,14 +317,15 @@ export default class AutomaticTransactionGenerator {
             connectorId,
             idTag,
           });
+          this.handleStartTransactionResponse(connectorId, startResponse);
           PerformanceStatistics.endMeasure(measureId, beginId);
           return startResponse;
         }
         this.connectorsStatus.get(connectorId).rejectedAuthorizeRequests++;
         PerformanceStatistics.endMeasure(measureId, beginId);
-        return authorizeResponse;
+        return startResponse;
       }
-      logger.info(this.logPrefix(connectorId) + ' start transaction for idTag ' + idTag);
+      logger.info(startTransactionLogMsg);
       // Start transaction
       startResponse = await this.chargingStation.ocppRequestService.requestHandler<
         StartTransactionRequest,
@@ -320,61 +334,39 @@ export default class AutomaticTransactionGenerator {
         connectorId,
         idTag,
       });
+      this.handleStartTransactionResponse(connectorId, startResponse);
       PerformanceStatistics.endMeasure(measureId, beginId);
       return startResponse;
     }
-    logger.info(this.logPrefix(connectorId) + ' start transaction without an idTag');
+    logger.info(`${this.logPrefix(connectorId)} start transaction without an idTag`);
     startResponse = await this.chargingStation.ocppRequestService.requestHandler<
       StartTransactionRequest,
       StartTransactionResponse
     >(this.chargingStation, RequestCommand.START_TRANSACTION, { connectorId });
+    this.handleStartTransactionResponse(connectorId, startResponse);
     PerformanceStatistics.endMeasure(measureId, beginId);
     return startResponse;
   }
 
   private async stopTransaction(
     connectorId: number,
-    reason: StopTransactionReason = StopTransactionReason.NONE
+    reason: StopTransactionReason = StopTransactionReason.LOCAL
   ): Promise<StopTransactionResponse> {
     const measureId = 'StopTransaction with ATG';
     const beginId = PerformanceStatistics.beginMeasure(measureId);
-    let transactionId = 0;
     let stopResponse: StopTransactionResponse;
-    if (this.chargingStation.getConnectorStatus(connectorId)?.transactionStarted) {
-      transactionId = this.chargingStation.getConnectorStatus(connectorId).transactionId;
-      if (
-        this.chargingStation.getBeginEndMeterValues() &&
-        this.chargingStation.getOcppStrictCompliance() &&
-        !this.chargingStation.getOutOfOrderEndMeterValues()
-      ) {
-        // FIXME: Implement OCPP version agnostic helpers
-        const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue(
-          this.chargingStation,
-          connectorId,
-          this.chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId)
-        );
-        await this.chargingStation.ocppRequestService.requestHandler<
-          MeterValuesRequest,
-          MeterValuesResponse
-        >(this.chargingStation, RequestCommand.METER_VALUES, {
-          connectorId,
-          transactionId,
-          meterValue: transactionEndMeterValue,
-        });
-      }
-      stopResponse = await this.chargingStation.ocppRequestService.requestHandler<
-        StopTransactionRequest,
-        StopTransactionResponse
-      >(this.chargingStation, RequestCommand.STOP_TRANSACTION, {
-        transactionId,
-        meterStop: this.chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId),
-        idTag: this.chargingStation.getTransactionIdTag(transactionId),
-        reason,
-      });
+    if (this.chargingStation.getConnectorStatus(connectorId)?.transactionStarted === true) {
+      stopResponse = await this.chargingStation.stopTransactionOnConnector(connectorId, reason);
       this.connectorsStatus.get(connectorId).stopTransactionRequests++;
+      if (stopResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
+        this.connectorsStatus.get(connectorId).acceptedStopTransactionRequests++;
+      } else {
+        this.connectorsStatus.get(connectorId).rejectedStopTransactionRequests++;
+      }
     } else {
+      const transactionId = this.chargingStation.getConnectorStatus(connectorId).transactionId;
       logger.warn(
-        `${this.logPrefix(connectorId)} trying to stop a not started transaction${
+        `${this.logPrefix(connectorId)} stopping a not started transaction${
           transactionId ? ' ' + transactionId.toString() : ''
         }`
       );
@@ -390,8 +382,21 @@ export default class AutomaticTransactionGenerator {
   private logPrefix(connectorId?: number): string {
     return Utils.logPrefix(
       ` ${this.chargingStation.stationInfo.chargingStationId} | ATG${
-        connectorId && ` on connector #${connectorId.toString()}`
+        connectorId !== undefined ? ` on connector #${connectorId.toString()}` : ''
       }:`
     );
   }
+
+  private handleStartTransactionResponse(
+    connectorId: number,
+    startResponse: StartTransactionResponse
+  ): void {
+    this.connectorsStatus.get(connectorId).startTransactionRequests++;
+    if (startResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
+      this.connectorsStatus.get(connectorId).acceptedStartTransactionRequests++;
+    } else {
+      logger.warn(this.logPrefix(connectorId) + ' start transaction rejected');
+      this.connectorsStatus.get(connectorId).rejectedStartTransactionRequests++;
+    }
+  }
 }