X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FBootstrap.ts;h=1550f6a7dc8ee92547fda280dbe4f569592f753e;hb=34c200d5d7239aed80b68da98b664b573bf6e8bd;hp=cebd8c8fcf2913e87fbcdf2b63d885d233bcbbee;hpb=0f040ac07b841b0eb9ed5e65d76c85adbb084aa2;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/Bootstrap.ts b/src/charging-station/Bootstrap.ts index cebd8c8f..1550f6a7 100644 --- a/src/charging-station/Bootstrap.ts +++ b/src/charging-station/Bootstrap.ts @@ -1,15 +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 { 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 { @@ -25,12 +27,16 @@ import { 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, WorkerConstants, WorkerFactory } from '../worker'; const moduleName = 'Bootstrap'; @@ -47,9 +53,11 @@ 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; + private stopping: boolean; private readonly workerScript: string; private constructor() { @@ -61,12 +69,14 @@ export class Bootstrap extends EventEmitter { handleUnhandledRejection(); handleUncaughtException(); this.started = false; + this.starting = false; + this.stopping = false; 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())); @@ -74,7 +84,7 @@ export class Bootstrap extends EventEmitter { (this.storage = StorageFactory.getStorage( Configuration.getPerformanceStorage().type, Configuration.getPerformanceStorage().uri, - this.logPrefix() + this.logPrefix(), )); Configuration.setConfigurationChangeCallback(async () => Bootstrap.getInstance().restart()); } @@ -87,72 +97,112 @@ export class Bootstrap extends EventEmitter { } public async start(): Promise { - 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); + if (!isMainThread) { + throw new Error('Cannot start charging stations simulator from worker thread'); + } + if (this.started === false) { + if (this.starting === false) { + this.starting = true; + 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); + } + } catch (error) { + console.error( + chalk.red( + `Error at starting charging station with template file ${stationTemplateUrl.file}: `, + ), + error, + ); } - } catch (error) { - console.error( - chalk.red( - `Error at starting charging station with template file ${stationTemplateUrl.file}: ` + } + 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 ${ + Configuration.workerDynamicPoolInUse() + ? `${Configuration.getWorker().poolMinSize?.toString()}/` + : '' + }${this.workerImplementation?.size}${ + Configuration.workerPoolInUse() + ? `/${Configuration.getWorker().poolMaxSize?.toString()}` + : '' + } worker(s) concurrently running in '${Configuration.getWorker().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', ), - error ); - } + console.info(chalk.green('Worker set/pool information:'), this.workerImplementation?.info); + this.started = true; + this.starting = false; + } else { + console.error(chalk.red('Cannot start an already starting charging stations simulator')); } - 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 ${ - Configuration.workerDynamicPoolInUse() - ? `${Configuration.getWorker().poolMinSize?.toString()}/` - : '' - }${this.workerImplementation?.size}${ - Configuration.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 === true) { - await this.uiServer?.sendInternalRequest( - this.uiServer.buildProtocolRequest( - Utils.generateUUID(), - ProcedureName.STOP_CHARGING_STATION, - Constants.EMPTY_FREEZED_OBJECT - ) - ); - await this.waitForChargingStationsStopped(); - await this.workerImplementation?.stop(); - this.workerImplementation = null; - this.uiServer?.stop(); - await this.storage?.close(); - this.resetCounters(); - this.initializedCounters = false; - this.started = false; + if (!isMainThread) { + throw new Error('Cannot stop charging stations simulator from worker thread'); + } + if (this.started === true) { + if (this.stopping === false) { + this.stopping = true; + await this.uiServer?.sendInternalRequest( + this.uiServer.buildProtocolRequest( + generateUUID(), + ProcedureName.STOP_CHARGING_STATION, + 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(); + await this.storage?.close(); + this.resetCounters(); + this.initializedCounters = false; + this.started = false; + this.stopping = false; + } else { + console.error(chalk.red('Cannot stop an already stopping charging stations simulator')); + } } else { - console.error(chalk.red('Cannot stop a not started charging stations simulator')); + console.error(chalk.red('Cannot stop an already stopped charging stations simulator')); } } @@ -162,6 +212,13 @@ export class Bootstrap extends EventEmitter { } private initializeWorkerImplementation(): void { + let elementsPerWorker: number; + if (Configuration.getWorker()?.elementsPerWorker === 'auto') { + elementsPerWorker = + this.numberOfChargingStations > availableParallelism() + ? Math.round(this.numberOfChargingStations / availableParallelism()) + : 1; + } this.workerImplementation === null && (this.workerImplementation = WorkerFactory.getWorkerImplementation( this.workerScript, @@ -171,17 +228,18 @@ export class Bootstrap extends EventEmitter { elementStartDelay: Configuration.getWorker().elementStartDelay, poolMaxSize: Configuration.getWorker().poolMaxSize, poolMinSize: Configuration.getWorker().poolMinSize, - elementsPerWorker: Configuration.getWorker().elementsPerWorker, + elementsPerWorker: + elementsPerWorker ?? (Configuration.getWorker().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( @@ -208,12 +266,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) { @@ -221,7 +279,7 @@ export class Bootstrap extends EventEmitter { `${this.logPrefix()} ${moduleName}.messageHandler: Error occurred while handling '${ msg.id }' event:`, - error + error, ); } } @@ -234,7 +292,7 @@ export class Bootstrap extends EventEmitter { data.stationInfo.chargingStationId } (hashId: ${data.stationInfo.hashId}) started (${ this.numberOfStartedChargingStations - } started from ${this.numberOfChargingStations})` + } started from ${this.numberOfChargingStations})`, ); }; @@ -246,7 +304,7 @@ export class Bootstrap extends EventEmitter { data.stationInfo.chargingStationId } (hashId: ${data.stationInfo.hashId}) stopped (${ this.numberOfStartedChargingStations - } started from ${this.numberOfChargingStations})` + } started from ${this.numberOfChargingStations})`, ); }; @@ -262,20 +320,20 @@ export class Bootstrap extends EventEmitter { if (this.initializedCounters === false) { this.resetCounters(); const stationTemplateUrls = Configuration.getStationTemplateUrls(); - if (Utils.isNotEmptyArray(stationTemplateUrls)) { + 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); } @@ -291,15 +349,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, ), }); } @@ -316,24 +374,7 @@ export class Bootstrap extends EventEmitter { }); }; - private waitForChargingStationsStopped = async ( - stoppedEventsToWait = this.numberOfStartedChargingStations - ): Promise => { - return new Promise((resolve) => { - let stoppedEvents = 0; - if (stoppedEventsToWait === 0) { - resolve(stoppedEvents); - } - this.on(ChargingStationWorkerMessageEvents.stopped, () => { - ++stoppedEvents; - if (stoppedEvents === stoppedEventsToWait) { - resolve(stoppedEvents); - } - }); - }); - }; - private logPrefix = (): string => { - return Utils.logPrefix(' Bootstrap |'); + return logPrefix(' Bootstrap |'); }; }