WorkerSet: remove ugly hack to deal with async worker message handler

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

diff --git a/src/worker/WorkerSet.ts b/src/worker/WorkerSet.ts
index 0c59c09108089d059184bcaac99e6ffc104c3341..f41752fc7a2b088fda4b8c68b4b74bec347b1bf9 100644 (file)
--- a/src/worker/WorkerSet.ts
+++ b/src/worker/WorkerSet.ts
@@ -1,81 +1,111 @@
-import { WorkerData, WorkerEvents, WorkerSetElement } from '../types/Worker';
+// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
 
-import Constants from '../utils/Constants';
-import Utils from '../utils/Utils';
 import { Worker } from 'worker_threads';
-import Wrk from './Wrk';
 
-export default class WorkerSet extends Wrk {
-  public maxElementsPerWorker: number;
-  private workers: Set<WorkerSetElement>;
+import { WorkerData, WorkerMessageEvents, WorkerOptions, WorkerSetElement } from '../types/Worker';
+import Utils from '../utils/Utils';
+import WorkerAbstract from './WorkerAbstract';
+import { WorkerUtils } from './WorkerUtils';
+
+export default class WorkerSet extends WorkerAbstract<WorkerData> {
+  private readonly workerSet: Set<WorkerSetElement>;
+  private readonly messageHandler: (message: unknown) => void;
 
   /**
    * 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>();
+    this.messageHandler =
+      workerOptions?.messageHandler ??
+      (() => {
+        /* This is intentional */
+      });
   }
 
   get size(): number {
-    return this.workers.size;
+    return this.workerSet.size;
+  }
+
+  get maxElementsPerWorker(): number | null {
+    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) {
-      this.startWorker();
-      // Start worker sequentially to optimize memory at startup
-      await 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 Utils.sleep(this.workerOptions.elementStartDelay);
+    }
   }
 
   /**
    *
-   * @return {Promise<void>}
+   * @returns
    * @public
    */
   public async start(): Promise<void> {
-    this.startWorker();
-    // Start worker sequentially to optimize memory at startup
-    await Utils.sleep(Constants.START_WORKER_DELAY);
+    await this.startWorker();
+  }
+
+  /**
+   *
+   * @returns
+   * @public
+   */
+  public async stop(): Promise<void> {
+    for (const workerSetElement of this.workerSet) {
+      await workerSetElement.worker.terminate();
+    }
+    this.workerSet.clear();
   }
 
   /**
    *
-   * @return {Promise}
    * @private
    */
-  private startWorker(): void {
+  private async startWorker(): Promise<void> {
     const worker = new Worker(this.workerScript);
-    worker.on('message', () => { });
-    worker.on('error', () => { });
+    worker.on('message', this.messageHandler);
+    worker.on('error', WorkerUtils.defaultErrorHandler);
     worker.on('exit', (code) => {
-      if (code !== 0) {
-        console.error(`Worker stopped with exit code ${code}`);
-      }
-      // FIXME: remove matching worker set element
+      WorkerUtils.defaultExitHandler(code);
+      this.workerSet.delete(this.getWorkerSetElementByWorker(worker));
     });
-    this.workers.add({ worker, numberOfWorkerElements: 0 });
+    this.workerSet.add({ worker, numberOfWorkerElements: 0 });
+    // Start worker sequentially to optimize memory at startup
+    this.workerOptions.workerStartDelay > 0 &&
+      (await Utils.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;
   }
 
@@ -85,11 +115,12 @@ export default class WorkerSet extends Wrk {
 
   private getWorkerSetElementByWorker(worker: Worker): WorkerSetElement {
     let workerSetElt: WorkerSetElement;
-    this.workers.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;
   }
 }