X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2FWorkerSet.ts;h=b09ea711df718bbcd508dfba52dd99112e90b285;hb=ce0abd8248cbc1c976bb298e45daeb0749387619;hp=b33d917c14a4b7865f60acd80029dd5522c3ebd0;hpb=a6ef1ece74c0d08e86a905571f4f6045c28131cb;p=e-mobility-charging-stations-simulator.git

diff --git a/src/worker/WorkerSet.ts b/src/worker/WorkerSet.ts
index b33d917c..b09ea711 100644
--- a/src/worker/WorkerSet.ts
+++ b/src/worker/WorkerSet.ts
@@ -1,10 +1,11 @@
-// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
+// Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved.
 
-import { EventEmitterAsyncResource } from 'node:events';
-import { SHARE_ENV, Worker } from 'node:worker_threads';
+import { randomUUID } from 'node:crypto'
+import { EventEmitterAsyncResource } from 'node:events'
+import { SHARE_ENV, Worker } from 'node:worker_threads'
 
-import { WorkerAbstract } from './WorkerAbstract.js';
-import { EMPTY_FUNCTION, workerSetVersion } from './WorkerConstants.js';
+import { WorkerAbstract } from './WorkerAbstract.js'
+import { EMPTY_FUNCTION, workerSetVersion } from './WorkerConstants.js'
 import {
   type SetInfo,
   type WorkerData,
@@ -12,15 +13,26 @@ import {
   WorkerMessageEvents,
   type WorkerOptions,
   type WorkerSetElement,
-  WorkerSetEvents,
-} from './WorkerTypes.js';
-import { randomizeDelay, sleep } from './WorkerUtils.js';
+  WorkerSetEvents
+} from './WorkerTypes.js'
+import { randomizeDelay, sleep } from './WorkerUtils.js'
 
-export class WorkerSet extends WorkerAbstract<WorkerData> {
-  public readonly emitter: EventEmitterAsyncResource | undefined;
-  private readonly workerSet: Set<WorkerSetElement>;
-  private started: boolean;
-  private workerStartup: boolean;
+interface ResponseWrapper<R extends WorkerData> {
+  resolve: (value: R | PromiseLike<R>) => void
+  reject: (reason?: unknown) => void
+  workerSetElement: WorkerSetElement
+}
+
+export class WorkerSet<D extends WorkerData, R extends WorkerData> extends WorkerAbstract<D, R> {
+  public readonly emitter: EventEmitterAsyncResource | undefined
+  private readonly workerSet: Set<WorkerSetElement>
+  private readonly promiseResponseMap: Map<
+    `${string}-${string}-${string}-${string}`,
+  ResponseWrapper<R>
+  >
+
+  private started: boolean
+  private workerStartup: boolean
 
   /**
    * Creates a new `WorkerSet`.
@@ -28,163 +40,206 @@ export class WorkerSet extends WorkerAbstract<WorkerData> {
    * @param workerScript -
    * @param workerOptions -
    */
-  constructor(workerScript: string, workerOptions: WorkerOptions) {
-    super(workerScript, workerOptions);
+  constructor (workerScript: string, workerOptions: WorkerOptions) {
+    super(workerScript, workerOptions)
     if (this.workerOptions.elementsPerWorker == null) {
-      throw new TypeError('Elements per worker is not defined');
+      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');
+      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');
+      throw new RangeError('Elements per worker must be greater than zero')
     }
-    this.workerSet = new Set<WorkerSetElement>();
-    if (this.workerOptions.poolOptions?.enableEvents) {
-      this.emitter = new EventEmitterAsyncResource({ name: 'workerset' });
+    this.workerSet = new Set<WorkerSetElement>()
+    this.promiseResponseMap = new Map<
+      `${string}-${string}-${string}-${string}`,
+    ResponseWrapper<R>
+    >()
+    if (this.workerOptions.poolOptions?.enableEvents === true) {
+      this.emitter = new EventEmitterAsyncResource({ name: 'workerset' })
     }
-    this.started = false;
-    this.workerStartup = false;
+    this.started = false
+    this.workerStartup = false
   }
 
-  get info(): SetInfo {
+  get info (): SetInfo {
     return {
       version: workerSetVersion,
       type: 'set',
       worker: 'thread',
+      started: this.started,
       size: this.size,
       elementsExecuting: [...this.workerSet].reduce(
         (accumulator, workerSetElement) => accumulator + workerSetElement.numberOfWorkerElements,
-        0,
+        0
       ),
-      elementsPerWorker: this.maxElementsPerWorker!,
-    };
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      elementsPerWorker: this.maxElementsPerWorker!
+    }
   }
 
-  get size(): number {
-    return this.workerSet.size;
+  get size (): number {
+    return this.workerSet.size
   }
 
-  get maxElementsPerWorker(): number | undefined {
-    return this.workerOptions.elementsPerWorker;
+  get maxElementsPerWorker (): number | undefined {
+    return this.workerOptions.elementsPerWorker
   }
 
   /** @inheritDoc */
-  public async start(): Promise<void> {
-    this.addWorkerSetElement();
+  public async start (): Promise<void> {
+    this.addWorkerSetElement()
     // Add worker set element sequentially to optimize memory at startup
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     this.workerOptions.workerStartDelay! > 0 &&
-      (await sleep(randomizeDelay(this.workerOptions.workerStartDelay!)));
-    this.emitter?.emit(WorkerSetEvents.started, this.info);
-    this.started = true;
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      (await sleep(randomizeDelay(this.workerOptions.workerStartDelay!)))
+    this.emitter?.emit(WorkerSetEvents.started, this.info)
+    this.started = true
   }
 
   /** @inheritDoc */
-  public async stop(): Promise<void> {
+  public async stop (): Promise<void> {
     for (const workerSetElement of this.workerSet) {
-      const worker = workerSetElement.worker;
-      const waitWorkerExit = new Promise<void>((resolve) => {
+      const worker = workerSetElement.worker
+      const waitWorkerExit = new Promise<void>(resolve => {
         worker.once('exit', () => {
-          resolve();
-        });
-      });
-      await worker.terminate();
-      await waitWorkerExit;
-      this.emitter?.emit(WorkerSetEvents.stopped, this.info);
-      this.emitter?.emitDestroy();
-      this.emitter?.removeAllListeners();
-      this.started = false;
+          resolve()
+        })
+      })
+      worker.unref()
+      await worker.terminate()
+      await waitWorkerExit
     }
+    this.emitter?.emit(WorkerSetEvents.stopped, this.info)
+    this.started = false
+    this.emitter?.emitDestroy()
   }
 
   /** @inheritDoc */
-  public async addElement(elementData: WorkerData): Promise<void> {
+  public async addElement (elementData: D): Promise<R> {
     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");
+      throw new Error('Cannot add a WorkerSet element: not started')
     }
-    const workerSetElement = await this.getWorkerSetElement();
-    workerSetElement.worker.postMessage({
-      event: WorkerMessageEvents.startWorkerElement,
-      data: elementData,
-    });
-    ++workerSetElement.numberOfWorkerElements;
+    const workerSetElement = await this.getWorkerSetElement()
+    const sendMessageToWorker = new Promise<R>((resolve, reject) => {
+      const message = {
+        uuid: randomUUID(),
+        event: WorkerMessageEvents.addWorkerElement,
+        data: elementData
+      } satisfies WorkerMessage<D>
+      workerSetElement.worker.postMessage(message)
+      this.promiseResponseMap.set(message.uuid, { resolve, reject, workerSetElement })
+    })
+    const response = await sendMessageToWorker
     // Add element sequentially to optimize memory at startup
-    if (this.workerOptions.elementStartDelay! > 0) {
-      await sleep(randomizeDelay(this.workerOptions.elementStartDelay!));
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    if (this.workerOptions.elementAddDelay! > 0) {
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      await sleep(randomizeDelay(this.workerOptions.elementAddDelay!))
     }
+    return response
   }
 
   /**
    * Adds a new `WorkerSetElement`.
    */
-  private addWorkerSetElement(): WorkerSetElement {
-    this.workerStartup = true;
+  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 ?? 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);
+      ...this.workerOptions.poolOptions?.workerOptions
+    })
+    worker.on('message', this.workerOptions.poolOptions?.messageHandler ?? EMPTY_FUNCTION)
+    worker.on('message', (message: WorkerMessage<R>) => {
+      const { uuid, event, data } = message
+      if (this.promiseResponseMap.has(uuid)) {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        const { resolve, reject, workerSetElement } = this.promiseResponseMap.get(uuid)!
+        switch (event) {
+          case WorkerMessageEvents.addedWorkerElement:
+            this.emitter?.emit(WorkerSetEvents.elementAdded, this.info)
+            ++workerSetElement.numberOfWorkerElements
+            resolve(data)
+            break
+          case WorkerMessageEvents.workerElementError:
+            this.emitter?.emit(WorkerSetEvents.elementError, data)
+            reject(data)
+            break
+          default:
+            reject(
+              new Error(
+                `Unknown worker message event: '${event}' received with data: '${JSON.stringify(
+                  data,
+                  undefined,
+                  2
+                )}'`
+              )
+            )
+        }
+        this.promiseResponseMap.delete(uuid)
       }
-    });
-    worker.on('error', this.workerOptions.poolOptions?.errorHandler ?? EMPTY_FUNCTION);
-    worker.on('error', (error) => {
-      this.emitter?.emit(WorkerSetEvents.error, error);
+    })
+    worker.on('error', this.workerOptions.poolOptions?.errorHandler ?? EMPTY_FUNCTION)
+    worker.on('error', error => {
+      this.emitter?.emit(WorkerSetEvents.error, error)
       if (
-        this.workerOptions.poolOptions?.restartWorkerOnError &&
+        this.workerOptions.poolOptions?.restartWorkerOnError === true &&
         this.started &&
         !this.workerStartup
       ) {
-        this.addWorkerSetElement();
+        this.addWorkerSetElement()
       }
-    });
-    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;
+      worker.unref()
+      worker.terminate().catch((error: unknown) => this.emitter?.emit(WorkerSetEvents.error, error))
+    })
+    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
   }
 
-  private removeWorkerSetElement(workerSetElement: WorkerSetElement): void {
-    this.workerSet.delete(workerSetElement);
+  private removeWorkerSetElement (workerSetElement: WorkerSetElement | undefined): void {
+    if (workerSetElement == null) {
+      return
+    }
+    this.workerSet.delete(workerSetElement)
   }
 
-  private async getWorkerSetElement(): Promise<WorkerSetElement> {
-    let chosenWorkerSetElement: WorkerSetElement | undefined;
+  private async getWorkerSetElement (): Promise<WorkerSetElement> {
+    let chosenWorkerSetElement: WorkerSetElement | undefined
     for (const workerSetElement of this.workerSet) {
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       if (workerSetElement.numberOfWorkerElements < this.workerOptions.elementsPerWorker!) {
-        chosenWorkerSetElement = workerSetElement;
-        break;
+        chosenWorkerSetElement = workerSetElement
+        break
       }
     }
-    if (!chosenWorkerSetElement) {
-      chosenWorkerSetElement = this.addWorkerSetElement();
+    if (chosenWorkerSetElement == null) {
+      chosenWorkerSetElement = this.addWorkerSetElement()
       // Add worker set element sequentially to optimize memory at startup
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       this.workerOptions.workerStartDelay! > 0 &&
-        (await sleep(randomizeDelay(this.workerOptions.workerStartDelay!)));
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        (await sleep(randomizeDelay(this.workerOptions.workerStartDelay!)))
     }
-    return chosenWorkerSetElement;
+    return chosenWorkerSetElement
   }
 
-  private getWorkerSetElementByWorker(worker: Worker): WorkerSetElement | undefined {
-    let workerSetElt: WorkerSetElement | undefined;
+  private getWorkerSetElementByWorker (worker: Worker): WorkerSetElement | undefined {
+    let workerSetElt: WorkerSetElement | undefined
     for (const workerSetElement of this.workerSet) {
       if (workerSetElement.worker.threadId === worker.threadId) {
-        workerSetElt = workerSetElement;
-        break;
+        workerSetElt = workerSetElement
+        break
       }
     }
-    return workerSetElt;
+    return workerSetElt
   }
 }