-// 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 { WorkerConstants } from './WorkerConstants';
+import { WorkerAbstract } from './WorkerAbstract.js'
+import { EMPTY_FUNCTION, workerSetVersion } from './WorkerConstants.js'
import {
type SetInfo,
type WorkerData,
+ type WorkerMessage,
WorkerMessageEvents,
type WorkerOptions,
type WorkerSetElement,
- WorkerSetEvents,
-} from './WorkerTypes';
-import { sleep } from './WorkerUtils';
+ WorkerSetEvents
+} from './WorkerTypes.js'
+import { randomizeDelay, sleep } from './WorkerUtils.js'
export class WorkerSet extends WorkerAbstract<WorkerData> {
- public readonly emitter: EventEmitterAsyncResource;
- private readonly workerSet: Set<WorkerSetElement>;
+ public readonly emitter: EventEmitterAsyncResource | undefined
+ private readonly workerSet: Set<WorkerSetElement>
+ private started: boolean
+ private workerStartup: boolean
/**
- * Create a new `WorkerSet`.
+ * Creates a new `WorkerSet`.
*
* @param workerScript -
* @param workerOptions -
*/
- constructor(workerScript: string, workerOptions?: WorkerOptions) {
- super(workerScript, workerOptions);
- this.workerOptions.poolOptions = {
- ...{
- enableEvents: true,
- restartWorkerOnError: true,
- },
- ...this.workerOptions.poolOptions,
- };
- this.workerSet = new Set<WorkerSetElement>();
- if (this.workerOptions?.poolOptions?.enableEvents) {
- this.emitter = new EventEmitterAsyncResource();
+ 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')
+ }
+ if (this.workerOptions.elementsPerWorker <= 0) {
+ throw new RangeError('Elements per worker must be greater than zero')
+ }
+ this.workerSet = new Set<WorkerSetElement>()
+ if (this.workerOptions.poolOptions?.enableEvents === true) {
+ this.emitter = new EventEmitterAsyncResource({ name: 'workerset' })
+ }
+ 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
),
- 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<void> {
- this.addWorkerSetElement();
+ public async start (): Promise<void> {
+ this.addWorkerSetElement()
// Add worker set element sequentially to optimize memory at startup
- this.workerOptions.workerStartDelay > 0 && (await sleep(this.workerOptions.workerStartDelay));
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.workerOptions.workerStartDelay! > 0 &&
+ // 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<void> {
+ public async stop (): Promise<void> {
for (const workerSetElement of this.workerSet) {
- await workerSetElement.worker.terminate();
+ const worker = workerSetElement.worker
+ const waitWorkerExit = new Promise<void>(resolve => {
+ worker.once('exit', () => {
+ resolve()
+ })
+ })
+ worker.unref()
+ await worker.terminate()
+ await waitWorkerExit
}
- this.workerSet.clear();
+ this.emitter?.emit(WorkerSetEvents.stopped, this.info)
+ this.started = false
+ this.emitter?.emitDestroy()
}
/** @inheritDoc */
- public async addElement(elementData: WorkerData): Promise<void> {
- if (!this.workerSet) {
- throw new Error("Cannot add a WorkerSet element: workers' set does not exist");
+ public async addElement (elementData: WorkerData): Promise<void> {
+ if (!this.started) {
+ throw new Error('Cannot add a WorkerSet element: not started')
}
- const workerSetElement = await this.getWorkerSetElement();
+ const workerSetElement = await this.getWorkerSetElement()
workerSetElement.worker.postMessage({
- id: 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(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!))
}
}
/**
- * Add a new `WorkerSetElement`.
+ * Adds a new `WorkerSetElement`.
*/
- private addWorkerSetElement(): WorkerSetElement {
+ 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 ?? WorkerConstants.EMPTY_FUNCTION
- );
- worker.on(
- 'error',
- this.workerOptions?.poolOptions?.errorHandler ?? WorkerConstants.EMPTY_FUNCTION
- );
- worker.on('error', (error) => {
- if (this.emitter !== undefined) {
- this.emitter.emit(WorkerSetEvents.error, error);
+ ...this.workerOptions.poolOptions?.workerOptions
+ })
+ worker.on('message', this.workerOptions.poolOptions?.messageHandler ?? EMPTY_FUNCTION)
+ worker.on('message', (message: WorkerMessage<WorkerData>) => {
+ 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)
}
- if (this.workerOptions?.poolOptions?.restartWorkerOnError) {
- this.addWorkerSetElement();
+ })
+ worker.on('error', this.workerOptions.poolOptions?.errorHandler ?? EMPTY_FUNCTION)
+ worker.on('error', error => {
+ this.emitter?.emit(WorkerSetEvents.error, error)
+ if (
+ this.workerOptions.poolOptions?.restartWorkerOnError === true &&
+ this.started &&
+ !this.workerStartup
+ ) {
+ this.addWorkerSetElement()
}
- });
- worker.on(
- 'online',
- this.workerOptions?.poolOptions?.onlineHandler ?? WorkerConstants.EMPTY_FUNCTION
- );
- worker.on(
- 'exit',
- this.workerOptions?.poolOptions?.exitHandler ?? WorkerConstants.EMPTY_FUNCTION
- );
- worker.once('exit', () => this.workerSet.delete(this.getWorkerSetElementByWorker(worker)));
- const workerSetElement: WorkerSetElement = { worker, numberOfWorkerElements: 0 };
- this.workerSet.add(workerSetElement);
- 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 | undefined): void {
+ if (workerSetElement == null) {
+ return
+ }
+ this.workerSet.delete(workerSetElement)
}
- private async getWorkerSetElement(): Promise<WorkerSetElement> {
- let chosenWorkerSetElement: WorkerSetElement;
+ private async getWorkerSetElement (): Promise<WorkerSetElement> {
+ let chosenWorkerSetElement: WorkerSetElement | undefined
for (const workerSetElement of this.workerSet) {
- if (workerSetElement.numberOfWorkerElements < this.workerOptions.elementsPerWorker) {
- chosenWorkerSetElement = workerSetElement;
- break;
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ if (workerSetElement.numberOfWorkerElements < this.workerOptions.elementsPerWorker!) {
+ chosenWorkerSetElement = workerSetElement
+ break
}
}
- if (!chosenWorkerSetElement) {
- chosenWorkerSetElement = this.addWorkerSetElement();
+ if (chosenWorkerSetElement == null) {
+ chosenWorkerSetElement = this.addWorkerSetElement()
// Add worker set element sequentially to optimize memory at startup
- this.workerOptions.workerStartDelay > 0 && (await sleep(this.workerOptions.workerStartDelay));
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.workerOptions.workerStartDelay! > 0 &&
+ // 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;
+ 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
}
}