feat: add pool and worker readyness tracking infrastructure

[poolifier.git] / src / pools / pool.ts

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index ef93982fbf19ab4c3350af3150116e7cb27dfd40..78d298f90f20381d3cb2157d276e32ced109f4a2 100644 (file)
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -1,11 +1,12 @@
-import EventEmitterAsyncResource from 'node:events'
+import { EventEmitter } from 'node:events'
 import type {
   ErrorHandler,
   ExitHandler,
   IWorker,
+  IWorkerNode,
   MessageHandler,
   OnlineHandler,
-  WorkerNode
+  WorkerType
 } from './worker'
 import type {
   WorkerChoiceStrategy,
@@ -31,29 +32,17 @@ export const PoolTypes = Object.freeze({
  */
 export type PoolType = keyof typeof PoolTypes
 
-/**
- * Enumeration of worker types.
- */
-export const WorkerTypes = Object.freeze({
-  cluster: 'cluster',
-  thread: 'thread'
-} as const)
-
-/**
- * Worker type.
- */
-export type WorkerType = keyof typeof WorkerTypes
-
 /**
  * Pool events emitter.
  */
-export class PoolEmitter extends EventEmitterAsyncResource {}
+export class PoolEmitter extends EventEmitter {}
 
 /**
  * Enumeration of pool events.
  */
 export const PoolEvents = Object.freeze({
   full: 'full',
+  ready: 'ready',
   busy: 'busy',
   error: 'error',
   taskError: 'taskError'
@@ -68,18 +57,38 @@ export type PoolEvent = keyof typeof PoolEvents
  * Pool information.
  */
 export interface PoolInfo {
-  type: PoolType
-  worker: WorkerType
-  minSize: number
-  maxSize: number
-  workerNodes: number
-  idleWorkerNodes: number
-  busyWorkerNodes: number
-  executedTasks: number
-  executingTasks: number
-  queuedTasks: number
-  maxQueuedTasks: number
-  failedTasks: number
+  readonly version: string
+  readonly type: PoolType
+  readonly worker: WorkerType
+  readonly ready: boolean
+  readonly strategy: WorkerChoiceStrategy
+  readonly minSize: number
+  readonly maxSize: number
+  /** Pool utilization ratio. */
+  readonly utilization?: number
+  /** Pool total worker nodes */
+  readonly workerNodes: number
+  /** Pool idle worker nodes */
+  readonly idleWorkerNodes: number
+  /** Pool busy worker nodes */
+  readonly busyWorkerNodes: number
+  readonly executedTasks: number
+  readonly executingTasks: number
+  readonly queuedTasks: number
+  readonly maxQueuedTasks: number
+  readonly failedTasks: number
+  readonly runTime?: {
+    readonly minimum: number
+    readonly maximum: number
+    readonly average: number
+    readonly median?: number
+  }
+  readonly waitTime?: {
+    readonly minimum: number
+    readonly maximum: number
+    readonly average: number
+    readonly median?: number
+  }
 }
 
 /**
@@ -91,7 +100,7 @@ export interface TasksQueueOptions {
    *
    * @defaultValue 1
    */
-  concurrency?: number
+  readonly concurrency?: number
 }
 
 /**
@@ -167,14 +176,15 @@ export interface IPool<
   /**
    * Pool worker nodes.
    */
-  readonly workerNodes: Array<WorkerNode<Worker, Data>>
+  readonly workerNodes: Array<IWorkerNode<Worker, Data>>
   /**
    * Emitter on which events can be listened to.
    *
    * Events that can currently be listened to:
    *
-   * - `'full'`: Emitted when the pool is dynamic and full.
-   * - `'busy'`: Emitted when the pool is busy.
+   * - `'full'`: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
+   * - `'ready'`: Emitted when the number of workers created in the pool has reached the maximum size expected and are ready.
+   * - `'busy'`: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.
    * - `'error'`: Emitted when an uncaught error occurs.
    * - `'taskError'`: Emitted when an error occurs while executing a task.
    */
@@ -186,18 +196,18 @@ export interface IPool<
    * @param name - The name of the worker function to execute. If not specified, the default worker function will be executed.
    * @returns Promise that will be fulfilled when the task is completed.
    */
-  execute: (data?: Data, name?: string) => Promise<Response>
+  readonly execute: (data?: Data, name?: string) => Promise<Response>
   /**
-   * Terminate every current worker in this pool.
+   * Terminates every current worker in this pool.
    */
-  destroy: () => Promise<void>
+  readonly destroy: () => Promise<void>
   /**
    * Sets the worker choice strategy in this pool.
    *
    * @param workerChoiceStrategy - The worker choice strategy.
    * @param workerChoiceStrategyOptions - The worker choice strategy options.
    */
-  setWorkerChoiceStrategy: (
+  readonly setWorkerChoiceStrategy: (
     workerChoiceStrategy: WorkerChoiceStrategy,
     workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
   ) => void
@@ -206,7 +216,7 @@ export interface IPool<
    *
    * @param workerChoiceStrategyOptions - The worker choice strategy options.
    */
-  setWorkerChoiceStrategyOptions: (
+  readonly setWorkerChoiceStrategyOptions: (
     workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
   ) => void
   /**
@@ -215,7 +225,7 @@ export interface IPool<
    * @param enable - Whether to enable or disable the worker tasks queue.
    * @param tasksQueueOptions - The worker tasks queue options.
    */
-  enableTasksQueue: (
+  readonly enableTasksQueue: (
     enable: boolean,
     tasksQueueOptions?: TasksQueueOptions
   ) => void
@@ -224,5 +234,5 @@ export interface IPool<
    *
    * @param tasksQueueOptions - The worker tasks queue options.
    */
-  setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void
+  readonly setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void
 }