Merge branch 'master' of github.com:poolifier/poolifier

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

diff --git a/src/pools/worker-node.ts b/src/pools/worker-node.ts
index a2878d8980e4c300a7dc0712c7fbbbe971868f27..d29a6e323f35208e22b6f87ca4610fb0af1b3e34 100644 (file)
--- a/src/pools/worker-node.ts
+++ b/src/pools/worker-node.ts
@@ -1,31 +1,31 @@
 import { EventEmitter } from 'node:events'
 import { MessageChannel } from 'node:worker_threads'
 
-import { CircularArray } from '../circular-array.js'
-import { Deque } from '../deque.js'
+import { CircularBuffer } from '../circular-buffer.js'
+import { PriorityQueue } from '../priority-queue.js'
 import type { Task } from '../utility-types.js'
 import { DEFAULT_TASK_NAME } from '../utils.js'
 import {
   checkWorkerNodeArguments,
   createWorker,
   getWorkerId,
-  getWorkerType
+  getWorkerType,
 } from './utils.js'
 import {
   type EventHandler,
   type IWorker,
   type IWorkerNode,
+  MeasurementHistorySize,
   type StrategyData,
   type WorkerInfo,
   type WorkerNodeOptions,
   type WorkerType,
   WorkerTypes,
-  type WorkerUsage
+  type WorkerUsage,
 } from './worker.js'
 
 /**
  * Worker node.
- *
  * @typeParam Worker - Type of worker.
  * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
  */
@@ -44,13 +44,12 @@ export class WorkerNode<Worker extends IWorker, Data = unknown>
   public messageChannel?: MessageChannel
   /** @inheritdoc */
   public tasksQueueBackPressureSize: number
-  private readonly tasksQueue: Deque<Task<Data>>
-  private onBackPressureStarted: boolean
+  private readonly tasksQueue: PriorityQueue<Task<Data>>
+  private setBackPressureFlag: boolean
   private readonly taskFunctionsUsage: Map<string, WorkerUsage>
 
   /**
    * Constructs a new worker node.
-   *
    * @param type - The worker type.
    * @param filePath - Path to the worker file.
    * @param opts - The worker node options.
@@ -60,7 +59,7 @@ export class WorkerNode<Worker extends IWorker, Data = unknown>
     checkWorkerNodeArguments(type, filePath, opts)
     this.worker = createWorker<Worker>(type, filePath, {
       env: opts.env,
-      workerOptions: opts.workerOptions
+      workerOptions: opts.workerOptions,
     })
     this.info = this.initWorkerInfo(this.worker)
     this.usage = this.initWorkerUsage()
@@ -69,11 +68,19 @@ export class WorkerNode<Worker extends IWorker, Data = unknown>
     }
     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     this.tasksQueueBackPressureSize = opts.tasksQueueBackPressureSize!
-    this.tasksQueue = new Deque<Task<Data>>()
-    this.onBackPressureStarted = false
+    this.tasksQueue = new PriorityQueue<Task<Data>>(
+      opts.tasksQueueBucketSize,
+      opts.tasksQueuePriority
+    )
+    this.setBackPressureFlag = false
     this.taskFunctionsUsage = new Map<string, WorkerUsage>()
   }
 
+  /** @inheritdoc */
+  public setTasksQueuePriority (enablePriority: boolean): void {
+    this.tasksQueue.enablePriority = enablePriority
+  }
+
   /** @inheritdoc */
   public tasksQueueSize (): number {
     return this.tasksQueue.size
@@ -81,34 +88,39 @@ export class WorkerNode<Worker extends IWorker, Data = unknown>
 
   /** @inheritdoc */
   public enqueueTask (task: Task<Data>): number {
-    const tasksQueueSize = this.tasksQueue.push(task)
-    if (this.hasBackPressure() && !this.onBackPressureStarted) {
-      this.onBackPressureStarted = true
+    const tasksQueueSize = this.tasksQueue.enqueue(task, task.priority)
+    if (
+      !this.setBackPressureFlag &&
+      this.hasBackPressure() &&
+      !this.info.backPressure
+    ) {
+      this.setBackPressureFlag = true
+      this.info.backPressure = true
       this.emit('backPressure', { workerId: this.info.id })
-      this.onBackPressureStarted = false
+      this.setBackPressureFlag = false
     }
     return tasksQueueSize
   }
 
   /** @inheritdoc */
-  public unshiftTask (task: Task<Data>): number {
-    const tasksQueueSize = this.tasksQueue.unshift(task)
-    if (this.hasBackPressure() && !this.onBackPressureStarted) {
-      this.onBackPressureStarted = true
-      this.emit('backPressure', { workerId: this.info.id })
-      this.onBackPressureStarted = false
+  public dequeueTask (bucket?: number): Task<Data> | undefined {
+    const task = this.tasksQueue.dequeue(bucket)
+    if (
+      !this.setBackPressureFlag &&
+      !this.hasBackPressure() &&
+      this.info.backPressure
+    ) {
+      this.setBackPressureFlag = true
+      this.info.backPressure = false
+      this.setBackPressureFlag = false
     }
-    return tasksQueueSize
-  }
-
-  /** @inheritdoc */
-  public dequeueTask (): Task<Data> | undefined {
-    return this.tasksQueue.shift()
+    return task
   }
 
   /** @inheritdoc */
-  public popTask (): Task<Data> | undefined {
-    return this.tasksQueue.pop()
+  public dequeueLastPrioritizedTask (): Task<Data> | undefined {
+    // Start from the last empty or partially filled bucket
+    return this.dequeueTask(this.tasksQueue.buckets + 1)
   }
 
   /** @inheritdoc */
@@ -121,12 +133,6 @@ export class WorkerNode<Worker extends IWorker, Data = unknown>
     return this.tasksQueue.size >= this.tasksQueueBackPressureSize
   }
 
-  /** @inheritdoc */
-  public resetUsage (): void {
-    this.usage = this.initWorkerUsage()
-    this.taskFunctionsUsage.clear()
-  }
-
   /** @inheritdoc */
   public async terminate (): Promise<void> {
     const waitWorkerExit = new Promise<void>(resolve => {
@@ -213,7 +219,8 @@ export class WorkerNode<Worker extends IWorker, Data = unknown>
       type: getWorkerType(worker)!,
       dynamic: false,
       ready: false,
-      stealing: false
+      stealing: false,
+      backPressure: false,
     }
   }
 
@@ -236,22 +243,22 @@ export class WorkerNode<Worker extends IWorker, Data = unknown>
         },
         sequentiallyStolen: 0,
         stolen: 0,
-        failed: 0
+        failed: 0,
       },
       runTime: {
-        history: new CircularArray<number>()
+        history: new CircularBuffer(MeasurementHistorySize),
       },
       waitTime: {
-        history: new CircularArray<number>()
+        history: new CircularBuffer(MeasurementHistorySize),
       },
       elu: {
         idle: {
-          history: new CircularArray<number>()
+          history: new CircularBuffer(MeasurementHistorySize),
         },
         active: {
-          history: new CircularArray<number>()
-        }
-      }
+          history: new CircularBuffer(MeasurementHistorySize),
+        },
+      },
     }
   }
 
@@ -279,22 +286,22 @@ export class WorkerNode<Worker extends IWorker, Data = unknown>
         },
         sequentiallyStolen: 0,
         stolen: 0,
-        failed: 0
+        failed: 0,
       },
       runTime: {
-        history: new CircularArray<number>()
+        history: new CircularBuffer(MeasurementHistorySize),
       },
       waitTime: {
-        history: new CircularArray<number>()
+        history: new CircularBuffer(MeasurementHistorySize),
       },
       elu: {
         idle: {
-          history: new CircularArray<number>()
+          history: new CircularBuffer(MeasurementHistorySize),
         },
         active: {
-          history: new CircularArray<number>()
-        }
-      }
+          history: new CircularBuffer(MeasurementHistorySize),
+        },
+      },
     }
   }
 }