refactor: cleanup performance statistics namespace

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

diff --git a/src/worker/WorkerSet.ts b/src/worker/WorkerSet.ts
index 9a6f457dd672bcfe42a004997db7ab8244108a6b..d761a12abe2eef9a133781b5c5f8ed1d53f178f8 100644 (file)
--- a/src/worker/WorkerSet.ts
+++ b/src/worker/WorkerSet.ts
@@ -1,106 +1,173 @@
-import { WorkerEvents, WorkerSetElement } from '../types/Worker';
+// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
 
-import Utils from '../utils/Utils';
-import { Worker } from 'worker_threads';
-import WorkerAbstract from './WorkerAbstract';
-import { WorkerUtils } from './WorkerUtils';
+import { EventEmitter } from 'node:events';
+import { SHARE_ENV, 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 SetInfo,
+  type WorkerData,
+  WorkerMessageEvents,
+  type WorkerOptions,
+  type WorkerSetElement,
+  WorkerSetEvents,
+} from './WorkerTypes';
+import { sleep } from './WorkerUtils';
+
+export class WorkerSet extends WorkerAbstract<WorkerData> {
+  public readonly emitter: EventEmitter;
+  private readonly workerSet: Set<WorkerSetElement>;
 
   /**
-   * Create a new `WorkerSet`.
+   * Creates a new `WorkerSet`.
    *
-   * @param {string} workerScript
-   * @param {number} maxElementsPerWorker
-   * @param {number} workerStartDelay
+   * @param workerScript -
+   * @param workerOptions -
    */
-  constructor(workerScript: string, maxElementsPerWorker = 1, workerStartDelay?: number) {
-    super(workerScript, workerStartDelay);
+  constructor(workerScript: string, workerOptions?: WorkerOptions) {
+    super(workerScript, workerOptions);
+    this.workerOptions.poolOptions = {
+      ...{
+        enableEvents: true,
+        restartWorkerOnError: true,
+      },
+      ...this.workerOptions.poolOptions,
+    };
     this.workerSet = new Set<WorkerSetElement>();
-    this.maxElementsPerWorker = maxElementsPerWorker;
+    if (this.workerOptions?.poolOptions?.enableEvents) {
+      this.emitter = new EventEmitter();
+    }
+  }
+
+  get info(): SetInfo {
+    return {
+      version: WorkerConstants.version,
+      type: 'set',
+      worker: 'thread',
+      size: this.size,
+      elementsExecuting: [...this.workerSet].reduce(
+        (accumulator, workerSetElement) => accumulator + workerSetElement.numberOfWorkerElements,
+        0
+      ),
+      elementsPerWorker: this.maxElementsPerWorker,
+    };
   }
 
   get size(): number {
     return this.workerSet.size;
   }
 
-  /**
-   *
-   * @param {T} elementData
-   * @returns {Promise<void>}
-   * @public
-   */
-  public async addElement(elementData: T): Promise<void> {
-    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(this.workerStartDelay);
-    }
-    this.getLastWorker().postMessage({ id: WorkerEvents.START_WORKER_ELEMENT, workerData: elementData });
-    this.getLastWorkerSetElement().numberOfWorkerElements++;
+  get maxElementsPerWorker(): number | undefined {
+    return this.workerOptions.elementsPerWorker;
   }
 
-  /**
-   *
-   * @returns {Promise<void>}
-   * @public
-   */
+  /** @inheritDoc */
   public async start(): Promise<void> {
-    this.startWorker();
-    // Start worker sequentially to optimize memory at startup
-    await Utils.sleep(this.workerStartDelay);
+    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) {
+      const workerExitPromise = new Promise<void>((resolve) => {
+        workerSetElement.worker.on('exit', () => {
+          resolve();
+        });
+      });
       await workerSetElement.worker.terminate();
+      await workerExitPromise;
     }
     this.workerSet.clear();
   }
 
+  /** @inheritDoc */
+  public async addElement(elementData: WorkerData): Promise<void> {
+    if (!this.workerSet) {
+      throw new Error("Cannot add a WorkerSet element: workers' set does not exist");
+    }
+    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);
+    }
+  }
+
   /**
-   *
-   * @private
+   * Adds a new `WorkerSetElement`.
    */
-  private startWorker(): void {
-    const worker = new Worker(this.workerScript);
-    worker.on('message', () => { });
-    worker.on('error', () => { });
-    worker.on('exit', (code) => {
-      WorkerUtils.defaultExitHandler(code);
-      this.workerSet.delete(this.getWorkerSetElementByWorker(worker));
+  private addWorkerSetElement(): WorkerSetElement {
+    const worker = new Worker(this.workerScript, {
+      env: SHARE_ENV,
+      ...this.workerOptions.poolOptions.workerOptions,
     });
-    this.workerSet.add({ worker, numberOfWorkerElements: 0 });
+    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);
+      }
+      if (this.workerOptions?.poolOptions?.restartWorkerOnError) {
+        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.removeWorkerSetElement(this.getWorkerSetElementByWorker(worker))
+    );
+    const workerSetElement: WorkerSetElement = { worker, numberOfWorkerElements: 0 };
+    this.workerSet.add(workerSetElement);
+    return workerSetElement;
   }
 
-  private getLastWorkerSetElement(): WorkerSetElement {
-    let workerSetElement: WorkerSetElement;
-    // eslint-disable-next-line no-empty
-    for (workerSetElement of this.workerSet) { }
-    return workerSetElement;
+  private removeWorkerSetElement(workerSetElement: WorkerSetElement): void {
+    this.workerSet.delete(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) => {
+    for (const workerSetElement of this.workerSet) {
       if (workerSetElement.worker.threadId === worker.threadId) {
         workerSetElt = workerSetElement;
+        break;
       }
-    });
+    }
     return workerSetElt;
   }
 }