Refine and use OCPP error specialisation

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

diff --git a/src/worker/WorkerSet.ts b/src/worker/WorkerSet.ts
index 21f9f482997a6ffad898b39e2bcb6c2d11af46cf..6ab08b92d3fbdc8ca557476ad160e25f889b7e71 100644 (file)
--- a/src/worker/WorkerSet.ts
+++ b/src/worker/WorkerSet.ts
@@ -1,24 +1,30 @@
-import { WorkerEvents, WorkerSetElement } from '../types/Worker';
+// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
+
+import { WorkerMessageEvents, WorkerOptions, WorkerSetElement } from '../types/Worker';
 
 import Utils from '../utils/Utils';
 import { Worker } from 'worker_threads';
 import WorkerAbstract from './WorkerAbstract';
+import { WorkerUtils } from './WorkerUtils';
 
 export default class WorkerSet<T> extends WorkerAbstract {
-  public maxElementsPerWorker: number;
+  public readonly maxElementsPerWorker: number;
+  private readonly messageHandler: (message: any) => void | Promise<void>;
   private workerSet: Set<WorkerSetElement>;
 
   /**
    * Create a new `WorkerSet`.
    *
-   * @param {string} workerScript
-   * @param {number} maxElementsPerWorker
-   * @param {number} workerStartDelay
+   * @param workerScript
+   * @param maxElementsPerWorker
+   * @param workerStartDelay
+   * @param opts
    */
-  constructor(workerScript: string, maxElementsPerWorker = 1, workerStartDelay?: number) {
+  constructor(workerScript: string, maxElementsPerWorker = 1, workerStartDelay?: number, opts?: WorkerOptions) {
     super(workerScript, workerStartDelay);
-    this.workerSet = new Set<WorkerSetElement>();
     this.maxElementsPerWorker = maxElementsPerWorker;
+    this.messageHandler = opts?.messageHandler ?? (() => { });
+    this.workerSet = new Set<WorkerSetElement>();
   }
 
   get size(): number {
@@ -27,26 +33,26 @@ export default class WorkerSet<T> extends WorkerAbstract {
 
   /**
    *
-   * @param {T} elementData
-   * @returns {Promise<void>}
+   * @param elementData
+   * @returns
    * @public
    */
   public async addElement(elementData: T): 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(this.workerStartDelay);
     }
-    this.getLastWorker().postMessage({ id: WorkerEvents.START_WORKER_ELEMENT, workerData: elementData });
+    this.getLastWorker().postMessage({ id: WorkerMessageEvents.START_WORKER_ELEMENT, data: elementData });
     this.getLastWorkerSetElement().numberOfWorkerElements++;
   }
 
   /**
    *
-   * @returns {Promise<void>}
+   * @returns
    * @public
    */
   public async start(): Promise<void> {
@@ -57,7 +63,7 @@ export default class WorkerSet<T> extends WorkerAbstract {
 
   /**
    *
-   * @returns {Promise<void>}
+   * @returns
    * @public
    */
   public async stop(): Promise<void> {
@@ -73,12 +79,10 @@ export default class WorkerSet<T> extends WorkerAbstract {
    */
   private startWorker(): void {
     const worker = new Worker(this.workerScript);
-    worker.on('message', () => { });
-    worker.on('error', () => { });
+    worker.on('message', this.messageHandler);
+    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 });
@@ -87,7 +91,7 @@ export default class WorkerSet<T> extends WorkerAbstract {
   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 +101,12 @@ export default class WorkerSet<T> extends WorkerAbstract {
 
   private getWorkerSetElementByWorker(worker: Worker): WorkerSetElement {
     let workerSetElt: WorkerSetElement;
-    this.workerSet.forEach((workerSetElement) => {
+    for (const workerSetElement of this.workerSet) {
       if (workerSetElement.worker.threadId === worker.threadId) {
         workerSetElt = workerSetElement;
+        break;
       }
-    });
+    }
     return workerSetElt;
   }
 }