-import { WorkerData, WorkerEvents, WorkerSetElement } from '../types/Worker';
+// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
-import Constants from '../utils/Constants';
-import Utils from '../utils/Utils';
-import { Worker } from 'worker_threads';
-import Wrk from './Wrk';
+import { Worker } from 'node:worker_threads';
-export default class WorkerSet extends Wrk {
- public maxElementsPerWorker: number;
- private workers: Set<WorkerSetElement>;
+import { WorkerAbstract } from './WorkerAbstract';
+import {
+ type MessageHandler,
+ type WorkerData,
+ WorkerMessageEvents,
+ type WorkerOptions,
+ type WorkerSetElement,
+} from './WorkerTypes';
+import { WorkerUtils } from './WorkerUtils';
+
+export class WorkerSet extends WorkerAbstract<WorkerData> {
+ private readonly workerSet: Set<WorkerSetElement>;
/**
* Create a new `WorkerSet`.
*
- * @param {string} workerScript
- * @param {number} maxElementsPerWorker
+ * @param workerScript -
+ * @param workerOptions -
*/
- constructor(workerScript: string, maxElementsPerWorker = 1) {
- super(workerScript);
- this.workers = new Set<WorkerSetElement>();
- this.maxElementsPerWorker = maxElementsPerWorker;
+ constructor(workerScript: string, workerOptions?: WorkerOptions) {
+ super(workerScript, workerOptions);
+ this.workerSet = new Set<WorkerSetElement>();
}
get size(): number {
- return this.workers.size;
+ return this.workerSet.size;
+ }
+
+ get maxElementsPerWorker(): number | undefined {
+ return this.workerOptions.elementsPerWorker;
}
/**
*
- * @return {Promise<void>}
+ * @param elementData -
+ * @returns
* @public
*/
public async addElement(elementData: WorkerData): Promise<void> {
- if (!this.workers) {
- throw Error('Cannot add a WorkerSet element: workers set does not exist');
+ if (!this.workerSet) {
+ throw new Error("Cannot add a WorkerSet element: workers' set does not exist");
}
- if (this.getLastWorkerSetElement().numberOfWorkerElements >= this.maxElementsPerWorker) {
- void this.startWorker();
- // Start worker sequentially to optimize memory at startup
- void Utils.sleep(Constants.START_WORKER_DELAY);
+ if (
+ this.workerSet.size === 0 ||
+ this.getLastWorkerSetElement().numberOfWorkerElements >= this.workerOptions.elementsPerWorker
+ ) {
+ await this.startWorker();
}
- this.getLastWorker().postMessage({ id: WorkerEvents.START_WORKER_ELEMENT, workerData: elementData });
+ this.getLastWorker().postMessage({
+ id: WorkerMessageEvents.START_WORKER_ELEMENT,
+ data: elementData,
+ });
this.getLastWorkerSetElement().numberOfWorkerElements++;
+ // Start element sequentially to optimize memory at startup
+ if (this.workerOptions.elementStartDelay > 0) {
+ await WorkerUtils.sleep(this.workerOptions.elementStartDelay);
+ }
}
/**
*
- * @return {Promise<void>}
+ * @returns
* @public
*/
public async start(): Promise<void> {
await this.startWorker();
- // Start worker sequentially to optimize memory at startup
- await Utils.sleep(Constants.START_WORKER_DELAY);
}
/**
*
- * @return {Promise}
- * @private
+ * @returns
+ * @public
*/
- private async startWorker() {
- return new Promise((resolve, reject) => {
- const worker = new Worker(this.workerScript);
- worker.on('message', resolve);
- worker.on('error', reject);
- worker.on('exit', (code) => {
- if (code !== 0) {
- reject(new Error(`Worker stopped with exit code ${code}`));
- }
- });
- this.workers.add({ worker, numberOfWorkerElements: 0 });
+ public async stop(): Promise<void> {
+ for (const workerSetElement of this.workerSet) {
+ await workerSetElement.worker.terminate();
+ }
+ this.workerSet.clear();
+ }
+
+ /**
+ * Start a new `Worker`.
+ */
+ private async startWorker(): Promise<void> {
+ const worker = new Worker(this.workerScript);
+ worker.on(
+ 'message',
+ (
+ this.workerOptions?.messageHandler ??
+ (() => {
+ /* This is intentional */
+ })
+ ).bind(this) as MessageHandler<Worker>
+ );
+ worker.on('error', WorkerUtils.defaultErrorHandler.bind(this) as (err: Error) => void);
+ worker.on('exit', (code) => {
+ WorkerUtils.defaultExitHandler(code);
+ this.workerSet.delete(this.getWorkerSetElementByWorker(worker));
});
+ this.workerSet.add({ worker, numberOfWorkerElements: 0 });
+ // Start worker sequentially to optimize memory at startup
+ this.workerOptions.workerStartDelay > 0 &&
+ (await WorkerUtils.sleep(this.workerOptions.workerStartDelay));
}
private getLastWorkerSetElement(): WorkerSetElement {
let workerSetElement: WorkerSetElement;
- // eslint-disable-next-line no-empty
- for (workerSetElement of this.workers) { }
+ for (workerSetElement of this.workerSet) {
+ /* This is intentional */
+ }
return workerSetElement;
}
private getLastWorker(): Worker {
return this.getLastWorkerSetElement().worker;
}
+
+ private getWorkerSetElementByWorker(worker: Worker): WorkerSetElement {
+ let workerSetElt: WorkerSetElement;
+ for (const workerSetElement of this.workerSet) {
+ if (workerSetElement.worker.threadId === worker.threadId) {
+ workerSetElt = workerSetElement;
+ break;
+ }
+ }
+ return workerSetElt;
+ }
}