X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2FWorkerSet.ts;h=7ddc96c73c27febb8a179a9faa4da6ee01c0615a;hb=c81424b89ca5184eea982c355791f658b4064ce7;hp=da1e5dd5b7b47cbf44291f2aa446ad9b154ae4c7;hpb=8baf3f8f3e3330c90cbd3474b6f5c7d589be17ff;p=e-mobility-charging-stations-simulator.git diff --git a/src/worker/WorkerSet.ts b/src/worker/WorkerSet.ts index da1e5dd5..7ddc96c7 100644 --- a/src/worker/WorkerSet.ts +++ b/src/worker/WorkerSet.ts @@ -1,30 +1,67 @@ // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. -import { Worker } from 'node:worker_threads'; +import { EventEmitter } from 'node:events'; +import { SHARE_ENV, Worker } from 'node:worker_threads'; import { WorkerAbstract } from './WorkerAbstract'; -import { WorkerConstants } from './WorkerConstants'; +import { EMPTY_FUNCTION, workerSetVersion } from './WorkerConstants'; import { - type MessageHandler, + type SetInfo, type WorkerData, + type WorkerMessage, WorkerMessageEvents, type WorkerOptions, type WorkerSetElement, + WorkerSetEvents, } from './WorkerTypes'; -import { defaultErrorHandler, defaultExitHandler, sleep } from './WorkerUtils'; +import { sleep } from './WorkerUtils'; export class WorkerSet extends WorkerAbstract { + public readonly emitter!: EventEmitter; private readonly workerSet: Set; + private started: boolean; + private workerStartup: boolean; /** - * Create a new `WorkerSet`. + * Creates a new `WorkerSet`. * * @param workerScript - * @param workerOptions - */ - constructor(workerScript: string, workerOptions?: WorkerOptions) { + constructor(workerScript: string, workerOptions: WorkerOptions) { super(workerScript, workerOptions); + if ( + this.workerOptions.elementsPerWorker === null || + this.workerOptions.elementsPerWorker === undefined + ) { + throw new TypeError('Elements per worker is not defined'); + } + if (!Number.isSafeInteger(this.workerOptions.elementsPerWorker)) { + throw new TypeError('Elements per worker must be an integer'); + } + if (this.workerOptions.elementsPerWorker <= 0) { + throw new RangeError('Elements per worker must be greater than zero'); + } this.workerSet = new Set(); + if (this.workerOptions.poolOptions?.enableEvents) { + this.emitter = new EventEmitter(); + } + this.started = false; + this.workerStartup = false; + } + + get info(): SetInfo { + return { + version: workerSetVersion, + type: 'set', + worker: 'thread', + size: this.size, + elementsExecuting: [...this.workerSet].reduce( + (accumulator, workerSetElement) => accumulator + workerSetElement.numberOfWorkerElements, + 0, + ), + elementsPerWorker: this.maxElementsPerWorker!, + }; } get size(): number { @@ -35,75 +72,111 @@ export class WorkerSet extends WorkerAbstract { return this.workerOptions.elementsPerWorker; } - /** @inheritDoc */ - public async addElement(elementData: WorkerData): Promise { - if (!this.workerSet) { - throw new Error("Cannot add a WorkerSet element: workers' set does not exist"); - } - let lastWorkerSetElement = this.getLastWorkerSetElement(); - if ( - this.workerSet.size === 0 || - lastWorkerSetElement.numberOfWorkerElements >= this.workerOptions.elementsPerWorker - ) { - this.startWorker(); - // Start worker sequentially to optimize memory at startup - this.workerOptions.workerStartDelay > 0 && (await sleep(this.workerOptions.workerStartDelay)); - lastWorkerSetElement = this.getLastWorkerSetElement(); - } - lastWorkerSetElement.worker.postMessage({ - id: WorkerMessageEvents.startWorkerElement, - data: elementData, - }); - ++lastWorkerSetElement.numberOfWorkerElements; - // Start element sequentially to optimize memory at startup - if (this.workerOptions.elementStartDelay > 0) { - await sleep(this.workerOptions.elementStartDelay); - } - } - /** @inheritDoc */ public async start(): Promise { - this.startWorker(); - // Start worker sequentially to optimize memory at startup - this.workerOptions.workerStartDelay > 0 && (await sleep(this.workerOptions.workerStartDelay)); + this.addWorkerSetElement(); + // Add worker set element sequentially to optimize memory at startup + this.workerOptions.workerStartDelay! > 0 && (await sleep(this.workerOptions.workerStartDelay!)); + this.started = true; } /** @inheritDoc */ public async stop(): Promise { for (const workerSetElement of this.workerSet) { - await workerSetElement.worker.terminate(); + const worker = workerSetElement.worker; + const waitWorkerExit = new Promise((resolve) => { + worker.on('exit', () => { + resolve(); + }); + }); + await worker.terminate(); + await waitWorkerExit; + this.started = false; + } + } + + /** @inheritDoc */ + public async addElement(elementData: WorkerData): Promise { + if (!this.started) { + throw new Error('Cannot add a WorkerSet element: not started'); + } + if (!this.workerSet) { + throw new Error("Cannot add a WorkerSet element: 'workerSet' property does not exist"); + } + const workerSetElement = await this.getWorkerSetElement(); + workerSetElement.worker.postMessage({ + event: WorkerMessageEvents.startWorkerElement, + data: elementData, + }); + ++workerSetElement.numberOfWorkerElements; + // Add element sequentially to optimize memory at startup + if (this.workerOptions.elementStartDelay! > 0) { + await sleep(this.workerOptions.elementStartDelay!); } - this.workerSet.clear(); } /** - * Start a new `Worker`. + * Adds a new `WorkerSetElement`. */ - private startWorker(): void { - const worker = new Worker(this.workerScript); - worker.on( - 'message', - (this.workerOptions?.messageHandler ?? WorkerConstants.EMPTY_FUNCTION).bind( - this - ) as MessageHandler + private addWorkerSetElement(): WorkerSetElement { + this.workerStartup = true; + const worker = new Worker(this.workerScript, { + env: SHARE_ENV, + ...this.workerOptions.poolOptions?.workerOptions, + }); + worker.on('message', this.workerOptions.poolOptions?.messageHandler ?? EMPTY_FUNCTION); + worker.on('message', (message: WorkerMessage) => { + if (message.event === WorkerMessageEvents.startedWorkerElement) { + this.emitter?.emit(WorkerSetEvents.elementStarted, this.info); + } else if (message.event === WorkerMessageEvents.startWorkerElementError) { + this.emitter?.emit(WorkerSetEvents.elementError, message.data); + } + }); + worker.on('error', this.workerOptions.poolOptions?.errorHandler ?? EMPTY_FUNCTION); + worker.on('error', (error) => { + this.emitter?.emit(WorkerSetEvents.error, error); + if ( + this.workerOptions.poolOptions?.restartWorkerOnError && + this.started && + !this.workerStartup + ) { + this.addWorkerSetElement(); + } + }); + worker.on('online', this.workerOptions.poolOptions?.onlineHandler ?? EMPTY_FUNCTION); + worker.on('exit', this.workerOptions.poolOptions?.exitHandler ?? EMPTY_FUNCTION); + worker.once('exit', () => + this.removeWorkerSetElement(this.getWorkerSetElementByWorker(worker)!), ); - worker.on('error', defaultErrorHandler.bind(this) as (err: Error) => void); - worker.on('error', () => this.startWorker()); - worker.on('exit', defaultExitHandler.bind(this) as (exitCode: number) => void); - worker.on('exit', () => this.workerSet.delete(this.getWorkerSetElementByWorker(worker))); - this.workerSet.add({ worker, numberOfWorkerElements: 0 }); + const workerSetElement: WorkerSetElement = { worker, numberOfWorkerElements: 0 }; + this.workerSet.add(workerSetElement); + this.workerStartup = false; + return workerSetElement; + } + + private removeWorkerSetElement(workerSetElement: WorkerSetElement): void { + this.workerSet.delete(workerSetElement); } - private getLastWorkerSetElement(): WorkerSetElement { - let workerSetElement: WorkerSetElement; - for (workerSetElement of this.workerSet) { - /* This is intentional */ + private async getWorkerSetElement(): Promise { + let chosenWorkerSetElement: WorkerSetElement | undefined; + for (const workerSetElement of this.workerSet) { + if (workerSetElement.numberOfWorkerElements < this.workerOptions.elementsPerWorker!) { + chosenWorkerSetElement = workerSetElement; + break; + } } - return workerSetElement; + if (!chosenWorkerSetElement) { + chosenWorkerSetElement = this.addWorkerSetElement(); + // Add worker set element sequentially to optimize memory at startup + this.workerOptions.workerStartDelay! > 0 && + (await sleep(this.workerOptions.workerStartDelay!)); + } + return chosenWorkerSetElement; } - private getWorkerSetElementByWorker(worker: Worker): WorkerSetElement { - let workerSetElt: WorkerSetElement; + private getWorkerSetElementByWorker(worker: Worker): WorkerSetElement | undefined { + let workerSetElt: WorkerSetElement | undefined; for (const workerSetElement of this.workerSet) { if (workerSetElement.worker.threadId === worker.threadId) { workerSetElt = workerSetElement;