X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FBootstrap.ts;h=653a8ddbc1f85fdcd84b29a47b278e44864385bf;hb=e8044a69a745aab08dfeea0bd9ec9dd7fe84cdd7;hp=80e14d151bef4897d4f4ec541e967529572d2003;hpb=e4cb2c14d14e95090cca15518594af1c3f369d2b;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/Bootstrap.ts b/src/charging-station/Bootstrap.ts index 80e14d15..653a8ddb 100644 --- a/src/charging-station/Bootstrap.ts +++ b/src/charging-station/Bootstrap.ts @@ -1,66 +1,63 @@ -// 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 'node:worker_threads'; import chalk from 'chalk'; -import { version } from '../../package.json'; -import BaseError from '../exception/BaseError'; -import { Storage } from '../performance/storage/Storage'; -import { StorageFactory } from '../performance/storage/StorageFactory'; +import { type AbstractUIServer, ChargingStationUtils, UIServerFactory } from './internal'; +import packageJson from '../../package.json' assert { type: 'json' }; +import { BaseError } from '../exception'; +import { type Storage, StorageFactory } from '../performance'; import { - ChargingStationData, - ChargingStationWorkerData, - ChargingStationWorkerMessage, - ChargingStationWorkerMessageData, + 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 Configuration from '../utils/Configuration'; -import logger from '../utils/Logger'; -import Utils from '../utils/Utils'; -import 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'; + type StationTemplateUrl, + type Statistics, +} from '../types'; +import { Configuration, Utils, logger } from '../utils'; +import { type MessageHandler, type WorkerAbstract, WorkerFactory } from '../worker'; const moduleName = 'Bootstrap'; -const missingChargingStationsConfigurationExitCode = 1; -const noChargingStationTemplatesExitCode = 2; +enum exitCodes { + missingChargingStationsConfiguration = 1, + noChargingStationTemplates = 2, +} -export default class Bootstrap { +export class Bootstrap { private static instance: Bootstrap | null = null; - private workerImplementation: WorkerAbstract | null = null; - private readonly uiServer!: AbstractUIServer; + public numberOfChargingStations!: number; + public numberOfChargingStationTemplates!: number; + private workerImplementation: WorkerAbstract | null; + private readonly uiServer!: AbstractUIServer | null; private readonly storage!: Storage; - private numberOfChargingStationTemplates!: number; - private numberOfChargingStations!: number; private numberOfStartedChargingStations!: number; - private readonly version: string = version; + private readonly version: string = packageJson.version; + private initializedCounters: boolean; private started: boolean; private readonly workerScript: string; private constructor() { + // Enable unconditionally for now + this.logUnhandledRejection(); + this.logUncaughtException(); + this.initializedCounters = false; this.started = false; + this.initializeCounters(); + 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 && - (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, @@ -77,94 +74,73 @@ export default class Bootstrap { } public async start(): Promise { - if (isMainThread && !this.started) { - try { - 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 (!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 - ); - } + if (isMainThread && this.started === false) { + this.initializeCounters(); + this.initializeWorkerImplementation(); + await this.workerImplementation?.start(); + await this.storage?.open(); + this.uiServer?.start(); + // Start ChargingStation object instance in worker thread + for (const stationTemplateUrl of Configuration.getStationTemplateUrls()) { + try { + const nbStations = stationTemplateUrl.numberOfStations ?? 0; + for (let index = 1; index <= nbStations; index++) { + await this.startChargingStation(index, stationTemplateUrl); } - } else { - console.warn( - chalk.yellow("'stationTemplateUrls' not defined or empty in configuration, exiting") + } catch (error) { + console.error( + chalk.red( + `Error at starting charging station with template file ${stationTemplateUrl.file}: ` + ), + error ); - 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)` - : '' - }` - ) - ); - } - this.started = true; - } catch (error) { - console.error(chalk.red('Bootstrap start error '), error); } + 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; } else { console.error(chalk.red('Cannot start an already started charging stations simulator')); } } public async stop(): Promise { - if (isMainThread && this.started) { - await this.workerImplementation.stop(); + if (isMainThread && this.started === true) { + await this.workerImplementation?.stop(); this.workerImplementation = null; this.uiServer?.stop(); await this.storage?.close(); + this.initializedCounters = false; + 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 { await this.stop(); - this.initialize(); await this.start(); } private initializeWorkerImplementation(): void { - !this.workerImplementation && + this.workerImplementation === null && (this.workerImplementation = WorkerFactory.getWorkerImplementation( this.workerScript, Configuration.getWorker().processType, @@ -177,9 +153,7 @@ export default class Bootstrap { poolOptions: { workerChoiceStrategy: Configuration.getWorker().poolStrategy, }, - messageHandler: this.messageHandler.bind(this) as ( - msg: ChargingStationWorkerMessage - ) => void, + messageHandler: this.messageHandler.bind(this) as MessageHandler, } )); } @@ -196,16 +170,16 @@ export default class Bootstrap { // ); try { switch (msg.id) { - case ChargingStationWorkerMessageEvents.STARTED: + case ChargingStationWorkerMessageEvents.started: this.workerEventStarted(msg.data as ChargingStationData); break; - case ChargingStationWorkerMessageEvents.STOPPED: + case ChargingStationWorkerMessageEvents.stopped: this.workerEventStopped(msg.data as ChargingStationData); break; - case ChargingStationWorkerMessageEvents.UPDATED: + case ChargingStationWorkerMessageEvents.updated: this.workerEventUpdated(msg.data as ChargingStationData); break; - case ChargingStationWorkerMessageEvents.PERFORMANCE_STATISTICS: + case ChargingStationWorkerMessageEvents.performanceStatistics: this.workerEventPerformanceStatistics(msg.data as Statistics); break; default: @@ -223,36 +197,82 @@ export default class Bootstrap { } } - private workerEventStarted(data: ChargingStationData) { - this.uiServer?.chargingStations.set(data.hashId, data); + 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.hashId, data); + 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.hashId, data); - } + 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 initializeCounters() { + if (this.initializedCounters === false) { + this.numberOfChargingStationTemplates = 0; + this.numberOfChargingStations = 0; + const stationTemplateUrls = Configuration.getStationTemplateUrls(); + if (Utils.isNotEmptyArray(stationTemplateUrls)) { + this.numberOfChargingStationTemplates = stationTemplateUrls.length; + for (const stationTemplateUrl of stationTemplateUrls) { + 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.initializedCounters = true; + } + } + + 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 { - const workerData: ChargingStationWorkerData = { + await this.workerImplementation?.addElement({ index, templateFile: path.join( path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'), @@ -260,12 +280,10 @@ export default class Bootstrap { 'station-templates', stationTemplateUrl.file ), - }; - await this.workerImplementation.addElement(workerData); - ++this.numberOfChargingStations; + }); } - private logPrefix(): string { + private logPrefix = (): string => { return Utils.logPrefix(' Bootstrap |'); - } + }; }