X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=5ed353f602d4f0420e6fca66044122c749098074;hb=e65c6cd9a3d6ed2e5b8af95120a5aa070101e945;hp=6b12c2f99b6b986d822668c2648e0ff0ec59bd33;hpb=f44936aebf12fc2aa4f507680e84171367185788;p=poolifier.git

diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts
index 6b12c2f9..5ed353f6 100644
--- a/src/pools/abstract-pool.ts
+++ b/src/pools/abstract-pool.ts
@@ -1,61 +1,51 @@
+import crypto from 'node:crypto'
 import type {
   MessageValue,
   PromiseWorkerResponseWrapper
 } from '../utility-types'
-import { EMPTY_FUNCTION, EMPTY_LITERAL } from '../utils'
-import { isKillBehavior, KillBehaviors } from '../worker/worker-options'
+import { EMPTY_FUNCTION } from '../utils'
+import { KillBehaviors, isKillBehavior } from '../worker/worker-options'
 import type { PoolOptions } from './pool'
 import { PoolEmitter } from './pool'
-import type { IPoolInternal, TasksUsage } from './pool-internal'
+import type { IPoolInternal, TasksUsage, WorkerType } from './pool-internal'
 import { PoolType } from './pool-internal'
 import type { IPoolWorker } from './pool-worker'
 import {
   WorkerChoiceStrategies,
-  WorkerChoiceStrategy
+  type WorkerChoiceStrategy
 } from './selection-strategies/selection-strategies-types'
 import { WorkerChoiceStrategyContext } from './selection-strategies/worker-choice-strategy-context'
 
 /**
  * Base class that implements some shared logic for all poolifier pools.
  *
- * @template Worker Type of worker which manages this pool.
- * @template Data Type of data sent to the worker. This can only be serializable data.
- * @template Response Type of response of execution. This can only be serializable data.
+ * @typeParam Worker - Type of worker which manages this pool.
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Response - Type of response of execution. This can only be serializable data.
  */
 export abstract class AbstractPool<
   Worker extends IPoolWorker,
   Data = unknown,
   Response = unknown
 > implements IPoolInternal<Worker, Data, Response> {
-  /** @inheritDoc */
-  public readonly workers: Worker[] = []
+  /** {@inheritDoc} */
+  public readonly workers: Array<WorkerType<Worker>> = []
 
-  /** @inheritDoc */
-  public readonly workersTasksUsage: Map<Worker, TasksUsage> = new Map<
-  Worker,
-  TasksUsage
-  >()
-
-  /** @inheritDoc */
+  /** {@inheritDoc} */
   public readonly emitter?: PoolEmitter
 
   /**
    * The promise map.
    *
-   * - `key`: This is the message Id of each submitted task.
+   * - `key`: This is the message id of each submitted task.
    * - `value`: An object that contains the worker, the resolve function and the reject function.
    *
    * When we receive a message from the worker we get a map entry and resolve/reject the promise based on the message.
    */
   protected promiseMap: Map<
-  number,
+  string,
   PromiseWorkerResponseWrapper<Worker, Response>
-  > = new Map<number, PromiseWorkerResponseWrapper<Worker, Response>>()
-
-  /**
-   * Id of the next message.
-   */
-  protected nextMessageId: number = 0
+  > = new Map<string, PromiseWorkerResponseWrapper<Worker, Response>>()
 
   /**
    * Worker choice strategy instance implementing the worker choice algorithm.
@@ -71,9 +61,9 @@ export abstract class AbstractPool<
   /**
    * Constructs a new poolifier pool.
    *
-   * @param numberOfWorkers Number of workers that this pool should manage.
-   * @param filePath Path to the worker-file.
-   * @param opts Options for the pool.
+   * @param numberOfWorkers - Number of workers that this pool should manage.
+   * @param filePath - Path to the worker-file.
+   * @param opts - Options for the pool.
    */
   public constructor (
     public readonly numberOfWorkers: number,
@@ -102,10 +92,10 @@ export abstract class AbstractPool<
         this.registerWorkerMessageListener(workerCreated, message => {
           if (
             isKillBehavior(KillBehaviors.HARD, message.kill) ||
-            this.getWorkerRunningTasks(workerCreated) === 0
+            this.getWorkerTasksUsage(workerCreated)?.running === 0
           ) {
             // Kill received from the worker, means that no new tasks are submitted to that worker for a while ( > maxInactiveTime)
-            void (this.destroyWorker(workerCreated) as Promise<void>)
+            void this.destroyWorker(workerCreated)
           }
         })
         return workerCreated
@@ -115,7 +105,10 @@ export abstract class AbstractPool<
   }
 
   private checkFilePath (filePath: string): void {
-    if (filePath == null || filePath.length === 0) {
+    if (
+      filePath == null ||
+      (typeof filePath === 'string' && filePath.trim().length === 0)
+    ) {
       throw new Error('Please specify a file with a worker implementation')
     }
   }
@@ -144,43 +137,43 @@ export abstract class AbstractPool<
     this.opts.enableEvents = opts.enableEvents ?? true
   }
 
-  /** @inheritDoc */
+  /** {@inheritDoc} */
   public abstract get type (): PoolType
 
-  /** @inheritDoc */
+  /** {@inheritDoc} */
   public get numberOfRunningTasks (): number {
     return this.promiseMap.size
   }
 
-  /** @inheritDoc */
-  public getWorkerIndex (worker: Worker): number {
-    return this.workers.indexOf(worker)
-  }
-
-  /** @inheritDoc */
-  public getWorkerRunningTasks (worker: Worker): number | undefined {
-    return this.workersTasksUsage.get(worker)?.running
-  }
-
-  /** @inheritDoc */
-  public getWorkerAverageTasksRunTime (worker: Worker): number | undefined {
-    return this.workersTasksUsage.get(worker)?.avgRunTime
+  /**
+   * Gets the given worker key.
+   *
+   * @param worker - The worker.
+   * @returns The worker key.
+   */
+  private getWorkerKey (worker: Worker): number {
+    return this.workers.findIndex(workerItem => workerItem.worker === worker)
   }
 
-  /** @inheritDoc */
+  /** {@inheritDoc} */
   public setWorkerChoiceStrategy (
     workerChoiceStrategy: WorkerChoiceStrategy
   ): void {
     this.opts.workerChoiceStrategy = workerChoiceStrategy
-    for (const worker of this.workers) {
-      this.resetWorkerTasksUsage(worker)
+    for (const workerItem of this.workers) {
+      this.setWorker(workerItem.worker, {
+        run: 0,
+        running: 0,
+        runTime: 0,
+        avgRunTime: 0
+      })
     }
     this.workerChoiceStrategyContext.setWorkerChoiceStrategy(
       workerChoiceStrategy
     )
   }
 
-  /** @inheritDoc */
+  /** {@inheritDoc} */
   public abstract get busy (): boolean
 
   protected internalGetBusyStatus (): boolean {
@@ -190,41 +183,45 @@ export abstract class AbstractPool<
     )
   }
 
-  /** @inheritDoc */
+  /** {@inheritDoc} */
   public findFreeWorker (): Worker | false {
-    for (const worker of this.workers) {
-      if (this.getWorkerRunningTasks(worker) === 0) {
+    for (const workerItem of this.workers) {
+      if (workerItem.tasksUsage.running === 0) {
         // A worker is free, return the matching worker
-        return worker
+        return workerItem.worker
       }
     }
     return false
   }
 
-  /** @inheritDoc */
+  /** {@inheritDoc} */
   public async execute (data: Data): Promise<Response> {
-    // Configure worker to handle message with the specified task
     const worker = this.chooseWorker()
-    const res = this.internalExecute(worker, this.nextMessageId)
+    const messageId = crypto.randomUUID()
+    const res = this.internalExecute(worker, messageId)
     this.checkAndEmitBusy()
     this.sendToWorker(worker, {
-      data: data ?? (EMPTY_LITERAL as Data),
-      id: this.nextMessageId
+      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+      data: data ?? ({} as Data),
+      id: messageId
     })
-    ++this.nextMessageId
     // eslint-disable-next-line @typescript-eslint/return-await
     return res
   }
 
-  /** @inheritDoc */
+  /** {@inheritDoc} */
   public async destroy (): Promise<void> {
-    await Promise.all(this.workers.map(worker => this.destroyWorker(worker)))
+    await Promise.all(
+      this.workers.map(async workerItem => {
+        await this.destroyWorker(workerItem.worker)
+      })
+    )
   }
 
   /**
    * Shutdowns given worker.
    *
-   * @param worker A worker within `workers`.
+   * @param worker - A worker within `workers`.
    */
   protected abstract destroyWorker (worker: Worker): void | Promise<void>
 
@@ -245,37 +242,47 @@ export abstract class AbstractPool<
    * Hook executed before the worker task promise resolution.
    * Can be overridden.
    *
-   * @param worker The worker.
+   * @param worker - The worker.
    */
   protected beforePromiseWorkerResponseHook (worker: Worker): void {
-    this.increaseWorkerRunningTasks(worker)
+    ++(this.getWorkerTasksUsage(worker) as TasksUsage).running
   }
 
   /**
    * Hook executed after the worker task promise resolution.
    * Can be overridden.
    *
-   * @param message The received message.
-   * @param promise The Promise response.
+   * @param message - The received message.
+   * @param promise - The Promise response.
    */
   protected afterPromiseWorkerResponseHook (
     message: MessageValue<Response>,
     promise: PromiseWorkerResponseWrapper<Worker, Response>
   ): void {
-    this.decreaseWorkerRunningTasks(promise.worker)
-    this.stepWorkerRunTasks(promise.worker, 1)
-    this.updateWorkerTasksRunTime(promise.worker, message.taskRunTime)
+    const workerTasksUsage = this.getWorkerTasksUsage(
+      promise.worker
+    ) as TasksUsage
+    --workerTasksUsage.running
+    ++workerTasksUsage.run
+    if (
+      this.workerChoiceStrategyContext.getWorkerChoiceStrategy()
+        .requiredStatistics.runTime
+    ) {
+      workerTasksUsage.runTime += message.taskRunTime ?? 0
+      if (workerTasksUsage.run !== 0) {
+        workerTasksUsage.avgRunTime =
+          workerTasksUsage.runTime / workerTasksUsage.run
+      }
+    }
   }
 
   /**
    * Removes the given worker from the pool.
    *
-   * @param worker The worker that will be removed.
+   * @param worker - The worker that will be removed.
    */
   protected removeWorker (worker: Worker): void {
-    // Clean worker from data structure
-    this.workers.splice(this.getWorkerIndex(worker), 1)
-    this.removeWorkerTasksUsage(worker)
+    this.workers.splice(this.getWorkerKey(worker), 1)
   }
 
   /**
@@ -292,8 +299,8 @@ export abstract class AbstractPool<
   /**
    * Sends a message to the given worker.
    *
-   * @param worker The worker which should receive the message.
-   * @param message The message.
+   * @param worker - The worker which should receive the message.
+   * @param message - The message.
    */
   protected abstract sendToWorker (
     worker: Worker,
@@ -303,8 +310,8 @@ export abstract class AbstractPool<
   /**
    * Registers a listener callback on a given worker.
    *
-   * @param worker The worker which should register a listener.
-   * @param listener The message listener callback.
+   * @param worker - The worker which should register a listener.
+   * @param listener - The message listener callback.
    */
   protected abstract registerWorkerMessageListener<
     Message extends Data | Response
@@ -318,9 +325,9 @@ export abstract class AbstractPool<
   /**
    * Function that can be hooked up when a worker has been newly created and moved to the workers registry.
    *
-   * Can be used to update the `maxListeners` or binding the `main-worker`<->`worker` connection if not bind by default.
+   * Can be used to update the `maxListeners` or binding the `main-worker`\<-\>`worker` connection if not bind by default.
    *
-   * @param worker The newly created worker.
+   * @param worker - The newly created worker.
    */
   protected abstract afterWorkerSetup (worker: Worker): void
 
@@ -336,12 +343,16 @@ export abstract class AbstractPool<
     worker.on('error', this.opts.errorHandler ?? EMPTY_FUNCTION)
     worker.on('online', this.opts.onlineHandler ?? EMPTY_FUNCTION)
     worker.on('exit', this.opts.exitHandler ?? EMPTY_FUNCTION)
-    worker.once('exit', () => this.removeWorker(worker))
-
-    this.workers.push(worker)
+    worker.once('exit', () => {
+      this.removeWorker(worker)
+    })
 
-    // Init worker tasks usage map
-    this.initWorkerTasksUsage(worker)
+    this.setWorker(worker, {
+      run: 0,
+      running: 0,
+      runTime: 0,
+      avgRunTime: 0
+    })
 
     this.afterWorkerSetup(worker)
 
@@ -372,7 +383,7 @@ export abstract class AbstractPool<
 
   private async internalExecute (
     worker: Worker,
-    messageId: number
+    messageId: string
   ): Promise<Response> {
     this.beforePromiseWorkerResponseHook(worker)
     return await new Promise<Response>((resolve, reject) => {
@@ -386,120 +397,25 @@ export abstract class AbstractPool<
     }
   }
 
-  /**
-   * Increases the number of tasks that the given worker has applied.
-   *
-   * @param worker Worker which running tasks is increased.
-   */
-  private increaseWorkerRunningTasks (worker: Worker): void {
-    this.stepWorkerRunningTasks(worker, 1)
-  }
-
-  /**
-   * Decreases the number of tasks that the given worker has applied.
-   *
-   * @param worker Worker which running tasks is decreased.
-   */
-  private decreaseWorkerRunningTasks (worker: Worker): void {
-    this.stepWorkerRunningTasks(worker, -1)
-  }
-
-  /**
-   * Steps the number of tasks that the given worker has applied.
-   *
-   * @param worker Worker which running tasks are stepped.
-   * @param step Number of running tasks step.
-   */
-  private stepWorkerRunningTasks (worker: Worker, step: number): void {
-    if (this.checkWorkerTasksUsage(worker)) {
-      const tasksUsage = this.workersTasksUsage.get(worker) as TasksUsage
-      tasksUsage.running = tasksUsage.running + step
-      this.workersTasksUsage.set(worker, tasksUsage)
-    }
-  }
-
-  /**
-   * Steps the number of tasks that the given worker has run.
-   *
-   * @param worker Worker which has run tasks.
-   * @param step Number of run tasks step.
-   */
-  private stepWorkerRunTasks (worker: Worker, step: number): void {
-    if (this.checkWorkerTasksUsage(worker)) {
-      const tasksUsage = this.workersTasksUsage.get(worker) as TasksUsage
-      tasksUsage.run = tasksUsage.run + step
-      this.workersTasksUsage.set(worker, tasksUsage)
-    }
-  }
-
-  /**
-   * Updates tasks runtime for the given worker.
-   *
-   * @param worker Worker which run the task.
-   * @param taskRunTime Worker task runtime.
-   */
-  private updateWorkerTasksRunTime (
-    worker: Worker,
-    taskRunTime: number | undefined
-  ): void {
-    if (
-      this.workerChoiceStrategyContext.getWorkerChoiceStrategy()
-        .requiredStatistics.runTime &&
-      this.checkWorkerTasksUsage(worker)
-    ) {
-      const tasksUsage = this.workersTasksUsage.get(worker) as TasksUsage
-      tasksUsage.runTime += taskRunTime ?? 0
-      if (tasksUsage.run !== 0) {
-        tasksUsage.avgRunTime = tasksUsage.runTime / tasksUsage.run
-      }
-      this.workersTasksUsage.set(worker, tasksUsage)
+  /** {@inheritDoc} */
+  public getWorkerTasksUsage (worker: Worker): TasksUsage | undefined {
+    const workerKey = this.getWorkerKey(worker)
+    if (workerKey !== -1) {
+      return this.workers[workerKey].tasksUsage
     }
+    throw new Error('Worker could not be found in the pool')
   }
 
   /**
-   * Checks if the given worker is registered in the workers tasks usage map.
+   * Sets the given worker.
    *
-   * @param worker Worker to check.
-   * @returns `true` if the worker is registered in the workers tasks usage map. `false` otherwise.
+   * @param worker - The worker.
+   * @param tasksUsage - The worker tasks usage.
    */
-  private checkWorkerTasksUsage (worker: Worker): boolean {
-    const hasTasksUsage = this.workersTasksUsage.has(worker)
-    if (!hasTasksUsage) {
-      throw new Error('Worker could not be found in workers tasks usage map')
-    }
-    return hasTasksUsage
-  }
-
-  /**
-   * Initializes tasks usage statistics.
-   *
-   * @param worker The worker.
-   */
-  private initWorkerTasksUsage (worker: Worker): void {
-    this.workersTasksUsage.set(worker, {
-      run: 0,
-      running: 0,
-      runTime: 0,
-      avgRunTime: 0
+  private setWorker (worker: Worker, tasksUsage: TasksUsage): void {
+    this.workers.push({
+      worker,
+      tasksUsage
     })
   }
-
-  /**
-   * Removes worker tasks usage statistics.
-   *
-   * @param worker The worker.
-   */
-  private removeWorkerTasksUsage (worker: Worker): void {
-    this.workersTasksUsage.delete(worker)
-  }
-
-  /**
-   * Resets worker tasks usage statistics.
-   *
-   * @param worker The worker.
-   */
-  private resetWorkerTasksUsage (worker: Worker): void {
-    this.removeWorkerTasksUsage(worker)
-    this.initWorkerTasksUsage(worker)
-  }
 }