import { randomUUID } from 'node:crypto'
import { performance } from 'node:perf_hooks'
import { existsSync } from 'node:fs'
+import { type TransferListItem } from 'node:worker_threads'
import type {
MessageValue,
PromiseResponseWrapper,
DEFAULT_TASK_NAME,
DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS,
EMPTY_FUNCTION,
- isAsyncFunction,
isKillBehavior,
isPlainObject,
median,
protected readonly opts: PoolOptions<Worker>
) {
if (!this.isMain()) {
- throw new Error('Cannot start a pool from a worker!')
+ throw new Error(
+ 'Cannot start a pool from a worker with the same type as the pool'
+ )
}
this.checkNumberOfWorkers(this.numberOfWorkers)
this.checkFilePath(this.filePath)
this.chooseWorkerNode = this.chooseWorkerNode.bind(this)
this.executeTask = this.executeTask.bind(this)
this.enqueueTask = this.enqueueTask.bind(this)
+ this.dequeueTask = this.dequeueTask.bind(this)
this.checkAndEmitEvents = this.checkAndEmitEvents.bind(this)
if (this.opts.enableEvents === true) {
protected checkDynamicPoolSize (min: number, max: number): void {
if (this.type === PoolTypes.dynamic) {
- if (min > max) {
+ if (max == null) {
+ throw new Error(
+ 'Cannot instantiate a dynamic pool without specifying the maximum pool size'
+ )
+ } else if (!Number.isSafeInteger(max)) {
+ throw new TypeError(
+ 'Cannot instantiate a dynamic pool with a non safe integer maximum pool size'
+ )
+ } else if (min > max) {
throw new RangeError(
'Cannot instantiate a dynamic pool with a maximum pool size inferior to the minimum pool size'
)
} else if (max === 0) {
throw new RangeError(
- 'Cannot instantiate a dynamic pool with a pool size equal to zero'
+ 'Cannot instantiate a dynamic pool with a maximum pool size equal to zero'
)
} else if (min === max) {
throw new RangeError(
accumulator + workerNode.usage.tasks.executing,
0
),
- queuedTasks: this.workerNodes.reduce(
- (accumulator, workerNode) =>
- accumulator + workerNode.usage.tasks.queued,
- 0
- ),
- maxQueuedTasks: this.workerNodes.reduce(
- (accumulator, workerNode) =>
- accumulator + (workerNode.usage.tasks?.maxQueued ?? 0),
- 0
- ),
+ ...(this.opts.enableTasksQueue === true && {
+ queuedTasks: this.workerNodes.reduce(
+ (accumulator, workerNode) =>
+ accumulator + workerNode.usage.tasks.queued,
+ 0
+ )
+ }),
+ ...(this.opts.enableTasksQueue === true && {
+ maxQueuedTasks: this.workerNodes.reduce(
+ (accumulator, workerNode) =>
+ accumulator + (workerNode.usage.tasks?.maxQueued ?? 0),
+ 0
+ )
+ }),
failedTasks: this.workerNodes.reduce(
(accumulator, workerNode) =>
accumulator + workerNode.usage.tasks.failed,
minimum: round(
Math.min(
...this.workerNodes.map(
- workerNode => workerNode.usage.runTime?.minimum ?? Infinity
+ (workerNode) => workerNode.usage.runTime?.minimum ?? Infinity
)
)
),
maximum: round(
Math.max(
...this.workerNodes.map(
- workerNode => workerNode.usage.runTime?.maximum ?? -Infinity
+ (workerNode) => workerNode.usage.runTime?.maximum ?? -Infinity
)
)
),
median: round(
median(
this.workerNodes.map(
- workerNode => workerNode.usage.runTime?.median ?? 0
+ (workerNode) => workerNode.usage.runTime?.median ?? 0
)
)
)
minimum: round(
Math.min(
...this.workerNodes.map(
- workerNode => workerNode.usage.waitTime?.minimum ?? Infinity
+ (workerNode) => workerNode.usage.waitTime?.minimum ?? Infinity
)
)
),
maximum: round(
Math.max(
...this.workerNodes.map(
- workerNode => workerNode.usage.waitTime?.maximum ?? -Infinity
+ (workerNode) => workerNode.usage.waitTime?.maximum ?? -Infinity
)
)
),
median: round(
median(
this.workerNodes.map(
- workerNode => workerNode.usage.waitTime?.median ?? 0
+ (workerNode) => workerNode.usage.waitTime?.median ?? 0
)
)
)
private checkMessageWorkerId (message: MessageValue<Response>): void {
if (
message.workerId != null &&
- this.getWorkerNodeKeyByWorkerId(message.workerId) == null
+ this.getWorkerNodeKeyByWorkerId(message.workerId) === -1
) {
throw new Error(
`Worker message received from unknown worker '${message.workerId}'`
* @param worker - The worker.
* @returns The worker node key if found in the pool worker nodes, `-1` otherwise.
*/
- private getWorkerNodeKey (worker: Worker): number {
+ private getWorkerNodeKeyByWorker (worker: Worker): number {
return this.workerNodes.findIndex(
- workerNode => workerNode.worker === worker
+ (workerNode) => workerNode.worker === worker
)
}
* Gets the worker node key given its worker id.
*
* @param workerId - The worker id.
- * @returns The worker node key if the worker id is found in the pool worker nodes, `undefined` otherwise.
+ * @returns The worker node key if the worker id is found in the pool worker nodes, `-1` otherwise.
*/
- private getWorkerNodeKeyByWorkerId (workerId: number): number | undefined {
- for (const [workerNodeKey, workerNode] of this.workerNodes.entries()) {
- if (workerNode.info.id === workerId) {
- return workerNodeKey
- }
- }
+ private getWorkerNodeKeyByWorkerId (workerId: number): number {
+ return this.workerNodes.findIndex(
+ (workerNode) => workerNode.info.id === workerId
+ )
}
/** @inheritDoc */
protected abstract get busy (): boolean
/**
- * Whether worker nodes are executing at least one task.
+ * Whether worker nodes are executing concurrently their tasks quota or not.
*
* @returns Worker nodes busyness boolean status.
*/
protected internalBusy (): boolean {
- return (
- this.workerNodes.findIndex(workerNode => {
- return workerNode.usage.tasks.executing === 0
- }) === -1
- )
+ if (this.opts.enableTasksQueue === true) {
+ return (
+ this.workerNodes.findIndex(
+ (workerNode) =>
+ workerNode.info.ready &&
+ workerNode.usage.tasks.executing <
+ (this.opts.tasksQueueOptions?.concurrency as number)
+ ) === -1
+ )
+ } else {
+ return (
+ this.workerNodes.findIndex(
+ (workerNode) =>
+ workerNode.info.ready && workerNode.usage.tasks.executing === 0
+ ) === -1
+ )
+ }
}
/** @inheritDoc */
- public async execute (data?: Data, name?: string): Promise<Response> {
+ public async execute (
+ data?: Data,
+ name?: string,
+ transferList?: TransferListItem[]
+ ): Promise<Response> {
return await new Promise<Response>((resolve, reject) => {
+ if (name != null && typeof name !== 'string') {
+ reject(new TypeError('name argument must be a string'))
+ }
+ if (transferList != null && !Array.isArray(transferList)) {
+ reject(new TypeError('transferList argument must be an array'))
+ }
const timestamp = performance.now()
const workerNodeKey = this.chooseWorkerNode()
const task: Task<Data> = {
name: name ?? DEFAULT_TASK_NAME,
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
data: data ?? ({} as Data),
+ transferList,
timestamp,
workerId: this.getWorkerInfo(workerNodeKey).id as number,
- id: randomUUID()
+ taskId: randomUUID()
}
- this.promiseResponseMap.set(task.id as string, {
+ this.promiseResponseMap.set(task.taskId as string, {
resolve,
reject,
workerNodeKey
})
if (
- this.opts.enableTasksQueue === true &&
- (this.busy ||
- this.workerNodes[workerNodeKey].usage.tasks.executing >=
- ((this.opts.tasksQueueOptions as TasksQueueOptions)
- .concurrency as number))
+ this.opts.enableTasksQueue === false ||
+ (this.opts.enableTasksQueue === true &&
+ this.workerNodes[workerNodeKey].usage.tasks.executing <
+ (this.opts.tasksQueueOptions?.concurrency as number))
) {
- this.enqueueTask(workerNodeKey, task)
- } else {
this.executeTask(workerNodeKey, task)
+ } else {
+ this.enqueueTask(workerNodeKey, task)
}
this.checkAndEmitEvents()
})
/** @inheritDoc */
public async destroy (): Promise<void> {
await Promise.all(
- this.workerNodes.map(async (workerNode, workerNodeKey) => {
- this.flushTasksQueue(workerNodeKey)
- // FIXME: wait for tasks to be finished
- const workerExitPromise = new Promise<void>(resolve => {
- workerNode.worker.on('exit', () => {
- resolve()
- })
- })
+ this.workerNodes.map(async (_, workerNodeKey) => {
await this.destroyWorkerNode(workerNodeKey)
- await workerExitPromise
})
)
}
+ protected async sendKillMessageToWorker (
+ workerNodeKey: number,
+ workerId: number
+ ): Promise<void> {
+ const waitForKillResponse = new Promise<void>((resolve, reject) => {
+ this.registerWorkerMessageListener(workerNodeKey, (message) => {
+ if (message.kill === 'success') {
+ resolve()
+ } else if (message.kill === 'failure') {
+ reject(new Error('Worker kill message handling failed'))
+ }
+ })
+ })
+ this.sendToWorker(workerNodeKey, { kill: true, workerId })
+ await waitForKillResponse
+ }
+
/**
* Terminates the worker node given its worker node key.
*
* @param workerNodeKey - The worker node key.
*/
- protected abstract destroyWorkerNode (
- workerNodeKey: number
- ): void | Promise<void>
+ protected abstract destroyWorkerNode (workerNodeKey: number): Promise<void>
/**
* Setup hook to execute code before worker nodes are created in the abstract constructor.
*
* @param workerNodeKey - The worker node key.
* @param message - The message.
+ * @param transferList - The optional array of transferable objects.
*/
protected abstract sendToWorker (
workerNodeKey: number,
- message: MessageValue<Data>
+ message: MessageValue<Data>,
+ transferList?: TransferListItem[]
): void
/**
worker.on('message', this.opts.messageHandler ?? EMPTY_FUNCTION)
worker.on('error', this.opts.errorHandler ?? EMPTY_FUNCTION)
- worker.on('error', error => {
- const workerNodeKey = this.getWorkerNodeKey(worker)
+ worker.on('error', (error) => {
+ const workerNodeKey = this.getWorkerNodeKeyByWorker(worker)
const workerInfo = this.getWorkerInfo(workerNodeKey)
workerInfo.ready = false
this.workerNodes[workerNodeKey].closeChannel()
*/
protected createAndSetupDynamicWorkerNode (): number {
const workerNodeKey = this.createAndSetupWorkerNode()
- this.registerWorkerMessageListener(workerNodeKey, message => {
+ this.registerWorkerMessageListener(workerNodeKey, (message) => {
const localWorkerNodeKey = this.getWorkerNodeKeyByWorkerId(
message.workerId
- ) as number
+ )
const workerUsage = this.workerNodes[localWorkerNodeKey].usage
+ // Kill message received from worker
if (
isKillBehavior(KillBehaviors.HARD, message.kill) ||
- (message.kill != null &&
+ (isKillBehavior(KillBehaviors.SOFT, message.kill) &&
((this.opts.enableTasksQueue === false &&
workerUsage.tasks.executing === 0) ||
(this.opts.enableTasksQueue === true &&
workerUsage.tasks.executing === 0 &&
this.tasksQueueSize(localWorkerNodeKey) === 0)))
) {
- // Kill message received from the worker: no new tasks are submitted to that worker for a while ( > maxInactiveTime)
- const destroyWorkerNodeBounded = this.destroyWorkerNode.bind(this)
- if (isAsyncFunction(destroyWorkerNodeBounded)) {
- (
- destroyWorkerNodeBounded as (workerNodeKey: number) => Promise<void>
- )(localWorkerNodeKey).catch(EMPTY_FUNCTION)
- } else {
- (destroyWorkerNodeBounded as (workerNodeKey: number) => void)(
- localWorkerNodeKey
- )
- }
+ this.destroyWorkerNode(localWorkerNodeKey).catch(EMPTY_FUNCTION)
}
})
const workerInfo = this.getWorkerInfo(workerNodeKey)
- workerInfo.dynamic = true
- if (this.workerChoiceStrategyContext.getStrategyPolicy().useDynamicWorker) {
- workerInfo.ready = true
- }
this.sendToWorker(workerNodeKey, {
checkActive: true,
workerId: workerInfo.id as number
})
+ workerInfo.dynamic = true
+ if (this.workerChoiceStrategyContext.getStrategyPolicy().useDynamicWorker) {
+ workerInfo.ready = true
+ }
return workerNodeKey
}
while (this.tasksQueueSize(workerNodeKey) > 0) {
let targetWorkerNodeKey: number = workerNodeKey
let minQueuedTasks = Infinity
+ let executeTask = false
for (const [workerNodeId, workerNode] of this.workerNodes.entries()) {
const workerInfo = this.getWorkerInfo(workerNodeId)
if (
workerInfo.ready &&
workerNode.usage.tasks.queued === 0
) {
+ if (
+ this.workerNodes[workerNodeId].usage.tasks.executing <
+ (this.opts.tasksQueueOptions?.concurrency as number)
+ ) {
+ executeTask = true
+ }
targetWorkerNodeKey = workerNodeId
break
}
targetWorkerNodeKey = workerNodeId
}
}
- this.enqueueTask(
- targetWorkerNodeKey,
- this.dequeueTask(workerNodeKey) as Task<Data>
- )
+ if (executeTask) {
+ this.executeTask(
+ targetWorkerNodeKey,
+ this.dequeueTask(workerNodeKey) as Task<Data>
+ )
+ } else {
+ this.enqueueTask(
+ targetWorkerNodeKey,
+ this.dequeueTask(workerNodeKey) as Task<Data>
+ )
+ }
}
}
* @returns The listener function to execute when a message is received from a worker.
*/
protected workerListener (): (message: MessageValue<Response>) => void {
- return message => {
+ return (message) => {
this.checkMessageWorkerId(message)
if (message.ready != null) {
- // Worker ready response received
+ // Worker ready response received from worker
this.handleWorkerReadyResponse(message)
- } else if (message.id != null) {
- // Task execution response received
+ } else if (message.taskId != null) {
+ // Task execution response received from worker
this.handleTaskExecutionResponse(message)
}
}
private handleWorkerReadyResponse (message: MessageValue<Response>): void {
this.getWorkerInfo(
- this.getWorkerNodeKeyByWorkerId(message.workerId) as number
+ this.getWorkerNodeKeyByWorkerId(message.workerId)
).ready = message.ready as boolean
if (this.emitter != null && this.ready) {
this.emitter.emit(PoolEvents.ready, this.info)
}
private handleTaskExecutionResponse (message: MessageValue<Response>): void {
- const promiseResponse = this.promiseResponseMap.get(message.id as string)
+ const promiseResponse = this.promiseResponseMap.get(
+ message.taskId as string
+ )
if (promiseResponse != null) {
if (message.taskError != null) {
this.emitter?.emit(PoolEvents.taskError, message.taskError)
}
const workerNodeKey = promiseResponse.workerNodeKey
this.afterTaskExecutionHook(workerNodeKey, message)
- this.promiseResponseMap.delete(message.id as string)
+ this.promiseResponseMap.delete(message.taskId as string)
if (
this.opts.enableTasksQueue === true &&
- this.tasksQueueSize(workerNodeKey) > 0
+ this.tasksQueueSize(workerNodeKey) > 0 &&
+ this.workerNodes[workerNodeKey].usage.tasks.executing <
+ (this.opts.tasksQueueOptions?.concurrency as number)
) {
this.executeTask(
workerNodeKey,
workerNode.info.ready = true
}
this.workerNodes.push(workerNode)
- const workerNodeKey = this.getWorkerNodeKey(worker)
+ const workerNodeKey = this.getWorkerNodeKeyByWorker(worker)
if (workerNodeKey === -1) {
throw new Error('Worker node not found')
}
* @param worker - The worker.
*/
private removeWorkerNode (worker: Worker): void {
- const workerNodeKey = this.getWorkerNodeKey(worker)
+ const workerNodeKey = this.getWorkerNodeKeyByWorker(worker)
if (workerNodeKey !== -1) {
this.workerNodes.splice(workerNodeKey, 1)
this.workerChoiceStrategyContext.remove(workerNodeKey)
*/
private executeTask (workerNodeKey: number, task: Task<Data>): void {
this.beforeTaskExecutionHook(workerNodeKey, task)
- this.sendToWorker(workerNodeKey, task)
+ this.sendToWorker(workerNodeKey, task, task.transferList)
}
private enqueueTask (workerNodeKey: number, task: Task<Data>): number {
return this.workerNodes[workerNodeKey].tasksQueueSize()
}
- private flushTasksQueue (workerNodeKey: number): void {
+ protected flushTasksQueue (workerNodeKey: number): void {
while (this.tasksQueueSize(workerNodeKey) > 0) {
this.executeTask(
workerNodeKey,