X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=72e830745558831db7933dfcfd5b6c8a03b35d78;hb=473c717a499d52ce8a069c43ee168b70cb5701f1;hp=a092dffde443b35d3c09fb8212b159ede3851c58;hpb=036c58dd9dc083da22c5fc39036a2ff49d10dc49;p=poolifier.git

diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts
index a092dffd..72e83074 100644
--- a/src/pools/abstract-pool.ts
+++ b/src/pools/abstract-pool.ts
@@ -4,116 +4,41 @@ import type {
 } from '../utility-types'
 import { EMPTY_FUNCTION } from '../utils'
 import { isKillBehavior, KillBehaviors } from '../worker/worker-options'
-import type { IPoolInternal } from './pool-internal'
-import { PoolEmitter, PoolType } from './pool-internal'
-import type { WorkerChoiceStrategy } from './selection-strategies'
+import type { PoolOptions } from './pool'
+import { PoolEmitter } from './pool'
+import type { IPoolInternal, TasksUsage } from './pool-internal'
+import { PoolType } from './pool-internal'
+import type { IPoolWorker } from './pool-worker'
 import {
   WorkerChoiceStrategies,
-  WorkerChoiceStrategyContext
-} from './selection-strategies'
+  WorkerChoiceStrategy
+} from './selection-strategies/selection-strategies-types'
+import { WorkerChoiceStrategyContext } from './selection-strategies/worker-choice-strategy-context'
 
 /**
- * Callback invoked if the worker raised an error.
- */
-export type ErrorHandler<Worker> = (this: Worker, e: Error) => void
-
-/**
- * Callback invoked when the worker has started successfully.
- */
-export type OnlineHandler<Worker> = (this: Worker) => void
-
-/**
- * Callback invoked when the worker exits successfully.
- */
-export type ExitHandler<Worker> = (this: Worker, code: number) => void
-
-/**
- * Basic interface that describes the minimum required implementation of listener events for a pool-worker.
- */
-export interface IWorker {
-  /**
-   * Register a listener to the error event.
-   *
-   * @param event `'error'`.
-   * @param handler The error handler.
-   */
-  on(event: 'error', handler: ErrorHandler<this>): void
-  /**
-   * Register a listener to the online event.
-   *
-   * @param event `'online'`.
-   * @param handler The online handler.
-   */
-  on(event: 'online', handler: OnlineHandler<this>): void
-  /**
-   * Register a listener to the exit event.
-   *
-   * @param event `'exit'`.
-   * @param handler The exit handler.
-   */
-  on(event: 'exit', handler: ExitHandler<this>): void
-  /**
-   * Register a listener to the exit event that will only performed once.
-   *
-   * @param event `'exit'`.
-   * @param handler The exit handler.
-   */
-  once(event: 'exit', handler: ExitHandler<this>): void
-}
-
-/**
- * Options for a poolifier pool.
- */
-export interface PoolOptions<Worker> {
-  /**
-   * A function that will listen for error event on each worker.
-   */
-  errorHandler?: ErrorHandler<Worker>
-  /**
-   * A function that will listen for online event on each worker.
-   */
-  onlineHandler?: OnlineHandler<Worker>
-  /**
-   * A function that will listen for exit event on each worker.
-   */
-  exitHandler?: ExitHandler<Worker>
-  /**
-   * The work choice strategy to use in this pool.
-   */
-  workerChoiceStrategy?: WorkerChoiceStrategy
-  /**
-   * Pool events emission.
-   *
-   * Default to true.
-   */
-  enableEvents?: boolean
-}
-
-/**
- * Base class containing some shared logic for all poolifier pools.
+ * 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.
  */
 export abstract class AbstractPool<
-  Worker extends IWorker,
+  Worker extends IPoolWorker,
   Data = unknown,
   Response = unknown
-> implements IPoolInternal<Worker, Data, Response>
-{
-  /** @inheritdoc */
+> implements IPoolInternal<Worker, Data, Response> {
+  /** @inheritDoc */
   public readonly workers: Worker[] = []
 
-  /** @inheritdoc */
-  public readonly tasks: Map<Worker, number> = new Map<Worker, number>()
+  /** @inheritDoc */
+  public readonly workersTasksUsage: Map<Worker, TasksUsage> = new Map<
+    Worker,
+    TasksUsage
+  >()
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   public readonly emitter?: PoolEmitter
 
-  /** @inheritdoc */
-  public readonly max?: number
-
   /**
    * The promise map.
    *
@@ -155,7 +80,7 @@ export abstract class AbstractPool<
     public readonly filePath: string,
     public readonly opts: PoolOptions<Worker>
   ) {
-    if (!this.isMain()) {
+    if (this.isMain() === false) {
       throw new Error('Cannot start a pool from a worker!')
     }
     this.checkNumberOfWorkers(this.numberOfWorkers)
@@ -167,21 +92,20 @@ export abstract class AbstractPool<
       this.createAndSetupWorker()
     }
 
-    if (this.opts.enableEvents) {
+    if (this.opts.enableEvents === true) {
       this.emitter = new PoolEmitter()
     }
     this.workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
       this,
       () => {
         const workerCreated = this.createAndSetupWorker()
-        this.registerWorkerMessageListener(workerCreated, async message => {
-          const tasksInProgress = this.tasks.get(workerCreated)
+        this.registerWorkerMessageListener(workerCreated, message => {
           if (
             isKillBehavior(KillBehaviors.HARD, message.kill) ||
-            tasksInProgress === 0
+            this.getWorkerRunningTasks(workerCreated) === 0
           ) {
             // Kill received from the worker, means that no new tasks are submitted to that worker for a while ( > maxInactiveTime)
-            await this.destroyWorker(workerCreated)
+            this.destroyWorker(workerCreated) as void
           }
         })
         return workerCreated
@@ -201,12 +125,12 @@ export abstract class AbstractPool<
       throw new Error(
         'Cannot instantiate a pool without specifying the number of workers'
       )
-    } else if (!Number.isSafeInteger(numberOfWorkers)) {
-      throw new Error(
+    } else if (Number.isSafeInteger(numberOfWorkers) === false) {
+      throw new TypeError(
         'Cannot instantiate a pool with a non integer number of workers'
       )
     } else if (numberOfWorkers < 0) {
-      throw new Error(
+      throw new RangeError(
         'Cannot instantiate a pool with a negative number of workers'
       )
     } else if (this.type === PoolType.FIXED && numberOfWorkers === 0) {
@@ -220,63 +144,84 @@ 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 */
+  /** @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
+  }
+
+  /** @inheritDoc */
   public setWorkerChoiceStrategy (
     workerChoiceStrategy: WorkerChoiceStrategy
   ): void {
     this.opts.workerChoiceStrategy = workerChoiceStrategy
+    for (const worker of this.workers) {
+      this.resetWorkerTasksUsage(worker)
+    }
     this.workerChoiceStrategyContext.setWorkerChoiceStrategy(
       workerChoiceStrategy
     )
   }
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   public abstract get busy (): boolean
 
   protected internalGetBusyStatus (): boolean {
     return (
       this.numberOfRunningTasks >= this.numberOfWorkers &&
-      this.findFreeTasksMapEntry() === false
+      this.findFreeWorker() === false
     )
   }
 
-  /** @inheritdoc */
-  public findFreeTasksMapEntry (): [Worker, number] | false {
-    for (const [worker, numberOfTasks] of this.tasks) {
-      if (numberOfTasks === 0) {
-        // A worker is free, return the matching tasks map entry
-        return [worker, numberOfTasks]
+  /** @inheritDoc */
+  public findFreeWorker (): Worker | false {
+    for (const worker of this.workers) {
+      if (this.getWorkerRunningTasks(worker) === 0) {
+        // A worker is free, return the matching worker
+        return worker
       }
     }
     return false
   }
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   public execute (data: Data): Promise<Response> {
     // Configure worker to handle message with the specified task
     const worker = this.chooseWorker()
-    const messageId = ++this.nextMessageId
-    const res = this.internalExecute(worker, messageId)
+    const res = this.internalExecute(worker, this.nextMessageId)
     this.checkAndEmitBusy()
-    this.sendToWorker(worker, { data: data || ({} as Data), id: messageId })
+    this.sendToWorker(worker, {
+      data: data ?? ({} as Data),
+      id: this.nextMessageId
+    })
+    ++this.nextMessageId
     return res
   }
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   public async destroy (): Promise<void> {
     await Promise.all(this.workers.map(worker => this.destroyWorker(worker)))
   }
 
   /**
-   * Shut down given worker.
+   * Shutdowns given worker.
    *
    * @param worker A worker within `workers`.
    */
@@ -296,52 +241,44 @@ export abstract class AbstractPool<
   protected abstract isMain (): boolean
 
   /**
-   * Increase the number of tasks that the given workers has applied.
-   *
-   * @param worker Worker whose tasks are increased.
-   */
-  protected increaseWorkersTask (worker: Worker): void {
-    this.stepWorkerNumberOfTasks(worker, 1)
-  }
-
-  /**
-   * Decrease the number of tasks that the given workers has applied.
+   * Hook executed before the worker task promise resolution.
+   * Can be overridden.
    *
-   * @param worker Worker whose tasks are decreased.
+   * @param worker The worker.
    */
-  protected decreaseWorkersTasks (worker: Worker): void {
-    this.stepWorkerNumberOfTasks(worker, -1)
+  protected beforePromiseWorkerResponseHook (worker: Worker): void {
+    this.increaseWorkerRunningTasks(worker)
   }
 
   /**
-   * Step the number of tasks that the given workers has applied.
+   * Hook executed after the worker task promise resolution.
+   * Can be overridden.
    *
-   * @param worker Worker whose tasks are set.
-   * @param step Worker number of tasks step.
+   * @param message The received message.
+   * @param promise The Promise response.
    */
-  private stepWorkerNumberOfTasks (worker: Worker, step: number): void {
-    const numberOfTasksInProgress = this.tasks.get(worker)
-    if (numberOfTasksInProgress !== undefined) {
-      this.tasks.set(worker, numberOfTasksInProgress + step)
-    } else {
-      throw Error('Worker could not be found in tasks map')
-    }
+  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)
   }
 
   /**
    * Removes the given worker from the pool.
    *
-   * @param worker Worker that will be removed.
+   * @param worker The worker that will be removed.
    */
   protected removeWorker (worker: Worker): void {
     // Clean worker from data structure
-    const workerIndex = this.workers.indexOf(worker)
-    this.workers.splice(workerIndex, 1)
-    this.tasks.delete(worker)
+    this.workers.splice(this.getWorkerIndex(worker), 1)
+    this.removeWorkerTasksUsage(worker)
   }
 
   /**
-   * Choose a worker for the next task.
+   * Chooses a worker for the next task.
    *
    * The default implementation uses a round robin algorithm to distribute the load.
    *
@@ -352,7 +289,7 @@ export abstract class AbstractPool<
   }
 
   /**
-   * Send a message to the given worker.
+   * Sends a message to the given worker.
    *
    * @param worker The worker which should receive the message.
    * @param message The message.
@@ -363,10 +300,10 @@ export abstract class AbstractPool<
   ): void
 
   /**
-   * Register a listener callback on a given worker.
+   * Registers a listener callback on a given worker.
    *
-   * @param worker A worker.
-   * @param listener A 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
@@ -376,7 +313,7 @@ export abstract class AbstractPool<
     worker: Worker,
     messageId: number
   ): Promise<Response> {
-    this.increaseWorkersTask(worker)
+    this.beforePromiseWorkerResponseHook(worker)
     return new Promise<Response>((resolve, reject) => {
       this.promiseMap.set(messageId, { resolve, reject, worker })
     })
@@ -402,8 +339,9 @@ export abstract class AbstractPool<
    * @returns New, completely set up worker.
    */
   protected createAndSetupWorker (): Worker {
-    const worker: Worker = this.createWorker()
+    const worker = this.createWorker()
 
+    worker.on('message', this.opts.messageHandler ?? EMPTY_FUNCTION)
     worker.on('error', this.opts.errorHandler ?? EMPTY_FUNCTION)
     worker.on('online', this.opts.onlineHandler ?? EMPTY_FUNCTION)
     worker.on('exit', this.opts.exitHandler ?? EMPTY_FUNCTION)
@@ -411,8 +349,8 @@ export abstract class AbstractPool<
 
     this.workers.push(worker)
 
-    // Init tasks map
-    this.tasks.set(worker, 0)
+    // Init worker tasks usage map
+    this.initWorkerTasksUsage(worker)
 
     this.afterWorkerSetup(worker)
 
@@ -422,16 +360,19 @@ export abstract class AbstractPool<
   /**
    * This function is the listener registered for each worker.
    *
-   * @returns The listener function to execute when a message is sent from a worker.
+   * @returns The listener function to execute when a message is received from a worker.
    */
   protected workerListener (): (message: MessageValue<Response>) => void {
     return message => {
-      if (message.id) {
-        const value = this.promiseMap.get(message.id)
-        if (value) {
-          this.decreaseWorkersTasks(value.worker)
-          if (message.error) value.reject(message.error)
-          else value.resolve(message.data as Response)
+      if (message.id !== undefined) {
+        const promise = this.promiseMap.get(message.id)
+        if (promise !== undefined) {
+          if (message.error) {
+            promise.reject(message.error)
+          } else {
+            promise.resolve(message.data as Response)
+          }
+          this.afterPromiseWorkerResponseHook(message, promise)
           this.promiseMap.delete(message.id)
         }
       }
@@ -439,8 +380,125 @@ export abstract class AbstractPool<
   }
 
   private checkAndEmitBusy (): void {
-    if (this.opts.enableEvents && this.busy) {
+    if (this.opts.enableEvents === true && this.busy === true) {
       this.emitter?.emit('busy')
     }
   }
+
+  /**
+   * 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) === true) {
+      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) === true) {
+      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 === true &&
+      this.checkWorkerTasksUsage(worker) === true
+    ) {
+      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)
+    }
+  }
+
+  /**
+   * Checks if the given worker is registered in the workers tasks usage map.
+   *
+   * @param worker Worker to check.
+   * @returns `true` if the worker is registered in the workers tasks usage map. `false` otherwise.
+   */
+  private checkWorkerTasksUsage (worker: Worker): boolean {
+    const hasTasksUsage = this.workersTasksUsage.has(worker)
+    if (hasTasksUsage === false) {
+      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
+    })
+  }
+
+  /**
+   * 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)
+  }
 }