fix: fix back pressure detection

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

diff --git a/src/pools/worker.ts b/src/pools/worker.ts
index d071413b04a0c1ab5f79f3bff17ac9c78354f2d5..1d0c4e22e47f073384bdf8c69e3c477ea9cb1d2b 100644 (file)
--- a/src/pools/worker.ts
+++ b/src/pools/worker.ts
@@ -1,5 +1,11 @@
+import type { MessageChannel } from 'node:worker_threads'
 import type { CircularArray } from '../circular-array'
-import type { Queue } from '../queue'
+import type { Task } from '../utility-types'
+
+/**
+ * Callback invoked when the worker has started successfully.
+ */
+export type OnlineHandler<Worker extends IWorker> = (this: Worker) => void
 
 /**
  * Callback invoked if the worker has received a message.
@@ -17,11 +23,6 @@ export type ErrorHandler<Worker extends IWorker> = (
   error: Error
 ) => void
 
-/**
- * Callback invoked when the worker has started successfully.
- */
-export type OnlineHandler<Worker extends IWorker> = (this: Worker) => void
-
 /**
  * Callback invoked when the worker exits successfully.
  */
@@ -30,31 +31,6 @@ export type ExitHandler<Worker extends IWorker> = (
   exitCode: number
 ) => void
 
-/**
- * Message object that is passed as a task between main worker and worker.
- *
- * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
- * @internal
- */
-export interface Task<Data = unknown> {
-  /**
-   * Task name.
-   */
-  readonly name?: string
-  /**
-   * Task input data that will be passed to the worker.
-   */
-  readonly data?: Data
-  /**
-   * Timestamp.
-   */
-  readonly timestamp?: number
-  /**
-   * Message UUID.
-   */
-  readonly id?: string
-}
-
 /**
  * Measurement statistics.
  *
@@ -119,13 +95,26 @@ export interface TaskStatistics {
   /**
    * Maximum number of queued tasks.
    */
-  readonly maxQueued: number
+  readonly maxQueued?: number
   /**
    * Number of failed tasks.
    */
   failed: number
 }
 
+/**
+ * Enumeration of worker types.
+ */
+export const WorkerTypes = Object.freeze({
+  thread: 'thread',
+  cluster: 'cluster'
+} as const)
+
+/**
+ * Worker type.
+ */
+export type WorkerType = keyof typeof WorkerTypes
+
 /**
  * Worker information.
  *
@@ -136,14 +125,22 @@ export interface WorkerInfo {
    * Worker id.
    */
   readonly id: number | undefined
+  /**
+   * Worker type.
+   */
+  type: WorkerType
   /**
    * Dynamic flag.
    */
   dynamic: boolean
   /**
-   * Started flag.
+   * Ready flag.
+   */
+  ready: boolean
+  /**
+   * Task function names.
    */
-  started: boolean
+  taskFunctions?: string[]
 }
 
 /**
@@ -185,9 +182,9 @@ export interface IWorker {
    * @param event - The event.
    * @param handler - The event handler.
    */
-  on: ((event: 'message', handler: MessageHandler<this>) => void) &
+  readonly on: ((event: 'online', handler: OnlineHandler<this>) => void) &
+  ((event: 'message', handler: MessageHandler<this>) => void) &
   ((event: 'error', handler: ErrorHandler<this>) => void) &
-  ((event: 'online', handler: OnlineHandler<this>) => void) &
   ((event: 'exit', handler: ExitHandler<this>) => void)
   /**
    * Registers a listener to the exit event that will only be performed once.
@@ -195,7 +192,7 @@ export interface IWorker {
    * @param event - `'exit'`.
    * @param handler - The exit handler.
    */
-  once: (event: 'exit', handler: ExitHandler<this>) => void
+  readonly once: (event: 'exit', handler: ExitHandler<this>) => void
 }
 
 /**
@@ -205,21 +202,65 @@ export interface IWorker {
  * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
  * @internal
  */
-export interface WorkerNode<Worker extends IWorker, Data = unknown> {
+export interface IWorkerNode<Worker extends IWorker, Data = unknown> {
   /**
-   * Worker node worker.
+   * Worker.
    */
   readonly worker: Worker
   /**
-   * Worker node worker info.
+   * Worker info.
    */
   readonly info: WorkerInfo
   /**
-   * Worker node worker usage statistics.
+   * Message channel.
+   */
+  readonly messageChannel?: MessageChannel
+  /**
+   * Worker usage statistics.
    */
   usage: WorkerUsage
   /**
-   * Worker node tasks queue.
+   * Tasks queue size.
+   *
+   * @returns The tasks queue size.
+   */
+  readonly tasksQueueSize: () => number
+  /**
+   * Enqueue task.
+   *
+   * @param task - The task to queue.
+   * @returns The tasks queue size.
+   */
+  readonly enqueueTask: (task: Task<Data>) => number
+  /**
+   * Dequeue task.
+   *
+   * @returns The dequeued task.
+   */
+  readonly dequeueTask: () => Task<Data> | undefined
+  /**
+   * Clears tasks queue.
+   */
+  readonly clearTasksQueue: () => void
+  /**
+   * Whether the worker node has back pressure (i.e. its tasks queue is full).
+   *
+   * @returns `true` if the worker node has back pressure, `false` otherwise.
+   */
+  readonly hasBackPressure: () => boolean
+  /**
+   * Resets usage statistics.
+   */
+  readonly resetUsage: () => void
+  /**
+   * Closes communication channel.
+   */
+  readonly closeChannel: () => void
+  /**
+   * Gets task function worker usage statistics.
+   *
+   * @param name - The task function name.
+   * @returns The task function worker usage statistics if the task function worker usage statistics are initialized, `undefined` otherwise.
    */
-  readonly tasksQueue: Queue<Task<Data>>
+  readonly getTaskFunctionWorkerUsage: (name: string) => WorkerUsage | undefined
 }