Fix workerSet linear ramp up at startup
[e-mobility-charging-stations-simulator.git] / src / worker / WorkerSet.ts
index 6ea0a05964d2af13370c23c0dbb7b60ae0246775..b62f63df546d3709e3c00bb4836131501b0076f2 100644 (file)
@@ -1,62 +1,65 @@
-import { WorkerEvents, WorkerSetElement } from '../types/Worker';
+// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
+
+import { WorkerData, WorkerMessageEvents, WorkerOptions, WorkerSetElement } from '../types/Worker';
 
-import Constants from '../utils/Constants';
 import Utils from '../utils/Utils';
 import { Worker } from 'worker_threads';
-import Wrk from './Wrk';
+import WorkerAbstract from './WorkerAbstract';
+import { WorkerUtils } from './WorkerUtils';
 
-export default class WorkerSet<T> extends Wrk {
-  public maxElementsPerWorker: number;
-  private workerSet: Set<WorkerSetElement>;
+export default class WorkerSet extends WorkerAbstract<WorkerData> {
+  private readonly workerSet: Set<WorkerSetElement>;
+  private readonly messageHandler: (message: unknown) => void | Promise<void>;
 
   /**
    * 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.messageHandler = workerOptions?.messageHandler ?? (() => { /* This is intentional */ });
   }
 
   get size(): number {
     return this.workerSet.size;
   }
 
+  get maxElementsPerWorker(): number | null {
+    return this.workerOptions.elementsPerWorker;
+  }
+
   /**
    *
-   * @return {Promise<void>}
+   * @param elementData
+   * @returns
    * @public
    */
-  public async addElement(elementData: T): Promise<void> {
+  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);
+    if (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, workerOptions: this.workerOptions, data: elementData });
     this.getLastWorkerSetElement().numberOfWorkerElements++;
   }
 
   /**
    *
-   * @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();
   }
 
   /**
    *
-   * @return {Promise<void>}
+   * @returns
    * @public
    */
   public async stop(): Promise<void> {
@@ -68,26 +71,28 @@ export default class WorkerSet<T> extends Wrk {
 
   /**
    *
-   * @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', (msg) => {
+      (async () => {
+        await this.messageHandler(msg);
+      })().catch(() => { /* This is intentional */ });
+    });
+    worker.on('error', () => { /* This is intentional */ });
     worker.on('exit', (code) => {
-      if (code !== 0) {
-        console.error(`Worker stopped with exit code ${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 Utils.sleep(this.workerOptions.workerStartDelay);
   }
 
   private getLastWorkerSetElement(): WorkerSetElement {
     let workerSetElement: WorkerSetElement;
-    // eslint-disable-next-line no-empty
-    for (workerSetElement of this.workerSet) { }
+    for (workerSetElement of this.workerSet) { /* This is intentional */ }
     return workerSetElement;
   }
 
@@ -97,11 +102,12 @@ export default class WorkerSet<T> extends Wrk {
 
   private getWorkerSetElementByWorker(worker: Worker): WorkerSetElement {
     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;
   }
 }