perf: use optimized circular buffer implementation to store measurements history
[poolifier.git] / src / pools / worker-node.ts
index 7a6a1500f962e4cc948ad593f3f40e45d49e53ad..d87a79c099c5dab34126e284ca2f14f4be72b3a1 100644 (file)
@@ -1,24 +1,28 @@
-import { MessageChannel } from 'node:worker_threads'
 import { EventEmitter } from 'node:events'
-import { CircularArray } from '../circular-array'
-import type { Task } from '../utility-types'
-import { DEFAULT_TASK_NAME, getWorkerId, getWorkerType } from '../utils'
-import { Deque } from '../deque'
+import { MessageChannel } from 'node:worker_threads'
+
+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 {
-  type ErrorHandler,
-  type ExitHandler,
+  checkWorkerNodeArguments,
+  createWorker,
+  getWorkerId,
+  getWorkerType
+} from './utils.js'
+import {
+  type EventHandler,
   type IWorker,
   type IWorkerNode,
-  type MessageHandler,
-  type OnlineHandler,
+  MeasurementHistorySize,
   type StrategyData,
   type WorkerInfo,
   type WorkerNodeOptions,
   type WorkerType,
   WorkerTypes,
   type WorkerUsage
-} from './worker'
-import { checkWorkerNodeArguments, createWorker } from './utils'
+} from './worker.js'
 
 /**
  * Worker node.
@@ -41,15 +45,15 @@ 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 - The worker file path.
+   * @param filePath - Path to the worker file.
    * @param opts - The worker node options.
    */
   constructor (type: WorkerType, filePath: string, opts: WorkerNodeOptions) {
@@ -64,9 +68,10 @@ export class WorkerNode<Worker extends IWorker, Data = unknown>
     if (this.info.type === WorkerTypes.thread) {
       this.messageChannel = new MessageChannel()
     }
-    this.tasksQueueBackPressureSize = opts.tasksQueueBackPressureSize
-    this.tasksQueue = new Deque<Task<Data>>()
-    this.onBackPressureStarted = false
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    this.tasksQueueBackPressureSize = opts.tasksQueueBackPressureSize!
+    this.tasksQueue = new PriorityQueue<Task<Data>>(opts.tasksQueueBucketSize)
+    this.setBackPressureFlag = false
     this.taskFunctionsUsage = new Map<string, WorkerUsage>()
   }
 
@@ -77,34 +82,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
-      this.emit('backPressure', { workerId: this.info.id as number })
-      this.onBackPressureStarted = false
+    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.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 as number })
-      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
+    return task
   }
 
   /** @inheritdoc */
-  public dequeueTask (): Task<Data> | undefined {
-    return this.tasksQueue.shift()
-  }
-
-  /** @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 */
@@ -117,12 +127,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 => {
@@ -132,13 +136,17 @@ export class WorkerNode<Worker extends IWorker, Data = unknown>
     })
     this.closeMessageChannel()
     this.removeAllListeners()
-    if (this.info.type === WorkerTypes.thread) {
-      await this.worker.terminate?.()
-    } else if (this.info.type === WorkerTypes.cluster) {
-      this.registerOnceWorkerEventHandler('disconnect', () => {
-        this.worker.kill?.()
-      })
-      this.worker.disconnect?.()
+    switch (this.info.type) {
+      case WorkerTypes.thread:
+        this.worker.unref?.()
+        await this.worker.terminate?.()
+        break
+      case WorkerTypes.cluster:
+        this.registerOnceWorkerEventHandler('disconnect', () => {
+          this.worker.kill?.()
+        })
+        this.worker.disconnect?.()
+        break
     }
     await waitWorkerExit
   }
@@ -146,44 +154,36 @@ export class WorkerNode<Worker extends IWorker, Data = unknown>
   /** @inheritdoc */
   public registerWorkerEventHandler (
     event: string,
-    listener:
-    | OnlineHandler<Worker>
-    | MessageHandler<Worker>
-    | ErrorHandler<Worker>
-    | ExitHandler<Worker>
+    handler: EventHandler<Worker>
   ): void {
-    this.worker.on(event, listener)
+    this.worker.on(event, handler)
   }
 
   /** @inheritdoc */
   public registerOnceWorkerEventHandler (
     event: string,
-    listener:
-    | OnlineHandler<Worker>
-    | MessageHandler<Worker>
-    | ErrorHandler<Worker>
-    | ExitHandler<Worker>
+    handler: EventHandler<Worker>
   ): void {
-    this.worker.once(event, listener)
+    this.worker.once(event, handler)
   }
 
   /** @inheritdoc */
   public getTaskFunctionWorkerUsage (name: string): WorkerUsage | undefined {
-    if (!Array.isArray(this.info.taskFunctionNames)) {
+    if (!Array.isArray(this.info.taskFunctionsProperties)) {
       throw new Error(
-        `Cannot get task function worker usage for task function name '${name}' when task function names list is not yet defined`
+        `Cannot get task function worker usage for task function name '${name}' when task function properties list is not yet defined`
       )
     }
     if (
-      Array.isArray(this.info.taskFunctionNames) &&
-      this.info.taskFunctionNames.length < 3
+      Array.isArray(this.info.taskFunctionsProperties) &&
+      this.info.taskFunctionsProperties.length < 3
     ) {
       throw new Error(
-        `Cannot get task function worker usage for task function name '${name}' when task function names list has less than 3 elements`
+        `Cannot get task function worker usage for task function name '${name}' when task function properties list has less than 3 elements`
       )
     }
     if (name === DEFAULT_TASK_NAME) {
-      name = this.info.taskFunctionNames[1]
+      name = this.info.taskFunctionsProperties[1].name
     }
     if (!this.taskFunctionsUsage.has(name)) {
       this.taskFunctionsUsage.set(name, this.initTaskFunctionWorkerUsage(name))
@@ -209,9 +209,12 @@ export class WorkerNode<Worker extends IWorker, Data = unknown>
   private initWorkerInfo (worker: Worker): WorkerInfo {
     return {
       id: getWorkerId(worker),
-      type: getWorkerType(worker) as WorkerType,
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      type: getWorkerType(worker)!,
       dynamic: false,
-      ready: false
+      ready: false,
+      stealing: false,
+      backPressure: false
     }
   }
 
@@ -237,17 +240,17 @@ export class WorkerNode<Worker extends IWorker, Data = unknown>
         failed: 0
       },
       runTime: {
-        history: new CircularArray<number>()
+        history: new CircularBuffer<number>(MeasurementHistorySize)
       },
       waitTime: {
-        history: new CircularArray<number>()
+        history: new CircularBuffer<number>(MeasurementHistorySize)
       },
       elu: {
         idle: {
-          history: new CircularArray<number>()
+          history: new CircularBuffer<number>(MeasurementHistorySize)
         },
         active: {
-          history: new CircularArray<number>()
+          history: new CircularBuffer<number>(MeasurementHistorySize)
         }
       }
     }
@@ -259,7 +262,8 @@ export class WorkerNode<Worker extends IWorker, Data = unknown>
       for (const task of this.tasksQueue) {
         if (
           (task.name === DEFAULT_TASK_NAME &&
-            name === (this.info.taskFunctionNames as string[])[1]) ||
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            name === this.info.taskFunctionsProperties![1].name) ||
           (task.name !== DEFAULT_TASK_NAME && name === task.name)
         ) {
           ++taskFunctionQueueSize
@@ -279,17 +283,17 @@ export class WorkerNode<Worker extends IWorker, Data = unknown>
         failed: 0
       },
       runTime: {
-        history: new CircularArray<number>()
+        history: new CircularBuffer<number>(MeasurementHistorySize)
       },
       waitTime: {
-        history: new CircularArray<number>()
+        history: new CircularBuffer<number>(MeasurementHistorySize)
       },
       elu: {
         idle: {
-          history: new CircularArray<number>()
+          history: new CircularBuffer<number>(MeasurementHistorySize)
         },
         active: {
-          history: new CircularArray<number>()
+          history: new CircularBuffer<number>(MeasurementHistorySize)
         }
       }
     }