build: cleanup eslint configuration

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

diff --git a/src/worker/WorkerSet.ts b/src/worker/WorkerSet.ts
index 61118a0d0a274d17871a71ec8e2ebec3efa2c2a9..17b5b6dde201c85f4c0af0cbaf3574d33968fb03 100644 (file)
--- a/src/worker/WorkerSet.ts
+++ b/src/worker/WorkerSet.ts
@@ -1,23 +1,26 @@
 // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
 
-import { EventEmitter } from 'node:events';
+import { EventEmitterAsyncResource } from 'node:events';
 import { SHARE_ENV, Worker } from 'node:worker_threads';
 
 import { WorkerAbstract } from './WorkerAbstract';
-import { WorkerConstants } from './WorkerConstants';
+import { EMPTY_FUNCTION, workerSetVersion } from './WorkerConstants';
 import {
   type SetInfo,
   type WorkerData,
+  type WorkerMessage,
   WorkerMessageEvents,
   type WorkerOptions,
   type WorkerSetElement,
   WorkerSetEvents,
 } from './WorkerTypes';
-import { sleep } from './WorkerUtils';
+import { randomizeDelay, sleep } from './WorkerUtils';
 
 export class WorkerSet extends WorkerAbstract<WorkerData> {
-  public readonly emitter!: EventEmitter;
+  public readonly emitter: EventEmitterAsyncResource | undefined;
   private readonly workerSet: Set<WorkerSetElement>;
+  private started: boolean;
+  private workerStartup: boolean;
 
   /**
    * Creates a new `WorkerSet`.
@@ -25,24 +28,31 @@ export class WorkerSet extends WorkerAbstract<WorkerData> {
    * @param workerScript -
    * @param workerOptions -
    */
-  constructor(workerScript: string, workerOptions?: WorkerOptions) {
+  constructor(workerScript: string, workerOptions: WorkerOptions) {
     super(workerScript, workerOptions);
-    this.workerOptions.poolOptions = {
-      ...{
-        enableEvents: true,
-        restartWorkerOnError: true,
-      },
-      ...this.workerOptions.poolOptions,
-    };
+    if (
+      this.workerOptions.elementsPerWorker === null ||
+      this.workerOptions.elementsPerWorker === undefined
+    ) {
+      throw new TypeError('Elements per worker is not defined');
+    }
+    if (!Number.isSafeInteger(this.workerOptions.elementsPerWorker)) {
+      throw new TypeError('Elements per worker must be an integer');
+    }
+    if (this.workerOptions.elementsPerWorker <= 0) {
+      throw new RangeError('Elements per worker must be greater than zero');
+    }
     this.workerSet = new Set<WorkerSetElement>();
     if (this.workerOptions.poolOptions?.enableEvents) {
-      this.emitter = new EventEmitter();
+      this.emitter = new EventEmitterAsyncResource({ name: 'workerset' });
     }
+    this.started = false;
+    this.workerStartup = false;
   }
 
   get info(): SetInfo {
     return {
-      version: WorkerConstants.version,
+      version: workerSetVersion,
       type: 'set',
       worker: 'thread',
       size: this.size,
@@ -66,37 +76,47 @@ export class WorkerSet extends WorkerAbstract<WorkerData> {
   public async start(): Promise<void> {
     this.addWorkerSetElement();
     // Add worker set element sequentially to optimize memory at startup
-    this.workerOptions.workerStartDelay! > 0 && (await sleep(this.workerOptions.workerStartDelay!));
+    this.workerOptions.workerStartDelay! > 0 &&
+      (await sleep(randomizeDelay(this.workerOptions.workerStartDelay!)));
+    this.emitter?.emit(WorkerSetEvents.started, this.info);
+    this.started = true;
   }
 
   /** @inheritDoc */
   public async stop(): Promise<void> {
     for (const workerSetElement of this.workerSet) {
-      const workerExitPromise = new Promise<void>((resolve) => {
-        workerSetElement.worker.on('exit', () => {
+      const worker = workerSetElement.worker;
+      const waitWorkerExit = new Promise<void>((resolve) => {
+        worker.once('exit', () => {
           resolve();
         });
       });
-      await workerSetElement.worker.terminate();
-      await workerExitPromise;
+      await worker.terminate();
+      await waitWorkerExit;
+      this.emitter?.emit(WorkerSetEvents.stopped, this.info);
+      this.emitter?.emitDestroy();
+      this.emitter?.removeAllListeners();
+      this.started = false;
     }
-    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");
+    if (!this.started) {
+      throw new Error('Cannot add a WorkerSet element: not started');
+    }
+    if (this.workerSet == null) {
+      throw new Error("Cannot add a WorkerSet element: 'workerSet' property does not exist");
     }
     const workerSetElement = await this.getWorkerSetElement();
     workerSetElement.worker.postMessage({
-      id: WorkerMessageEvents.startWorkerElement,
+      event: WorkerMessageEvents.startWorkerElement,
       data: elementData,
     });
     ++workerSetElement.numberOfWorkerElements;
     // Add element sequentially to optimize memory at startup
     if (this.workerOptions.elementStartDelay! > 0) {
-      await sleep(this.workerOptions.elementStartDelay!);
+      await sleep(randomizeDelay(this.workerOptions.elementStartDelay!));
     }
   }
 
@@ -104,37 +124,38 @@ export class WorkerSet extends WorkerAbstract<WorkerData> {
    * Adds a new `WorkerSetElement`.
    */
   private addWorkerSetElement(): WorkerSetElement {
+    this.workerStartup = true;
     const worker = new Worker(this.workerScript, {
       env: SHARE_ENV,
       ...this.workerOptions.poolOptions?.workerOptions,
     });
-    worker.on(
-      'message',
-      this.workerOptions.poolOptions?.messageHandler ?? WorkerConstants.EMPTY_FUNCTION,
-    );
-    worker.on(
-      'error',
-      this.workerOptions.poolOptions?.errorHandler ?? WorkerConstants.EMPTY_FUNCTION,
-    );
+    worker.on('message', this.workerOptions.poolOptions?.messageHandler ?? EMPTY_FUNCTION);
+    worker.on('message', (message: WorkerMessage<WorkerData>) => {
+      if (message.event === WorkerMessageEvents.startedWorkerElement) {
+        this.emitter?.emit(WorkerSetEvents.elementStarted, this.info);
+      } else if (message.event === WorkerMessageEvents.startWorkerElementError) {
+        this.emitter?.emit(WorkerSetEvents.elementError, message.data);
+      }
+    });
+    worker.on('error', this.workerOptions.poolOptions?.errorHandler ?? EMPTY_FUNCTION);
     worker.on('error', (error) => {
       this.emitter?.emit(WorkerSetEvents.error, error);
-      if (this.workerOptions.poolOptions?.restartWorkerOnError) {
+      if (
+        this.workerOptions.poolOptions?.restartWorkerOnError &&
+        this.started &&
+        !this.workerStartup
+      ) {
         this.addWorkerSetElement();
       }
     });
-    worker.on(
-      'online',
-      this.workerOptions.poolOptions?.onlineHandler ?? WorkerConstants.EMPTY_FUNCTION,
-    );
-    worker.on(
-      'exit',
-      this.workerOptions.poolOptions?.exitHandler ?? WorkerConstants.EMPTY_FUNCTION,
-    );
+    worker.on('online', this.workerOptions.poolOptions?.onlineHandler ?? EMPTY_FUNCTION);
+    worker.on('exit', this.workerOptions.poolOptions?.exitHandler ?? EMPTY_FUNCTION);
     worker.once('exit', () =>
       this.removeWorkerSetElement(this.getWorkerSetElementByWorker(worker)!),
     );
     const workerSetElement: WorkerSetElement = { worker, numberOfWorkerElements: 0 };
     this.workerSet.add(workerSetElement);
+    this.workerStartup = false;
     return workerSetElement;
   }
 
@@ -154,7 +175,7 @@ export class WorkerSet extends WorkerAbstract<WorkerData> {
       chosenWorkerSetElement = this.addWorkerSetElement();
       // Add worker set element sequentially to optimize memory at startup
       this.workerOptions.workerStartDelay! > 0 &&
-        (await sleep(this.workerOptions.workerStartDelay!));
+        (await sleep(randomizeDelay(this.workerOptions.workerStartDelay!)));
     }
     return chosenWorkerSetElement;
   }