X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FBootstrap.ts;h=802a944525cc4c824e6a282aa048c20ab6a0e9cc;hb=afbb820255fb5afe908c743ae53ae5a5f990c700;hp=3aab9416ee4555e62f7e268d55d192f9607e95d2;hpb=4bfd80fa794b4b2f89427ef9f5944664ce3bdade;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/Bootstrap.ts b/src/charging-station/Bootstrap.ts index 3aab9416..3993ae1f 100644 --- a/src/charging-station/Bootstrap.ts +++ b/src/charging-station/Bootstrap.ts @@ -1,136 +1,564 @@ -// Partial Copyright Jerome Benoit. 2021. All Rights Reserved. - -import { ChargingStationWorkerData, ChargingStationWorkerMessage, ChargingStationWorkerMessageEvents } from '../types/ChargingStationWorker'; - -import Configuration from '../utils/Configuration'; -import Statistics from '../types/Statistics'; -import { Storage } from '../performance/storage/Storage'; -import { StorageFactory } from '../performance/storage/StorageFactory'; -import { UIServiceUtils } from './ui-websocket-services/UIServiceUtils'; -import UIWebSocketServer from './UIWebSocketServer'; -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'; - -export default class Bootstrap { - private static instance: Bootstrap | null = null; - private workerImplementation: WorkerAbstract | null = null; - private readonly uiWebSocketServer!: UIWebSocketServer; - private readonly storage!: Storage; - private numberOfChargingStations: number; - private readonly version: string = version; - private started: boolean; - private readonly workerScript: string; - - private constructor() { - this.started = false; - this.workerScript = path.join(path.resolve(__dirname, '../'), 'charging-station', 'ChargingStationWorker.js'); - this.initWorkerImplementation(); - Configuration.getUIWebSocketServer().enabled && (this.uiWebSocketServer = new UIWebSocketServer({ - ...Configuration.getUIWebSocketServer().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) { - Bootstrap.instance = new Bootstrap(); +// Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved. + +import { EventEmitter } from 'node:events' +import { dirname, extname, join, parse } from 'node:path' +import process, { exit } from 'node:process' +import { fileURLToPath } from 'node:url' +import { isMainThread } from 'node:worker_threads' +import type { Worker } from 'worker_threads' + +import chalk from 'chalk' +import { type MessageHandler, availableParallelism } from 'poolifier' + +import { waitChargingStationEvents } from './Helpers.js' +import type { AbstractUIServer } from './ui-server/AbstractUIServer.js' +import { UIServerFactory } from './ui-server/UIServerFactory.js' +import { version } from '../../package.json' +import { BaseError } from '../exception/index.js' +import { type Storage, StorageFactory } from '../performance/index.js' +import { + type ChargingStationData, + type ChargingStationOptions, + type ChargingStationWorkerData, + type ChargingStationWorkerEventError, + type ChargingStationWorkerMessage, + type ChargingStationWorkerMessageData, + ChargingStationWorkerMessageEvents, + ConfigurationSection, + ProcedureName, + type Statistics, + type StorageConfiguration, + type UIServerConfiguration, + type WorkerConfiguration +} from '../types/index.js' +import { + Configuration, + Constants, + formatDurationMilliSeconds, + generateUUID, + handleUncaughtException, + handleUnhandledRejection, + isAsyncFunction, + isNotEmptyArray, + logPrefix, + logger +} from '../utils/index.js' +import { type WorkerAbstract, WorkerFactory } from '../worker/index.js' + +const moduleName = 'Bootstrap' + +enum exitCodes { + succeeded = 0, + missingChargingStationsConfiguration = 1, + duplicateChargingStationTemplateUrls = 2, + noChargingStationTemplates = 3, + gracefulShutdownError = 4 +} + +interface TemplateChargingStations { + configured: number + added: number + started: number + indexes: Set +} + +export class Bootstrap extends EventEmitter { + private static instance: Bootstrap | null = null + private workerImplementation?: WorkerAbstract + private readonly uiServer?: AbstractUIServer + private storage?: Storage + private readonly templatesChargingStations: Map + private readonly version: string = version + private initializedCounters: boolean + private started: boolean + private starting: boolean + private stopping: boolean + + private constructor () { + super() + for (const signal of ['SIGINT', 'SIGQUIT', 'SIGTERM']) { + process.on(signal, this.gracefulShutdown.bind(this)) } - return Bootstrap.instance; - } - - public async start(): Promise { - if (isMainThread && !this.started) { - try { - this.numberOfChargingStations = 0; - await this.storage?.open(); - await this.workerImplementation.start(); - this.uiWebSocketServer?.start(); - const stationTemplateUrls = Configuration.getStationTemplateUrls(); - // Start ChargingStation object in worker thread - if (stationTemplateUrls) { - for (const stationTemplateUrl of stationTemplateUrls) { - try { - 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(stationTemplateUrl.file)) - }; - await this.workerImplementation.addElement(workerData); - this.numberOfChargingStations++; - } - } catch (error) { - console.error(chalk.red('Charging station start with template file ' + stationTemplateUrl.file + ' error '), error); - } + // Enable unconditionally for now + handleUnhandledRejection() + handleUncaughtException() + this.started = false + this.starting = false + this.stopping = false + this.templatesChargingStations = new Map() + this.uiServer = UIServerFactory.getUIServerImplementation( + Configuration.getConfigurationSection(ConfigurationSection.uiServer) + ) + this.initializedCounters = false + this.initializeCounters() + Configuration.configurationChangeCallback = async () => { + if (isMainThread) { + await Bootstrap.getInstance().restart() + } + } + } + + public static getInstance (): Bootstrap { + if (Bootstrap.instance === null) { + Bootstrap.instance = new Bootstrap() + } + return Bootstrap.instance + } + + public get numberOfChargingStationTemplates (): number { + return this.templatesChargingStations.size + } + + public get numberOfConfiguredChargingStations (): number { + return [...this.templatesChargingStations.values()].reduce( + (accumulator, value) => accumulator + value.configured, + 0 + ) + } + + public getLastIndex (templateName: string): number { + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + const indexes = [...this.templatesChargingStations.get(templateName)!.indexes] + .concat(0) + .sort((a, b) => a - b) + for (let i = 0; i < indexes.length - 1; i++) { + if (indexes[i + 1] - indexes[i] !== 1) { + return indexes[i] + } + } + return indexes[indexes.length - 1] + } + + public getPerformanceStatistics (): IterableIterator | undefined { + return this.storage?.getPerformanceStatistics() + } + + private get numberOfAddedChargingStations (): number { + return [...this.templatesChargingStations.values()].reduce( + (accumulator, value) => accumulator + value.added, + 0 + ) + } + + private get numberOfStartedChargingStations (): number { + return [...this.templatesChargingStations.values()].reduce( + (accumulator, value) => accumulator + value.started, + 0 + ) + } + + public async start (): Promise { + if (!this.started) { + if (!this.starting) { + this.starting = true + this.on(ChargingStationWorkerMessageEvents.added, this.workerEventAdded) + this.on(ChargingStationWorkerMessageEvents.deleted, this.workerEventDeleted) + this.on(ChargingStationWorkerMessageEvents.started, this.workerEventStarted) + this.on(ChargingStationWorkerMessageEvents.stopped, this.workerEventStopped) + this.on(ChargingStationWorkerMessageEvents.updated, this.workerEventUpdated) + this.on( + ChargingStationWorkerMessageEvents.performanceStatistics, + this.workerEventPerformanceStatistics + ) + this.on( + ChargingStationWorkerMessageEvents.workerElementError, + (eventError: ChargingStationWorkerEventError) => { + logger.error( + `${this.logPrefix()} ${moduleName}.start: Error occurred while handling '${eventError.event}' event on worker:`, + eventError + ) } - } else { - console.warn(chalk.yellow('No stationTemplateUrls defined in configuration, exiting')); + ) + this.initializeCounters() + const workerConfiguration = Configuration.getConfigurationSection( + ConfigurationSection.worker + ) + this.initializeWorkerImplementation(workerConfiguration) + await this.workerImplementation?.start() + const performanceStorageConfiguration = + Configuration.getConfigurationSection( + ConfigurationSection.performanceStorage + ) + if (performanceStorageConfiguration.enabled === true) { + this.storage = StorageFactory.getStorage( + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + performanceStorageConfiguration.type!, + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + performanceStorageConfiguration.uri!, + this.logPrefix() + ) + await this.storage?.open() } - 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 ${this.numberOfChargingStations.toString()} charging station(s) and ${Utils.workerDynamicPoolInUse() ? `${Configuration.getWorkerPoolMinSize().toString()}/` : ''}${this.workerImplementation.size}${Utils.workerPoolInUse() ? `/${Configuration.getWorkerPoolMaxSize().toString()}` : ''} worker(s) concurrently running in '${Configuration.getWorkerProcess()}' mode${this.workerImplementation.maxElementsPerWorker ? ` (${this.workerImplementation.maxElementsPerWorker} charging station(s) per worker)` : ''}`)); + Configuration.getConfigurationSection(ConfigurationSection.uiServer) + .enabled === true && this.uiServer?.start() + // Start ChargingStation object instance in worker thread + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + for (const stationTemplateUrl of Configuration.getStationTemplateUrls()!) { + try { + const nbStations = + this.templatesChargingStations.get(parse(stationTemplateUrl.file).name)?.configured ?? + stationTemplateUrl.numberOfStations + for (let index = 1; index <= nbStations; index++) { + await this.addChargingStation(index, stationTemplateUrl.file) + } + } catch (error) { + console.error( + chalk.red( + `Error at starting charging station with template file ${stationTemplateUrl.file}: ` + ), + error + ) + } } - 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.numberOfConfiguredChargingStations} configured charging station(s) from ${this.numberOfChargingStationTemplates} charging station template(s) and ${ + Configuration.workerDynamicPoolInUse() ? `${workerConfiguration.poolMinSize}/` : '' + }${this.workerImplementation?.size}${ + Configuration.workerPoolInUse() ? `/${workerConfiguration.poolMaxSize}` : '' + } worker(s) concurrently running in '${workerConfiguration.processType}' mode${ + this.workerImplementation?.maxElementsPerWorker != null + ? ` (${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 fixed pool or worker set mode instead' + ) + ) + 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')) } } else { - console.error(chalk.red('Cannot start an already started charging stations simulator')); + console.error(chalk.red('Cannot start an already started charging stations simulator')) } } - public async stop(): Promise { - if (isMainThread && this.started) { - await this.workerImplementation.stop(); - this.uiWebSocketServer?.stop(); - await this.storage?.close(); + public async stop (): Promise { + if (this.started) { + if (!this.stopping) { + this.stopping = true + await this.uiServer?.sendInternalRequest( + this.uiServer.buildProtocolRequest( + generateUUID(), + ProcedureName.STOP_CHARGING_STATION, + Constants.EMPTY_FROZEN_OBJECT + ) + ) + try { + await this.waitChargingStationsStopped() + } catch (error) { + console.error(chalk.red('Error while waiting for charging stations to stop: '), error) + } + await this.workerImplementation?.stop() + delete this.workerImplementation + this.removeAllListeners() + await this.storage?.close() + delete this.storage + this.started = false + this.stopping = false + } else { + console.error(chalk.red('Cannot stop an already stopping charging stations simulator')) + } } else { - console.error(chalk.red('Trying to stop the charging stations simulator while not started')); + console.error(chalk.red('Cannot stop an already stopped charging stations simulator')) } - this.started = false; } - public async restart(): Promise { - await this.stop(); - this.initWorkerImplementation(); - await this.start(); + private async restart (): Promise { + await this.stop() + Configuration.getConfigurationSection(ConfigurationSection.uiServer) + .enabled !== true && this.uiServer?.stop() + this.initializedCounters = false + await this.start() } - private initWorkerImplementation(): void { - this.workerImplementation = WorkerFactory.getWorkerImplementation(this.workerScript, Configuration.getWorkerProcess(), + private async waitChargingStationsStopped (): Promise { + return await new Promise((resolve, reject) => { + const waitTimeout = setTimeout(() => { + const timeoutMessage = `Timeout ${formatDurationMilliSeconds( + Constants.STOP_CHARGING_STATIONS_TIMEOUT + )} reached at stopping charging stations` + console.warn(chalk.yellow(timeoutMessage)) + reject(new Error(timeoutMessage)) + }, Constants.STOP_CHARGING_STATIONS_TIMEOUT) + waitChargingStationEvents( + this, + ChargingStationWorkerMessageEvents.stopped, + this.numberOfStartedChargingStations + ) + .then(() => { + resolve('Charging stations stopped') + }) + .catch(reject) + .finally(() => { + clearTimeout(waitTimeout) + }) + }) + } + + private initializeWorkerImplementation (workerConfiguration: WorkerConfiguration): void { + if (!isMainThread) { + return + } + let elementsPerWorker: number + switch (workerConfiguration.elementsPerWorker) { + case 'all': + elementsPerWorker = this.numberOfConfiguredChargingStations + break + case 'auto': + default: + elementsPerWorker = + this.numberOfConfiguredChargingStations > availableParallelism() + ? Math.round(this.numberOfConfiguredChargingStations / (availableParallelism() * 1.5)) + : 1 + break + } + this.workerImplementation = WorkerFactory.getWorkerImplementation( + join( + dirname(fileURLToPath(import.meta.url)), + `ChargingStationWorker${extname(fileURLToPath(import.meta.url))}` + ), + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + workerConfiguration.processType!, { - workerStartDelay: Configuration.getWorkerStartDelay(), - elementStartDelay: Configuration.getElementStartDelay(), - poolMaxSize: Configuration.getWorkerPoolMaxSize(), - poolMinSize: Configuration.getWorkerPoolMinSize(), - elementsPerWorker: Configuration.getChargingStationsPerWorker(), + workerStartDelay: workerConfiguration.startDelay, + elementStartDelay: workerConfiguration.elementStartDelay, + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + poolMaxSize: workerConfiguration.poolMaxSize!, + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + poolMinSize: workerConfiguration.poolMinSize!, + elementsPerWorker, poolOptions: { - workerChoiceStrategy: Configuration.getWorkerPoolStrategy() - }, - messageHandler: async (msg: ChargingStationWorkerMessage) => { - if (msg.id === ChargingStationWorkerMessageEvents.STARTED) { - this.uiWebSocketServer.chargingStations.add(msg.data.id as string); - } else if (msg.id === ChargingStationWorkerMessageEvents.STOPPED) { - this.uiWebSocketServer.chargingStations.delete(msg.data.id as string); - } else if (msg.id === ChargingStationWorkerMessageEvents.PERFORMANCE_STATISTICS) { - await this.storage.storePerformanceStatistics(msg.data as unknown as Statistics); - } + messageHandler: this.messageHandler.bind(this) as MessageHandler, + workerOptions: { resourceLimits: workerConfiguration.resourceLimits } } - }); + } + ) + } + + private messageHandler ( + msg: ChargingStationWorkerMessage + ): void { + // logger.debug( + // `${this.logPrefix()} ${moduleName}.messageHandler: Worker channel message received: ${JSON.stringify( + // msg, + // undefined, + // 2 + // )}` + // ) + try { + switch (msg.event) { + case ChargingStationWorkerMessageEvents.added: + this.emit(ChargingStationWorkerMessageEvents.added, msg.data) + break + case ChargingStationWorkerMessageEvents.deleted: + this.emit(ChargingStationWorkerMessageEvents.deleted, msg.data) + break + case ChargingStationWorkerMessageEvents.started: + this.emit(ChargingStationWorkerMessageEvents.started, msg.data) + break + case ChargingStationWorkerMessageEvents.stopped: + this.emit(ChargingStationWorkerMessageEvents.stopped, msg.data) + break + case ChargingStationWorkerMessageEvents.updated: + this.emit(ChargingStationWorkerMessageEvents.updated, msg.data) + break + case ChargingStationWorkerMessageEvents.performanceStatistics: + this.emit(ChargingStationWorkerMessageEvents.performanceStatistics, msg.data) + break + case ChargingStationWorkerMessageEvents.addedWorkerElement: + this.emit(ChargingStationWorkerMessageEvents.addWorkerElement, msg.data) + break + case ChargingStationWorkerMessageEvents.workerElementError: + this.emit(ChargingStationWorkerMessageEvents.workerElementError, msg.data) + break + default: + throw new BaseError( + `Unknown charging station worker event: '${ + msg.event + }' received with data: ${JSON.stringify(msg.data, undefined, 2)}` + ) + } + } catch (error) { + logger.error( + `${this.logPrefix()} ${moduleName}.messageHandler: Error occurred while handling '${ + msg.event + }' event:`, + error + ) + } + } + + private readonly workerEventAdded = (data: ChargingStationData): void => { + this.uiServer?.chargingStations.set(data.stationInfo.hashId, data) + logger.info( + `${this.logPrefix()} ${moduleName}.workerEventAdded: Charging station ${ + data.stationInfo.chargingStationId + } (hashId: ${data.stationInfo.hashId}) added (${ + this.numberOfAddedChargingStations + } added from ${this.numberOfConfiguredChargingStations} configured charging station(s))` + ) + } + + private readonly workerEventDeleted = (data: ChargingStationData): void => { + this.uiServer?.chargingStations.delete(data.stationInfo.hashId) + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + const templateChargingStations = this.templatesChargingStations.get( + data.stationInfo.templateName + )! + --templateChargingStations.added + templateChargingStations.indexes.delete(data.stationInfo.templateIndex) + logger.info( + `${this.logPrefix()} ${moduleName}.workerEventDeleted: Charging station ${ + data.stationInfo.chargingStationId + } (hashId: ${data.stationInfo.hashId}) deleted (${ + this.numberOfAddedChargingStations + } added from ${this.numberOfConfiguredChargingStations} configured charging station(s))` + ) + } + + private readonly workerEventStarted = (data: ChargingStationData): void => { + this.uiServer?.chargingStations.set(data.stationInfo.hashId, data) + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + ++this.templatesChargingStations.get(data.stationInfo.templateName)!.started + logger.info( + `${this.logPrefix()} ${moduleName}.workerEventStarted: Charging station ${ + data.stationInfo.chargingStationId + } (hashId: ${data.stationInfo.hashId}) started (${ + this.numberOfStartedChargingStations + } started from ${this.numberOfAddedChargingStations} added charging station(s))` + ) + } + + private readonly workerEventStopped = (data: ChargingStationData): void => { + this.uiServer?.chargingStations.set(data.stationInfo.hashId, data) + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + --this.templatesChargingStations.get(data.stationInfo.templateName)!.started + logger.info( + `${this.logPrefix()} ${moduleName}.workerEventStopped: Charging station ${ + data.stationInfo.chargingStationId + } (hashId: ${data.stationInfo.hashId}) stopped (${ + this.numberOfStartedChargingStations + } started from ${this.numberOfAddedChargingStations} added charging station(s))` + ) + } + + private readonly workerEventUpdated = (data: ChargingStationData): void => { + this.uiServer?.chargingStations.set(data.stationInfo.hashId, data) + } + + private readonly workerEventPerformanceStatistics = (data: Statistics): void => { + // eslint-disable-next-line @typescript-eslint/unbound-method + if (isAsyncFunction(this.storage?.storePerformanceStatistics)) { + ( + this.storage.storePerformanceStatistics as ( + performanceStatistics: Statistics + ) => Promise + )(data).catch(Constants.EMPTY_FUNCTION) + } else { + (this.storage?.storePerformanceStatistics as (performanceStatistics: Statistics) => void)( + data + ) + } + } + + private initializeCounters (): void { + if (!this.initializedCounters) { + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + const stationTemplateUrls = Configuration.getStationTemplateUrls()! + if (isNotEmptyArray(stationTemplateUrls)) { + for (const stationTemplateUrl of stationTemplateUrls) { + const templateName = parse(stationTemplateUrl.file).name + this.templatesChargingStations.set(templateName, { + configured: stationTemplateUrl.numberOfStations, + added: 0, + started: 0, + indexes: new Set() + }) + this.uiServer?.chargingStationTemplates.add(templateName) + } + if (this.templatesChargingStations.size !== stationTemplateUrls.length) { + console.error( + chalk.red( + "'stationTemplateUrls' contains duplicate entries, please check your configuration" + ) + ) + exit(exitCodes.duplicateChargingStationTemplateUrls) + } + } else { + console.error( + chalk.red("'stationTemplateUrls' not defined or empty, please check your configuration") + ) + exit(exitCodes.missingChargingStationsConfiguration) + } + if ( + this.numberOfConfiguredChargingStations === 0 && + Configuration.getConfigurationSection(ConfigurationSection.uiServer) + .enabled !== true + ) { + console.error( + chalk.red( + "'stationTemplateUrls' has no charging station enabled and UI server is disabled, please check your configuration" + ) + ) + exit(exitCodes.noChargingStationTemplates) + } + this.initializedCounters = true + } + } + + public async addChargingStation ( + index: number, + stationTemplateFile: string, + options?: ChargingStationOptions + ): Promise { + await this.workerImplementation?.addElement({ + index, + templateFile: join( + dirname(fileURLToPath(import.meta.url)), + 'assets', + 'station-templates', + stationTemplateFile + ), + options + }) + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + const templateChargingStations = this.templatesChargingStations.get( + parse(stationTemplateFile).name + )! + ++templateChargingStations.added + templateChargingStations.indexes.add(index) + } + + private gracefulShutdown (): void { + this.stop() + .then(() => { + console.info(chalk.green('Graceful shutdown')) + this.uiServer?.stop() + this.waitChargingStationsStopped() + .then(() => { + exit(exitCodes.succeeded) + }) + .catch(() => { + exit(exitCodes.gracefulShutdownError) + }) + }) + .catch(error => { + console.error(chalk.red('Error while shutdowning charging stations simulator: '), error) + exit(exitCodes.gracefulShutdownError) + }) } - private logPrefix(): string { - return Utils.logPrefix(' Bootstrap |'); + private readonly logPrefix = (): string => { + return logPrefix(' Bootstrap |') } }