X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=87f4a8fa03f781aab2a17926fd98ab088387bf1b;hb=64383951fbf11fdf6a804fc6d081635fb925e403;hp=9d18ed70c7cd0d8204c510cfb52f5a774fe831be;hpb=ff733df7ebd4813628b27a5d27d509163e12af84;p=poolifier.git

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index 9d18ed70..87f4a8fa 100644
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -1,23 +1,62 @@
-import EventEmitter from 'node:events'
+import EventEmitterAsyncResource from 'node:events'
 import type {
   ErrorHandler,
   ExitHandler,
+  IWorker,
   MessageHandler,
-  OnlineHandler
+  OnlineHandler,
+  WorkerNode
 } from './worker'
-import type { WorkerChoiceStrategy } from './selection-strategies/selection-strategies-types'
+import type {
+  WorkerChoiceStrategy,
+  WorkerChoiceStrategyOptions
+} from './selection-strategies/selection-strategies-types'
+
+/**
+ * Enumeration of pool types.
+ */
+export const PoolTypes = Object.freeze({
+  /**
+   * Fixed pool type.
+   */
+  fixed: 'fixed',
+  /**
+   * Dynamic pool type.
+   */
+  dynamic: 'dynamic'
+} as const)
+
+/**
+ * Pool type.
+ */
+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 EventEmitter {}
+export class PoolEmitter extends EventEmitterAsyncResource {}
 
 /**
  * Enumeration of pool events.
  */
 export const PoolEvents = Object.freeze({
   full: 'full',
-  busy: 'busy'
+  busy: 'busy',
+  error: 'error',
+  taskError: 'taskError'
 } as const)
 
 /**
@@ -25,10 +64,47 @@ export const PoolEvents = Object.freeze({
  */
 export type PoolEvent = keyof typeof PoolEvents
 
+/**
+ * Pool information.
+ */
+export interface PoolInfo {
+  type: PoolType
+  worker: WorkerType
+  minSize: number
+  maxSize: number
+  /** Pool utilization ratio. */
+  utilization: number
+  /** Pool total worker nodes */
+  workerNodes: number
+  /** Pool idle worker nodes */
+  idleWorkerNodes: number
+  /** Pool busy worker nodes */
+  busyWorkerNodes: number
+  executedTasks: number
+  executingTasks: number
+  queuedTasks: number
+  maxQueuedTasks: number
+  failedTasks: number
+}
+
+/**
+ * Worker tasks queue options.
+ */
+export interface TasksQueueOptions {
+  /**
+   * Maximum number of tasks that can be executed concurrently on a worker.
+   *
+   * @defaultValue 1
+   */
+  concurrency?: number
+}
+
 /**
  * Options for a poolifier pool.
+ *
+ * @typeParam Worker - Type of worker.
  */
-export interface PoolOptions<Worker> {
+export interface PoolOptions<Worker extends IWorker> {
   /**
    * A function that will listen for message event on each worker.
    */
@@ -47,8 +123,18 @@ export interface PoolOptions<Worker> {
   exitHandler?: ExitHandler<Worker>
   /**
    * The worker choice strategy to use in this pool.
+   *
+   * @defaultValue WorkerChoiceStrategies.ROUND_ROBIN
    */
   workerChoiceStrategy?: WorkerChoiceStrategy
+  /**
+   * The worker choice strategy options.
+   */
+  workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
+  /**
+   * Restart worker on error.
+   */
+  restartWorkerOnError?: boolean
   /**
    * Pool events emission.
    *
@@ -58,19 +144,35 @@ export interface PoolOptions<Worker> {
   /**
    * Pool worker tasks queue.
    *
-   * @experimental
    * @defaultValue false
    */
   enableTasksQueue?: boolean
+  /**
+   * Pool worker tasks queue options.
+   */
+  tasksQueueOptions?: TasksQueueOptions
 }
 
 /**
  * Contract definition for a poolifier 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.
+ * @typeParam Worker - Type of worker which manages this pool.
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
  */
-export interface IPool<Data = unknown, Response = unknown> {
+export interface IPool<
+  Worker extends IWorker,
+  Data = unknown,
+  Response = unknown
+> {
+  /**
+   * Pool information.
+   */
+  readonly info: PoolInfo
+  /**
+   * Pool worker nodes.
+   */
+  readonly workerNodes: Array<WorkerNode<Worker, Data>>
   /**
    * Emitter on which events can be listened to.
    *
@@ -78,23 +180,54 @@ export interface IPool<Data = unknown, Response = unknown> {
    *
    * - `'full'`: Emitted when the pool is dynamic and full.
    * - `'busy'`: Emitted when the pool is busy.
+   * - `'error'`: Emitted when an uncaught error occurs.
+   * - `'taskError'`: Emitted when an error occurs while executing a task.
    */
   readonly emitter?: PoolEmitter
   /**
-   * Performs the task specified in the constructor with the data parameter.
+   * Executes the specified function in the worker constructor with the task data input parameter.
    *
-   * @param data - The input for the specified task. This can only be serializable data.
-   * @returns Promise that will be resolved when the task is successfully completed.
+   * @param data - The task input data for the specified worker function. This can only be structured-cloneable data.
+   * @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) => Promise<Response>
+  execute: (data?: Data, name?: string) => Promise<Response>
   /**
-   * Shutdowns every current worker in this pool.
+   * Terminates every current worker in this pool.
    */
   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: (
+    workerChoiceStrategy: WorkerChoiceStrategy,
+    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
+  ) => void
+  /**
+   * Sets the worker choice strategy options in this pool.
+   *
+   * @param workerChoiceStrategyOptions - The worker choice strategy options.
+   */
+  setWorkerChoiceStrategyOptions: (
+    workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
+  ) => void
+  /**
+   * Enables/disables the worker tasks queue in this pool.
+   *
+   * @param enable - Whether to enable or disable the worker tasks queue.
+   * @param tasksQueueOptions - The worker tasks queue options.
+   */
+  enableTasksQueue: (
+    enable: boolean,
+    tasksQueueOptions?: TasksQueueOptions
+  ) => void
+  /**
+   * Sets the worker tasks queue options in this pool.
+   *
+   * @param tasksQueueOptions - The worker tasks queue options.
    */
-  setWorkerChoiceStrategy: (workerChoiceStrategy: WorkerChoiceStrategy) => void
+  setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void
 }