refactor: remove unneeded encapsulation around tasks usage handling

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

diff --git a/src/pools/pool-internal.ts b/src/pools/pool-internal.ts
index dd71ae71045b555d99b64a24bba516461c77b561..9da6495266ab6c6e4654def94eca460b4630cb24 100644 (file)
--- a/src/pools/pool-internal.ts
+++ b/src/pools/pool-internal.ts
@@ -1,9 +1,8 @@
-import EventEmitter from 'events'
-import type { IWorker } from './abstract-pool'
 import type { IPool } from './pool'
+import type { IPoolWorker } from './pool-worker'
 
 /**
- * Pool types.
+ * Internal pool types.
  */
 export enum PoolType {
   FIXED = 'fixed',
@@ -11,43 +10,41 @@ export enum PoolType {
 }
 
 /**
- * Internal poolifier pool emitter.
+ * Internal tasks usage statistics.
  */
-export class PoolEmitter extends EventEmitter {}
+export interface TasksUsage {
+  run: number
+  running: number
+  runTime: number
+  avgRunTime: number
+}
+
+/**
+ * Internal worker type.
+ *
+ * @typeParam Worker - Type of worker which manages this pool.
+ */
+export interface WorkerType<Worker extends IPoolWorker> {
+  worker: Worker
+  tasksUsage: TasksUsage
+}
 
 /**
  * Internal contract definition for a poolifier pool.
  *
- * @template Worker Type of worker which manages this pool.
- * @template Data Type of data sent to the worker.
- * @template Response Type of response of execution.
+ * @typeParam Worker - Type of worker which manages this pool.
+ * @typeParam Data - Type of data sent to the worker.
+ * @typeParam Response - Type of response of execution.
  */
 export interface IPoolInternal<
-  Worker extends IWorker,
+  Worker extends IPoolWorker,
   Data = unknown,
   Response = unknown
 > extends IPool<Data, Response> {
   /**
-   * List of currently available workers.
-   */
-  readonly workers: Worker[]
-
-  /**
-   * The tasks map.
-   *
-   * - `key`: The `Worker`
-   * - `value`: Number of tasks currently in progress on the worker.
-   */
-  readonly tasks: Map<Worker, number>
-
-  /**
-   * Emitter on which events can be listened to.
-   *
-   * Events that can currently be listened to:
-   *
-   * - `'busy'`
+   * Pool workers map.
    */
-  readonly emitter?: PoolEmitter
+  readonly workers: Map<number, WorkerType<Worker>>
 
   /**
    * Pool type.
@@ -56,11 +53,6 @@ export interface IPoolInternal<
    */
   readonly type: PoolType
 
-  /**
-   * Maximum number of workers that can be created by this pool.
-   */
-  readonly max?: number
-
   /**
    * Whether the pool is busy or not.
    *
@@ -74,13 +66,21 @@ export interface IPoolInternal<
   readonly numberOfRunningTasks: number
 
   /**
-   * Find a tasks map entry with a free worker based on the number of tasks the worker has applied.
+   * Finds a free worker 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 returned.
    *
-   * If an entry is found with a worker that has `0` tasks, it is detected as free.
+   * If no free worker is found, `false` is returned.
    *
-   * If no tasks map entry with a free worker was found, `false` will be returned.
+   * @returns A free worker if there is one, otherwise `false`.
+   */
+  findFreeWorker: () => Worker | false
+
+  /**
+   * Gets worker tasks usage.
    *
-   * @returns A tasks map entry with a free worker if there was one, otherwise `false`.
+   * @param worker - The worker.
+   * @returns The tasks usage on the worker.
    */
-  findFreeTasksMapEntry(): [Worker, number] | false
+  getWorkerTasksUsage: (worker: Worker) => TasksUsage | undefined
 }