-import { CircularArray } from '../circular-array'
-import { Queue } from '../queue'
+import { EventEmitter } from 'node:events'
+import { MessageChannel } from 'node:worker_threads'
+
+import { CircularArray } from '../circular-array.js'
+import { Deque } from '../deque.js'
+import type { Task } from '../utility-types.js'
+import { DEFAULT_TASK_NAME } from '../utils.js'
+import {
+ checkWorkerNodeArguments,
+ createWorker,
+ getWorkerId,
+ getWorkerType
+} from './utils.js'
import {
+ type EventHandler,
type IWorker,
type IWorkerNode,
- type Task,
+ type StrategyData,
type WorkerInfo,
+ type WorkerNodeOptions,
type WorkerType,
WorkerTypes,
type WorkerUsage
-} from './worker'
+} 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.
+ */
export class WorkerNode<Worker extends IWorker, Data = unknown>
-implements IWorkerNode<Worker, Data> {
+ extends EventEmitter
+ implements IWorkerNode<Worker, Data> {
+ /** @inheritdoc */
public readonly worker: Worker
+ /** @inheritdoc */
public readonly info: WorkerInfo
+ /** @inheritdoc */
public usage: WorkerUsage
- private readonly tasksQueue: Queue<Task<Data>>
+ /** @inheritdoc */
+ public strategyData?: StrategyData
+ /** @inheritdoc */
+ public messageChannel?: MessageChannel
+ /** @inheritdoc */
+ public tasksQueueBackPressureSize: number
+ private readonly tasksQueue: Deque<Task<Data>>
+ private onBackPressureStarted: boolean
+ private readonly taskFunctionsUsage: Map<string, WorkerUsage>
- constructor (worker: Worker, workerType: WorkerType) {
- this.worker = worker
- this.info = this.initWorkerInfo(worker, workerType)
+ /**
+ * Constructs a new worker node.
+ *
+ * @param type - The worker type.
+ * @param filePath - Path to the worker file.
+ * @param opts - The worker node options.
+ */
+ constructor (type: WorkerType, filePath: string, opts: WorkerNodeOptions) {
+ super()
+ checkWorkerNodeArguments(type, filePath, opts)
+ this.worker = createWorker<Worker>(type, filePath, {
+ env: opts.env,
+ workerOptions: opts.workerOptions
+ })
+ this.info = this.initWorkerInfo(this.worker)
this.usage = this.initWorkerUsage()
- this.tasksQueue = new Queue<Task<Data>>()
+ if (this.info.type === WorkerTypes.thread) {
+ this.messageChannel = new MessageChannel()
+ }
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.tasksQueueBackPressureSize = opts.tasksQueueBackPressureSize!
+ this.tasksQueue = new Deque<Task<Data>>()
+ this.onBackPressureStarted = false
+ this.taskFunctionsUsage = new Map<string, WorkerUsage>()
}
/** @inheritdoc */
return this.tasksQueue.size
}
- /**
- * Worker node tasks queue maximum size.
- *
- * @returns The tasks queue maximum size.
- */
- private tasksQueueMaxSize (): number {
- return this.tasksQueue.maxSize
+ /** @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 })
+ this.onBackPressureStarted = false
+ }
+ return tasksQueueSize
}
/** @inheritdoc */
- public enqueueTask (task: Task<Data>): number {
- return this.tasksQueue.enqueue(task)
+ 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
+ }
+ return tasksQueueSize
}
/** @inheritdoc */
public dequeueTask (): Task<Data> | undefined {
- return this.tasksQueue.dequeue()
+ return this.tasksQueue.shift()
+ }
+
+ /** @inheritdoc */
+ public popTask (): Task<Data> | undefined {
+ return this.tasksQueue.pop()
}
/** @inheritdoc */
this.tasksQueue.clear()
}
+ /** @inheritdoc */
+ public hasBackPressure (): boolean {
+ 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 => {
+ this.registerOnceWorkerEventHandler('exit', () => {
+ resolve()
+ })
+ })
+ this.closeMessageChannel()
+ this.removeAllListeners()
+ 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
+ }
+
+ /** @inheritdoc */
+ public registerWorkerEventHandler (
+ event: string,
+ handler: EventHandler<Worker>
+ ): void {
+ this.worker.on(event, handler)
+ }
+
+ /** @inheritdoc */
+ public registerOnceWorkerEventHandler (
+ event: string,
+ handler: EventHandler<Worker>
+ ): void {
+ this.worker.once(event, handler)
}
- private initWorkerInfo (worker: Worker, workerType: WorkerType): WorkerInfo {
+ /** @inheritdoc */
+ public getTaskFunctionWorkerUsage (name: string): WorkerUsage | undefined {
+ if (!Array.isArray(this.info.taskFunctionNames)) {
+ throw new Error(
+ `Cannot get task function worker usage for task function name '${name}' when task function names list is not yet defined`
+ )
+ }
+ if (
+ Array.isArray(this.info.taskFunctionNames) &&
+ this.info.taskFunctionNames.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`
+ )
+ }
+ if (name === DEFAULT_TASK_NAME) {
+ name = this.info.taskFunctionNames[1]
+ }
+ if (!this.taskFunctionsUsage.has(name)) {
+ this.taskFunctionsUsage.set(name, this.initTaskFunctionWorkerUsage(name))
+ }
+ return this.taskFunctionsUsage.get(name)
+ }
+
+ /** @inheritdoc */
+ public deleteTaskFunctionWorkerUsage (name: string): boolean {
+ return this.taskFunctionsUsage.delete(name)
+ }
+
+ private closeMessageChannel (): void {
+ if (this.messageChannel != null) {
+ this.messageChannel.port1.unref()
+ this.messageChannel.port2.unref()
+ this.messageChannel.port1.close()
+ this.messageChannel.port2.close()
+ delete this.messageChannel
+ }
+ }
+
+ private initWorkerInfo (worker: Worker): WorkerInfo {
return {
- id: this.getWorkerId(worker, workerType),
- type: workerType,
+ id: getWorkerId(worker),
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ type: getWorkerType(worker)!,
dynamic: false,
- started: true
+ ready: false,
+ stealing: false
}
}
private initWorkerUsage (): WorkerUsage {
const getTasksQueueSize = (): number => {
- return this.tasksQueueSize()
+ return this.tasksQueue.size
}
- const getTasksMaxQueueSize = (): number => {
- return this.tasksQueueMaxSize()
+ const getTasksQueueMaxSize = (): number => {
+ return this.tasksQueue.maxSize
}
return {
tasks: {
return getTasksQueueSize()
},
get maxQueued (): number {
- return getTasksMaxQueueSize()
+ return getTasksQueueMaxSize()
},
+ sequentiallyStolen: 0,
+ stolen: 0,
failed: 0
},
runTime: {
- history: new CircularArray()
+ history: new CircularArray<number>()
},
waitTime: {
- history: new CircularArray()
+ history: new CircularArray<number>()
},
elu: {
idle: {
- history: new CircularArray()
+ history: new CircularArray<number>()
},
active: {
- history: new CircularArray()
+ history: new CircularArray<number>()
}
}
}
}
- /**
- * Gets the worker id.
- *
- * @param worker - The worker.
- * @returns The worker id.
- */
- private getWorkerId (
- worker: Worker,
- workerType: WorkerType
- ): number | undefined {
- if (workerType === WorkerTypes.thread) {
- return worker.threadId
- } else if (workerType === WorkerTypes.cluster) {
- return worker.id
+ private initTaskFunctionWorkerUsage (name: string): WorkerUsage {
+ const getTaskFunctionQueueSize = (): number => {
+ let taskFunctionQueueSize = 0
+ for (const task of this.tasksQueue) {
+ if (
+ (task.name === DEFAULT_TASK_NAME &&
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ name === this.info.taskFunctionNames![1]) ||
+ (task.name !== DEFAULT_TASK_NAME && name === task.name)
+ ) {
+ ++taskFunctionQueueSize
+ }
+ }
+ return taskFunctionQueueSize
+ }
+ return {
+ tasks: {
+ executed: 0,
+ executing: 0,
+ get queued (): number {
+ return getTaskFunctionQueueSize()
+ },
+ sequentiallyStolen: 0,
+ stolen: 0,
+ failed: 0
+ },
+ runTime: {
+ history: new CircularArray<number>()
+ },
+ waitTime: {
+ history: new CircularArray<number>()
+ },
+ elu: {
+ idle: {
+ history: new CircularArray<number>()
+ },
+ active: {
+ history: new CircularArray<number>()
+ }
+ }
}
}
}
repositories / poolifier.git / blobdiff