X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FBootstrap.ts;h=2c5d6a7d532b7f7d1eefabd17d8e8923b0c8e08f;hb=42371a2ed3ad187c91417fa759fd260ae86dee7c;hp=b59d925fb233202461ba71d2d07a9d9d3c7f5c01;hpb=399cbb1463bd05cea2cf29df0360e6fa6d446400;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/Bootstrap.ts b/src/charging-station/Bootstrap.ts index b59d925f..2c5d6a7d 100644 --- a/src/charging-station/Bootstrap.ts +++ b/src/charging-station/Bootstrap.ts @@ -1,16 +1,17 @@ // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. import { EventEmitter } from 'node:events'; -import path from 'node:path'; +import { dirname, extname, join } from 'node:path'; import { fileURLToPath } from 'node:url'; -import { type Worker, isMainThread } from 'node:worker_threads'; +import { isMainThread } from 'node:worker_threads'; import chalk from 'chalk'; +import { availableParallelism } from 'poolifier'; -import { ChargingStationUtils } from './ChargingStationUtils'; +import { waitChargingStationEvents } from './ChargingStationUtils'; import type { AbstractUIServer } from './ui-server/AbstractUIServer'; import { UIServerFactory } from './ui-server/UIServerFactory'; -import packageJson from '../../package.json' assert { type: 'json' }; +import { version } from '../../package.json' assert { type: 'json' }; import { BaseError } from '../exception'; import { type Storage, StorageFactory } from '../performance'; import { @@ -19,19 +20,27 @@ import { type ChargingStationWorkerMessage, type ChargingStationWorkerMessageData, ChargingStationWorkerMessageEvents, + ConfigurationSection, ProcedureName, type StationTemplateUrl, type Statistics, + type StorageConfiguration, + type UIServerConfiguration, + type WorkerConfiguration, } from '../types'; import { Configuration, Constants, - Utils, + formatDurationMilliSeconds, + generateUUID, handleUncaughtException, handleUnhandledRejection, + isNotEmptyArray, + isNullOrUndefined, + logPrefix, logger, } from '../utils'; -import { type MessageHandler, type WorkerAbstract, WorkerFactory } from '../worker'; +import { type WorkerAbstract, WorkerFactory } from '../worker'; const moduleName = 'Bootstrap'; @@ -48,7 +57,7 @@ export class Bootstrap extends EventEmitter { private readonly uiServer!: AbstractUIServer | null; private readonly storage!: Storage; private numberOfStartedChargingStations!: number; - private readonly version: string = packageJson.version; + private readonly version: string = version; private initializedCounters: boolean; private started: boolean; private starting: boolean; @@ -69,17 +78,26 @@ export class Bootstrap extends EventEmitter { this.initializedCounters = false; this.initializeCounters(); this.workerImplementation = null; - this.workerScript = path.join( - path.dirname(fileURLToPath(import.meta.url)), - `ChargingStationWorker${path.extname(fileURLToPath(import.meta.url))}` + this.workerScript = join( + dirname(fileURLToPath(import.meta.url)), + `ChargingStationWorker${extname(fileURLToPath(import.meta.url))}`, ); - Configuration.getUIServer().enabled === true && - (this.uiServer = UIServerFactory.getUIServerImplementation(Configuration.getUIServer())); - Configuration.getPerformanceStorage().enabled === true && + Configuration.getConfigurationSection(ConfigurationSection.uiServer) + .enabled === true && + (this.uiServer = UIServerFactory.getUIServerImplementation( + Configuration.getConfigurationSection(ConfigurationSection.uiServer), + )); + Configuration.getConfigurationSection( + ConfigurationSection.performanceStorage, + ).enabled === true && (this.storage = StorageFactory.getStorage( - Configuration.getPerformanceStorage().type, - Configuration.getPerformanceStorage().uri, - this.logPrefix() + Configuration.getConfigurationSection( + ConfigurationSection.performanceStorage, + ).type!, + Configuration.getConfigurationSection( + ConfigurationSection.performanceStorage, + ).uri!, + this.logPrefix(), )); Configuration.setConfigurationChangeCallback(async () => Bootstrap.getInstance().restart()); } @@ -104,7 +122,7 @@ export class Bootstrap extends EventEmitter { await this.storage?.open(); this.uiServer?.start(); // Start ChargingStation object instance in worker thread - for (const stationTemplateUrl of Configuration.getStationTemplateUrls()) { + for (const stationTemplateUrl of Configuration.getStationTemplateUrls()!) { try { const nbStations = stationTemplateUrl.numberOfStations ?? 0; for (let index = 1; index <= nbStations; index++) { @@ -113,9 +131,9 @@ export class Bootstrap extends EventEmitter { } catch (error) { console.error( chalk.red( - `Error at starting charging station with template file ${stationTemplateUrl.file}: ` + `Error at starting charging station with template file ${stationTemplateUrl.file}: `, ), - error + error, ); } } @@ -125,19 +143,34 @@ export class Bootstrap extends EventEmitter { this.version } started with ${this.numberOfChargingStations.toString()} charging station(s) from ${this.numberOfChargingStationTemplates.toString()} configured charging station template(s) and ${ Configuration.workerDynamicPoolInUse() - ? `${Configuration.getWorker().poolMinSize?.toString()}/` + ? `${Configuration.getConfigurationSection( + ConfigurationSection.worker, + ).poolMinSize?.toString()}/` : '' }${this.workerImplementation?.size}${ Configuration.workerPoolInUse() - ? `/${Configuration.getWorker().poolMaxSize?.toString()}` + ? `/${Configuration.getConfigurationSection( + ConfigurationSection.worker, + ).poolMaxSize?.toString()}` : '' - } worker(s) concurrently running in '${Configuration.getWorker().processType}' mode${ - !Utils.isNullOrUndefined(this.workerImplementation?.maxElementsPerWorker) + } worker(s) concurrently running in '${ + Configuration.getConfigurationSection( + ConfigurationSection.worker, + ).processType + }' mode${ + !isNullOrUndefined(this.workerImplementation?.maxElementsPerWorker) ? ` (${this.workerImplementation?.maxElementsPerWorker} charging station(s) per worker)` : '' - }` - ) + }`, + ), ); + Configuration.workerDynamicPoolInUse() && + console.warn( + chalk.yellow( + 'Charging stations simulator is using dynamic pool mode. This is an experimental feature with known issues.\nPlease consider using static pool or worker set mode instead', + ), + ); + console.info(chalk.green('Worker set/pool information:'), this.workerImplementation?.info); this.started = true; this.starting = false; } else { @@ -157,16 +190,27 @@ export class Bootstrap extends EventEmitter { this.stopping = true; await this.uiServer?.sendInternalRequest( this.uiServer.buildProtocolRequest( - Utils.generateUUID(), + generateUUID(), ProcedureName.STOP_CHARGING_STATION, - Constants.EMPTY_FREEZED_OBJECT - ) - ); - await ChargingStationUtils.waitForChargingStationEvents( - this, - ChargingStationWorkerMessageEvents.stopped, - this.numberOfChargingStations + Constants.EMPTY_FREEZED_OBJECT, + ), ); + await Promise.race([ + waitChargingStationEvents( + this, + ChargingStationWorkerMessageEvents.stopped, + this.numberOfChargingStations, + ), + new Promise((resolve) => { + setTimeout(() => { + const message = `Timeout reached ${formatDurationMilliSeconds( + Constants.STOP_SIMULATOR_TIMEOUT, + )} at stopping charging stations simulator`; + console.warn(chalk.yellow(message)); + resolve(message); + }, Constants.STOP_SIMULATOR_TIMEOUT); + }), + ]); await this.workerImplementation?.stop(); this.workerImplementation = null; this.uiServer?.stop(); @@ -189,33 +233,54 @@ export class Bootstrap extends EventEmitter { } private initializeWorkerImplementation(): void { + let elementsPerWorker: number | undefined; + if ( + Configuration.getConfigurationSection(ConfigurationSection.worker) + ?.elementsPerWorker === 'auto' + ) { + elementsPerWorker = + this.numberOfChargingStations > availableParallelism() + ? Math.round(this.numberOfChargingStations / availableParallelism()) + : 1; + } this.workerImplementation === null && (this.workerImplementation = WorkerFactory.getWorkerImplementation( this.workerScript, - Configuration.getWorker().processType, + Configuration.getConfigurationSection(ConfigurationSection.worker) + .processType!, { - workerStartDelay: Configuration.getWorker().startDelay, - elementStartDelay: Configuration.getWorker().elementStartDelay, - poolMaxSize: Configuration.getWorker().poolMaxSize, - poolMinSize: Configuration.getWorker().poolMinSize, - elementsPerWorker: Configuration.getWorker().elementsPerWorker, + workerStartDelay: Configuration.getConfigurationSection( + ConfigurationSection.worker, + ).startDelay, + elementStartDelay: Configuration.getConfigurationSection( + ConfigurationSection.worker, + ).elementStartDelay, + poolMaxSize: Configuration.getConfigurationSection( + ConfigurationSection.worker, + ).poolMaxSize!, + poolMinSize: Configuration.getConfigurationSection( + ConfigurationSection.worker, + ).poolMinSize!, + elementsPerWorker: + elementsPerWorker ?? + (Configuration.getConfigurationSection(ConfigurationSection.worker) + .elementsPerWorker as number), poolOptions: { - workerChoiceStrategy: Configuration.getWorker().poolStrategy, + messageHandler: this.messageHandler.bind(this) as (message: unknown) => void, }, - messageHandler: this.messageHandler.bind(this) as MessageHandler, - } + }, )); } private messageHandler( - msg: ChargingStationWorkerMessage + msg: ChargingStationWorkerMessage, ): void { // logger.debug( // `${this.logPrefix()} ${moduleName}.messageHandler: Worker channel message received: ${JSON.stringify( // msg, // null, - // 2 - // )}` + // 2, + // )}`, // ); try { switch (msg.id) { @@ -235,12 +300,12 @@ export class Bootstrap extends EventEmitter { this.workerEventPerformanceStatistics(msg.data as Statistics); this.emit( ChargingStationWorkerMessageEvents.performanceStatistics, - msg.data as Statistics + msg.data as Statistics, ); break; default: throw new BaseError( - `Unknown event type: '${msg.id}' for data: ${JSON.stringify(msg.data, null, 2)}` + `Unknown event type: '${msg.id}' for data: ${JSON.stringify(msg.data, null, 2)}`, ); } } catch (error) { @@ -248,7 +313,7 @@ export class Bootstrap extends EventEmitter { `${this.logPrefix()} ${moduleName}.messageHandler: Error occurred while handling '${ msg.id }' event:`, - error + error, ); } } @@ -261,7 +326,7 @@ export class Bootstrap extends EventEmitter { data.stationInfo.chargingStationId } (hashId: ${data.stationInfo.hashId}) started (${ this.numberOfStartedChargingStations - } started from ${this.numberOfChargingStations})` + } started from ${this.numberOfChargingStations})`, ); }; @@ -273,7 +338,7 @@ export class Bootstrap extends EventEmitter { data.stationInfo.chargingStationId } (hashId: ${data.stationInfo.hashId}) stopped (${ this.numberOfStartedChargingStations - } started from ${this.numberOfChargingStations})` + } started from ${this.numberOfChargingStations})`, ); }; @@ -288,21 +353,21 @@ export class Bootstrap extends EventEmitter { private initializeCounters() { if (this.initializedCounters === false) { this.resetCounters(); - const stationTemplateUrls = Configuration.getStationTemplateUrls(); - if (Utils.isNotEmptyArray(stationTemplateUrls)) { + const stationTemplateUrls = Configuration.getStationTemplateUrls()!; + if (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") + 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') + chalk.yellow('No charging station template enabled in configuration, exiting'), ); process.exit(exitCodes.noChargingStationTemplates); } @@ -318,15 +383,15 @@ export class Bootstrap extends EventEmitter { private async startChargingStation( index: number, - stationTemplateUrl: StationTemplateUrl + stationTemplateUrl: StationTemplateUrl, ): Promise { await this.workerImplementation?.addElement({ index, - templateFile: path.join( - path.dirname(fileURLToPath(import.meta.url)), + templateFile: join( + dirname(fileURLToPath(import.meta.url)), 'assets', 'station-templates', - stationTemplateUrl.file + stationTemplateUrl.file, ), }); } @@ -344,6 +409,6 @@ export class Bootstrap extends EventEmitter { }; private logPrefix = (): string => { - return Utils.logPrefix(' Bootstrap |'); + return logPrefix(' Bootstrap |'); }; }