X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=257b0d64b0844d664ba00763b1dcde79c4711ee7;hb=e5536a06df85c554b8832f5fb5195b369258053b;hp=92e399edf37bc51f2af2a45db428851f2e63be18;hpb=c4855468bc26a7ee37d2c8ef34bb1ac864448e77;p=poolifier.git

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index 92e399ed..257b0d64 100644
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -1,4 +1,4 @@
-import EventEmitter from 'node:events'
+import EventEmitterAsyncResource from 'node:events'
 import type {
   ErrorHandler,
   ExitHandler,
@@ -13,32 +13,50 @@ import type {
 } from './selection-strategies/selection-strategies-types'
 
 /**
- * Pool types.
- *
- * @enum
+ * Enumeration of pool types.
  */
-export enum PoolType {
+export const PoolTypes = Object.freeze({
   /**
    * Fixed pool type.
    */
-  FIXED = 'fixed',
+  fixed: 'fixed',
   /**
    * Dynamic pool type.
    */
-  DYNAMIC = 'dynamic'
-}
+  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)
 
 /**
@@ -46,6 +64,24 @@ export const PoolEvents = Object.freeze({
  */
 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
+}
+
 /**
  * Worker tasks queue options.
  */
@@ -60,6 +96,8 @@ export interface TasksQueueOptions {
 
 /**
  * Options for a poolifier pool.
+ *
+ * @typeParam Worker - Type of worker.
  */
 export interface PoolOptions<Worker extends IWorker> {
   /**
@@ -80,12 +118,18 @@ export interface PoolOptions<Worker extends IWorker> {
   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.
    *
@@ -95,14 +139,11 @@ export interface PoolOptions<Worker extends IWorker> {
   /**
    * Pool worker tasks queue.
    *
-   * @experimental
    * @defaultValue false
    */
   enableTasksQueue?: boolean
   /**
    * Pool worker tasks queue options.
-   *
-   * @experimental
    */
   tasksQueueOptions?: TasksQueueOptions
 }
@@ -112,7 +153,7 @@ export interface PoolOptions<Worker extends IWorker> {
  *
  * @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.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
  */
 export interface IPool<
   Worker extends IWorker,
@@ -120,11 +161,9 @@ export interface IPool<
   Response = unknown
 > {
   /**
-   * Pool type.
-   *
-   * If it is `'dynamic'`, it provides the `max` property.
+   * Pool information.
    */
-  readonly type: PoolType
+  readonly info: PoolInfo
   /**
    * Pool worker nodes.
    */
@@ -136,45 +175,54 @@ export interface IPool<
    *
    * - `'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
   /**
-   * Whether the pool is full or not.
+   * Executes the specified function in the worker constructor with the task data input parameter.
    *
-   * The pool filling boolean status.
+   * @param data - The task input data for the specified worker function. This can only be serializable 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.
    */
-  readonly full: boolean
+  execute: (data?: Data, name?: string) => Promise<Response>
   /**
-   * Whether the pool is busy or not.
-   *
-   * The pool busyness boolean status.
+   * Terminate every current worker in this pool.
    */
-  readonly busy: boolean
+  destroy: () => Promise<void>
   /**
-   * Finds a free worker node key based on the number of tasks the worker has applied.
-   *
-   * If a worker is found with `0` running tasks, it is detected as free and its worker node key is returned.
-   *
-   * If no free worker is found, `-1` is returned.
+   * Sets the worker choice strategy in this pool.
    *
-   * @returns A worker node key if there is one, `-1` otherwise.
+   * @param workerChoiceStrategy - The worker choice strategy.
+   * @param workerChoiceStrategyOptions - The worker choice strategy options.
    */
-  findFreeWorkerNodeKey: () => number
+  setWorkerChoiceStrategy: (
+    workerChoiceStrategy: WorkerChoiceStrategy,
+    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
+  ) => void
   /**
-   * Performs the task specified in the constructor with the data parameter.
+   * Sets the worker choice strategy options in this pool.
    *
-   * @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 workerChoiceStrategyOptions - The worker choice strategy options.
    */
-  execute: (data: Data) => Promise<Response>
+  setWorkerChoiceStrategyOptions: (
+    workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
+  ) => void
   /**
-   * Shutdowns every current worker in this pool.
+   * 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.
    */
-  destroy: () => Promise<void>
+  enableTasksQueue: (
+    enable: boolean,
+    tasksQueueOptions?: TasksQueueOptions
+  ) => void
   /**
-   * Sets the worker choice strategy in this pool.
+   * Sets the worker tasks queue options in this pool.
    *
-   * @param workerChoiceStrategy - The worker choice strategy.
+   * @param tasksQueueOptions - The worker tasks queue options.
    */
-  setWorkerChoiceStrategy: (workerChoiceStrategy: WorkerChoiceStrategy) => void
+  setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void
 }