Enforce singleton design pattern for the logger

[e-mobility-charging-stations-simulator.git] / src / performance / PerformanceStatistics.ts

diff --git a/src/performance/PerformanceStatistics.ts b/src/performance/PerformanceStatistics.ts
index ff79133608e278f78c37b0cba4f73ca3f449a849..96006346cdfea57bebfbe27cf8f5ccd99bddaa23 100644 (file)
--- a/src/performance/PerformanceStatistics.ts
+++ b/src/performance/PerformanceStatistics.ts
@@ -3,26 +3,26 @@
 import { CircularArray, DEFAULT_CIRCULAR_ARRAY_SIZE } from '../utils/CircularArray';
 import { IncomingRequestCommand, RequestCommand } from '../types/ocpp/Requests';
 import { PerformanceEntry, PerformanceObserver, performance } from 'perf_hooks';
-import Statistics, { StatisticsData } from '../types/Statistics';
+import Statistics, { StatisticsData, TimeSeries } from '../types/Statistics';
 
+import { ChargingStationWorkerMessageEvents } from '../types/ChargingStationWorker';
 import Configuration from '../utils/Configuration';
 import { MessageType } from '../types/ocpp/MessageType';
 import { URL } from 'url';
 import Utils from '../utils/Utils';
-import { WorkerMessageEvents } from '../types/Worker';
-import logger from '../utils/Logger';
+import getLogger from '../utils/Logger';
 import { parentPort } from 'worker_threads';
 
 export default class PerformanceStatistics {
-  private objId: string;
+  private readonly objId: string;
   private performanceObserver: PerformanceObserver;
-  private statistics: Statistics;
+  private readonly statistics: Statistics;
   private displayInterval: NodeJS.Timeout;
 
-  public constructor(objId: string, URI: URL) {
+  public constructor(objId: string, uri: URL) {
     this.objId = objId;
     this.initializePerformanceObserver();
-    this.statistics = { id: this.objId ?? 'Object id not specified', URI: URI.toString(), createdAt: new Date(), statisticsData: {} };
+    this.statistics = { id: this.objId ?? 'Object id not specified', uri: uri.toString(), createdAt: new Date(), statisticsData: new Map<string, Partial<StatisticsData>>() };
   }
 
   public static beginMeasure(id: string): string {
@@ -39,39 +39,28 @@ export default class PerformanceStatistics {
   public addRequestStatistic(command: RequestCommand | IncomingRequestCommand, messageType: MessageType): void {
     switch (messageType) {
       case MessageType.CALL_MESSAGE:
-        if (this.statistics.statisticsData[command] && this.statistics.statisticsData[command].countRequest) {
-          this.statistics.statisticsData[command].countRequest++;
+        if (this.statistics.statisticsData.has(command) && this.statistics.statisticsData.get(command)?.countRequest) {
+          this.statistics.statisticsData.get(command).countRequest++;
         } else {
-          this.statistics.statisticsData[command] = {} as StatisticsData;
-          this.statistics.statisticsData[command].countRequest = 1;
+          this.statistics.statisticsData.set(command, Object.assign({ countRequest: 1 }, this.statistics.statisticsData.get(command)));
         }
         break;
       case MessageType.CALL_RESULT_MESSAGE:
-        if (this.statistics.statisticsData[command]) {
-          if (this.statistics.statisticsData[command].countResponse) {
-            this.statistics.statisticsData[command].countResponse++;
-          } else {
-            this.statistics.statisticsData[command].countResponse = 1;
-          }
+        if (this.statistics.statisticsData.has(command) && this.statistics.statisticsData.get(command)?.countResponse) {
+          this.statistics.statisticsData.get(command).countResponse++;
         } else {
-          this.statistics.statisticsData[command] = {} as StatisticsData;
-          this.statistics.statisticsData[command].countResponse = 1;
+          this.statistics.statisticsData.set(command, Object.assign({ countResponse: 1 }, this.statistics.statisticsData.get(command)));
         }
         break;
       case MessageType.CALL_ERROR_MESSAGE:
-        if (this.statistics.statisticsData[command]) {
-          if (this.statistics.statisticsData[command].countError) {
-            this.statistics.statisticsData[command].countError++;
-          } else {
-            this.statistics.statisticsData[command].countError = 1;
-          }
+        if (this.statistics.statisticsData.has(command) && this.statistics.statisticsData.get(command)?.countError) {
+          this.statistics.statisticsData.get(command).countError++;
         } else {
-          this.statistics.statisticsData[command] = {} as StatisticsData;
-          this.statistics.statisticsData[command].countError = 1;
+          this.statistics.statisticsData.set(command, Object.assign({ countError: 1 }, this.statistics.statisticsData.get(command)));
         }
         break;
       default:
-        logger.error(`${this.logPrefix()} wrong message type ${messageType}`);
+        getLogger().error(`${this.logPrefix()} wrong message type ${messageType}`);
         break;
     }
   }
@@ -79,7 +68,7 @@ export default class PerformanceStatistics {
   public start(): void {
     this.startLogStatisticsInterval();
     if (Configuration.getPerformanceStorage().enabled) {
-      logger.info(`${this.logPrefix()} storage enabled: type ${Configuration.getPerformanceStorage().type}, URI: ${Configuration.getPerformanceStorage().URI}`);
+      getLogger().info(`${this.logPrefix()} storage enabled: type ${Configuration.getPerformanceStorage().type}, uri: ${Configuration.getPerformanceStorage().uri}`);
     }
   }
 
@@ -100,13 +89,13 @@ export default class PerformanceStatistics {
     this.performanceObserver = new PerformanceObserver((list) => {
       const lastPerformanceEntry = list.getEntries()[0];
       this.addPerformanceEntryToStatistics(lastPerformanceEntry);
-      logger.debug(`${this.logPrefix()} '${lastPerformanceEntry.name}' performance entry: %j`, lastPerformanceEntry);
+      getLogger().debug(`${this.logPrefix()} '${lastPerformanceEntry.name}' performance entry: %j`, lastPerformanceEntry);
     });
     this.performanceObserver.observe({ entryTypes: ['measure'] });
   }
 
   private logStatistics(): void {
-    logger.info(this.logPrefix() + ' %j', this.statistics);
+    getLogger().info(this.logPrefix() + ' %j', this.statistics);
   }
 
   private startLogStatisticsInterval(): void {
@@ -114,9 +103,9 @@ export default class PerformanceStatistics {
       this.displayInterval = setInterval(() => {
         this.logStatistics();
       }, Configuration.getLogStatisticsInterval() * 1000);
-      logger.info(this.logPrefix() + ' logged every ' + Utils.secondsToHHMMSS(Configuration.getLogStatisticsInterval()));
+      getLogger().info(this.logPrefix() + ' logged every ' + Utils.formatDurationSeconds(Configuration.getLogStatisticsInterval()));
     } else {
-      logger.info(this.logPrefix() + ' log interval is set to ' + Configuration.getLogStatisticsInterval().toString() + '. Not logging statistics');
+      getLogger().info(this.logPrefix() + ' log interval is set to ' + Configuration.getLogStatisticsInterval().toString() + '. Not logging statistics');
     }
   }
 
@@ -176,26 +165,40 @@ export default class PerformanceStatistics {
       entryName = MAP_NAME[entryName];
     }
     // Initialize command statistics
-    if (!this.statistics.statisticsData[entryName]) {
-      this.statistics.statisticsData[entryName] = {} as StatisticsData;
+    if (!this.statistics.statisticsData.has(entryName)) {
+      this.statistics.statisticsData.set(entryName, {});
     }
     // Update current statistics
     this.statistics.updatedAt = new Date();
-    this.statistics.statisticsData[entryName].countTimeMeasurement = this.statistics.statisticsData[entryName].countTimeMeasurement ? this.statistics.statisticsData[entryName].countTimeMeasurement + 1 : 1;
-    this.statistics.statisticsData[entryName].currentTimeMeasurement = entry.duration;
-    this.statistics.statisticsData[entryName].minTimeMeasurement = this.statistics.statisticsData[entryName].minTimeMeasurement ? (this.statistics.statisticsData[entryName].minTimeMeasurement > entry.duration ? entry.duration : this.statistics.statisticsData[entryName].minTimeMeasurement) : entry.duration;
-    this.statistics.statisticsData[entryName].maxTimeMeasurement = this.statistics.statisticsData[entryName].maxTimeMeasurement ? (this.statistics.statisticsData[entryName].maxTimeMeasurement < entry.duration ? entry.duration : this.statistics.statisticsData[entryName].maxTimeMeasurement) : entry.duration;
-    this.statistics.statisticsData[entryName].totalTimeMeasurement = this.statistics.statisticsData[entryName].totalTimeMeasurement ? this.statistics.statisticsData[entryName].totalTimeMeasurement + entry.duration : entry.duration;
-    this.statistics.statisticsData[entryName].avgTimeMeasurement = this.statistics.statisticsData[entryName].totalTimeMeasurement / this.statistics.statisticsData[entryName].countTimeMeasurement;
-    Array.isArray(this.statistics.statisticsData[entryName].timeMeasurementSeries) ? this.statistics.statisticsData[entryName].timeMeasurementSeries.push(entry.duration) : this.statistics.statisticsData[entryName].timeMeasurementSeries = new CircularArray<number>(DEFAULT_CIRCULAR_ARRAY_SIZE, entry.duration);
-    this.statistics.statisticsData[entryName].medTimeMeasurement = this.median(this.statistics.statisticsData[entryName].timeMeasurementSeries);
-    this.statistics.statisticsData[entryName].ninetyFiveThPercentileTimeMeasurement = this.percentile(this.statistics.statisticsData[entryName].timeMeasurementSeries, 95);
-    this.statistics.statisticsData[entryName].stdDevTimeMeasurement = this.stdDeviation(this.statistics.statisticsData[entryName].timeMeasurementSeries);
+    this.statistics.statisticsData.get(entryName).countTimeMeasurement = this.statistics.statisticsData.get(entryName)?.countTimeMeasurement
+      ? this.statistics.statisticsData.get(entryName).countTimeMeasurement + 1
+      : 1;
+    this.statistics.statisticsData.get(entryName).currentTimeMeasurement = entry.duration;
+    this.statistics.statisticsData.get(entryName).minTimeMeasurement = this.statistics.statisticsData.get(entryName)?.minTimeMeasurement
+      ? (this.statistics.statisticsData.get(entryName).minTimeMeasurement > entry.duration ? entry.duration : this.statistics.statisticsData.get(entryName).minTimeMeasurement)
+      : entry.duration;
+    this.statistics.statisticsData.get(entryName).maxTimeMeasurement = this.statistics.statisticsData.get(entryName)?.maxTimeMeasurement
+      ? (this.statistics.statisticsData.get(entryName).maxTimeMeasurement < entry.duration ? entry.duration : this.statistics.statisticsData.get(entryName).maxTimeMeasurement)
+      : entry.duration;
+    this.statistics.statisticsData.get(entryName).totalTimeMeasurement = this.statistics.statisticsData.get(entryName)?.totalTimeMeasurement
+      ? this.statistics.statisticsData.get(entryName).totalTimeMeasurement + entry.duration
+      : entry.duration;
+    this.statistics.statisticsData.get(entryName).avgTimeMeasurement = this.statistics.statisticsData.get(entryName).totalTimeMeasurement / this.statistics.statisticsData.get(entryName).countTimeMeasurement;
+    Array.isArray(this.statistics.statisticsData.get(entryName).timeMeasurementSeries)
+      ? this.statistics.statisticsData.get(entryName).timeMeasurementSeries.push({ timestamp: entry.startTime, value: entry.duration })
+      : this.statistics.statisticsData.get(entryName).timeMeasurementSeries = new CircularArray<TimeSeries>(DEFAULT_CIRCULAR_ARRAY_SIZE, { timestamp: entry.startTime, value: entry.duration });
+    this.statistics.statisticsData.get(entryName).medTimeMeasurement = this.median(this.extractTimeSeriesValues(this.statistics.statisticsData.get(entryName).timeMeasurementSeries));
+    this.statistics.statisticsData.get(entryName).ninetyFiveThPercentileTimeMeasurement = this.percentile(this.extractTimeSeriesValues(this.statistics.statisticsData.get(entryName).timeMeasurementSeries), 95);
+    this.statistics.statisticsData.get(entryName).stdDevTimeMeasurement = this.stdDeviation(this.extractTimeSeriesValues(this.statistics.statisticsData.get(entryName).timeMeasurementSeries));
     if (Configuration.getPerformanceStorage().enabled) {
-      parentPort.postMessage({ id: WorkerMessageEvents.PERFORMANCE_STATISTICS, data: this.statistics });
+      parentPort.postMessage({ id: ChargingStationWorkerMessageEvents.PERFORMANCE_STATISTICS, data: this.statistics });
     }
   }
 
+  private extractTimeSeriesValues(timeSeries: CircularArray<TimeSeries>): number[] {
+    return timeSeries.map((timeSeriesItem) => timeSeriesItem.value);
+  }
+
   private logPrefix(): string {
     return Utils.logPrefix(` ${this.objId} | Performance statistics`);
   }