X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=e4947cdc6b6caeca4c77d485d8b15d83c3591272;hb=cdb517b318cd4f26b4895988ae8444d50945ddde;hp=7944606d9c84dbcc7dc32a9547c8a6e425b48e01;hpb=a35560bac09e829e1e19f88f8fd1d71a64c9d50b;p=poolifier.git diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index 7944606d..e4947cdc 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -1,309 +1,637 @@ -import type { MessageValue } from '../utility-types' -import type { IPoolInternal } from './pool-internal' -import { PoolEmitter } from './pool-internal' -import type { WorkerChoiceStrategy } from './selection-strategies' +import crypto from 'node:crypto' +import { performance } from 'node:perf_hooks' +import type { MessageValue, PromiseResponseWrapper } from '../utility-types' +import { + DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS, + EMPTY_FUNCTION, + isPlainObject, + median +} from '../utils' +import { KillBehaviors, isKillBehavior } from '../worker/worker-options' +import { CircularArray } from '../circular-array' +import { Queue } from '../queue' +import { + type IPool, + PoolEmitter, + PoolEvents, + type PoolInfo, + type PoolOptions, + type PoolType, + PoolTypes, + type TasksQueueOptions, + type WorkerType +} from './pool' +import type { IWorker, Task, WorkerNode, WorkerUsage } from './worker' import { WorkerChoiceStrategies, - WorkerChoiceStrategyContext -} from './selection-strategies' - -/** - * An intentional empty function. - */ -const EMPTY_FUNCTION: () => void = () => { - /* Intentionally empty */ -} - -/** - * Callback invoked if the worker raised an error. - */ -export type ErrorHandler = (this: Worker, e: Error) => void - -/** - * Callback invoked when the worker has started successfully. - */ -export type OnlineHandler = (this: Worker) => void - -/** - * Callback invoked when the worker exits successfully. - */ -export type ExitHandler = (this: Worker, code: number) => void - -/** - * Basic interface that describes the minimum required implementation of listener events for a pool-worker. - */ -export interface IWorker { - /** - * Register a listener to the error event. - * - * @param event `'error'`. - * @param handler The error handler. - */ - on(event: 'error', handler: ErrorHandler): void - /** - * Register a listener to the online event. - * - * @param event `'online'`. - * @param handler The online handler. - */ - on(event: 'online', handler: OnlineHandler): void - /** - * Register a listener to the exit event. - * - * @param event `'exit'`. - * @param handler The exit handler. - */ - on(event: 'exit', handler: ExitHandler): void - /** - * Register a listener to the exit event that will only performed once. - * - * @param event `'exit'`. - * @param handler The exit handler. - */ - once(event: 'exit', handler: ExitHandler): void -} + type WorkerChoiceStrategy, + type WorkerChoiceStrategyOptions +} from './selection-strategies/selection-strategies-types' +import { WorkerChoiceStrategyContext } from './selection-strategies/worker-choice-strategy-context' /** - * Options for a poolifier pool. - */ -export interface PoolOptions { - /** - * A function that will listen for error event on each worker. - */ - errorHandler?: ErrorHandler - /** - * A function that will listen for online event on each worker. - */ - onlineHandler?: OnlineHandler - /** - * A function that will listen for exit event on each worker. - */ - exitHandler?: ExitHandler - /** - * This is just to avoid non-useful warning messages. - * - * Will be used to set `maxListeners` on event emitters (workers are event emitters). - * - * @default 1000 - * @see [Node events emitter.setMaxListeners(n)](https://nodejs.org/api/events.html#events_emitter_setmaxlisteners_n) - */ - maxTasks?: number - /** - * The work choice strategy to use in this pool. - */ - workerChoiceStrategy?: WorkerChoiceStrategy -} - -/** - * Base class containing some shared logic for all poolifier pools. + * Base class that implements some shared logic for all poolifier pools. * - * @template Worker Type of worker which manages this pool. - * @template Data Type of data sent to the worker. This can only be serializable data. - * @template Response Type of response of execution. This can only be serializable data. + * @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 execution response. This can only be serializable data. */ export abstract class AbstractPool< Worker extends IWorker, Data = unknown, Response = unknown -> implements IPoolInternal { - /** @inheritdoc */ - public readonly workers: Worker[] = [] - - /** @inheritdoc */ - public readonly tasks: Map = new Map() +> implements IPool { + /** @inheritDoc */ + public readonly workerNodes: Array> = [] - /** @inheritdoc */ - public readonly emitter: PoolEmitter + /** @inheritDoc */ + public readonly emitter?: PoolEmitter /** - * ID of the next message. + * The 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 nextMessageId: number = 0 + protected promiseResponseMap: Map< + string, + PromiseResponseWrapper + > = new Map>() /** - * Worker choice strategy instance implementing the worker choice algorithm. + * Worker choice strategy context referencing a worker choice algorithm implementation. * - * Default to a strategy implementing a round robin algorithm. + * Default to a round robin algorithm. */ protected workerChoiceStrategyContext: WorkerChoiceStrategyContext< - Worker, - Data, - Response + Worker, + Data, + Response > /** * Constructs a new poolifier pool. * - * @param numberOfWorkers Number of workers that this pool should manage. - * @param filePath Path to the worker-file. - * @param opts Options for the pool. Default: `{ maxTasks: 1000 }` + * @param numberOfWorkers - Number of workers that this pool should manage. + * @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 = { maxTasks: 1000 } + 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!') } + this.checkNumberOfWorkers(this.numberOfWorkers) this.checkFilePath(this.filePath) + this.checkPoolOptions(this.opts) + + 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< + Worker, + Data, + Response + >( + this, + this.opts.workerChoiceStrategy, + this.opts.workerChoiceStrategyOptions + ) + this.setupHook() for (let i = 1; i <= this.numberOfWorkers; i++) { this.createAndSetupWorker() } - - this.emitter = new PoolEmitter() - this.workerChoiceStrategyContext = new WorkerChoiceStrategyContext( - this, - opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN - ) } private checkFilePath (filePath: string): void { - if (!filePath) { + if ( + filePath == null || + (typeof filePath === 'string' && filePath.trim().length === 0) + ) { throw new Error('Please specify a file with a worker implementation') } } - /** @inheritdoc */ - public isDynamic (): boolean { - return false + private checkNumberOfWorkers (numberOfWorkers: number): void { + if (numberOfWorkers == null) { + throw new Error( + 'Cannot instantiate a pool without specifying the number of workers' + ) + } else if (!Number.isSafeInteger(numberOfWorkers)) { + throw new TypeError( + '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 === PoolTypes.fixed && numberOfWorkers === 0) { + throw new Error('Cannot instantiate a fixed pool with no worker') + } } - /** @inheritdoc */ - public setWorkerChoiceStrategy ( + private checkPoolOptions (opts: PoolOptions): void { + 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') + } + } + + private checkValidWorkerChoiceStrategy ( workerChoiceStrategy: WorkerChoiceStrategy ): void { + if (!Object.values(WorkerChoiceStrategies).includes(workerChoiceStrategy)) { + throw new Error( + `Invalid worker choice strategy '${workerChoiceStrategy}'` + ) + } + } + + 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' + ) + } + } + + 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 as number) <= 0) { + throw new Error( + `Invalid worker tasks concurrency '${ + tasksQueueOptions.concurrency as number + }'` + ) + } + } + + /** @inheritDoc */ + public get info (): PoolInfo { + return { + type: this.type, + worker: this.worker, + minSize: this.minSize, + maxSize: this.maxSize, + workerNodes: this.workerNodes.length, + idleWorkerNodes: this.workerNodes.reduce( + (accumulator, workerNode) => + workerNode.workerUsage.tasks.executing === 0 + ? accumulator + 1 + : accumulator, + 0 + ), + busyWorkerNodes: this.workerNodes.reduce( + (accumulator, workerNode) => + workerNode.workerUsage.tasks.executing > 0 + ? accumulator + 1 + : accumulator, + 0 + ), + executedTasks: this.workerNodes.reduce( + (accumulator, workerNode) => + accumulator + workerNode.workerUsage.tasks.executed, + 0 + ), + executingTasks: this.workerNodes.reduce( + (accumulator, workerNode) => + accumulator + workerNode.workerUsage.tasks.executing, + 0 + ), + queuedTasks: this.workerNodes.reduce( + (accumulator, workerNode) => accumulator + workerNode.tasksQueue.size, + 0 + ), + maxQueuedTasks: this.workerNodes.reduce( + (accumulator, workerNode) => + accumulator + workerNode.tasksQueue.maxSize, + 0 + ), + failedTasks: this.workerNodes.reduce( + (accumulator, workerNode) => + accumulator + workerNode.workerUsage.tasks.failed, + 0 + ) + } + } + + /** + * 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 + + /** + * Gets the given worker its worker node key. + * + * @param worker - The worker. + * @returns The worker node key if the worker is found in the pool worker nodes, `-1` otherwise. + */ + private getWorkerNodeKey (worker: Worker): number { + return this.workerNodes.findIndex( + workerNode => workerNode.worker === worker + ) + } + + /** @inheritDoc */ + public setWorkerChoiceStrategy ( + workerChoiceStrategy: WorkerChoiceStrategy, + workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions + ): void { + this.checkValidWorkerChoiceStrategy(workerChoiceStrategy) + this.opts.workerChoiceStrategy = workerChoiceStrategy this.workerChoiceStrategyContext.setWorkerChoiceStrategy( - workerChoiceStrategy + this.opts.workerChoiceStrategy ) + if (workerChoiceStrategyOptions != null) { + this.setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions) + } + for (const workerNode of this.workerNodes) { + this.setWorkerNodeTasksUsage(workerNode, { + tasks: { + executed: 0, + executing: 0, + queued: + this.opts.enableTasksQueue === true + ? workerNode.tasksQueue.size + : 0, + failed: 0 + }, + runTime: { + aggregation: 0, + average: 0, + median: 0, + history: new CircularArray() + }, + waitTime: { + aggregation: 0, + average: 0, + median: 0, + history: new CircularArray() + }, + elu: undefined + }) + this.setWorkerStatistics(workerNode.worker) + } } - /** @inheritdoc */ - public execute (data: Data): Promise { - // Configure worker to handle message with the specified task - const worker = this.chooseWorker() - this.increaseWorkersTask(worker) - const messageId = ++this.nextMessageId - const res = this.internalExecute(worker, messageId) - this.sendToWorker(worker, { data: data || ({} as Data), id: messageId }) - return res + /** @inheritDoc */ + public setWorkerChoiceStrategyOptions ( + workerChoiceStrategyOptions: WorkerChoiceStrategyOptions + ): void { + this.checkValidWorkerChoiceStrategyOptions(workerChoiceStrategyOptions) + this.opts.workerChoiceStrategyOptions = workerChoiceStrategyOptions + this.workerChoiceStrategyContext.setOptions( + this.opts.workerChoiceStrategyOptions + ) } - /** @inheritdoc */ - public async destroy (): Promise { - await Promise.all(this.workers.map(worker => this.destroyWorker(worker))) + /** @inheritDoc */ + public enableTasksQueue ( + enable: boolean, + tasksQueueOptions?: TasksQueueOptions + ): void { + if (this.opts.enableTasksQueue === true && !enable) { + this.flushTasksQueues() + } + this.opts.enableTasksQueue = enable + this.setTasksQueueOptions(tasksQueueOptions as TasksQueueOptions) } - /** @inheritdoc */ - public abstract destroyWorker (worker: Worker): void | Promise + /** @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 + } + } /** - * Setup hook that can be overridden by a Poolifier pool implementation - * to run code before workers are created in the abstract constructor. + * Whether the pool is full or not. + * + * The pool filling boolean status. */ - protected setupHook (): void { - // Can be overridden + protected get full (): boolean { + return this.workerNodes.length >= this.maxSize } /** - * Should return whether the worker is the main worker or not. + * Whether the pool is busy or not. + * + * The pool busyness boolean status. */ - protected abstract isMain (): boolean + protected abstract get busy (): boolean + + protected internalBusy (): boolean { + return ( + this.workerNodes.findIndex(workerNode => { + return workerNode.workerUsage.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: crypto.randomUUID() + } + const res = new Promise((resolve, reject) => { + this.promiseResponseMap.set(submittedTask.id as string, { + resolve, + reject, + worker: this.workerNodes[workerNodeKey].worker + }) + }) + if ( + this.opts.enableTasksQueue === true && + (this.busy || + this.workerNodes[workerNodeKey].workerUsage.tasks.executing >= + ((this.opts.tasksQueueOptions as TasksQueueOptions) + .concurrency as number)) + ) { + this.enqueueTask(workerNodeKey, submittedTask) + } else { + this.executeTask(workerNodeKey, submittedTask) + } + this.workerChoiceStrategyContext.update(workerNodeKey) + 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 + await this.destroyWorker(workerNode.worker) + }) + ) + } /** - * Increase the number of tasks that the given workers has done. + * Shutdowns the given worker. * - * @param worker Worker whose tasks are increased. + * @param worker - A worker within `workerNodes`. */ - protected increaseWorkersTask (worker: Worker): void { - this.stepWorkerNumberOfTasks(worker, 1) - } + protected abstract destroyWorker (worker: Worker): void | Promise /** - * Decrease the number of tasks that the given workers has done. + * Setup hook to execute code before worker node are created in the abstract constructor. + * Can be overridden * - * @param worker Worker whose tasks are decreased. + * @virtual */ - protected decreaseWorkersTasks (worker: Worker): void { - this.stepWorkerNumberOfTasks(worker, -1) + protected setupHook (): void { + // Intentionally empty } /** - * Step the number of tasks that the given workers has done. + * Should return whether the worker is the main worker or not. + */ + protected abstract isMain (): boolean + + /** + * Hook executed before the worker task execution. + * Can be overridden. * - * @param worker Worker whose tasks are set. - * @param step Worker number of tasks step. + * @param workerNodeKey - The worker node key. */ - private stepWorkerNumberOfTasks (worker: Worker, step: number): void { - const numberOfTasksInProgress = this.tasks.get(worker) - if (numberOfTasksInProgress !== undefined) { - this.tasks.set(worker, numberOfTasksInProgress + step) - } else { - throw Error('Worker could not be found in tasks map') + protected beforeTaskExecutionHook (workerNodeKey: number): void { + ++this.workerNodes[workerNodeKey].workerUsage.tasks.executing + if (this.opts.enableTasksQueue === true) { + this.workerNodes[workerNodeKey].workerUsage.tasks.queued = + this.tasksQueueSize(workerNodeKey) } } /** - * Removes the given worker from the pool. + * Hook executed after the worker task execution. + * Can be overridden. * - * @param worker Worker that will be removed. + * @param worker - The worker. + * @param message - The received message. */ - protected removeWorker (worker: Worker): void { - // Clean worker from data structure - const workerIndex = this.workers.indexOf(worker) - this.workers.splice(workerIndex, 1) - this.tasks.delete(worker) + protected afterTaskExecutionHook ( + worker: Worker, + message: MessageValue + ): void { + const workerUsage = + this.workerNodes[this.getWorkerNodeKey(worker)].workerUsage + const workerTaskStatistics = workerUsage.tasks + --workerTaskStatistics.executing + ++workerTaskStatistics.executed + if (message.taskError != null) { + ++workerTaskStatistics.failed + } + + this.updateRunTimeWorkerUsage(workerUsage, message) + this.updateWaitTimeWorkerUsage(workerUsage, message) + this.updateEluWorkerUsage(workerUsage, message) + } + + private updateRunTimeWorkerUsage ( + workerUsage: WorkerUsage, + message: MessageValue + ): void { + if (this.workerChoiceStrategyContext.getTaskStatistics().runTime) { + workerUsage.runTime.aggregation += message.taskPerformance?.runTime ?? 0 + if ( + this.workerChoiceStrategyContext.getTaskStatistics().avgRunTime && + workerUsage.tasks.executed !== 0 + ) { + workerUsage.runTime.average = + workerUsage.runTime.aggregation / workerUsage.tasks.executed + } + if ( + this.workerChoiceStrategyContext.getTaskStatistics().medRunTime && + message.taskPerformance?.runTime != null + ) { + workerUsage.runTime.history.push(message.taskPerformance.runTime) + workerUsage.runTime.median = median(workerUsage.runTime.history) + } + } + } + + private updateWaitTimeWorkerUsage ( + workerUsage: WorkerUsage, + message: MessageValue + ): void { + if (this.workerChoiceStrategyContext.getTaskStatistics().waitTime) { + workerUsage.waitTime.aggregation += message.taskPerformance?.waitTime ?? 0 + if ( + this.workerChoiceStrategyContext.getTaskStatistics().avgWaitTime && + workerUsage.tasks.executed !== 0 + ) { + workerUsage.waitTime.average = + workerUsage.waitTime.aggregation / workerUsage.tasks.executed + } + if ( + this.workerChoiceStrategyContext.getTaskStatistics().medWaitTime && + message.taskPerformance?.waitTime != null + ) { + workerUsage.waitTime.history.push(message.taskPerformance.waitTime) + workerUsage.waitTime.median = median(workerUsage.waitTime.history) + } + } + } + + private updateEluWorkerUsage ( + workerTasksUsage: WorkerUsage, + message: MessageValue + ): void { + if (this.workerChoiceStrategyContext.getTaskStatistics().elu) { + if ( + workerTasksUsage.elu != null && + message.taskPerformance?.elu != null + ) { + workerTasksUsage.elu = { + idle: workerTasksUsage.elu.idle + message.taskPerformance.elu.idle, + active: + workerTasksUsage.elu.active + message.taskPerformance.elu.active, + utilization: + (workerTasksUsage.elu.utilization + + message.taskPerformance.elu.utilization) / + 2 + } + } else if (message.taskPerformance?.elu != null) { + workerTasksUsage.elu = message.taskPerformance.elu + } + } } /** - * Choose a worker for the next task. + * Chooses a worker node for the next task. * - * The default implementation uses a round robin algorithm to distribute the load. + * The default worker choice strategy uses a round robin algorithm to distribute the load. * - * @returns Worker. + * @returns The worker node key */ - protected chooseWorker (): Worker { - return this.workerChoiceStrategyContext.execute() + protected chooseWorkerNode (): number { + let workerNodeKey: number + if (this.type === PoolTypes.dynamic && !this.full && this.internalBusy()) { + const workerCreated = this.createAndSetupWorker() + this.registerWorkerMessageListener(workerCreated, message => { + const currentWorkerNodeKey = this.getWorkerNodeKey(workerCreated) + if ( + isKillBehavior(KillBehaviors.HARD, message.kill) || + (message.kill != null && + this.workerNodes[currentWorkerNodeKey].workerUsage.tasks + .executing === 0) + ) { + // Kill message received from the worker: no new tasks are submitted to that worker for a while ( > maxInactiveTime) + this.flushTasksQueue(currentWorkerNodeKey) + // FIXME: wait for tasks to be finished + void (this.destroyWorker(workerCreated) as Promise) + } + }) + workerNodeKey = this.getWorkerNodeKey(workerCreated) + } else { + workerNodeKey = this.workerChoiceStrategyContext.execute() + } + return workerNodeKey } /** - * Send a message to the given worker. + * Sends a message to the given worker. * - * @param worker The worker which should receive the message. - * @param message The message. + * @param worker - The worker which should receive the message. + * @param message - The message. */ protected abstract sendToWorker ( worker: Worker, message: MessageValue ): void - /** @inheritdoc */ - public abstract registerWorkerMessageListener< - Message extends Data | Response - > (worker: Worker, listener: (message: MessageValue) => void): void - - protected abstract unregisterWorkerMessageListener< + /** + * Registers a listener callback on the given 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 - - protected internalExecute ( - worker: Worker, - messageId: number - ): Promise { - return new Promise((resolve, reject) => { - const listener: (message: MessageValue) => void = message => { - if (message.id === messageId) { - this.unregisterWorkerMessageListener(worker, listener) - this.decreaseWorkersTasks(worker) - if (message.error) reject(message.error) - else resolve(message.data as Response) - } - } - this.registerWorkerMessageListener(worker, listener) - }) - } + >(worker: Worker, listener: (message: MessageValue) => void): void /** * Returns a newly created worker. @@ -311,30 +639,219 @@ 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 workers registry. + * Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes. * - * Can be used to update the `maxListeners` or binding the `main-worker`<->`worker` connection if not bind by default. + * 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. + * @param worker - The newly created worker. */ protected abstract afterWorkerSetup (worker: Worker): void - /** @inheritdoc */ - public createAndSetupWorker (): Worker { - const worker: Worker = this.createWorker() + /** + * Creates a new worker and sets it up completely in the pool worker nodes. + * + * @returns New, completely set up worker. + */ + protected createAndSetupWorker (): Worker { + const worker = this.createWorker() + 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) + } + }) + worker.on('error', () => { + if (this.opts.restartWorkerOnError === true) { + this.createAndSetupWorker() + } + }) worker.on('online', this.opts.onlineHandler ?? EMPTY_FUNCTION) worker.on('exit', this.opts.exitHandler ?? EMPTY_FUNCTION) - worker.once('exit', () => this.removeWorker(worker)) + worker.once('exit', () => { + this.removeWorkerNode(worker) + }) - this.workers.push(worker) + this.pushWorkerNode(worker) - // Init tasks map - this.tasks.set(worker, 0) + this.setWorkerStatistics(worker) this.afterWorkerSetup(worker) return worker } + + /** + * This function 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.id != null) { + // Task execution response received + const promiseResponse = this.promiseResponseMap.get(message.id) + if (promiseResponse != null) { + if (message.taskError != null) { + promiseResponse.reject(message.taskError.message) + if (this.emitter != null) { + this.emitter.emit(PoolEvents.taskError, message.taskError) + } + } else { + promiseResponse.resolve(message.data as Response) + } + this.afterTaskExecutionHook(promiseResponse.worker, message) + this.promiseResponseMap.delete(message.id) + const workerNodeKey = this.getWorkerNodeKey(promiseResponse.worker) + if ( + this.opts.enableTasksQueue === true && + this.tasksQueueSize(workerNodeKey) > 0 + ) { + this.executeTask( + workerNodeKey, + this.dequeueTask(workerNodeKey) as Task + ) + } + } + } + } + } + + 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) + } + } + } + + /** + * 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.workerUsage = workerUsage + } + + /** + * Pushes the given worker in the pool worker nodes. + * + * @param worker - The worker. + * @returns The worker nodes length. + */ + private pushWorkerNode (worker: Worker): number { + return this.workerNodes.push({ + worker, + workerUsage: { + tasks: { + executed: 0, + executing: 0, + queued: 0, + failed: 0 + }, + runTime: { + aggregation: 0, + average: 0, + median: 0, + history: new CircularArray() + }, + + waitTime: { + aggregation: 0, + average: 0, + median: 0, + history: new CircularArray() + }, + elu: undefined + }, + tasksQueue: new Queue>() + }) + } + + /** + * Sets the given worker in the pool worker nodes. + * + * @param workerNodeKey - The worker node key. + * @param worker - The worker. + * @param workerUsage - The worker usage. + * @param tasksQueue - The worker task queue. + */ + private setWorkerNode ( + workerNodeKey: number, + worker: Worker, + workerUsage: WorkerUsage, + tasksQueue: Queue> + ): void { + this.workerNodes[workerNodeKey] = { + worker, + 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) + if (workerNodeKey !== -1) { + this.workerNodes.splice(workerNodeKey, 1) + this.workerChoiceStrategyContext.remove(workerNodeKey) + } + } + + private executeTask (workerNodeKey: number, task: Task): void { + this.beforeTaskExecutionHook(workerNodeKey) + this.sendToWorker(this.workerNodes[workerNodeKey].worker, task) + } + + private enqueueTask (workerNodeKey: number, task: Task): number { + return this.workerNodes[workerNodeKey].tasksQueue.enqueue(task) + } + + private dequeueTask (workerNodeKey: number): Task | undefined { + return this.workerNodes[workerNodeKey].tasksQueue.dequeue() + } + + private tasksQueueSize (workerNodeKey: number): number { + return this.workerNodes[workerNodeKey].tasksQueue.size + } + + private flushTasksQueue (workerNodeKey: number): void { + if (this.tasksQueueSize(workerNodeKey) > 0) { + for (let i = 0; i < this.tasksQueueSize(workerNodeKey); i++) { + this.executeTask( + workerNodeKey, + this.dequeueTask(workerNodeKey) as Task + ) + } + } + } + + 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.getTaskStatistics().runTime, + waitTime: this.workerChoiceStrategyContext.getTaskStatistics().waitTime, + elu: this.workerChoiceStrategyContext.getTaskStatistics().elu + } + }) + } }