build(deps): apply updates

[e-mobility-charging-stations-simulator.git] / src / worker / WorkerSet.ts

diff --git a/src/worker/WorkerSet.ts b/src/worker/WorkerSet.ts
index bda3018bf9a2df631dd9057dc6647844ebbf03f3..ff172d63cd158b5ce7ed3541f2eaf7702bace5b5 100644 (file)
--- a/src/worker/WorkerSet.ts
+++ b/src/worker/WorkerSet.ts
@@ -1,65 +1,68 @@
-import { 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 WorkerAbstract from './WorkerAbstract';
+import EventEmitterAsyncResource from 'node:events';
+import { Worker } from 'node:worker_threads';
 
-export default class WorkerSet<T> extends WorkerAbstract {
-  public maxElementsPerWorker: number;
-  private workerSet: Set<WorkerSetElement>;
+import { WorkerAbstract } from './WorkerAbstract';
+import { WorkerConstants } from './WorkerConstants';
+import {
+  type MessageHandler,
+  type WorkerData,
+  WorkerMessageEvents,
+  type WorkerOptions,
+  type WorkerSetElement,
+} from './WorkerTypes';
+import { defaultErrorHandler, defaultExitHandler, sleep } from './WorkerUtils';
+
+export class WorkerSet extends WorkerAbstract<WorkerData> {
+  public readonly emitter: EventEmitterAsyncResource;
+  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);
+  constructor(workerScript: string, workerOptions?: WorkerOptions) {
+    super(workerScript, workerOptions);
     this.workerSet = new Set<WorkerSetElement>();
-    this.maxElementsPerWorker = maxElementsPerWorker;
+    this.emitter = new EventEmitterAsyncResource();
   }
 
   get size(): number {
     return this.workerSet.size;
   }
 
-  /**
-   *
-   * @param elementData
-   * @returns {Promise<void>}
-   * @public
-   */
-  public async addElement(elementData: T): Promise<void> {
+  get maxElementsPerWorker(): number | undefined {
+    return this.workerOptions.elementsPerWorker;
+  }
+
+  /** @inheritDoc */
+  public async addElement(elementData: WorkerData): Promise<void> {
     if (!this.workerSet) {
-      throw Error('Cannot add a WorkerSet element: workers\' set does not exist');
+      throw new Error("Cannot add a WorkerSet element: workers' set does not exist");
     }
-    if (this.getLastWorkerSetElement().numberOfWorkerElements >= this.maxElementsPerWorker) {
-      this.startWorker();
-      // Start worker sequentially to optimize memory at startup
-      await Utils.sleep(Constants.START_WORKER_DELAY);
+    const workerSetElement = await this.getWorkerSetElement();
+    workerSetElement.worker.postMessage({
+      id: 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.getLastWorker().postMessage({ id: WorkerEvents.START_WORKER_ELEMENT, workerData: elementData });
-    this.getLastWorkerSetElement().numberOfWorkerElements++;
   }
 
-  /**
-   *
-   * @returns {Promise<void>}
-   * @public
-   */
+  /** @inheritDoc */
   public async start(): Promise<void> {
-    this.startWorker();
-    // Start worker sequentially to optimize memory at startup
-    await Utils.sleep(Constants.START_WORKER_DELAY);
+    this.addWorkerSetElement();
+    // Add worker set element sequentially to optimize memory at startup
+    this.workerOptions.workerStartDelay > 0 && (await sleep(this.workerOptions.workerStartDelay));
   }
 
-  /**
-   *
-   * @returns {Promise<void>}
-   * @public
-   */
+  /** @inheritDoc */
   public async stop(): Promise<void> {
     for (const workerSetElement of this.workerSet) {
       await workerSetElement.worker.terminate();
@@ -68,41 +71,52 @@ export default class WorkerSet<T> extends WorkerAbstract {
   }
 
   /**
-   *
-   * @returns {Promise}
-   * @private
+   * Add a new `WorkerSetElement`.
    */
-  private startWorker(): void {
+  private addWorkerSetElement(): WorkerSetElement {
     const worker = new Worker(this.workerScript);
-    worker.on('message', () => { });
-    worker.on('error', () => { });
-    worker.on('exit', (code) => {
-      if (code !== 0) {
-        console.error(`Worker stopped with exit code ${code}`);
-      }
-      this.workerSet.delete(this.getWorkerSetElementByWorker(worker));
+    worker.on(
+      'message',
+      (this.workerOptions?.messageHandler ?? WorkerConstants.EMPTY_FUNCTION).bind(
+        this
+      ) as MessageHandler<Worker>
+    );
+    worker.on('error', defaultErrorHandler.bind(this) as (err: Error) => void);
+    worker.on('error', (error) => {
+      this.emitter.emit('error', error);
+      this.addWorkerSetElement();
     });
-    this.workerSet.add({ worker, numberOfWorkerElements: 0 });
-  }
-
-  private getLastWorkerSetElement(): WorkerSetElement {
-    let workerSetElement: WorkerSetElement;
-    // eslint-disable-next-line no-empty
-    for (workerSetElement of this.workerSet) { }
+    worker.on('exit', defaultExitHandler.bind(this) as (exitCode: number) => void);
+    worker.on('exit', () => this.workerSet.delete(this.getWorkerSetElementByWorker(worker)));
+    const workerSetElement: WorkerSetElement = { worker, numberOfWorkerElements: 0 };
+    this.workerSet.add(workerSetElement);
     return workerSetElement;
   }
 
-  private getLastWorker(): Worker {
-    return this.getLastWorkerSetElement().worker;
+  private async getWorkerSetElement(): Promise<WorkerSetElement> {
+    let chosenWorkerSetElement: WorkerSetElement;
+    for (const workerSetElement of this.workerSet) {
+      if (workerSetElement.numberOfWorkerElements < this.workerOptions.elementsPerWorker) {
+        chosenWorkerSetElement = workerSetElement;
+        break;
+      }
+    }
+    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 {
+  private getWorkerSetElementByWorker(worker: Worker): WorkerSetElement | undefined {
     let workerSetElt: WorkerSetElement;
-    this.workerSet.forEach((workerSetElement) => {
-      if (JSON.stringify(workerSetElement.worker) === JSON.stringify(worker)) {
+    for (const workerSetElement of this.workerSet) {
+      if (workerSetElement.worker.threadId === worker.threadId) {
         workerSetElt = workerSetElement;
+        break;
       }
-    });
+    }
     return workerSetElt;
   }
 }