+import { EventEmitter } from 'node:events'
import { MessageChannel } from 'node:worker_threads'
-import { CircularArray } from '../circular-array'
-import type { Task } from '../utility-types'
+
+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 {
- DEFAULT_TASK_NAME,
- EMPTY_FUNCTION,
- exponentialDelay,
+ checkWorkerNodeArguments,
+ createWorker,
getWorkerId,
- getWorkerType,
- sleep
-} from '../utils'
-import { Deque } from '../deque'
+ getWorkerType
+} from './utils.js'
import {
+ type EventHandler,
type IWorker,
type IWorkerNode,
type StrategyData,
type WorkerInfo,
- type WorkerNodeEventCallback,
+ type WorkerNodeOptions,
type WorkerType,
WorkerTypes,
type WorkerUsage
-} from './worker'
+} from './worker.js'
/**
* 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 messageChannel?: MessageChannel
/** @inheritdoc */
public tasksQueueBackPressureSize: number
- /** @inheritdoc */
- public onBackPressure?: WorkerNodeEventCallback
- /** @inheritdoc */
- public onEmptyQueue?: WorkerNodeEventCallback
private readonly tasksQueue: Deque<Task<Data>>
private onBackPressureStarted: boolean
- private onEmptyQueueCount: number
private readonly taskFunctionsUsage: Map<string, WorkerUsage>
/**
* Constructs a new worker node.
*
- * @param worker - The worker.
- * @param tasksQueueBackPressureSize - The tasks queue back pressure size.
+ * @param type - The worker type.
+ * @param filePath - Path to the worker file.
+ * @param opts - The worker node options.
*/
- constructor (worker: Worker, tasksQueueBackPressureSize: number) {
- this.checkWorkerNodeArguments(worker, tasksQueueBackPressureSize)
- this.worker = worker
- this.info = this.initWorkerInfo(worker)
+ 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.tasksQueueBackPressureSize = tasksQueueBackPressureSize
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.tasksQueueBackPressureSize = opts.tasksQueueBackPressureSize!
this.tasksQueue = new Deque<Task<Data>>()
this.onBackPressureStarted = false
- this.onEmptyQueueCount = 0
this.taskFunctionsUsage = new Map<string, WorkerUsage>()
}
/** @inheritdoc */
public enqueueTask (task: Task<Data>): number {
const tasksQueueSize = this.tasksQueue.push(task)
- if (
- this.onBackPressure != null &&
- this.hasBackPressure() &&
- !this.onBackPressureStarted
- ) {
+ if (this.hasBackPressure() && !this.onBackPressureStarted) {
this.onBackPressureStarted = true
- this.onBackPressure(this.info.id as number)
+ this.emit('backPressure', { workerId: this.info.id })
this.onBackPressureStarted = false
}
return tasksQueueSize
/** @inheritdoc */
public unshiftTask (task: Task<Data>): number {
const tasksQueueSize = this.tasksQueue.unshift(task)
- if (
- this.onBackPressure != null &&
- this.hasBackPressure() &&
- !this.onBackPressureStarted
- ) {
+ if (this.hasBackPressure() && !this.onBackPressureStarted) {
this.onBackPressureStarted = true
- this.onBackPressure(this.info.id as number)
+ this.emit('backPressure', { workerId: this.info.id })
this.onBackPressureStarted = false
}
return tasksQueueSize
/** @inheritdoc */
public dequeueTask (): Task<Data> | undefined {
- const task = this.tasksQueue.shift()
- if (
- this.onEmptyQueue != null &&
- this.tasksQueue.size === 0 &&
- this.onEmptyQueueCount === 0
- ) {
- this.startOnEmptyQueue().catch(EMPTY_FUNCTION)
- }
- return task
+ return this.tasksQueue.shift()
}
/** @inheritdoc */
public popTask (): Task<Data> | undefined {
- const task = this.tasksQueue.pop()
- if (
- this.onEmptyQueue != null &&
- this.tasksQueue.size === 0 &&
- this.onEmptyQueueCount === 0
- ) {
- this.startOnEmptyQueue().catch(EMPTY_FUNCTION)
- }
- return task
+ 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()
+ 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)
}
/** @inheritdoc */
return this.taskFunctionsUsage.get(name)
}
- private async startOnEmptyQueue (): Promise<void> {
- if (
- this.onEmptyQueueCount > 0 &&
- (this.usage.tasks.executing > 0 || this.tasksQueue.size > 0)
- ) {
- this.onEmptyQueueCount = 0
- return
+ /** @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
}
- ++this.onEmptyQueueCount
- this.onEmptyQueue?.(this.info.id as number)
- await sleep(exponentialDelay(this.onEmptyQueueCount))
- await this.startOnEmptyQueue()
}
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
}
}
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>()
}
}
}
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.taskFunctionNames![1]) ||
(task.name !== DEFAULT_TASK_NAME && name === task.name)
) {
++taskFunctionQueueSize
get queued (): number {
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>()
}
}
}
}
-
- private checkWorkerNodeArguments (
- worker: Worker,
- tasksQueueBackPressureSize: number
- ): void {
- if (worker == null) {
- throw new TypeError('Cannot construct a worker node without a worker')
- }
- if (tasksQueueBackPressureSize == null) {
- throw new TypeError(
- 'Cannot construct a worker node without a tasks queue back pressure size'
- )
- }
- if (!Number.isSafeInteger(tasksQueueBackPressureSize)) {
- throw new TypeError(
- 'Cannot construct a worker node with a tasks queue back pressure size that is not an integer'
- )
- }
- if (tasksQueueBackPressureSize <= 0) {
- throw new RangeError(
- 'Cannot construct a worker node with a tasks queue back pressure size that is not a positive integer'
- )
- }
- }
}
repositories / poolifier.git / blobdiff