X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=18d4fb8362dcfdd9de125e0e83ca51aa91b98ff3;hb=310de0aa5d5b3887a4de4ef6a0b42e7b7a560987;hp=fc18d6b6b4b0492b36fb8a168ec34fc5b96b0f6c;hpb=02fd3265f178909511619be1593c3ff9774c8685;p=poolifier.git diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index fc18d6b6..18d4fb83 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -1,17 +1,23 @@ import { randomUUID } from 'node:crypto' import { performance } from 'node:perf_hooks' -import type { MessageValue, PromiseResponseWrapper } from '../utility-types' +import { existsSync } from 'node:fs' +import { type TransferListItem } from 'node:worker_threads' +import type { + MessageValue, + PromiseResponseWrapper, + Task +} from '../utility-types' import { + DEFAULT_TASK_NAME, DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS, EMPTY_FUNCTION, isKillBehavior, isPlainObject, median, - round + round, + updateMeasurementStatistics } from '../utils' import { KillBehaviors } from '../worker/worker-options' -import { CircularArray } from '../circular-array' -import { Queue } from '../queue' import { type IPool, PoolEmitter, @@ -20,19 +26,17 @@ import { type PoolOptions, type PoolType, PoolTypes, - type TasksQueueOptions, - type WorkerType, - WorkerTypes + type TasksQueueOptions } from './pool' import type { IWorker, - MessageHandler, - Task, + IWorkerNode, WorkerInfo, - WorkerNode, + WorkerType, WorkerUsage } from './worker' import { + type MeasurementStatisticsRequirements, Measurements, WorkerChoiceStrategies, type WorkerChoiceStrategy, @@ -40,6 +44,7 @@ import { } from './selection-strategies/selection-strategies-types' import { WorkerChoiceStrategyContext } from './selection-strategies/worker-choice-strategy-context' import { version } from './version' +import { WorkerNode } from './worker-node' /** * Base class that implements some shared logic for all poolifier pools. @@ -54,23 +59,21 @@ export abstract class AbstractPool< Response = unknown > implements IPool { /** @inheritDoc */ - public readonly workerNodes: Array> = [] + public readonly workerNodes: Array> = [] /** @inheritDoc */ public readonly emitter?: PoolEmitter /** - * The execution response promise map. + * The task execution response promise map. * * - `key`: The message id of each submitted task. * - `value`: An object that contains the worker, the execution response promise resolve and reject callbacks. * * When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id. */ - protected promiseResponseMap: Map< - string, - PromiseResponseWrapper - > = new Map>() + protected promiseResponseMap: Map> = + new Map>() /** * Worker choice strategy context referencing a worker choice algorithm implementation. @@ -81,10 +84,18 @@ export abstract class AbstractPool< Response > + /** + * Whether the pool is starting or not. + */ + private readonly starting: boolean /** * The start timestamp of the pool. */ private readonly startTimestamp + /** + * The task function names. + */ + private taskFunctions!: string[] /** * Constructs a new poolifier pool. @@ -99,7 +110,9 @@ export abstract class AbstractPool< protected readonly opts: PoolOptions ) { 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) @@ -108,6 +121,7 @@ export abstract class AbstractPool< 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) { @@ -125,9 +139,9 @@ export abstract class AbstractPool< this.setupHook() - while (this.workerNodes.length < this.numberOfWorkers) { - this.createAndSetupWorker() - } + this.starting = true + this.startPool() + this.starting = false this.startTimestamp = performance.now() } @@ -135,10 +149,14 @@ export abstract class AbstractPool< private checkFilePath (filePath: string): void { if ( filePath == null || + typeof filePath !== 'string' || (typeof filePath === 'string' && filePath.trim().length === 0) ) { throw new Error('Please specify a file with a worker implementation') } + if (!existsSync(filePath)) { + throw new Error(`Cannot find the worker file '${filePath}'`) + } } private checkNumberOfWorkers (numberOfWorkers: number): void { @@ -155,7 +173,33 @@ export abstract class AbstractPool< 'Cannot instantiate a pool with a negative number of workers' ) } else if (this.type === PoolTypes.fixed && numberOfWorkers === 0) { - throw new Error('Cannot instantiate a fixed pool with no worker') + throw new RangeError('Cannot instantiate a fixed pool with zero worker') + } + } + + protected checkDynamicPoolSize (min: number, max: number): void { + if (this.type === PoolTypes.dynamic) { + 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 maximum pool size equal to zero' + ) + } else if (min === max) { + throw new RangeError( + 'Cannot instantiate a dynamic pool with a minimum pool size equal to the maximum pool size. Use a fixed pool instead' + ) + } } } @@ -248,12 +292,26 @@ export abstract class AbstractPool< } } + private startPool (): void { + while ( + this.workerNodes.reduce( + (accumulator, workerNode) => + !workerNode.info.dynamic ? accumulator + 1 : accumulator, + 0 + ) < this.numberOfWorkers + ) { + this.createAndSetupWorkerNode() + } + } + /** @inheritDoc */ public get info (): PoolInfo { return { version, type: this.type, worker: this.worker, + ready: this.ready, + strategy: this.opts.workerChoiceStrategy as WorkerChoiceStrategy, minSize: this.minSize, maxSize: this.maxSize, ...(this.workerChoiceStrategyContext.getTaskStatisticsRequirements() @@ -283,16 +341,20 @@ export abstract class AbstractPool< 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 - ), + ...(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, @@ -301,43 +363,110 @@ export abstract class AbstractPool< ...(this.workerChoiceStrategyContext.getTaskStatisticsRequirements() .runTime.aggregate && { runTime: { - minimum: Math.min( - ...this.workerNodes.map( - workerNode => workerNode.usage.runTime?.minimum ?? Infinity + minimum: round( + Math.min( + ...this.workerNodes.map( + (workerNode) => workerNode.usage.runTime?.minimum ?? Infinity + ) + ) + ), + maximum: round( + Math.max( + ...this.workerNodes.map( + (workerNode) => workerNode.usage.runTime?.maximum ?? -Infinity + ) ) ), - maximum: Math.max( - ...this.workerNodes.map( - workerNode => workerNode.usage.runTime?.maximum ?? -Infinity + average: round( + this.workerNodes.reduce( + (accumulator, workerNode) => + accumulator + (workerNode.usage.runTime?.aggregate ?? 0), + 0 + ) / + this.workerNodes.reduce( + (accumulator, workerNode) => + accumulator + (workerNode.usage.tasks?.executed ?? 0), + 0 + ) + ), + ...(this.workerChoiceStrategyContext.getTaskStatisticsRequirements() + .runTime.median && { + median: round( + median( + this.workerNodes.map( + (workerNode) => workerNode.usage.runTime?.median ?? 0 + ) + ) ) - ) + }) } }), ...(this.workerChoiceStrategyContext.getTaskStatisticsRequirements() .waitTime.aggregate && { waitTime: { - minimum: Math.min( - ...this.workerNodes.map( - workerNode => workerNode.usage.waitTime?.minimum ?? Infinity + minimum: round( + Math.min( + ...this.workerNodes.map( + (workerNode) => workerNode.usage.waitTime?.minimum ?? Infinity + ) ) ), - maximum: Math.max( - ...this.workerNodes.map( - workerNode => workerNode.usage.waitTime?.maximum ?? -Infinity + maximum: round( + Math.max( + ...this.workerNodes.map( + (workerNode) => workerNode.usage.waitTime?.maximum ?? -Infinity + ) ) - ) + ), + average: round( + this.workerNodes.reduce( + (accumulator, workerNode) => + accumulator + (workerNode.usage.waitTime?.aggregate ?? 0), + 0 + ) / + this.workerNodes.reduce( + (accumulator, workerNode) => + accumulator + (workerNode.usage.tasks?.executed ?? 0), + 0 + ) + ), + ...(this.workerChoiceStrategyContext.getTaskStatisticsRequirements() + .waitTime.median && { + median: round( + median( + this.workerNodes.map( + (workerNode) => workerNode.usage.waitTime?.median ?? 0 + ) + ) + ) + }) } }) } } /** - * Gets the approximate pool utilization. + * The pool readiness boolean status. + */ + private get ready (): boolean { + return ( + this.workerNodes.reduce( + (accumulator, workerNode) => + !workerNode.info.dynamic && workerNode.info.ready + ? accumulator + 1 + : accumulator, + 0 + ) >= this.minSize + ) + } + + /** + * The approximate pool utilization. * * @returns The pool utilization. */ private get utilization (): number { - const poolRunTimeCapacity = + const poolTimeCapacity = (performance.now() - this.startTimestamp) * this.maxSize const totalTasksRunTime = this.workerNodes.reduce( (accumulator, workerNode) => @@ -349,40 +478,48 @@ export abstract class AbstractPool< accumulator + (workerNode.usage.waitTime?.aggregate ?? 0), 0 ) - return (totalTasksRunTime + totalTasksWaitTime) / poolRunTimeCapacity + return (totalTasksRunTime + totalTasksWaitTime) / poolTimeCapacity } /** - * Pool type. + * The pool type. * * If it is `'dynamic'`, it provides the `max` property. */ protected abstract get type (): PoolType /** - * Gets the worker type. + * The worker type. */ protected abstract get worker (): WorkerType /** - * Pool minimum size. + * The pool minimum size. */ protected abstract get minSize (): number /** - * Pool maximum size. + * The pool maximum size. */ protected abstract get maxSize (): number /** - * Get the worker given its id. + * Checks if the worker id sent in the received message from a worker is valid. * - * @param workerId - The worker id. - * @returns The worker if found in the pool worker nodes, `undefined` otherwise. + * @param message - The received message. + * @throws {@link https://nodejs.org/api/errors.html#class-error} If the worker id is invalid. */ - private getWorkerById (workerId: number): Worker | undefined { - return this.workerNodes.find(workerNode => workerNode.info.id === workerId) - ?.worker + private checkMessageWorkerId (message: MessageValue): void { + if (message.workerId == null) { + throw new Error('Worker message received without worker id') + } else if ( + message.workerId != null && + this.getWorkerNodeKeyByWorkerId(message.workerId) === -1 + ) { + throw new Error( + `Worker message received from unknown worker '${message.workerId}'` + ) + } } /** @@ -391,9 +528,21 @@ export abstract class AbstractPool< * @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 + ) + } + + /** + * 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, `-1` otherwise. + */ + private getWorkerNodeKeyByWorkerId (workerId: number): number { return this.workerNodes.findIndex( - workerNode => workerNode.worker === worker + (workerNode) => workerNode.info.id === workerId ) } @@ -410,12 +559,9 @@ export abstract class AbstractPool< if (workerChoiceStrategyOptions != null) { this.setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions) } - for (const workerNode of this.workerNodes) { - this.setWorkerNodeTasksUsage( - workerNode, - this.getInitialWorkerUsage(workerNode.worker) - ) - this.setWorkerStatistics(workerNode.worker) + for (const [workerNodeKey, workerNode] of this.workerNodes.entries()) { + workerNode.resetUsage() + this.sendStatisticsMessageToWorker(workerNodeKey) } } @@ -478,75 +624,130 @@ export abstract class AbstractPool< 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 { - const timestamp = performance.now() - const workerNodeKey = this.chooseWorkerNode() - const submittedTask: Task = { - name, - // eslint-disable-next-line @typescript-eslint/consistent-type-assertions - data: data ?? ({} as Data), - timestamp, - id: randomUUID() + public listTaskFunctions (): string[] { + if (this.taskFunctions != null) { + return this.taskFunctions + } else { + return [] } - const res = new Promise((resolve, reject) => { - this.promiseResponseMap.set(submittedTask.id as string, { + } + + /** @inheritDoc */ + public async execute ( + data?: Data, + name?: string, + transferList?: TransferListItem[] + ): Promise { + return await new Promise((resolve, reject) => { + if (name != null && typeof name !== 'string') { + reject(new TypeError('name argument must be a string')) + } + if ( + name != null && + typeof name === 'string' && + name.trim().length === 0 + ) { + reject(new TypeError('name argument must not be an empty string')) + } + if ( + name != null && + this.taskFunctions != null && + !this.taskFunctions.includes(name) + ) { + reject( + new Error(`Task function '${name}' is not registered in the pool`) + ) + } + 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 = { + 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, + taskId: randomUUID() + } + this.promiseResponseMap.set(task.taskId as string, { resolve, reject, - worker: this.workerNodes[workerNodeKey].worker + workerNodeKey }) + if ( + this.opts.enableTasksQueue === false || + (this.opts.enableTasksQueue === true && + this.workerNodes[workerNodeKey].usage.tasks.executing < + (this.opts.tasksQueueOptions?.concurrency as number)) + ) { + this.executeTask(workerNodeKey, task) + } else { + this.enqueueTask(workerNodeKey, task) + } + this.checkAndEmitEvents() }) - if ( - this.opts.enableTasksQueue === true && - (this.busy || - this.workerNodes[workerNodeKey].usage.tasks.executing >= - ((this.opts.tasksQueueOptions as TasksQueueOptions) - .concurrency as number)) - ) { - this.enqueueTask(workerNodeKey, submittedTask) - } else { - this.executeTask(workerNodeKey, submittedTask) - } - this.checkAndEmitEvents() - // eslint-disable-next-line @typescript-eslint/return-await - return res } /** @inheritDoc */ public async destroy (): Promise { await Promise.all( - this.workerNodes.map(async (workerNode, workerNodeKey) => { - this.flushTasksQueue(workerNodeKey) - // FIXME: wait for tasks to be finished - const workerExitPromise = new Promise(resolve => { - workerNode.worker.on('exit', () => { - resolve() - }) - }) - await this.destroyWorker(workerNode.worker) - await workerExitPromise + this.workerNodes.map(async (_, workerNodeKey) => { + await this.destroyWorkerNode(workerNodeKey) }) ) + this.emitter?.emit(PoolEvents.destroy) + } + + protected async sendKillMessageToWorker ( + workerNodeKey: number, + workerId: number + ): Promise { + await new Promise((resolve, reject) => { + this.registerWorkerMessageListener(workerNodeKey, (message) => { + if (message.kill === 'success') { + resolve() + } else if (message.kill === 'failure') { + reject(new Error(`Worker ${workerId} kill message handling failed`)) + } + }) + this.sendToWorker(workerNodeKey, { kill: true, workerId }) + }) } /** - * Terminates the given worker. + * Terminates the worker node given its worker node key. * - * @param worker - A worker within `workerNodes`. + * @param workerNodeKey - The worker node key. */ - protected abstract destroyWorker (worker: Worker): void | Promise + protected abstract destroyWorkerNode (workerNodeKey: number): Promise /** * Setup hook to execute code before worker nodes are created in the abstract constructor. @@ -577,23 +778,34 @@ export abstract class AbstractPool< const workerUsage = this.workerNodes[workerNodeKey].usage ++workerUsage.tasks.executing this.updateWaitTimeWorkerUsage(workerUsage, task) + const taskWorkerUsage = this.workerNodes[workerNodeKey].getTaskWorkerUsage( + task.name as string + ) as WorkerUsage + ++taskWorkerUsage.tasks.executing + this.updateWaitTimeWorkerUsage(taskWorkerUsage, task) } /** * Hook executed after the worker task execution. * Can be overridden. * - * @param worker - The worker. + * @param workerNodeKey - The worker node key. * @param message - The received message. */ protected afterTaskExecutionHook ( - worker: Worker, + workerNodeKey: number, message: MessageValue ): void { - const workerUsage = this.workerNodes[this.getWorkerNodeKey(worker)].usage + const workerUsage = this.workerNodes[workerNodeKey].usage this.updateTaskStatisticsWorkerUsage(workerUsage, message) this.updateRunTimeWorkerUsage(workerUsage, message) this.updateEluWorkerUsage(workerUsage, message) + const taskWorkerUsage = this.workerNodes[workerNodeKey].getTaskWorkerUsage( + message.taskPerformance?.name ?? DEFAULT_TASK_NAME + ) as WorkerUsage + this.updateTaskStatisticsWorkerUsage(taskWorkerUsage, message) + this.updateRunTimeWorkerUsage(taskWorkerUsage, message) + this.updateEluWorkerUsage(taskWorkerUsage, message) } private updateTaskStatisticsWorkerUsage ( @@ -602,8 +814,9 @@ export abstract class AbstractPool< ): void { const workerTaskStatistics = workerUsage.tasks --workerTaskStatistics.executing - ++workerTaskStatistics.executed - if (message.taskError != null) { + if (message.taskError == null) { + ++workerTaskStatistics.executed + } else { ++workerTaskStatistics.failed } } @@ -612,39 +825,12 @@ export abstract class AbstractPool< workerUsage: WorkerUsage, message: MessageValue ): void { - if ( - this.workerChoiceStrategyContext.getTaskStatisticsRequirements().runTime - .aggregate - ) { - const taskRunTime = message.taskPerformance?.runTime ?? 0 - workerUsage.runTime.aggregate = - (workerUsage.runTime.aggregate ?? 0) + taskRunTime - workerUsage.runTime.minimum = Math.min( - taskRunTime, - workerUsage.runTime?.minimum ?? Infinity - ) - workerUsage.runTime.maximum = Math.max( - taskRunTime, - workerUsage.runTime?.maximum ?? -Infinity - ) - if ( - this.workerChoiceStrategyContext.getTaskStatisticsRequirements().runTime - .average && - workerUsage.tasks.executed !== 0 - ) { - workerUsage.runTime.average = - workerUsage.runTime.aggregate / - (workerUsage.tasks.executed - workerUsage.tasks.failed) - } - if ( - this.workerChoiceStrategyContext.getTaskStatisticsRequirements().runTime - .median && - message.taskPerformance?.runTime != null - ) { - workerUsage.runTime.history.push(message.taskPerformance.runTime) - workerUsage.runTime.median = median(workerUsage.runTime.history) - } - } + updateMeasurementStatistics( + workerUsage.runTime, + this.workerChoiceStrategyContext.getTaskStatisticsRequirements().runTime, + message.taskPerformance?.runTime ?? 0, + workerUsage.tasks.executed + ) } private updateWaitTimeWorkerUsage ( @@ -653,54 +839,34 @@ export abstract class AbstractPool< ): void { const timestamp = performance.now() const taskWaitTime = timestamp - (task.timestamp ?? timestamp) - if ( - this.workerChoiceStrategyContext.getTaskStatisticsRequirements().waitTime - .aggregate - ) { - workerUsage.waitTime.aggregate = - (workerUsage.waitTime?.aggregate ?? 0) + taskWaitTime - workerUsage.waitTime.minimum = Math.min( - taskWaitTime, - workerUsage.waitTime?.minimum ?? Infinity - ) - workerUsage.waitTime.maximum = Math.max( - taskWaitTime, - workerUsage.waitTime?.maximum ?? -Infinity - ) - if ( - this.workerChoiceStrategyContext.getTaskStatisticsRequirements() - .waitTime.average && - workerUsage.tasks.executed !== 0 - ) { - workerUsage.waitTime.average = - workerUsage.waitTime.aggregate / - (workerUsage.tasks.executed - workerUsage.tasks.failed) - } - if ( - this.workerChoiceStrategyContext.getTaskStatisticsRequirements() - .waitTime.median - ) { - workerUsage.waitTime.history.push(taskWaitTime) - workerUsage.waitTime.median = median(workerUsage.waitTime.history) - } - } + updateMeasurementStatistics( + workerUsage.waitTime, + this.workerChoiceStrategyContext.getTaskStatisticsRequirements().waitTime, + taskWaitTime, + workerUsage.tasks.executed + ) } private updateEluWorkerUsage ( workerUsage: WorkerUsage, message: MessageValue ): void { - if ( + const eluTaskStatisticsRequirements: MeasurementStatisticsRequirements = this.workerChoiceStrategyContext.getTaskStatisticsRequirements().elu - .aggregate - ) { + updateMeasurementStatistics( + workerUsage.elu.active, + eluTaskStatisticsRequirements, + message.taskPerformance?.elu?.active ?? 0, + workerUsage.tasks.executed + ) + updateMeasurementStatistics( + workerUsage.elu.idle, + eluTaskStatisticsRequirements, + message.taskPerformance?.elu?.idle ?? 0, + workerUsage.tasks.executed + ) + if (eluTaskStatisticsRequirements.aggregate) { if (message.taskPerformance?.elu != null) { - workerUsage.elu.idle.aggregate = - (workerUsage.elu.idle?.aggregate ?? 0) + - message.taskPerformance.elu.idle - workerUsage.elu.active.aggregate = - (workerUsage.elu.active?.aggregate ?? 0) + - message.taskPerformance.elu.active if (workerUsage.elu.utilization != null) { workerUsage.elu.utilization = (workerUsage.elu.utilization + @@ -709,46 +875,6 @@ export abstract class AbstractPool< } else { workerUsage.elu.utilization = message.taskPerformance.elu.utilization } - workerUsage.elu.idle.minimum = Math.min( - message.taskPerformance.elu.idle, - workerUsage.elu.idle?.minimum ?? Infinity - ) - workerUsage.elu.idle.maximum = Math.max( - message.taskPerformance.elu.idle, - workerUsage.elu.idle?.maximum ?? -Infinity - ) - workerUsage.elu.active.minimum = Math.min( - message.taskPerformance.elu.active, - workerUsage.elu.active?.minimum ?? Infinity - ) - workerUsage.elu.active.maximum = Math.max( - message.taskPerformance.elu.active, - workerUsage.elu.active?.maximum ?? -Infinity - ) - if ( - this.workerChoiceStrategyContext.getTaskStatisticsRequirements().elu - .average && - workerUsage.tasks.executed !== 0 - ) { - const executedTasks = - workerUsage.tasks.executed - workerUsage.tasks.failed - workerUsage.elu.idle.average = - workerUsage.elu.idle.aggregate / executedTasks - workerUsage.elu.active.average = - workerUsage.elu.active.aggregate / executedTasks - } - if ( - this.workerChoiceStrategyContext.getTaskStatisticsRequirements().elu - .median && - message.taskPerformance?.elu != null - ) { - workerUsage.elu.idle.history.push(message.taskPerformance.elu.idle) - workerUsage.elu.active.history.push( - message.taskPerformance.elu.active - ) - workerUsage.elu.idle.median = median(workerUsage.elu.idle.history) - workerUsage.elu.active.median = median(workerUsage.elu.active.history) - } } } } @@ -758,15 +884,15 @@ export abstract class AbstractPool< * * The default worker choice strategy uses a round robin algorithm to distribute the tasks. * - * @returns The worker node key + * @returns The chosen worker node key */ private chooseWorkerNode (): number { if (this.shallCreateDynamicWorker()) { - const worker = this.createAndSetupDynamicWorker() + const workerNodeKey = this.createAndSetupDynamicWorkerNode() if ( this.workerChoiceStrategyContext.getStrategyPolicy().useDynamicWorker ) { - return this.getWorkerNodeKey(worker) + return workerNodeKey } } return this.workerChoiceStrategyContext.execute() @@ -782,29 +908,18 @@ export abstract class AbstractPool< } /** - * Sends a message to the given worker. + * Sends a message to worker given its worker node key. * - * @param worker - The worker which should receive the message. + * @param workerNodeKey - The worker node key. * @param message - The message. + * @param transferList - The optional array of transferable objects. */ protected abstract sendToWorker ( - worker: Worker, - message: MessageValue + workerNodeKey: number, + message: MessageValue, + transferList?: TransferListItem[] ): void - /** - * Registers a listener callback on the given worker. - * - * @param worker - The worker which should register a listener. - * @param listener - The message listener callback. - */ - private registerWorkerMessageListener( - worker: Worker, - listener: (message: MessageValue) => void - ): void { - worker.on('message', listener as MessageHandler) - } - /** * Creates a new worker. * @@ -813,155 +928,230 @@ export abstract class AbstractPool< protected abstract createWorker (): Worker /** - * Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes. - * Can be overridden. + * Creates a new, completely set up worker node. * - * @param worker - The newly created worker. + * @returns New, completely set up worker node key. */ - protected afterWorkerSetup (worker: Worker): void { - // Listen to worker messages. - this.registerWorkerMessageListener(worker, this.workerListener()) - } - - /** - * Creates a new worker and sets it up completely in the pool worker nodes. - * - * @returns New, completely set up worker. - */ - protected createAndSetupWorker (): Worker { + protected createAndSetupWorkerNode (): number { const worker = this.createWorker() + worker.on('online', this.opts.onlineHandler ?? EMPTY_FUNCTION) worker.on('message', this.opts.messageHandler ?? EMPTY_FUNCTION) worker.on('error', this.opts.errorHandler ?? EMPTY_FUNCTION) - worker.on('error', error => { - if (this.emitter != null) { - this.emitter.emit(PoolEvents.error, error) - } - if (this.opts.enableTasksQueue === true) { - const workerNodeKey = this.getWorkerNodeKey(worker) - while (this.tasksQueueSize(workerNodeKey) > 0) { - let targetWorkerNodeKey: number = workerNodeKey - let minQueuedTasks = Infinity - for (const [workerNodeId, workerNode] of this.workerNodes.entries()) { - if ( - workerNodeId !== workerNodeKey && - workerNode.usage.tasks.queued === 0 - ) { - targetWorkerNodeKey = workerNodeId - break - } - if ( - workerNodeId !== workerNodeKey && - workerNode.usage.tasks.queued < minQueuedTasks - ) { - minQueuedTasks = workerNode.usage.tasks.queued - targetWorkerNodeKey = workerNodeId - } - } - this.enqueueTask( - targetWorkerNodeKey, - this.dequeueTask(workerNodeKey) as Task - ) - } - } - if (this.opts.restartWorkerOnError === true) { - if (this.getWorkerInfo(this.getWorkerNodeKey(worker)).dynamic) { - this.createAndSetupDynamicWorker() + worker.on('error', (error) => { + const workerNodeKey = this.getWorkerNodeKeyByWorker(worker) + const workerInfo = this.getWorkerInfo(workerNodeKey) + workerInfo.ready = false + this.workerNodes[workerNodeKey].closeChannel() + this.emitter?.emit(PoolEvents.error, error) + if (this.opts.restartWorkerOnError === true && !this.starting) { + if (workerInfo.dynamic) { + this.createAndSetupDynamicWorkerNode() } else { - this.createAndSetupWorker() + this.createAndSetupWorkerNode() } } + if (this.opts.enableTasksQueue === true) { + this.redistributeQueuedTasks(workerNodeKey) + } }) - worker.on('online', this.opts.onlineHandler ?? EMPTY_FUNCTION) worker.on('exit', this.opts.exitHandler ?? EMPTY_FUNCTION) worker.once('exit', () => { this.removeWorkerNode(worker) }) - this.pushWorkerNode(worker) + const workerNodeKey = this.addWorkerNode(worker) - this.setWorkerStatistics(worker) + this.afterWorkerNodeSetup(workerNodeKey) - this.afterWorkerSetup(worker) - - return worker + return workerNodeKey } /** - * Creates a new dynamic worker and sets it up completely in the pool worker nodes. + * Creates a new, completely set up dynamic worker node. * - * @returns New, completely set up dynamic worker. + * @returns New, completely set up dynamic worker node key. */ - protected createAndSetupDynamicWorker (): Worker { - const worker = this.createAndSetupWorker() - this.getWorkerInfo(this.getWorkerNodeKey(worker)).dynamic = true - this.registerWorkerMessageListener(worker, message => { - const workerNodeKey = this.getWorkerNodeKey(worker) + protected createAndSetupDynamicWorkerNode (): number { + const workerNodeKey = this.createAndSetupWorkerNode() + this.registerWorkerMessageListener(workerNodeKey, (message) => { + const localWorkerNodeKey = this.getWorkerNodeKeyByWorkerId( + message.workerId + ) + 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 && - this.workerNodes[workerNodeKey].usage.tasks.executing === 0) || + workerUsage.tasks.executing === 0) || (this.opts.enableTasksQueue === true && - this.workerNodes[workerNodeKey].usage.tasks.executing === 0 && - this.tasksQueueSize(workerNodeKey) === 0))) + 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) - void (this.destroyWorker(worker) as Promise) + this.destroyWorkerNode(localWorkerNodeKey).catch((error) => { + this.emitter?.emit(PoolEvents.error, error) + }) } }) - return worker + const workerInfo = this.getWorkerInfo(workerNodeKey) + this.sendToWorker(workerNodeKey, { + checkActive: true, + workerId: workerInfo.id as number + }) + workerInfo.dynamic = true + if (this.workerChoiceStrategyContext.getStrategyPolicy().useDynamicWorker) { + workerInfo.ready = true + } + return workerNodeKey } /** - * This function is the listener registered for each worker message. + * Registers a listener callback on the worker given its worker node key. + * + * @param workerNodeKey - The worker node key. + * @param listener - The message listener callback. + */ + protected abstract registerWorkerMessageListener< + Message extends Data | Response + >( + workerNodeKey: number, + listener: (message: MessageValue) => void + ): void + + /** + * Method hooked up after a worker node has been newly created. + * Can be overridden. + * + * @param workerNodeKey - The newly created worker node key. + */ + protected afterWorkerNodeSetup (workerNodeKey: number): void { + // Listen to worker messages. + this.registerWorkerMessageListener(workerNodeKey, this.workerListener()) + // Send the startup message to worker. + this.sendStartupMessageToWorker(workerNodeKey) + // Send the statistics message to worker. + this.sendStatisticsMessageToWorker(workerNodeKey) + } + + /** + * Sends the startup message to worker given its worker node key. + * + * @param workerNodeKey - The worker node key. + */ + protected abstract sendStartupMessageToWorker (workerNodeKey: number): void + + /** + * Sends the statistics message to worker given its worker node key. + * + * @param workerNodeKey - The worker node key. + */ + private sendStatisticsMessageToWorker (workerNodeKey: number): void { + this.sendToWorker(workerNodeKey, { + statistics: { + runTime: + this.workerChoiceStrategyContext.getTaskStatisticsRequirements() + .runTime.aggregate, + elu: this.workerChoiceStrategyContext.getTaskStatisticsRequirements() + .elu.aggregate + }, + workerId: this.getWorkerInfo(workerNodeKey).id as number + }) + } + + private redistributeQueuedTasks (workerNodeKey: number): void { + 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 ( + workerNodeId !== workerNodeKey && + 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 + } + if ( + workerNodeId !== workerNodeKey && + workerInfo.ready && + workerNode.usage.tasks.queued < minQueuedTasks + ) { + minQueuedTasks = workerNode.usage.tasks.queued + targetWorkerNodeKey = workerNodeId + } + } + if (executeTask) { + this.executeTask( + targetWorkerNodeKey, + this.dequeueTask(workerNodeKey) as Task + ) + } else { + this.enqueueTask( + targetWorkerNodeKey, + this.dequeueTask(workerNodeKey) as Task + ) + } + } + } + + /** + * This method is the listener registered for each worker message. * * @returns The listener function to execute when a message is received from a worker. */ protected workerListener (): (message: MessageValue) => void { - return message => { - if (message.workerId != null && message.started != null) { - // Worker started message received - this.handleWorkerStartedMessage(message) - } else if (message.id != null) { - // Task execution response received + return (message) => { + this.checkMessageWorkerId(message) + if (message.ready != null) { + // Worker ready response received from worker + this.handleWorkerReadyResponse(message) + } else if (message.taskId != null) { + // Task execution response received from worker this.handleTaskExecutionResponse(message) + } else if (message.taskFunctions != null) { + // Task functions message received from worker + this.taskFunctions = message.taskFunctions } } } - private handleWorkerStartedMessage (message: MessageValue): void { - // Worker started message received - const worker = this.getWorkerById(message.workerId as number) - if (worker != null) { - this.workerNodes[this.getWorkerNodeKey(worker)].info.started = - message.started as boolean - } else { - throw new Error( - `Worker started message received from unknown worker '${ - message.workerId as number - }'` - ) + private handleWorkerReadyResponse (message: MessageValue): void { + this.getWorkerInfo( + 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): 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) { - if (this.emitter != null) { - this.emitter.emit(PoolEvents.taskError, message.taskError) - } + this.emitter?.emit(PoolEvents.taskError, message.taskError) promiseResponse.reject(message.taskError.message) } else { promiseResponse.resolve(message.data as Response) } - this.afterTaskExecutionHook(promiseResponse.worker, message) - this.promiseResponseMap.delete(message.id as string) - const workerNodeKey = this.getWorkerNodeKey(promiseResponse.worker) + const workerNodeKey = promiseResponse.workerNodeKey + this.afterTaskExecutionHook(workerNodeKey, message) + 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, @@ -984,127 +1174,80 @@ export abstract class AbstractPool< } /** - * Sets the given worker node its tasks usage in the pool. - * - * @param workerNode - The worker node. - * @param workerUsage - The worker usage. - */ - private setWorkerNodeTasksUsage ( - workerNode: WorkerNode, - workerUsage: WorkerUsage - ): void { - workerNode.usage = workerUsage - } - - /** - * Gets the worker information. + * Gets the worker information given its worker node key. * * @param workerNodeKey - The worker node key. + * @returns The worker information. */ - private getWorkerInfo (workerNodeKey: number): WorkerInfo { + protected getWorkerInfo (workerNodeKey: number): WorkerInfo { return this.workerNodes[workerNodeKey].info } /** - * Pushes the given worker in the pool worker nodes. - * - * @param worker - The worker. - * @returns The worker nodes length. - */ - private pushWorkerNode (worker: Worker): number { - this.workerNodes.push({ - worker, - info: this.getInitialWorkerInfo(worker), - usage: this.getInitialWorkerUsage(), - tasksQueue: new Queue>() - }) - this.setWorkerNodeTasksUsage( - this.workerNodes[this.getWorkerNodeKey(worker)], - this.getInitialWorkerUsage(worker) - ) - return this.workerNodes.length - } - - /** - * Gets the worker id. + * Adds the given worker in the pool worker nodes. * * @param worker - The worker. - * @returns The worker id. + * @returns The added worker node key. + * @throws {@link https://nodejs.org/api/errors.html#class-error} If the added worker node is not found. */ - private getWorkerId (worker: Worker): number | undefined { - if (this.worker === WorkerTypes.thread) { - return worker.threadId - } else if (this.worker === WorkerTypes.cluster) { - return worker.id + private addWorkerNode (worker: Worker): number { + const workerNode = new WorkerNode(worker, this.worker) + // Flag the worker node as ready at pool startup. + if (this.starting) { + workerNode.info.ready = true } + this.workerNodes.push(workerNode) + const workerNodeKey = this.getWorkerNodeKeyByWorker(worker) + if (workerNodeKey === -1) { + throw new Error('Worker node not found') + } + return workerNodeKey } - // /** - // * Sets the given worker in the pool worker nodes. - // * - // * @param workerNodeKey - The worker node key. - // * @param worker - The worker. - // * @param workerInfo - The worker info. - // * @param workerUsage - The worker usage. - // * @param tasksQueue - The worker task queue. - // */ - // private setWorkerNode ( - // workerNodeKey: number, - // worker: Worker, - // workerInfo: WorkerInfo, - // workerUsage: WorkerUsage, - // tasksQueue: Queue> - // ): void { - // this.workerNodes[workerNodeKey] = { - // worker, - // info: workerInfo, - // usage: workerUsage, - // tasksQueue - // } - // } - /** * Removes the given worker from the pool worker nodes. * * @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) } } + /** + * Executes the given task on the worker given its worker node key. + * + * @param workerNodeKey - The worker node key. + * @param task - The task to execute. + */ private executeTask (workerNodeKey: number, task: Task): void { this.beforeTaskExecutionHook(workerNodeKey, task) - this.sendToWorker(this.workerNodes[workerNodeKey].worker, task) + this.sendToWorker(workerNodeKey, task, task.transferList) } private enqueueTask (workerNodeKey: number, task: Task): number { - return this.workerNodes[workerNodeKey].tasksQueue.enqueue(task) + return this.workerNodes[workerNodeKey].enqueueTask(task) } private dequeueTask (workerNodeKey: number): Task | undefined { - return this.workerNodes[workerNodeKey].tasksQueue.dequeue() + return this.workerNodes[workerNodeKey].dequeueTask() } private tasksQueueSize (workerNodeKey: number): number { - return this.workerNodes[workerNodeKey].tasksQueue.size - } - - private tasksMaxQueueSize (workerNodeKey: number): number { - return this.workerNodes[workerNodeKey].tasksQueue.maxSize + return this.workerNodes[workerNodeKey].tasksQueueSize() } - private flushTasksQueue (workerNodeKey: number): void { + protected flushTasksQueue (workerNodeKey: number): void { while (this.tasksQueueSize(workerNodeKey) > 0) { this.executeTask( workerNodeKey, this.dequeueTask(workerNodeKey) as Task ) } - this.workerNodes[workerNodeKey].tasksQueue.clear() + this.workerNodes[workerNodeKey].clearTasksQueue() } private flushTasksQueues (): void { @@ -1112,72 +1255,4 @@ export abstract class AbstractPool< this.flushTasksQueue(workerNodeKey) } } - - private setWorkerStatistics (worker: Worker): void { - this.sendToWorker(worker, { - statistics: { - runTime: - this.workerChoiceStrategyContext.getTaskStatisticsRequirements() - .runTime.aggregate, - elu: this.workerChoiceStrategyContext.getTaskStatisticsRequirements() - .elu.aggregate - } - }) - } - - private getInitialWorkerUsage (worker?: Worker): WorkerUsage { - const getTasksQueueSize = (worker?: Worker): number => { - if (worker == null) { - return 0 - } - // FIXME: Workaround tasks queue initialization race issue. - try { - return this.tasksQueueSize(this.getWorkerNodeKey(worker)) - } catch { - return 0 - } - } - const getTasksMaxQueueSize = (worker?: Worker): number => { - if (worker == null) { - return 0 - } - // FIXME: Workaround tasks queue initialization race issue. - try { - return this.tasksMaxQueueSize(this.getWorkerNodeKey(worker)) - } catch { - return 0 - } - } - return { - tasks: { - executed: 0, - executing: 0, - get queued (): number { - return getTasksQueueSize(worker) - }, - get maxQueued (): number { - return getTasksMaxQueueSize(worker) - }, - failed: 0 - }, - runTime: { - history: new CircularArray() - }, - waitTime: { - history: new CircularArray() - }, - elu: { - idle: { - history: new CircularArray() - }, - active: { - history: new CircularArray() - } - } - } - } - - private getInitialWorkerInfo (worker: Worker): WorkerInfo { - return { id: this.getWorkerId(worker), dynamic: false, started: true } - } }