refactor: cleanup pool options defaults handling
[e-mobility-charging-stations-simulator.git] / src / worker / WorkerSet.ts
index fd81840a7a35139e238ff203facef400576e6572..7ddc96c73c27febb8a179a9faa4da6ee01c0615a 100644 (file)
@@ -3,10 +3,8 @@
 import { EventEmitter } from 'node:events';
 import { SHARE_ENV, Worker } from 'node:worker_threads';
 
-import type { ThreadPoolOptions } from 'poolifier';
-
 import { WorkerAbstract } from './WorkerAbstract';
-import { WorkerConstants } from './WorkerConstants';
+import { EMPTY_FUNCTION, workerSetVersion } from './WorkerConstants';
 import {
   type SetInfo,
   type WorkerData,
@@ -18,14 +16,11 @@ import {
 } from './WorkerTypes';
 import { sleep } from './WorkerUtils';
 
-const DEFAULT_POOL_OPTIONS: ThreadPoolOptions = {
-  enableEvents: true,
-  restartWorkerOnError: true,
-};
-
 export class WorkerSet extends WorkerAbstract<WorkerData> {
   public readonly emitter!: EventEmitter;
   private readonly workerSet: Set<WorkerSetElement>;
+  private started: boolean;
+  private workerStartup: boolean;
 
   /**
    * Creates a new `WorkerSet`.
@@ -35,19 +30,29 @@ export class WorkerSet extends WorkerAbstract<WorkerData> {
    */
   constructor(workerScript: string, workerOptions: WorkerOptions) {
     super(workerScript, workerOptions);
-    this.workerOptions.poolOptions = {
-      ...DEFAULT_POOL_OPTIONS,
-      ...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.started = false;
+    this.workerStartup = false;
   }
 
   get info(): SetInfo {
     return {
-      version: WorkerConstants.version,
+      version: workerSetVersion,
       type: 'set',
       worker: 'thread',
       size: this.size,
@@ -72,6 +77,7 @@ export class WorkerSet extends WorkerAbstract<WorkerData> {
     this.addWorkerSetElement();
     // Add worker set element sequentially to optimize memory at startup
     this.workerOptions.workerStartDelay! > 0 && (await sleep(this.workerOptions.workerStartDelay!));
+    this.started = true;
   }
 
   /** @inheritDoc */
@@ -85,13 +91,17 @@ export class WorkerSet extends WorkerAbstract<WorkerData> {
       });
       await worker.terminate();
       await waitWorkerExit;
+      this.started = false;
     }
   }
 
   /** @inheritDoc */
   public async addElement(elementData: WorkerData): Promise<void> {
+    if (!this.started) {
+      throw new Error('Cannot add a WorkerSet element: not started');
+    }
     if (!this.workerSet) {
-      throw new Error("Cannot add a WorkerSet element: workers' set does not exist");
+      throw new Error("Cannot add a WorkerSet element: 'workerSet' property does not exist");
     }
     const workerSetElement = await this.getWorkerSetElement();
     workerSetElement.worker.postMessage({
@@ -109,14 +119,12 @@ 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('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);
@@ -124,29 +132,25 @@ export class WorkerSet extends WorkerAbstract<WorkerData> {
         this.emitter?.emit(WorkerSetEvents.elementError, message.data);
       }
     });
-    worker.on(
-      'error',
-      this.workerOptions.poolOptions?.errorHandler ?? WorkerConstants.EMPTY_FUNCTION,
-    );
+    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;
   }