Implement singleton design pattern with strict null check
[e-mobility-charging-stations-simulator.git] / src / charging-station / Bootstrap.ts
index 511a4d7a452afa6cd651bc3deae8f8426af830b9..0fa2c88d35c868650e76fa059a86f75d96c54b7e 100644 (file)
@@ -1,37 +1,66 @@
 // Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
 
-import { ChargingStationWorkerData, ChargingStationWorkerMessage, ChargingStationWorkerMessageEvents } from '../types/ChargingStationWorker';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { isMainThread } from 'worker_threads';
 
-import Configuration from '../utils/Configuration';
+import chalk from 'chalk';
+
+import { version } from '../../package.json';
 import { Storage } from '../performance/storage/Storage';
 import { StorageFactory } from '../performance/storage/StorageFactory';
+import {
+  ChargingStationWorkerData,
+  ChargingStationWorkerMessage,
+  ChargingStationWorkerMessageEvents,
+} from '../types/ChargingStationWorker';
+import { StationTemplateUrl } from '../types/ConfigurationData';
+import Statistics from '../types/Statistics';
+import { ApplicationProtocol } from '../types/UIProtocol';
+import Configuration from '../utils/Configuration';
 import Utils from '../utils/Utils';
 import WorkerAbstract from '../worker/WorkerAbstract';
 import WorkerFactory from '../worker/WorkerFactory';
-import chalk from 'chalk';
-import { isMainThread } from 'worker_threads';
-import path from 'path';
-import { version } from '../../package.json';
+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 {
   private static instance: Bootstrap | null = null;
-  private static workerImplementation: WorkerAbstract | null = null;
-  private static storage: Storage;
-  private static numberOfChargingStations: number;
-  private version: string = version;
+  private workerImplementation: WorkerAbstract<ChargingStationWorkerData> | null = null;
+  private readonly uiServer!: AbstractUIServer;
+  private readonly storage!: Storage;
+  private numberOfChargingStationTemplates!: number;
+  private numberOfChargingStations!: number;
+  private readonly version: string = version;
   private started: boolean;
-  private workerScript: string;
+  private readonly workerScript: string;
 
   private constructor() {
     this.started = false;
-    this.workerScript = path.join(path.resolve(__dirname, '../'), 'charging-station', 'ChargingStationWorker.js');
-    this.initWorkerImplementation();
-    Bootstrap.storage = StorageFactory.getStorage(Configuration.getPerformanceStorage().type, Configuration.getPerformanceStorage().URI, this.logPrefix());
+    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 &&
+      (this.storage = StorageFactory.getStorage(
+        Configuration.getPerformanceStorage().type,
+        Configuration.getPerformanceStorage().uri,
+        this.logPrefix()
+      ));
     Configuration.setConfigurationChangeCallback(async () => Bootstrap.getInstance().restart());
   }
 
   public static getInstance(): Bootstrap {
-    if (!Bootstrap.instance) {
+    if (Bootstrap.instance === null) {
       Bootstrap.instance = new Bootstrap();
     }
     return Bootstrap.instance;
@@ -40,33 +69,60 @@ export default class Bootstrap {
   public async start(): Promise<void> {
     if (isMainThread && !this.started) {
       try {
-        Bootstrap.numberOfChargingStations = 0;
-        await Bootstrap.storage.open();
-        await Bootstrap.workerImplementation.start();
+        this.initialize();
+        await this.storage?.open();
+        await this.workerImplementation.start();
+        this.uiServer?.start();
+        const stationTemplateUrls = Configuration.getStationTemplateUrls();
+        this.numberOfChargingStationTemplates = stationTemplateUrls.length;
         // Start ChargingStation object in worker thread
-        if (Configuration.getStationTemplateURLs()) {
-          for (const stationURL of Configuration.getStationTemplateURLs()) {
+        if (!Utils.isEmptyArray(stationTemplateUrls)) {
+          for (const stationTemplateUrl of stationTemplateUrls) {
             try {
-              const nbStations = stationURL.numberOfStations ?? 0;
+              const nbStations = stationTemplateUrl.numberOfStations ?? 0;
               for (let index = 1; index <= nbStations; index++) {
-                const workerData: ChargingStationWorkerData = {
-                  index,
-                  templateFile: path.join(path.resolve(__dirname, '../'), 'assets', 'station-templates', path.basename(stationURL.file))
-                };
-                await Bootstrap.workerImplementation.addElement(workerData);
-                Bootstrap.numberOfChargingStations++;
+                await this.startChargingStation(index, stationTemplateUrl);
               }
             } catch (error) {
-              console.error(chalk.red('Charging station start with template file ' + stationURL.file + ' error '), error);
+              console.error(
+                chalk.red(
+                  'Error at starting charging station with template file ' +
+                    stationTemplateUrl.file +
+                    ': '
+                ),
+                error
+              );
             }
           }
         } else {
-          console.warn(chalk.yellow('No stationTemplateURLs defined in configuration, exiting'));
+          console.warn(
+            chalk.yellow("'stationTemplateUrls' not defined or empty in configuration, exiting")
+          );
         }
-        if (Bootstrap.numberOfChargingStations === 0) {
-          console.warn(chalk.yellow('No charging station template enabled in configuration, exiting'));
+        if (this.numberOfChargingStations === 0) {
+          console.warn(
+            chalk.yellow('No charging station template enabled in configuration, exiting')
+          );
         } else {
-          console.log(chalk.green(`Charging stations simulator ${this.version} started with ${Bootstrap.numberOfChargingStations.toString()} charging station(s) and ${Utils.workerDynamicPoolInUse() ? `${Configuration.getWorkerPoolMinSize().toString()}/` : ''}${Bootstrap.workerImplementation.size}${Utils.workerPoolInUse() ? `/${Configuration.getWorkerPoolMaxSize().toString()}` : ''} worker(s) concurrently running in '${Configuration.getWorkerProcess()}' mode${Bootstrap.workerImplementation.maxElementsPerWorker ? ` (${Bootstrap.workerImplementation.maxElementsPerWorker} charging station(s) per worker)` : ''}`));
+          console.log(
+            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)`
+                  : ''
+              }`
+            )
+          );
         }
         this.started = true;
       } catch (error) {
@@ -79,8 +135,10 @@ export default class Bootstrap {
 
   public async stop(): Promise<void> {
     if (isMainThread && this.started) {
-      await Bootstrap.workerImplementation.stop();
-      await Bootstrap.storage.close();
+      await this.workerImplementation.stop();
+      this.workerImplementation = null;
+      this.uiServer?.stop();
+      await this.storage?.close();
     } else {
       console.error(chalk.red('Trying to stop the charging stations simulator while not started'));
     }
@@ -89,26 +147,58 @@ export default class Bootstrap {
 
   public async restart(): Promise<void> {
     await this.stop();
-    this.initWorkerImplementation();
+    this.initialize();
     await this.start();
   }
 
-  private initWorkerImplementation(): void {
-    Bootstrap.workerImplementation = WorkerFactory.getWorkerImplementation<ChargingStationWorkerData>(this.workerScript, Configuration.getWorkerProcess(),
-      {
-        startDelay: Configuration.getWorkerStartDelay(),
-        poolMaxSize: Configuration.getWorkerPoolMaxSize(),
-        poolMinSize: Configuration.getWorkerPoolMinSize(),
-        elementsPerWorker: Configuration.getChargingStationsPerWorker(),
-        poolOptions: {
-          workerChoiceStrategy: Configuration.getWorkerPoolStrategy()
-        },
-        messageHandler: async (msg: ChargingStationWorkerMessage) => {
-          if (msg.id === ChargingStationWorkerMessageEvents.PERFORMANCE_STATISTICS) {
-            await Bootstrap.storage.storePerformanceStatistics(msg.data);
-          }
+  private initializeWorkerImplementation(): void {
+    !this.workerImplementation &&
+      (this.workerImplementation = WorkerFactory.getWorkerImplementation<ChargingStationWorkerData>(
+        this.workerScript,
+        Configuration.getWorker().processType,
+        {
+          workerStartDelay: Configuration.getWorker().startDelay,
+          elementStartDelay: Configuration.getWorker().elementStartDelay,
+          poolMaxSize: Configuration.getWorker().poolMaxSize,
+          poolMinSize: Configuration.getWorker().poolMinSize,
+          elementsPerWorker: Configuration.getWorker().elementsPerWorker,
+          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);
+            }
+          },
         }
-      });
+      ));
+  }
+
+  private initialize() {
+    this.numberOfChargingStations = 0;
+    this.numberOfChargingStationTemplates = 0;
+    this.initializeWorkerImplementation();
+  }
+
+  private async startChargingStation(
+    index: number,
+    stationTemplateUrl: StationTemplateUrl
+  ): Promise<void> {
+    const workerData: ChargingStationWorkerData = {
+      index,
+      templateFile: path.join(
+        path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'),
+        'assets',
+        'station-templates',
+        stationTemplateUrl.file
+      ),
+    };
+    await this.workerImplementation.addElement(workerData);
+    this.numberOfChargingStations++;
   }
 
   private logPrefix(): string {