Linter fixes
[e-mobility-charging-stations-simulator.git] / src / charging-station / Bootstrap.ts
index b5e90bd80fcdae1f55bf3e65b9d2e0e3831fd04b..7b2db1c795033a2f697f2989c3f69a7a5eb9ed30 100644 (file)
@@ -1,56 +1,65 @@
-// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
+// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
 
 import path from 'path';
 import { fileURLToPath } from 'url';
-import { isMainThread } from 'worker_threads';
+import { type Worker, isMainThread } from 'worker_threads';
 
 import chalk from 'chalk';
 
+import { ChargingStationUtils } from './ChargingStationUtils';
+import type { AbstractUIServer } from './ui-server/AbstractUIServer';
+import UIServerFactory from './ui-server/UIServerFactory';
 import { version } from '../../package.json';
-import { Storage } from '../performance/storage/Storage';
+import BaseError from '../exception/BaseError';
+import type { Storage } from '../performance/storage/Storage';
 import { StorageFactory } from '../performance/storage/StorageFactory';
 import {
-  ChargingStationWorkerData,
-  ChargingStationWorkerMessage,
+  type ChargingStationData,
+  type ChargingStationWorkerData,
+  type ChargingStationWorkerMessage,
+  type ChargingStationWorkerMessageData,
   ChargingStationWorkerMessageEvents,
 } from '../types/ChargingStationWorker';
-import { StationTemplateUrl } from '../types/ConfigurationData';
-import Statistics from '../types/Statistics';
-import { ApplicationProtocol } from '../types/UIProtocol';
+import type { StationTemplateUrl } from '../types/ConfigurationData';
+import type { Statistics } from '../types/Statistics';
+import type { MessageHandler } from '../types/Worker';
 import Configuration from '../utils/Configuration';
+import logger from '../utils/Logger';
 import Utils from '../utils/Utils';
-import WorkerAbstract from '../worker/WorkerAbstract';
+import type WorkerAbstract from '../worker/WorkerAbstract';
 import WorkerFactory from '../worker/WorkerFactory';
-import { ChargingStationUtils } from './ChargingStationUtils';
-import { AbstractUIServer } from './ui-server/AbstractUIServer';
-import { UIServiceUtils } from './ui-server/ui-services/UIServiceUtils';
-import UIServerFactory from './ui-server/UIServerFactory';
 
-export default class Bootstrap {
+const moduleName = 'Bootstrap';
+
+enum exitCodes {
+  missingChargingStationsConfiguration = 1,
+  noChargingStationTemplates = 2,
+}
+
+export class Bootstrap {
   private static instance: Bootstrap | null = null;
-  private workerImplementation: WorkerAbstract<ChargingStationWorkerData> | null = null;
+  private workerImplementation: WorkerAbstract<ChargingStationWorkerData> | null;
   private readonly uiServer!: AbstractUIServer;
   private readonly storage!: Storage;
   private numberOfChargingStationTemplates!: number;
   private numberOfChargingStations!: number;
+  private numberOfStartedChargingStations!: number;
   private readonly version: string = version;
   private started: boolean;
   private readonly workerScript: string;
 
   private constructor() {
     this.started = false;
+    this.workerImplementation = null;
     this.workerScript = path.join(
       path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'),
       'charging-station',
       'ChargingStationWorker' + path.extname(fileURLToPath(import.meta.url))
     );
     this.initialize();
-    Configuration.getUIServer().enabled &&
-      (this.uiServer = UIServerFactory.getUIServerImplementation(ApplicationProtocol.WS, {
-        ...Configuration.getUIServer().options,
-        handleProtocols: UIServiceUtils.handleProtocols,
-      }));
-    Configuration.getPerformanceStorage().enabled &&
+    Configuration.getUIServer().enabled === true &&
+      (this.uiServer = UIServerFactory.getUIServerImplementation(Configuration.getUIServer()));
+    Configuration.getPerformanceStorage().enabled === true &&
       (this.storage = StorageFactory.getStorage(
         Configuration.getPerformanceStorage().type,
         Configuration.getPerformanceStorage().uri,
@@ -60,15 +69,18 @@ export default class Bootstrap {
   }
 
   public static getInstance(): Bootstrap {
-    if (!Bootstrap.instance) {
+    if (Bootstrap.instance === null) {
       Bootstrap.instance = new Bootstrap();
     }
     return Bootstrap.instance;
   }
 
   public async start(): Promise<void> {
-    if (isMainThread && !this.started) {
+    if (isMainThread && this.started === false) {
       try {
+        // Enable unconditionally for now
+        this.logUnhandledRejection();
+        this.logUncaughtException();
         this.initialize();
         await this.storage?.open();
         await this.workerImplementation.start();
@@ -98,13 +110,15 @@ export default class Bootstrap {
           console.warn(
             chalk.yellow("'stationTemplateUrls' not defined or empty in configuration, exiting")
           );
+          process.exit(exitCodes.missingChargingStationsConfiguration);
         }
         if (this.numberOfChargingStations === 0) {
           console.warn(
             chalk.yellow('No charging station template enabled in configuration, exiting')
           );
+          process.exit(exitCodes.noChargingStationTemplates);
         } else {
-          console.log(
+          console.info(
             chalk.green(
               `Charging stations simulator ${
                 this.version
@@ -126,7 +140,7 @@ export default class Bootstrap {
         }
         this.started = true;
       } catch (error) {
-        console.error(chalk.red('Bootstrap start error '), error);
+        console.error(chalk.red('Bootstrap start error: '), error);
       }
     } else {
       console.error(chalk.red('Cannot start an already started charging stations simulator'));
@@ -134,15 +148,15 @@ export default class Bootstrap {
   }
 
   public async stop(): Promise<void> {
-    if (isMainThread && this.started) {
+    if (isMainThread && this.started === true) {
       await this.workerImplementation.stop();
       this.workerImplementation = null;
       this.uiServer?.stop();
       await this.storage?.close();
+      this.started = false;
     } else {
-      console.error(chalk.red('Trying to stop the charging stations simulator while not started'));
+      console.error(chalk.red('Cannot stop a not started charging stations simulator'));
     }
-    this.started = false;
   }
 
   public async restart(): Promise<void> {
@@ -152,7 +166,7 @@ export default class Bootstrap {
   }
 
   private initializeWorkerImplementation(): void {
-    !this.workerImplementation &&
+    this.workerImplementation === null &&
       (this.workerImplementation = WorkerFactory.getWorkerImplementation<ChargingStationWorkerData>(
         this.workerScript,
         Configuration.getWorker().processType,
@@ -165,25 +179,101 @@ export default class Bootstrap {
           poolOptions: {
             workerChoiceStrategy: Configuration.getWorker().poolStrategy,
           },
-          messageHandler: async (msg: ChargingStationWorkerMessage) => {
-            if (msg.id === ChargingStationWorkerMessageEvents.STARTED) {
-              this.uiServer.chargingStations.add(msg.data.id as string);
-            } else if (msg.id === ChargingStationWorkerMessageEvents.STOPPED) {
-              this.uiServer.chargingStations.delete(msg.data.id as string);
-            } else if (msg.id === ChargingStationWorkerMessageEvents.PERFORMANCE_STATISTICS) {
-              await this.storage.storePerformanceStatistics(msg.data as unknown as Statistics);
-            }
-          },
+          messageHandler: this.messageHandler.bind(this) as MessageHandler<Worker>,
         }
       ));
   }
 
+  private messageHandler(
+    msg: ChargingStationWorkerMessage<ChargingStationWorkerMessageData>
+  ): void {
+    // logger.debug(
+    //   `${this.logPrefix()} ${moduleName}.messageHandler: Worker channel message received: ${JSON.stringify(
+    //     msg,
+    //     null,
+    //     2
+    //   )}`
+    // );
+    try {
+      switch (msg.id) {
+        case ChargingStationWorkerMessageEvents.STARTED:
+          this.workerEventStarted(msg.data as ChargingStationData);
+          break;
+        case ChargingStationWorkerMessageEvents.STOPPED:
+          this.workerEventStopped(msg.data as ChargingStationData);
+          break;
+        case ChargingStationWorkerMessageEvents.UPDATED:
+          this.workerEventUpdated(msg.data as ChargingStationData);
+          break;
+        case ChargingStationWorkerMessageEvents.PERFORMANCE_STATISTICS:
+          this.workerEventPerformanceStatistics(msg.data as Statistics);
+          break;
+        default:
+          throw new BaseError(
+            `Unknown event type: '${msg.id}' for data: ${JSON.stringify(msg.data, null, 2)}`
+          );
+      }
+    } catch (error) {
+      logger.error(
+        `${this.logPrefix()} ${moduleName}.messageHandler: Error occurred while handling '${
+          msg.id
+        }' event:`,
+        error
+      );
+    }
+  }
+
+  private workerEventStarted = (data: ChargingStationData) => {
+    this.uiServer?.chargingStations.set(data.stationInfo.hashId, data);
+    ++this.numberOfStartedChargingStations;
+    logger.info(
+      `${this.logPrefix()} ${moduleName}.workerEventStarted: Charging station ${
+        data.stationInfo.chargingStationId
+      } (hashId: ${data.stationInfo.hashId}) started (${
+        this.numberOfStartedChargingStations
+      } started from ${this.numberOfChargingStations})`
+    );
+  };
+
+  private workerEventStopped = (data: ChargingStationData) => {
+    this.uiServer?.chargingStations.set(data.stationInfo.hashId, data);
+    --this.numberOfStartedChargingStations;
+    logger.info(
+      `${this.logPrefix()} ${moduleName}.workerEventStopped: Charging station ${
+        data.stationInfo.chargingStationId
+      } (hashId: ${data.stationInfo.hashId}) stopped (${
+        this.numberOfStartedChargingStations
+      } started from ${this.numberOfChargingStations})`
+    );
+  };
+
+  private workerEventUpdated = (data: ChargingStationData) => {
+    this.uiServer?.chargingStations.set(data.stationInfo.hashId, data);
+  };
+
+  private workerEventPerformanceStatistics = (data: Statistics) => {
+    this.storage.storePerformanceStatistics(data) as void;
+  };
+
   private initialize() {
-    this.numberOfChargingStations = 0;
     this.numberOfChargingStationTemplates = 0;
+    this.numberOfChargingStations = 0;
+    this.numberOfStartedChargingStations = 0;
     this.initializeWorkerImplementation();
   }
 
+  private logUncaughtException(): void {
+    process.on('uncaughtException', (error: Error) => {
+      console.error(chalk.red('Uncaught exception: '), error);
+    });
+  }
+
+  private logUnhandledRejection(): void {
+    process.on('unhandledRejection', (reason: unknown) => {
+      console.error(chalk.red('Unhandled rejection: '), reason);
+    });
+  }
+
   private async startChargingStation(
     index: number,
     stationTemplateUrl: StationTemplateUrl
@@ -194,11 +284,11 @@ export default class Bootstrap {
         path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'),
         'assets',
         'station-templates',
-        path.basename(stationTemplateUrl.file)
+        stationTemplateUrl.file
       ),
     };
     await this.workerImplementation.addElement(workerData);
-    this.numberOfChargingStations++;
+    ++this.numberOfChargingStations;
   }
 
   private logPrefix(): string {