Strict null check fixes
[e-mobility-charging-stations-simulator.git] / src / charging-station / Bootstrap.ts
index a6eb4939cf4f6cd0bf612362fbbc6744cd0cd53b..8a161e54a66e210c9fd856b3cf06295e12db9b5a 100644 (file)
+// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
+
+import path from 'path';
+import { fileURLToPath } from '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 {
+  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 { StationWorkerData } from '../types/Worker';
+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 { isMainThread } from 'worker_threads';
-import path from 'path';
 
-export default class Bootstrap {
-  private static instance: Bootstrap;
+const moduleName = 'Bootstrap';
+
+enum exitCodes {
+  missingChargingStationsConfiguration = 1,
+  noChargingStationTemplates = 2,
+}
+
+export class Bootstrap {
+  private static instance: Bootstrap | null = null;
+  private workerImplementation: WorkerAbstract<ChargingStationWorkerData> | null;
+  private readonly uiServer!: AbstractUIServer;
+  private readonly storage!: Storage;
+  private numberOfChargingStationTemplates!: number | undefined;
+  private numberOfChargingStations!: number;
+  private numberOfStartedChargingStations!: number;
+  private readonly version: string = version;
   private started: boolean;
-  private workerScript: string;
-  private workerImplementationInstance: WorkerAbstract | null = null;
+  private readonly workerScript: string;
 
   private constructor() {
     this.started = false;
-    this.workerScript = path.join(path.resolve(__dirname, '../'), 'charging-station', 'StationWorker.js');
-    Configuration.setConfigurationChangeCallback(async () => this.restart());
+    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 === true &&
+      (this.uiServer = UIServerFactory.getUIServerImplementation(Configuration.getUIServer()));
+    Configuration.getPerformanceStorage().enabled === true &&
+      (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;
   }
 
   public async start(): Promise<void> {
-    if (isMainThread && !this.started) {
+    if (isMainThread && this.started === false) {
       try {
-        let numStationsTotal = 0;
-        await this.getWorkerImplementationInstance()?.start();
+        // Enable unconditionally for now
+        this.logUnhandledRejection();
+        this.logUncaughtException();
+        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 ? stationURL.numberOfStations : 0;
+              const nbStations = stationTemplateUrl.numberOfStations ?? 0;
               for (let index = 1; index <= nbStations; index++) {
-                const workerData: StationWorkerData = {
-                  index,
-                  templateFile: path.join(path.resolve(__dirname, '../'), 'assets', 'station-templates', path.basename(stationURL.file))
-                };
-                await this.getWorkerImplementationInstance()?.addElement(workerData);
-                numStationsTotal++;
+                await this.startChargingStation(index, stationTemplateUrl);
               }
             } catch (error) {
-              console.error('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.log('No stationTemplateURLs defined in configuration, exiting');
+          console.warn(
+            chalk.yellow("'stationTemplateUrls' not defined or empty in configuration, exiting")
+          );
+          process.exit(exitCodes.missingChargingStationsConfiguration);
         }
-        if (numStationsTotal === 0) {
-          console.log('No charging station template enabled in configuration, exiting');
+        if (this.numberOfChargingStations === 0) {
+          console.warn(
+            chalk.yellow('No charging station template enabled in configuration, exiting')
+          );
+          process.exit(exitCodes.noChargingStationTemplates);
         } else {
-          console.log(`Charging station simulator started with ${numStationsTotal.toString()} charging station(s) and ${Utils.workerDynamicPoolInUse() ? `${Configuration.getWorkerPoolMinSize().toString()}/` : ''}${this.getWorkerImplementationInstance().size}${Utils.workerPoolInUse() ? `/${Configuration.getWorkerPoolMaxSize().toString()}` : ''} worker(s) concurrently running in '${Configuration.getWorkerProcess()}' mode${this.getWorkerImplementationInstance().maxElementsPerWorker ? ` (${this.getWorkerImplementationInstance().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${
+                this.workerImplementation?.maxElementsPerWorker
+                  ? ` (${this.workerImplementation?.maxElementsPerWorker} charging station(s) per worker)`
+                  : ''
+              }`
+            )
+          );
         }
         this.started = true;
       } catch (error) {
-        console.error('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'));
     }
   }
 
   public async stop(): Promise<void> {
-    if (isMainThread && this.started) {
-      await this.getWorkerImplementationInstance()?.stop();
-      // Nullify to force worker implementation instance creation
-      this.workerImplementationInstance = null;
+    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('Cannot stop a not started charging stations simulator'));
     }
-    this.started = false;
   }
 
   public async restart(): Promise<void> {
     await this.stop();
+    this.initialize();
     await this.start();
   }
 
-  private getWorkerImplementationInstance(): WorkerAbstract | null {
-    if (!this.workerImplementationInstance) {
-      this.workerImplementationInstance = WorkerFactory.getWorkerImplementation<StationWorkerData>(this.workerScript, Configuration.getWorkerProcess(),
+  private initializeWorkerImplementation(): void {
+    this.workerImplementation === null &&
+      (this.workerImplementation = WorkerFactory.getWorkerImplementation<ChargingStationWorkerData>(
+        this.workerScript,
+        Configuration.getWorker().processType,
         {
-          startDelay: Configuration.getWorkerStartDelay(),
-          poolMaxSize: Configuration.getWorkerPoolMaxSize(),
-          poolMinSize: Configuration.getWorkerPoolMinSize(),
-          elementsPerWorker: Configuration.getChargingStationsPerWorker(),
+          workerStartDelay: Configuration.getWorker().startDelay,
+          elementStartDelay: Configuration.getWorker().elementStartDelay,
+          poolMaxSize: Configuration.getWorker().poolMaxSize,
+          poolMinSize: Configuration.getWorker().poolMinSize,
+          elementsPerWorker: Configuration.getWorker().elementsPerWorker,
           poolOptions: {
-            workerChoiceStrategy: Configuration.getWorkerPoolStrategy()
-          }
-        });
+            workerChoiceStrategy: Configuration.getWorker().poolStrategy,
+          },
+          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
+      );
     }
-    return this.workerImplementationInstance;
+  }
+
+  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.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
+  ): 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 {
+    return Utils.logPrefix(' Bootstrap |');
   }
 }