import { MessageChannel } from 'node:worker_threads'
+import { EventEmitter } from 'node:events'
import { CircularArray } from '../circular-array'
-import { Queue } from '../queue'
import type { Task } from '../utility-types'
-import { DEFAULT_TASK_NAME } from '../utils'
+import { DEFAULT_TASK_NAME, getWorkerId, getWorkerType } from '../utils'
+import { Deque } from '../deque'
import {
+ type ErrorHandler,
+ type ExitHandler,
type IWorker,
type IWorkerNode,
+ type MessageHandler,
+ type OnlineHandler,
+ type StrategyData,
type WorkerInfo,
+ type WorkerNodeOptions,
type WorkerType,
WorkerTypes,
type WorkerUsage
} from './worker'
+import { checkWorkerNodeArguments, createWorker } from './utils'
/**
* Worker node.
* @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
+ /** @inheritdoc */
+ public strategyData?: StrategyData
+ /** @inheritdoc */
public messageChannel?: MessageChannel
/** @inheritdoc */
- public usage: WorkerUsage
+ public tasksQueueBackPressureSize: number
+ private readonly tasksQueue: Deque<Task<Data>>
+ private onBackPressureStarted: boolean
private readonly taskFunctionsUsage: Map<string, WorkerUsage>
- private readonly tasksQueue: Queue<Task<Data>>
- private readonly tasksQueueBackPressureSize: number
/**
* Constructs a new worker node.
*
- * @param worker - The worker.
- * @param workerType - The worker type.
- * @param poolMaxSize - The pool maximum size.
+ * @param type - The worker type.
+ * @param filePath - Path to the worker file.
+ * @param opts - The worker node options.
*/
- constructor (worker: Worker, workerType: WorkerType, poolMaxSize: number) {
- if (worker == null) {
- throw new Error('Cannot construct a worker node without a worker')
- }
- if (workerType == null) {
- throw new Error('Cannot construct a worker node without a worker type')
- }
- if (poolMaxSize == null) {
- throw new Error(
- 'Cannot construct a worker node without a pool maximum size'
- )
- }
- if (isNaN(poolMaxSize)) {
- throw new Error(
- 'Cannot construct a worker node with a NaN pool maximum size'
- )
- }
- this.worker = worker
- this.info = this.initWorkerInfo(worker, workerType)
- if (workerType === WorkerTypes.thread) {
+ 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()
+ if (this.info.type === WorkerTypes.thread) {
this.messageChannel = new MessageChannel()
}
- this.usage = this.initWorkerUsage()
+ this.tasksQueueBackPressureSize = opts.tasksQueueBackPressureSize
+ this.tasksQueue = new Deque<Task<Data>>()
+ this.onBackPressureStarted = false
this.taskFunctionsUsage = new Map<string, WorkerUsage>()
- this.tasksQueue = new Queue<Task<Data>>()
- this.tasksQueueBackPressureSize = Math.pow(poolMaxSize, 2)
}
/** @inheritdoc */
return this.tasksQueue.size
}
- /**
- * 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 as number })
+ 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 as number })
+ 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 */
}
/** @inheritdoc */
- public closeChannel (): void {
- if (this.messageChannel != null) {
- this.messageChannel?.port1.unref()
- this.messageChannel?.port2.unref()
- this.messageChannel?.port1.close()
- this.messageChannel?.port2.close()
- delete this.messageChannel
+ public async terminate (): Promise<void> {
+ const waitWorkerExit = new Promise<void>(resolve => {
+ this.registerOnceWorkerEventHandler('exit', () => {
+ resolve()
+ })
+ })
+ 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?.()
}
+ await waitWorkerExit
+ }
+
+ /** @inheritdoc */
+ public registerWorkerEventHandler (
+ event: string,
+ handler:
+ | OnlineHandler<Worker>
+ | MessageHandler<Worker>
+ | ErrorHandler<Worker>
+ | ExitHandler<Worker>
+ ): void {
+ this.worker.on(event, handler)
+ }
+
+ /** @inheritdoc */
+ public registerOnceWorkerEventHandler (
+ event: string,
+ handler:
+ | OnlineHandler<Worker>
+ | MessageHandler<Worker>
+ | ErrorHandler<Worker>
+ | ExitHandler<Worker>
+ ): void {
+ this.worker.once(event, handler)
}
/** @inheritdoc */
public getTaskFunctionWorkerUsage (name: string): WorkerUsage | undefined {
- if (!Array.isArray(this.info.taskFunctions)) {
+ 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.taskFunctions) &&
- this.info.taskFunctions.length < 3
+ 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.taskFunctions[1]
+ name = this.info.taskFunctionNames[1]
}
if (!this.taskFunctionsUsage.has(name)) {
this.taskFunctionsUsage.set(name, this.initTaskFunctionWorkerUsage(name))
return this.taskFunctionsUsage.get(name)
}
- private initWorkerInfo (worker: Worker, workerType: WorkerType): WorkerInfo {
+ /** @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),
+ type: getWorkerType(worker) as WorkerType,
dynamic: false,
ready: false
}
private initWorkerUsage (): WorkerUsage {
const getTasksQueueSize = (): number => {
- return this.tasksQueueSize()
+ return this.tasksQueue.size
}
const getTasksQueueMaxSize = (): number => {
- return this.tasksQueueMaxSize()
+ return this.tasksQueue.maxSize
}
return {
tasks: {
get maxQueued (): number {
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>()
}
}
}
}
private initTaskFunctionWorkerUsage (name: string): WorkerUsage {
- const getTaskQueueSize = (): number => {
- let taskQueueSize = 0
+ const getTaskFunctionQueueSize = (): number => {
+ let taskFunctionQueueSize = 0
for (const task of this.tasksQueue) {
- if (task.name === name) {
- ++taskQueueSize
+ if (
+ (task.name === DEFAULT_TASK_NAME &&
+ name === (this.info.taskFunctionNames as string[])[1]) ||
+ (task.name !== DEFAULT_TASK_NAME && name === task.name)
+ ) {
+ ++taskFunctionQueueSize
}
}
- return taskQueueSize
+ return taskFunctionQueueSize
}
return {
tasks: {
executed: 0,
executing: 0,
get queued (): number {
- return getTaskQueueSize()
+ return getTaskFunctionQueueSize()
},
+ 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.
- * @param workerType - The worker type.
- * @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
- }
- }
}
repositories / poolifier.git / blobdiff