X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=6462cb09a882c6c005ceea481cacb5519e2de0de;hb=075e51d1065e974cf3080d61d0d9ceedf88313de;hp=1d4e7ae0d07f18ede013a5fefda5f7430302584c;hpb=5a94e4b950eaf2234e07f87261ddea1482e839c6;p=poolifier.git diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index 1d4e7ae0..50ce2026 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -1,68 +1,82 @@ +import { randomUUID } from 'node:crypto' +import { performance } from 'node:perf_hooks' +import { existsSync } from 'node:fs' import type { MessageValue, - PromiseWorkerResponseWrapper + PromiseResponseWrapper, + Task } from '../utility-types' -import { EMPTY_FUNCTION } from '../utils' -import { KillBehaviors, isKillBehavior } from '../worker/worker-options' -import type { PoolOptions } from './pool' -import { PoolEmitter } from './pool' -import type { IPoolInternal, TasksUsage, WorkerType } from './pool-internal' -import { PoolType } from './pool-internal' -import type { IPoolWorker } from './pool-worker' import { + DEFAULT_TASK_NAME, + DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS, + EMPTY_FUNCTION, + isKillBehavior, + isPlainObject, + median, + round +} from '../utils' +import { KillBehaviors } from '../worker/worker-options' +import { + type IPool, + PoolEmitter, + PoolEvents, + type PoolInfo, + type PoolOptions, + type PoolType, + PoolTypes, + type TasksQueueOptions +} from './pool' +import type { + IWorker, + IWorkerNode, + MessageHandler, + WorkerInfo, + WorkerType, + WorkerUsage +} from './worker' +import { + Measurements, WorkerChoiceStrategies, - type WorkerChoiceStrategy + type WorkerChoiceStrategy, + type WorkerChoiceStrategyOptions } 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. * * @typeParam Worker - Type of worker which manages this pool. - * @typeParam Data - Type of data sent to the worker. This can only be serializable data. - * @typeParam Response - Type of response of execution. This can only be serializable data. + * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. + * @typeParam Response - Type of execution response. This can only be structured-cloneable data. */ export abstract class AbstractPool< - Worker extends IPoolWorker, + Worker extends IWorker, Data = unknown, Response = unknown -> implements IPoolInternal { - /** {@inheritDoc} */ - public readonly workers: Map> = new Map< - number, - WorkerType - >() - - /** {@inheritDoc} */ - public readonly emitter?: PoolEmitter +> implements IPool { + /** @inheritDoc */ + public readonly workerNodes: Array> = [] - /** - * Id of the next worker. - */ - protected nextWorkerId: number = 0 + /** @inheritDoc */ + public readonly emitter?: PoolEmitter /** - * The promise map. + * The execution response promise map. * - * - `key`: This is the message id of each submitted task. - * - `value`: An object that contains the worker, the resolve function and the reject function. + * - `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 and resolve/reject the promise based on the message. + * When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id. */ - protected promiseMap: Map< - number, - PromiseWorkerResponseWrapper - > = new Map>() + protected promiseResponseMap: Map< + string, + PromiseResponseWrapper + > = new Map>() /** - * Id of the next message. - */ - protected nextMessageId: number = 0 - - /** - * Worker choice strategy instance implementing the worker choice algorithm. - * - * Default to a strategy implementing a round robin algorithm. + * Worker choice strategy context referencing a worker choice algorithm implementation. */ protected workerChoiceStrategyContext: WorkerChoiceStrategyContext< Worker, @@ -70,17 +84,26 @@ export abstract class AbstractPool< Response > + /** + * Whether the pool is starting. + */ + private readonly starting: boolean + /** + * The start timestamp of the pool. + */ + private readonly startTimestamp + /** * Constructs a new poolifier pool. * * @param numberOfWorkers - Number of workers that this pool should manage. - * @param filePath - Path to the worker-file. + * @param filePath - Path to the worker file. * @param opts - Options for the pool. */ public constructor ( - public readonly numberOfWorkers: number, - public readonly filePath: string, - public readonly opts: PoolOptions + protected readonly numberOfWorkers: number, + protected readonly filePath: string, + protected readonly opts: PoolOptions ) { if (!this.isMain()) { throw new Error('Cannot start a pool from a worker!') @@ -88,41 +111,53 @@ export abstract class AbstractPool< this.checkNumberOfWorkers(this.numberOfWorkers) this.checkFilePath(this.filePath) this.checkPoolOptions(this.opts) - this.setupHook() - for (let i = 1; i <= this.numberOfWorkers; i++) { - this.createAndSetupWorker() - } + this.chooseWorkerNode = this.chooseWorkerNode.bind(this) + this.executeTask = this.executeTask.bind(this) + this.enqueueTask = this.enqueueTask.bind(this) + this.checkAndEmitEvents = this.checkAndEmitEvents.bind(this) if (this.opts.enableEvents === true) { this.emitter = new PoolEmitter() } - this.workerChoiceStrategyContext = new WorkerChoiceStrategyContext( + this.workerChoiceStrategyContext = new WorkerChoiceStrategyContext< + Worker, + Data, + Response + >( this, - () => { - const workerCreated = this.createAndSetupWorker() - this.registerWorkerMessageListener(workerCreated, message => { - if ( - isKillBehavior(KillBehaviors.HARD, message.kill) || - this.getWorkerRunningTasks(workerCreated) === 0 - ) { - // Kill received from the worker, means that no new tasks are submitted to that worker for a while ( > maxInactiveTime) - void this.destroyWorker(workerCreated) - } - }) - return workerCreated - }, - this.opts.workerChoiceStrategy + this.opts.workerChoiceStrategy, + this.opts.workerChoiceStrategyOptions ) + + this.setupHook() + + this.starting = true + while ( + this.workerNodes.reduce( + (accumulator, workerNode) => + !workerNode.info.dynamic ? accumulator + 1 : accumulator, + 0 + ) < this.numberOfWorkers + ) { + this.createAndSetupWorker() + } + this.starting = false + + this.startTimestamp = performance.now() } 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 { @@ -132,130 +167,513 @@ export abstract class AbstractPool< ) } else if (!Number.isSafeInteger(numberOfWorkers)) { throw new TypeError( - 'Cannot instantiate a pool with a non integer number of workers' + 'Cannot instantiate a pool with a non safe integer number of workers' ) } else if (numberOfWorkers < 0) { throw new RangeError( 'Cannot instantiate a pool with a negative number of workers' ) - } else if (this.type === PoolType.FIXED && numberOfWorkers === 0) { - throw new Error('Cannot instantiate a fixed pool with no worker') + } else if (this.type === PoolTypes.fixed && numberOfWorkers === 0) { + throw new RangeError('Cannot instantiate a fixed pool with zero worker') + } + } + + protected checkDynamicPoolSize (min: number, max: number): void { + if (this.type === PoolTypes.dynamic) { + 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' + ) + } 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' + ) + } } } private checkPoolOptions (opts: PoolOptions): void { - this.opts.workerChoiceStrategy = - opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN - this.opts.enableEvents = opts.enableEvents ?? true + if (isPlainObject(opts)) { + this.opts.workerChoiceStrategy = + opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN + this.checkValidWorkerChoiceStrategy(this.opts.workerChoiceStrategy) + this.opts.workerChoiceStrategyOptions = + opts.workerChoiceStrategyOptions ?? + DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS + this.checkValidWorkerChoiceStrategyOptions( + this.opts.workerChoiceStrategyOptions + ) + this.opts.restartWorkerOnError = opts.restartWorkerOnError ?? true + this.opts.enableEvents = opts.enableEvents ?? true + this.opts.enableTasksQueue = opts.enableTasksQueue ?? false + if (this.opts.enableTasksQueue) { + this.checkValidTasksQueueOptions( + opts.tasksQueueOptions as TasksQueueOptions + ) + this.opts.tasksQueueOptions = this.buildTasksQueueOptions( + opts.tasksQueueOptions as TasksQueueOptions + ) + } + } else { + throw new TypeError('Invalid pool options: must be a plain object') + } } - /** {@inheritDoc} */ - public abstract get type (): PoolType + private checkValidWorkerChoiceStrategy ( + workerChoiceStrategy: WorkerChoiceStrategy + ): void { + if (!Object.values(WorkerChoiceStrategies).includes(workerChoiceStrategy)) { + throw new Error( + `Invalid worker choice strategy '${workerChoiceStrategy}'` + ) + } + } - /** {@inheritDoc} */ - public get numberOfRunningTasks (): number { - return this.promiseMap.size + private checkValidWorkerChoiceStrategyOptions ( + workerChoiceStrategyOptions: WorkerChoiceStrategyOptions + ): void { + if (!isPlainObject(workerChoiceStrategyOptions)) { + throw new TypeError( + 'Invalid worker choice strategy options: must be a plain object' + ) + } + if ( + workerChoiceStrategyOptions.weights != null && + Object.keys(workerChoiceStrategyOptions.weights).length !== this.maxSize + ) { + throw new Error( + 'Invalid worker choice strategy options: must have a weight for each worker node' + ) + } + if ( + workerChoiceStrategyOptions.measurement != null && + !Object.values(Measurements).includes( + workerChoiceStrategyOptions.measurement + ) + ) { + throw new Error( + `Invalid worker choice strategy options: invalid measurement '${workerChoiceStrategyOptions.measurement}'` + ) + } + } + + private checkValidTasksQueueOptions ( + tasksQueueOptions: TasksQueueOptions + ): void { + if (tasksQueueOptions != null && !isPlainObject(tasksQueueOptions)) { + throw new TypeError('Invalid tasks queue options: must be a plain object') + } + if ( + tasksQueueOptions?.concurrency != null && + !Number.isSafeInteger(tasksQueueOptions.concurrency) + ) { + throw new TypeError( + 'Invalid worker tasks concurrency: must be an integer' + ) + } + if ( + tasksQueueOptions?.concurrency != null && + tasksQueueOptions.concurrency <= 0 + ) { + throw new Error( + `Invalid worker tasks concurrency '${tasksQueueOptions.concurrency}'` + ) + } + } + + /** @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() + .runTime.aggregate && + this.workerChoiceStrategyContext.getTaskStatisticsRequirements() + .waitTime.aggregate && { utilization: round(this.utilization) }), + workerNodes: this.workerNodes.length, + idleWorkerNodes: this.workerNodes.reduce( + (accumulator, workerNode) => + workerNode.usage.tasks.executing === 0 + ? accumulator + 1 + : accumulator, + 0 + ), + busyWorkerNodes: this.workerNodes.reduce( + (accumulator, workerNode) => + workerNode.usage.tasks.executing > 0 ? accumulator + 1 : accumulator, + 0 + ), + executedTasks: this.workerNodes.reduce( + (accumulator, workerNode) => + accumulator + workerNode.usage.tasks.executed, + 0 + ), + executingTasks: this.workerNodes.reduce( + (accumulator, workerNode) => + 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 + ), + failedTasks: this.workerNodes.reduce( + (accumulator, workerNode) => + accumulator + workerNode.usage.tasks.failed, + 0 + ), + ...(this.workerChoiceStrategyContext.getTaskStatisticsRequirements() + .runTime.aggregate && { + runTime: { + 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 + ) + ) + ), + 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: round( + Math.min( + ...this.workerNodes.map( + workerNode => workerNode.usage.waitTime?.minimum ?? 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 + ) + ) + ) + }) + } + }) + } + } + + private get ready (): boolean { + return ( + this.workerNodes.reduce( + (accumulator, workerNode) => + !workerNode.info.dynamic && workerNode.info.ready + ? accumulator + 1 + : accumulator, + 0 + ) >= this.minSize + ) } /** - * Gets worker key. + * Gets the approximate pool utilization. * - * @param worker - The worker. - * @returns The worker key. + * @returns The pool utilization. */ - private getWorkerKey (worker: Worker): number | undefined { - return [...this.workers].find(([, value]) => value.worker === worker)?.[0] + private get utilization (): number { + const poolTimeCapacity = + (performance.now() - this.startTimestamp) * this.maxSize + const totalTasksRunTime = this.workerNodes.reduce( + (accumulator, workerNode) => + accumulator + (workerNode.usage.runTime?.aggregate ?? 0), + 0 + ) + const totalTasksWaitTime = this.workerNodes.reduce( + (accumulator, workerNode) => + accumulator + (workerNode.usage.waitTime?.aggregate ?? 0), + 0 + ) + return (totalTasksRunTime + totalTasksWaitTime) / poolTimeCapacity } - /** {@inheritDoc} */ - public getWorkerRunningTasks (worker: Worker): number | undefined { - return this.workers.get(this.getWorkerKey(worker) as number)?.tasksUsage - ?.running + /** + * Pool type. + * + * If it is `'dynamic'`, it provides the `max` property. + */ + protected abstract get type (): PoolType + + /** + * Gets the worker type. + */ + protected abstract get worker (): WorkerType + + /** + * Pool minimum size. + */ + protected abstract get minSize (): number + + /** + * Pool maximum size. + */ + protected abstract get maxSize (): number + + /** + * Get the worker given its id. + * + * @param workerId - The worker id. + * @returns The worker if found in the pool worker nodes, `undefined` otherwise. + */ + private getWorkerById (workerId: number): Worker | undefined { + return this.workerNodes.find(workerNode => workerNode.info.id === workerId) + ?.worker + } + + /** + * Checks if the worker id sent in the received message from a worker is valid. + * + * @param message - The received message. + * @throws {@link https://nodejs.org/api/errors.html#class-error} If the worker id is invalid. + */ + private checkMessageWorkerId (message: MessageValue): void { + if ( + message.workerId != null && + this.getWorkerById(message.workerId) == null + ) { + throw new Error( + `Worker message received from unknown worker '${message.workerId}'` + ) + } } - /** {@inheritDoc} */ - public getWorkerAverageTasksRunTime (worker: Worker): number | undefined { - return this.workers.get(this.getWorkerKey(worker) as number)?.tasksUsage - ?.avgRunTime + /** + * Gets the given worker its worker node key. + * + * @param worker - The worker. + * @returns The worker node key if found in the pool worker nodes, `-1` otherwise. + */ + private getWorkerNodeKey (worker: Worker): number { + return this.workerNodes.findIndex( + workerNode => workerNode.worker === worker + ) } - /** {@inheritDoc} */ + /** @inheritDoc */ public setWorkerChoiceStrategy ( - workerChoiceStrategy: WorkerChoiceStrategy + workerChoiceStrategy: WorkerChoiceStrategy, + workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions ): void { + this.checkValidWorkerChoiceStrategy(workerChoiceStrategy) this.opts.workerChoiceStrategy = workerChoiceStrategy - for (const [key, value] of this.workers) { - this.setWorker(key, value.worker, { - run: 0, - running: 0, - runTime: 0, - avgRunTime: 0 - }) - } this.workerChoiceStrategyContext.setWorkerChoiceStrategy( - workerChoiceStrategy + this.opts.workerChoiceStrategy ) + if (workerChoiceStrategyOptions != null) { + this.setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions) + } + for (const workerNode of this.workerNodes) { + workerNode.resetUsage() + this.setWorkerStatistics(workerNode.worker) + } } - /** {@inheritDoc} */ - public abstract get busy (): boolean - - protected internalGetBusyStatus (): boolean { - return ( - this.numberOfRunningTasks >= this.numberOfWorkers && - this.findFreeWorker() === false + /** @inheritDoc */ + public setWorkerChoiceStrategyOptions ( + workerChoiceStrategyOptions: WorkerChoiceStrategyOptions + ): void { + this.checkValidWorkerChoiceStrategyOptions(workerChoiceStrategyOptions) + this.opts.workerChoiceStrategyOptions = workerChoiceStrategyOptions + this.workerChoiceStrategyContext.setOptions( + this.opts.workerChoiceStrategyOptions ) } - /** {@inheritDoc} */ - public findFreeWorker (): Worker | false { - for (const value of this.workers.values()) { - if (value.tasksUsage.running === 0) { - // A worker is free, return the matching worker - return value.worker - } + /** @inheritDoc */ + public enableTasksQueue ( + enable: boolean, + tasksQueueOptions?: TasksQueueOptions + ): void { + if (this.opts.enableTasksQueue === true && !enable) { + this.flushTasksQueues() } - return false + this.opts.enableTasksQueue = enable + this.setTasksQueueOptions(tasksQueueOptions as TasksQueueOptions) } - /** {@inheritDoc} */ - public async execute (data: Data): Promise { - // Configure worker to handle message with the specified task - const worker = this.chooseWorker() - const res = this.internalExecute(worker, this.nextMessageId) - this.checkAndEmitBusy() - this.sendToWorker(worker, { + /** @inheritDoc */ + public setTasksQueueOptions (tasksQueueOptions: TasksQueueOptions): void { + if (this.opts.enableTasksQueue === true) { + this.checkValidTasksQueueOptions(tasksQueueOptions) + this.opts.tasksQueueOptions = + this.buildTasksQueueOptions(tasksQueueOptions) + } else if (this.opts.tasksQueueOptions != null) { + delete this.opts.tasksQueueOptions + } + } + + private buildTasksQueueOptions ( + tasksQueueOptions: TasksQueueOptions + ): TasksQueueOptions { + return { + concurrency: tasksQueueOptions?.concurrency ?? 1 + } + } + + /** + * Whether the pool is full or not. + * + * The pool filling boolean status. + */ + protected get full (): boolean { + return this.workerNodes.length >= this.maxSize + } + + /** + * Whether the pool is busy or not. + * + * The pool busyness boolean status. + */ + protected abstract get busy (): boolean + + /** + * Whether worker nodes are executing at least one task. + * + * @returns Worker nodes busyness boolean status. + */ + protected internalBusy (): boolean { + return ( + this.workerNodes.findIndex(workerNode => { + return 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: name ?? DEFAULT_TASK_NAME, // eslint-disable-next-line @typescript-eslint/consistent-type-assertions data: data ?? ({} as Data), - id: this.nextMessageId + timestamp, + workerId: this.getWorkerInfo(workerNodeKey).id as number, + id: randomUUID() + } + const res = new Promise((resolve, reject) => { + this.promiseResponseMap.set(submittedTask.id as string, { + resolve, + reject, + worker: this.workerNodes[workerNodeKey].worker + }) }) - ++this.nextMessageId + 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} */ + /** @inheritDoc */ public async destroy (): Promise { await Promise.all( - [...this.workers].map(async ([, value]) => { - await this.destroyWorker(value.worker) + 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 }) ) } /** - * Shutdowns given worker. + * Terminates the given worker. * - * @param worker - A worker within `workers`. + * @param worker - A worker within `workerNodes`. */ protected abstract destroyWorker (worker: Worker): void | Promise /** - * Setup hook that can be overridden by a Poolifier pool implementation - * to run code before workers are created in the abstract constructor. + * Setup hook to execute code before worker nodes are created in the abstract constructor. + * Can be overridden. + * + * @virtual */ protected setupHook (): void { - // Can be overridden + // Intentionally empty } /** @@ -264,50 +682,229 @@ export abstract class AbstractPool< protected abstract isMain (): boolean /** - * Hook executed before the worker task promise resolution. + * Hook executed before the worker task execution. * Can be overridden. * - * @param worker - The worker. + * @param workerNodeKey - The worker node key. + * @param task - The task to execute. */ - protected beforePromiseWorkerResponseHook (worker: Worker): void { - this.increaseWorkerRunningTasks(worker) + protected beforeTaskExecutionHook ( + workerNodeKey: number, + task: Task + ): void { + 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 promise resolution. + * Hook executed after the worker task execution. * Can be overridden. * + * @param worker - The worker. * @param message - The received message. - * @param promise - The Promise response. */ - protected afterPromiseWorkerResponseHook ( - message: MessageValue, - promise: PromiseWorkerResponseWrapper + protected afterTaskExecutionHook ( + worker: Worker, + message: MessageValue + ): void { + const workerNodeKey = this.getWorkerNodeKey(worker) + 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 ( + workerUsage: WorkerUsage, + message: MessageValue + ): void { + const workerTaskStatistics = workerUsage.tasks + --workerTaskStatistics.executing + if (message.taskError == null) { + ++workerTaskStatistics.executed + } else { + ++workerTaskStatistics.failed + } + } + + private updateRunTimeWorkerUsage ( + 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 + } + if ( + this.workerChoiceStrategyContext.getTaskStatisticsRequirements().runTime + .median && + message.taskPerformance?.runTime != null + ) { + workerUsage.runTime.history.push(message.taskPerformance.runTime) + workerUsage.runTime.median = median(workerUsage.runTime.history) + } + } + } + + private updateWaitTimeWorkerUsage ( + workerUsage: WorkerUsage, + task: Task + ): 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 + } + if ( + this.workerChoiceStrategyContext.getTaskStatisticsRequirements() + .waitTime.median + ) { + workerUsage.waitTime.history.push(taskWaitTime) + workerUsage.waitTime.median = median(workerUsage.waitTime.history) + } + } + } + + private updateEluWorkerUsage ( + workerUsage: WorkerUsage, + message: MessageValue ): void { - this.decreaseWorkerRunningTasks(promise.worker) - this.stepWorkerRunTasks(promise.worker, 1) - this.updateWorkerTasksRunTime(promise.worker, message.taskRunTime) + if ( + this.workerChoiceStrategyContext.getTaskStatisticsRequirements().elu + .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 + + message.taskPerformance.elu.utilization) / + 2 + } 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 + ) { + workerUsage.elu.idle.average = + workerUsage.elu.idle.aggregate / workerUsage.tasks.executed + workerUsage.elu.active.average = + workerUsage.elu.active.aggregate / workerUsage.tasks.executed + } + if ( + this.workerChoiceStrategyContext.getTaskStatisticsRequirements().elu + .median + ) { + 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) + } + } + } } /** - * Removes the given worker from the pool. + * Chooses a worker node for the next task. + * + * The default worker choice strategy uses a round robin algorithm to distribute the tasks. * - * @param worker - The worker that will be removed. + * @returns The worker node key */ - protected removeWorker (worker: Worker): void { - this.workers.delete(this.getWorkerKey(worker) as number) - --this.nextWorkerId + private chooseWorkerNode (): number { + if (this.shallCreateDynamicWorker()) { + const worker = this.createAndSetupDynamicWorker() + if ( + this.workerChoiceStrategyContext.getStrategyPolicy().useDynamicWorker + ) { + return this.getWorkerNodeKey(worker) + } + } + return this.workerChoiceStrategyContext.execute() } /** - * Chooses a worker for the next task. + * Conditions for dynamic worker creation. * - * The default implementation uses a round robin algorithm to distribute the load. - * - * @returns Worker. + * @returns Whether to create a dynamic worker or not. */ - protected chooseWorker (): Worker { - return this.workerChoiceStrategyContext.execute() + private shallCreateDynamicWorker (): boolean { + return this.type === PoolTypes.dynamic && !this.full && this.internalBusy() } /** @@ -322,31 +919,14 @@ export abstract class AbstractPool< ): void /** - * Registers a listener callback on a given worker. + * Creates a new worker. * - * @param worker - The worker which should register a listener. - * @param listener - The message listener callback. - */ - protected abstract registerWorkerMessageListener< - Message extends Data | Response - >(worker: Worker, listener: (message: MessageValue) => void): void - - /** - * Returns a newly created worker. + * @returns Newly created worker. */ protected abstract createWorker (): Worker /** - * Function that can be hooked up when a worker has been newly created and moved to the workers registry. - * - * Can be used to update the `maxListeners` or binding the `main-worker`\<-\>`worker` connection if not bind by default. - * - * @param worker - The newly created worker. - */ - protected abstract afterWorkerSetup (worker: Worker): void - - /** - * Creates a new worker for this pool and sets it up completely. + * Creates a new worker and sets it up completely in the pool worker nodes. * * @returns New, completely set up worker. */ @@ -355,19 +935,31 @@ export abstract class AbstractPool< 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) + const workerInfo = this.getWorkerInfo(workerNodeKey) + workerInfo.ready = false + if (this.emitter != null) { + this.emitter.emit(PoolEvents.error, error) + } + if (this.opts.restartWorkerOnError === true && !this.starting) { + if (workerInfo.dynamic) { + this.createAndSetupDynamicWorker() + } else { + this.createAndSetupWorker() + } + } + 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.removeWorker(worker) + this.removeWorkerNode(worker) }) - this.setWorker(this.nextWorkerId, worker, { - run: 0, - running: 0, - runTime: 0, - avgRunTime: 0 - }) - ++this.nextWorkerId + this.addWorkerNode(worker) this.afterWorkerSetup(worker) @@ -375,147 +967,255 @@ export abstract class AbstractPool< } /** - * This function is the listener registered for each worker. + * Creates a new dynamic worker and sets it up completely in the pool worker nodes. * - * @returns The listener function to execute when a message is received from a worker. + * @returns New, completely set up dynamic worker. */ - protected workerListener (): (message: MessageValue) => void { - return message => { - if (message.id !== undefined) { - const promise = this.promiseMap.get(message.id) - if (promise !== undefined) { - if (message.error != null) { - promise.reject(message.error) - } else { - promise.resolve(message.data as Response) - } - this.afterPromiseWorkerResponseHook(message, promise) - this.promiseMap.delete(message.id) - } + protected createAndSetupDynamicWorker (): Worker { + const worker = this.createAndSetupWorker() + this.registerWorkerMessageListener(worker, message => { + const workerNodeKey = this.getWorkerNodeKey(worker) + if ( + isKillBehavior(KillBehaviors.HARD, message.kill) || + (message.kill != null && + ((this.opts.enableTasksQueue === false && + this.workerNodes[workerNodeKey].usage.tasks.executing === 0) || + (this.opts.enableTasksQueue === true && + this.workerNodes[workerNodeKey].usage.tasks.executing === 0 && + this.tasksQueueSize(workerNodeKey) === 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) } - } - } - - private async internalExecute ( - worker: Worker, - messageId: number - ): Promise { - this.beforePromiseWorkerResponseHook(worker) - return await new Promise((resolve, reject) => { - this.promiseMap.set(messageId, { resolve, reject, worker }) }) - } - - private checkAndEmitBusy (): void { - if (this.opts.enableEvents === true && this.busy) { - this.emitter?.emit('busy') + const workerInfo = this.getWorkerInfo(this.getWorkerNodeKey(worker)) + workerInfo.dynamic = true + if (this.workerChoiceStrategyContext.getStrategyPolicy().useDynamicWorker) { + workerInfo.ready = true } + this.sendToWorker(worker, { + checkActive: true, + workerId: workerInfo.id as number + }) + return worker } /** - * Increases the number of tasks that the given worker has applied. + * Registers a listener callback on the given worker. * - * @param worker - Worker which running tasks is increased. + * @param worker - The worker which should register a listener. + * @param listener - The message listener callback. */ - private increaseWorkerRunningTasks (worker: Worker): void { - this.stepWorkerRunningTasks(worker, 1) + private registerWorkerMessageListener( + worker: Worker, + listener: (message: MessageValue) => void + ): void { + worker.on('message', listener as MessageHandler) } /** - * Decreases the number of tasks that the given worker has applied. + * Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes. + * Can be overridden. * - * @param worker - Worker which running tasks is decreased. + * @param worker - The newly created worker. */ - private decreaseWorkerRunningTasks (worker: Worker): void { - this.stepWorkerRunningTasks(worker, -1) + protected afterWorkerSetup (worker: Worker): void { + // Listen to worker messages. + this.registerWorkerMessageListener(worker, this.workerListener()) + // Send startup message to worker. + this.sendWorkerStartupMessage(worker) + // Setup worker task statistics computation. + this.setWorkerStatistics(worker) } - /** - * Get tasks usage of the given worker. - * - * @param worker - Worker which tasks usage is returned. - */ - private getWorkerTasksUsage (worker: Worker): TasksUsage | undefined { - if (this.checkWorker(worker)) { - const workerKey = this.getWorkerKey(worker) as number - const workerEntry = this.workers.get(workerKey) as WorkerType - return workerEntry.tasksUsage + private sendWorkerStartupMessage (worker: Worker): void { + this.sendToWorker(worker, { + ready: false, + workerId: this.getWorkerInfo(this.getWorkerNodeKey(worker)).id as number + }) + } + + private redistributeQueuedTasks (workerNodeKey: number): void { + while (this.tasksQueueSize(workerNodeKey) > 0) { + let targetWorkerNodeKey: number = workerNodeKey + let minQueuedTasks = Infinity + for (const [workerNodeId, workerNode] of this.workerNodes.entries()) { + const workerInfo = this.getWorkerInfo(workerNodeId) + if ( + workerNodeId !== workerNodeKey && + workerInfo.ready && + workerNode.usage.tasks.queued === 0 + ) { + targetWorkerNodeKey = workerNodeId + break + } + if ( + workerNodeId !== workerNodeKey && + workerInfo.ready && + workerNode.usage.tasks.queued < minQueuedTasks + ) { + minQueuedTasks = workerNode.usage.tasks.queued + targetWorkerNodeKey = workerNodeId + } + } + this.enqueueTask( + targetWorkerNodeKey, + this.dequeueTask(workerNodeKey) as Task + ) } } /** - * Steps the number of tasks that the given worker has applied. + * This function is the listener registered for each worker message. * - * @param worker - Worker which running tasks are stepped. - * @param step - Number of running tasks step. + * @returns The listener function to execute when a message is received from a worker. */ - private stepWorkerRunningTasks (worker: Worker, step: number): void { - // prettier-ignore - (this.getWorkerTasksUsage(worker) as TasksUsage).running += step + protected workerListener (): (message: MessageValue) => void { + return message => { + this.checkMessageWorkerId(message) + if (message.ready != null) { + // Worker ready response received + this.handleWorkerReadyResponse(message) + } else if (message.id != null) { + // Task execution response received + this.handleTaskExecutionResponse(message) + } + } + } + + private handleWorkerReadyResponse (message: MessageValue): void { + const worker = this.getWorkerById(message.workerId) + this.getWorkerInfo(this.getWorkerNodeKey(worker as Worker)).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) + if (promiseResponse != null) { + if (message.taskError != null) { + if (this.emitter != null) { + 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) + if ( + this.opts.enableTasksQueue === true && + this.tasksQueueSize(workerNodeKey) > 0 + ) { + this.executeTask( + workerNodeKey, + this.dequeueTask(workerNodeKey) as Task + ) + } + this.workerChoiceStrategyContext.update(workerNodeKey) + } + } + + private checkAndEmitEvents (): void { + if (this.emitter != null) { + if (this.busy) { + this.emitter.emit(PoolEvents.busy, this.info) + } + if (this.type === PoolTypes.dynamic && this.full) { + this.emitter.emit(PoolEvents.full, this.info) + } + } } /** - * Steps the number of tasks that the given worker has run. + * Gets the worker information. * - * @param worker - Worker which has run tasks. - * @param step - Number of run tasks step. + * @param workerNodeKey - The worker node key. */ - private stepWorkerRunTasks (worker: Worker, step: number): void { - // prettier-ignore - (this.getWorkerTasksUsage(worker) as TasksUsage).run += step + private getWorkerInfo (workerNodeKey: number): WorkerInfo { + return this.workerNodes[workerNodeKey].info } /** - * Updates tasks runtime for the given worker. + * Adds the given worker in the pool worker nodes. * - * @param worker - Worker which run the task. - * @param taskRunTime - Worker task runtime. + * @param worker - The worker. + * @returns The worker nodes length. */ - private updateWorkerTasksRunTime ( - worker: Worker, - taskRunTime: number | undefined - ): void { - if ( - this.workerChoiceStrategyContext.getWorkerChoiceStrategy() - .requiredStatistics.runTime - ) { - const workerTasksUsage = this.getWorkerTasksUsage(worker) as TasksUsage - workerTasksUsage.runTime += taskRunTime ?? 0 - if (workerTasksUsage.run !== 0) { - workerTasksUsage.avgRunTime = - workerTasksUsage.runTime / workerTasksUsage.run - } + 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 } + return this.workerNodes.push(workerNode) } /** - * Sets the given worker. + * Removes the given worker from the pool worker nodes. * - * @param workerKey - The worker key. * @param worker - The worker. - * @param tasksUsage - The worker tasks usage. */ - private setWorker ( - workerKey: number, - worker: Worker, - tasksUsage: TasksUsage - ): void { - this.workers.set(workerKey, { - worker, - tasksUsage - }) + private removeWorkerNode (worker: Worker): void { + const workerNodeKey = this.getWorkerNodeKey(worker) + if (workerNodeKey !== -1) { + this.workerNodes.splice(workerNodeKey, 1) + this.workerChoiceStrategyContext.remove(workerNodeKey) + } } /** - * Checks if the given worker is registered in the pool. + * Executes the given task on the given worker. * - * @param worker - Worker to check. - * @returns `true` if the worker is registered in the pool. + * @param worker - The worker. + * @param task - The task to execute. */ - private checkWorker (worker: Worker): boolean { - if (this.getWorkerKey(worker) == null) { - throw new Error('Worker could not be found in the pool') + private executeTask (workerNodeKey: number, task: Task): void { + this.beforeTaskExecutionHook(workerNodeKey, task) + this.sendToWorker(this.workerNodes[workerNodeKey].worker, task) + } + + private enqueueTask (workerNodeKey: number, task: Task): number { + return this.workerNodes[workerNodeKey].enqueueTask(task) + } + + private dequeueTask (workerNodeKey: number): Task | undefined { + return this.workerNodes[workerNodeKey].dequeueTask() + } + + private tasksQueueSize (workerNodeKey: number): number { + return this.workerNodes[workerNodeKey].tasksQueueSize() + } + + private flushTasksQueue (workerNodeKey: number): void { + while (this.tasksQueueSize(workerNodeKey) > 0) { + this.executeTask( + workerNodeKey, + this.dequeueTask(workerNodeKey) as Task + ) } - return true + this.workerNodes[workerNodeKey].clearTasksQueue() + } + + private flushTasksQueues (): void { + for (const [workerNodeKey] of this.workerNodes.entries()) { + this.flushTasksQueue(workerNodeKey) + } + } + + private setWorkerStatistics (worker: Worker): void { + this.sendToWorker(worker, { + statistics: { + runTime: + this.workerChoiceStrategyContext.getTaskStatisticsRequirements() + .runTime.aggregate, + elu: this.workerChoiceStrategyContext.getTaskStatisticsRequirements() + .elu.aggregate + }, + workerId: this.getWorkerInfo(this.getWorkerNodeKey(worker)).id as number + }) } }