X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2FWorkerSet.ts;h=10606d2e498639bb6d0097f2d6c3740465746113;hb=195c627f62717d86ebc1c3dfd4a69f25277ceb70;hp=c5df860ced4fc85b16e7067c805605b05db75e04;hpb=1f7173559059235505c4cca840d2c92a5b2daa6e;p=e-mobility-charging-stations-simulator.git diff --git a/src/worker/WorkerSet.ts b/src/worker/WorkerSet.ts index c5df860c..10606d2e 100644 --- a/src/worker/WorkerSet.ts +++ b/src/worker/WorkerSet.ts @@ -1,10 +1,10 @@ -// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. +// Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved. -import { EventEmitterAsyncResource } from 'node:events'; -import { SHARE_ENV, Worker } from 'node:worker_threads'; +import { EventEmitterAsyncResource } from 'node:events' +import { SHARE_ENV, Worker } from 'node:worker_threads' -import { WorkerAbstract } from './WorkerAbstract'; -import { EMPTY_FUNCTION, workerSetVersion } from './WorkerConstants'; +import { WorkerAbstract } from './WorkerAbstract.js' +import { EMPTY_FUNCTION, workerSetVersion } from './WorkerConstants.js' import { type SetInfo, type WorkerData, @@ -12,15 +12,15 @@ import { WorkerMessageEvents, type WorkerOptions, type WorkerSetElement, - WorkerSetEvents, -} from './WorkerTypes'; -import { randomizeDelay, sleep } from './WorkerUtils'; + WorkerSetEvents +} from './WorkerTypes.js' +import { randomizeDelay, sleep } from './WorkerUtils.js' export class WorkerSet extends WorkerAbstract { - public readonly emitter: EventEmitterAsyncResource | undefined; - private readonly workerSet: Set; - private started: boolean; - private workerStartup: boolean; + public readonly emitter: EventEmitterAsyncResource | undefined + private readonly workerSet: Set + private started: boolean + private workerStartup: boolean /** * Creates a new `WorkerSet`. @@ -28,165 +28,177 @@ export class WorkerSet extends WorkerAbstract { * @param workerScript - * @param 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'); + constructor (workerScript: string, workerOptions: WorkerOptions) { + super(workerScript, workerOptions) + if (this.workerOptions.elementsPerWorker == null) { + 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'); + 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'); + if ( + typeof this.workerOptions.elementsPerWorker === 'number' && + 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 EventEmitterAsyncResource({ name: 'workerset' }); + this.workerSet = new Set() + if (this.workerOptions.poolOptions?.enableEvents === true) { + this.emitter = new EventEmitterAsyncResource({ name: 'workerset' }) } - this.started = false; - this.workerStartup = false; + this.started = false + this.workerStartup = false } - get info(): SetInfo { + get info (): SetInfo { return { version: workerSetVersion, type: 'set', worker: 'thread', + started: this.started, size: this.size, elementsExecuting: [...this.workerSet].reduce( (accumulator, workerSetElement) => accumulator + workerSetElement.numberOfWorkerElements, - 0, + 0 ), - elementsPerWorker: this.maxElementsPerWorker!, - }; + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + elementsPerWorker: this.maxElementsPerWorker! + } } - get size(): number { - return this.workerSet.size; + get size (): number { + return this.workerSet.size } - get maxElementsPerWorker(): number | undefined { - return this.workerOptions.elementsPerWorker; + get maxElementsPerWorker (): number | undefined { + return this.workerOptions.elementsPerWorker } /** @inheritDoc */ - public async start(): Promise { - this.addWorkerSetElement(); + public async start (): Promise { + this.addWorkerSetElement() // Add worker set element sequentially to optimize memory at startup + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion this.workerOptions.workerStartDelay! > 0 && - (await sleep(randomizeDelay(this.workerOptions.workerStartDelay!))); - this.emitter?.emit(WorkerSetEvents.started, this.info); - this.started = true; + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + (await sleep(randomizeDelay(this.workerOptions.workerStartDelay!))) + this.emitter?.emit(WorkerSetEvents.started, this.info) + this.started = true } /** @inheritDoc */ - public async stop(): Promise { + public async stop (): Promise { for (const workerSetElement of this.workerSet) { - const worker = workerSetElement.worker; - const waitWorkerExit = new Promise((resolve) => { + const worker = workerSetElement.worker + const waitWorkerExit = new Promise(resolve => { worker.once('exit', () => { - resolve(); - }); - }); - await worker.terminate(); - await waitWorkerExit; - this.emitter?.emit(WorkerSetEvents.stopped, this.info); - this.emitter?.emitDestroy(); - this.started = false; + resolve() + }) + }) + worker.unref() + await worker.terminate() + await waitWorkerExit } + this.emitter?.emit(WorkerSetEvents.stopped, this.info) + this.started = false + this.emitter?.emitDestroy() } /** @inheritDoc */ - public async addElement(elementData: WorkerData): Promise { + 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"); + throw new Error('Cannot add a WorkerSet element: not started') } - const workerSetElement = await this.getWorkerSetElement(); + const workerSetElement = await this.getWorkerSetElement() workerSetElement.worker.postMessage({ - event: WorkerMessageEvents.startWorkerElement, - data: elementData, - }); - ++workerSetElement.numberOfWorkerElements; + event: WorkerMessageEvents.addWorkerElement, + data: elementData + }) + ++workerSetElement.numberOfWorkerElements // Add element sequentially to optimize memory at startup - if (this.workerOptions.elementStartDelay! > 0) { - await sleep(randomizeDelay(this.workerOptions.elementStartDelay!)); + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + if (this.workerOptions.elementAddDelay! > 0) { + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + await sleep(randomizeDelay(this.workerOptions.elementAddDelay!)) } } /** * Adds a new `WorkerSetElement`. */ - private addWorkerSetElement(): WorkerSetElement { - this.workerStartup = true; + 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); + ...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); + if (message.event === WorkerMessageEvents.addedWorkerElement) { + this.emitter?.emit(WorkerSetEvents.elementAdded, this.info) + } else if (message.event === WorkerMessageEvents.workerElementError) { + 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); + }) + 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.workerOptions.poolOptions?.restartWorkerOnError === true && this.started && !this.workerStartup ) { - this.addWorkerSetElement(); + 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)!), - ); - const workerSetElement: WorkerSetElement = { worker, numberOfWorkerElements: 0 }; - this.workerSet.add(workerSetElement); - this.workerStartup = false; - return workerSetElement; + worker.unref() + worker.terminate().catch((error: unknown) => this.emitter?.emit(WorkerSetEvents.error, error)) + }) + 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)) + }) + 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 removeWorkerSetElement (workerSetElement: WorkerSetElement | undefined): void { + if (workerSetElement == null) { + return + } + this.workerSet.delete(workerSetElement) } - private async getWorkerSetElement(): Promise { - let chosenWorkerSetElement: WorkerSetElement | undefined; + private async getWorkerSetElement (): Promise { + let chosenWorkerSetElement: WorkerSetElement | undefined for (const workerSetElement of this.workerSet) { + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion if (workerSetElement.numberOfWorkerElements < this.workerOptions.elementsPerWorker!) { - chosenWorkerSetElement = workerSetElement; - break; + chosenWorkerSetElement = workerSetElement + break } } - if (!chosenWorkerSetElement) { - chosenWorkerSetElement = this.addWorkerSetElement(); + if (chosenWorkerSetElement == null) { + chosenWorkerSetElement = this.addWorkerSetElement() // Add worker set element sequentially to optimize memory at startup + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion this.workerOptions.workerStartDelay! > 0 && - (await sleep(randomizeDelay(this.workerOptions.workerStartDelay!))); + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + (await sleep(randomizeDelay(this.workerOptions.workerStartDelay!))) } - return chosenWorkerSetElement; + return chosenWorkerSetElement } - private getWorkerSetElementByWorker(worker: Worker): WorkerSetElement | undefined { - let workerSetElt: WorkerSetElement | undefined; + private getWorkerSetElementByWorker (worker: Worker): WorkerSetElement | undefined { + let workerSetElt: WorkerSetElement | undefined for (const workerSetElement of this.workerSet) { if (workerSetElement.worker.threadId === worker.threadId) { - workerSetElt = workerSetElement; - break; + workerSetElt = workerSetElement + break } } - return workerSetElt; + return workerSetElt } }