feat: add tasks wait time account per worker

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

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index fe03741a68254c686991c5ed6b222857e1ff70c8..14b30812d14bd21e55c0af4aee77db5daf8bc7e4 100644 (file)
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -1,20 +1,38 @@
-import EventEmitter from 'node:events'
+import EventEmitterAsyncResource from 'node:events'
 import type {
   ErrorHandler,
   ExitHandler,
   IWorker,
   MessageHandler,
-  OnlineHandler
+  OnlineHandler,
+  WorkerNode
 } from './worker'
 import type {
   WorkerChoiceStrategy,
   WorkerChoiceStrategyOptions
 } from './selection-strategies/selection-strategies-types'
 
+/**
+ * Pool types.
+ *
+ * @enum
+ * @internal
+ */
+export enum PoolType {
+  /**
+   * Fixed pool type.
+   */
+  FIXED = 'fixed',
+  /**
+   * Dynamic pool type.
+   */
+  DYNAMIC = 'dynamic'
+}
+
 /**
  * Pool events emitter.
  */
-export class PoolEmitter extends EventEmitter {}
+export class PoolEmitter extends EventEmitterAsyncResource {}
 
 /**
  * Enumeration of pool events.
@@ -43,6 +61,8 @@ export interface TasksQueueOptions {
 
 /**
  * Options for a poolifier pool.
+ *
+ * @typeParam Worker - Type of worker.
  */
 export interface PoolOptions<Worker extends IWorker> {
   /**
@@ -63,6 +83,8 @@ export interface PoolOptions<Worker extends IWorker> {
   exitHandler?: ExitHandler<Worker>
   /**
    * The worker choice strategy to use in this pool.
+   *
+   * @defaultValue WorkerChoiceStrategies.ROUND_ROBIN
    */
   workerChoiceStrategy?: WorkerChoiceStrategy
   /**
@@ -78,14 +100,11 @@ export interface PoolOptions<Worker extends IWorker> {
   /**
    * Pool worker tasks queue.
    *
-   * @experimental
    * @defaultValue false
    */
   enableTasksQueue?: boolean
   /**
    * Pool worker tasks queue options.
-   *
-   * @experimental
    */
   tasksQueueOptions?: TasksQueueOptions
 }
@@ -93,10 +112,29 @@ export interface PoolOptions<Worker extends IWorker> {
 /**
  * Contract definition for a poolifier pool.
  *
+ * @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<Data = unknown, Response = unknown> {
+export interface IPool<
+  Worker extends IWorker,
+  Data = unknown,
+  Response = unknown
+> {
+  /**
+   * Pool type.
+   *
+   * If it is `'dynamic'`, it provides the `max` property.
+   */
+  readonly type: PoolType
+  /**
+   * Pool maximum size.
+   */
+  readonly size: number
+  /**
+   * Pool worker nodes.
+   */
+  readonly workerNodes: Array<WorkerNode<Worker, Data>>
   /**
    * Emitter on which events can be listened to.
    *
@@ -107,12 +145,13 @@ export interface IPool<Data = unknown, Response = unknown> {
    */
   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 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.
    */
-  execute: (data: Data) => Promise<Response>
+  execute: (data?: Data, name?: string) => Promise<Response>
   /**
    * Shutdowns every current worker in this pool.
    */
@@ -121,6 +160,34 @@ export interface IPool<Data = unknown, Response = unknown> {
    * 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
 }