refactor(simulator): remove unneeded duplicate initialization at startup
[e-mobility-charging-stations-simulator.git] / src / charging-station / Bootstrap.ts
index 7c80067ccd93905b2e76cec7ac9a3641bd670ff6..7a823e56f3ed7f253db079fbf8482d188528ecf4 100644 (file)
@@ -1,59 +1,64 @@
-// 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 path from 'node:path';
+import { fileURLToPath } from 'node:url';
+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 BaseError from '../exception/BaseError';
 import type { Storage } from '../performance/storage/Storage';
 import { StorageFactory } from '../performance/storage/StorageFactory';
 import {
-  ChargingStationData,
-  ChargingStationWorkerData,
-  ChargingStationWorkerMessage,
-  ChargingStationWorkerMessageData,
+  type ChargingStationData,
+  type ChargingStationWorkerData,
+  type ChargingStationWorkerMessage,
+  type ChargingStationWorkerMessageData,
   ChargingStationWorkerMessageEvents,
 } from '../types/ChargingStationWorker';
 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 type WorkerAbstract from '../worker/WorkerAbstract';
 import WorkerFactory from '../worker/WorkerFactory';
-import { ChargingStationUtils } from './ChargingStationUtils';
-import type { AbstractUIServer } from './ui-server/AbstractUIServer';
-import UIServerFactory from './ui-server/UIServerFactory';
 
 const moduleName = 'Bootstrap';
 
-const missingChargingStationsConfigurationExitCode = 1;
-const noChargingStationTemplatesExitCode = 2;
+enum exitCodes {
+  missingChargingStationsConfiguration = 1,
+  noChargingStationTemplates = 2,
+}
 
 export class Bootstrap {
   private static instance: Bootstrap | null = null;
+  public numberOfChargingStations!: number;
+  public numberOfChargingStationTemplates!: number;
   private workerImplementation: WorkerAbstract<ChargingStationWorkerData> | null;
-  private readonly uiServer!: AbstractUIServer;
+  private readonly uiServer!: AbstractUIServer | null;
   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() {
+    // Enable unconditionally for now
+    this.logUnhandledRejection();
+    this.logUncaughtException();
     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))
+      `ChargingStationWorker${path.extname(fileURLToPath(import.meta.url))}`
     );
-    this.initialize();
     Configuration.getUIServer().enabled === true &&
       (this.uiServer = UIServerFactory.getUIServerImplementation(Configuration.getUIServer()));
     Configuration.getPerformanceStorage().enabled === true &&
@@ -75,66 +80,47 @@ export class Bootstrap {
   public async start(): Promise<void> {
     if (isMainThread && this.started === false) {
       try {
-        // Enable unconditionally for now
-        this.logUnhandledRejection();
-        this.logUncaughtException();
-        this.initialize();
+        this.initializeCounters();
+        this.initializeWorkerImplementation();
         await this.storage?.open();
-        await this.workerImplementation.start();
+        await this.workerImplementation?.start();
         this.uiServer?.start();
         const stationTemplateUrls = Configuration.getStationTemplateUrls();
-        this.numberOfChargingStationTemplates = stationTemplateUrls.length;
         // Start ChargingStation object in worker thread
-        if (!Utils.isEmptyArray(stationTemplateUrls)) {
-          for (const stationTemplateUrl of stationTemplateUrls) {
-            try {
-              const nbStations = stationTemplateUrl.numberOfStations ?? 0;
-              for (let index = 1; index <= nbStations; index++) {
-                await this.startChargingStation(index, stationTemplateUrl);
-              }
-            } catch (error) {
-              console.error(
-                chalk.red(
-                  'Error at starting charging station with template file ' +
-                    stationTemplateUrl.file +
-                    ': '
-                ),
-                error
-              );
+        for (const stationTemplateUrl of stationTemplateUrls) {
+          try {
+            const nbStations = stationTemplateUrl.numberOfStations ?? 0;
+            for (let index = 1; index <= nbStations; index++) {
+              await this.startChargingStation(index, stationTemplateUrl);
             }
+          } catch (error) {
+            console.error(
+              chalk.red(
+                `Error at starting charging station with template file ${stationTemplateUrl.file}: `
+              ),
+              error
+            );
           }
-        } else {
-          console.warn(
-            chalk.yellow("'stationTemplateUrls' not defined or empty in configuration, exiting")
-          );
-          process.exit(missingChargingStationsConfigurationExitCode);
-        }
-        if (this.numberOfChargingStations === 0) {
-          console.warn(
-            chalk.yellow('No charging station template enabled in configuration, exiting')
-          );
-          process.exit(noChargingStationTemplatesExitCode);
-        } else {
-          console.info(
-            chalk.green(
-              `Charging stations simulator ${
-                this.version
-              } started with ${this.numberOfChargingStations.toString()} charging station(s) from ${this.numberOfChargingStationTemplates.toString()} configured charging station template(s) and ${
-                ChargingStationUtils.workerDynamicPoolInUse()
-                  ? `${Configuration.getWorker().poolMinSize.toString()}/`
-                  : ''
-              }${this.workerImplementation.size}${
-                ChargingStationUtils.workerPoolInUse()
-                  ? `/${Configuration.getWorker().poolMaxSize.toString()}`
-                  : ''
-              } worker(s) concurrently running in '${Configuration.getWorker().processType}' mode${
-                this.workerImplementation.maxElementsPerWorker
-                  ? ` (${this.workerImplementation.maxElementsPerWorker} charging station(s) per worker)`
-                  : ''
-              }`
-            )
-          );
         }
+        console.info(
+          chalk.green(
+            `Charging stations simulator ${
+              this.version
+            } started with ${this.numberOfChargingStations.toString()} charging station(s) from ${this.numberOfChargingStationTemplates.toString()} configured charging station template(s) and ${
+              ChargingStationUtils.workerDynamicPoolInUse()
+                ? `${Configuration.getWorker().poolMinSize?.toString()}/`
+                : ''
+            }${this.workerImplementation?.size}${
+              ChargingStationUtils.workerPoolInUse()
+                ? `/${Configuration.getWorker().poolMaxSize?.toString()}`
+                : ''
+            } worker(s) concurrently running in '${Configuration.getWorker().processType}' mode${
+              !Utils.isNullOrUndefined(this.workerImplementation?.maxElementsPerWorker)
+                ? ` (${this.workerImplementation?.maxElementsPerWorker} charging station(s) per worker)`
+                : ''
+            }`
+          )
+        );
         this.started = true;
       } catch (error) {
         console.error(chalk.red('Bootstrap start error: '), error);
@@ -146,7 +132,7 @@ export class Bootstrap {
 
   public async stop(): Promise<void> {
     if (isMainThread && this.started === true) {
-      await this.workerImplementation.stop();
+      await this.workerImplementation?.stop();
       this.workerImplementation = null;
       this.uiServer?.stop();
       await this.storage?.close();
@@ -158,7 +144,6 @@ export class Bootstrap {
 
   public async restart(): Promise<void> {
     await this.stop();
-    this.initialize();
     await this.start();
   }
 
@@ -176,9 +161,7 @@ export class Bootstrap {
           poolOptions: {
             workerChoiceStrategy: Configuration.getWorker().poolStrategy,
           },
-          messageHandler: this.messageHandler.bind(this) as (
-            msg: ChargingStationWorkerMessage<ChargingStationWorkerMessageData>
-          ) => void,
+          messageHandler: this.messageHandler.bind(this) as MessageHandler<Worker>,
         }
       ));
   }
@@ -225,11 +208,25 @@ export class Bootstrap {
   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) => {
@@ -240,11 +237,26 @@ export class Bootstrap {
     this.storage.storePerformanceStatistics(data) as void;
   };
 
-  private initialize() {
+  private initializeCounters() {
     this.numberOfChargingStationTemplates = 0;
     this.numberOfChargingStations = 0;
+    const stationTemplateUrls = Configuration.getStationTemplateUrls();
+    if (!Utils.isEmptyArray(stationTemplateUrls)) {
+      this.numberOfChargingStationTemplates = stationTemplateUrls?.length;
+      stationTemplateUrls.forEach((stationTemplateUrl) => {
+        this.numberOfChargingStations += stationTemplateUrl.numberOfStations ?? 0;
+      });
+    } else {
+      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);
+    }
     this.numberOfStartedChargingStations = 0;
-    this.initializeWorkerImplementation();
   }
 
   private logUncaughtException(): void {
@@ -272,11 +284,10 @@ export class Bootstrap {
         stationTemplateUrl.file
       ),
     };
-    await this.workerImplementation.addElement(workerData);
-    ++this.numberOfChargingStations;
+    await this.workerImplementation?.addElement(workerData);
   }
 
-  private logPrefix(): string {
+  private logPrefix = (): string => {
     return Utils.logPrefix(' Bootstrap |');
-  }
+  };
 }