X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=85a47e38f7c248f7a92ff9e53166e2121048015c;hb=d715b7bc2973eed82edebb1f7d233d451ad3c97b;hp=b9a7cd398920fc77a754d3d4047414beae94ba46;hpb=3fa4cdd2951436bbb60a46b9d0ac151a4aa45ce1;p=poolifier.git diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index b9a7cd39..85a47e38 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -1,4 +1,5 @@ import crypto from 'node:crypto' +import { performance } from 'node:perf_hooks' import type { MessageValue, PromiseResponseWrapper } from '../utility-types' import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS, @@ -13,9 +14,12 @@ import { type IPool, PoolEmitter, PoolEvents, + type PoolInfo, type PoolOptions, - PoolType, - type TasksQueueOptions + type PoolType, + PoolTypes, + type TasksQueueOptions, + type WorkerType } from './pool' import type { IWorker, Task, TasksUsage, WorkerNode } from './worker' import { @@ -75,9 +79,9 @@ export abstract class AbstractPool< * @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!') @@ -91,12 +95,6 @@ export abstract class AbstractPool< this.enqueueTask = this.enqueueTask.bind(this) this.checkAndEmitEvents = this.checkAndEmitEvents.bind(this) - this.setupHook() - - for (let i = 1; i <= this.numberOfWorkers; i++) { - this.createAndSetupWorker() - } - if (this.opts.enableEvents === true) { this.emitter = new PoolEmitter() } @@ -109,6 +107,12 @@ export abstract class AbstractPool< this.opts.workerChoiceStrategy, this.opts.workerChoiceStrategyOptions ) + + this.setupHook() + + for (let i = 1; i <= this.numberOfWorkers; i++) { + this.createAndSetupWorker() + } } private checkFilePath (filePath: string): void { @@ -133,7 +137,7 @@ export abstract class AbstractPool< throw new RangeError( 'Cannot instantiate a pool with a negative number of workers' ) - } else if (this.type === PoolType.FIXED && numberOfWorkers === 0) { + } else if (this.type === PoolTypes.fixed && numberOfWorkers === 0) { throw new Error('Cannot instantiate a fixed pool with no worker') } } @@ -149,6 +153,7 @@ export abstract class AbstractPool< 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) { @@ -184,7 +189,7 @@ export abstract class AbstractPool< } if ( workerChoiceStrategyOptions.weights != null && - Object.keys(workerChoiceStrategyOptions.weights).length !== this.size + Object.keys(workerChoiceStrategyOptions.weights).length !== this.maxSize ) { throw new Error( 'Invalid worker choice strategy options: must have a weight for each worker node' @@ -208,33 +213,61 @@ export abstract class AbstractPool< } /** @inheritDoc */ - public abstract get type (): PoolType + 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.tasksUsage.running === 0 ? accumulator + 1 : accumulator, + 0 + ), + busyWorkerNodes: this.workerNodes.reduce( + (accumulator, workerNode) => + workerNode.tasksUsage.running > 0 ? accumulator + 1 : accumulator, + 0 + ), + runningTasks: this.workerNodes.reduce( + (accumulator, workerNode) => + accumulator + workerNode.tasksUsage.running, + 0 + ), + queuedTasks: this.workerNodes.reduce( + (accumulator, workerNode) => accumulator + workerNode.tasksQueue.size, + 0 + ), + maxQueuedTasks: this.workerNodes.reduce( + (accumulator, workerNode) => + accumulator + workerNode.tasksQueue.maxSize, + 0 + ) + } + } - /** @inheritDoc */ - public abstract get size (): number + /** + * Pool type. + * + * If it is `'dynamic'`, it provides the `max` property. + */ + protected abstract get type (): PoolType /** - * Number of tasks running in the pool. + * Gets the worker type. */ - private get numberOfRunningTasks (): number { - return this.workerNodes.reduce( - (accumulator, workerNode) => accumulator + workerNode.tasksUsage.running, - 0 - ) - } + protected abstract get worker (): WorkerType /** - * Number of tasks queued in the pool. + * Pool minimum size. */ - private get numberOfQueuedTasks (): number { - if (this.opts.enableTasksQueue === false) { - return 0 - } - return this.workerNodes.reduce( - (accumulator, workerNode) => accumulator + workerNode.tasksQueue.size, - 0 - ) - } + protected abstract get minSize (): number + + /** + * Pool maximum size. + */ + protected abstract get maxSize (): number /** * Gets the given worker its worker node key. @@ -255,22 +288,28 @@ export abstract class AbstractPool< ): void { this.checkValidWorkerChoiceStrategy(workerChoiceStrategy) this.opts.workerChoiceStrategy = workerChoiceStrategy + this.workerChoiceStrategyContext.setWorkerChoiceStrategy( + this.opts.workerChoiceStrategy + ) + if (workerChoiceStrategyOptions != null) { + this.setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions) + } for (const workerNode of this.workerNodes) { this.setWorkerNodeTasksUsage(workerNode, { - run: 0, + ran: 0, running: 0, runTime: 0, runTimeHistory: new CircularArray(), avgRunTime: 0, medRunTime: 0, - error: 0 + waitTime: 0, + waitTimeHistory: new CircularArray(), + avgWaitTime: 0, + medWaitTime: 0, + error: 0, + elu: undefined }) - } - this.workerChoiceStrategyContext.setWorkerChoiceStrategy( - this.opts.workerChoiceStrategy - ) - if (workerChoiceStrategyOptions != null) { - this.setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions) + this.setWorkerStatistics(workerNode.worker) } } @@ -303,7 +342,7 @@ export abstract class AbstractPool< this.checkValidTasksQueueOptions(tasksQueueOptions) this.opts.tasksQueueOptions = this.buildTasksQueueOptions(tasksQueueOptions) - } else { + } else if (this.opts.tasksQueueOptions != null) { delete this.opts.tasksQueueOptions } } @@ -321,7 +360,9 @@ export abstract class AbstractPool< * * The pool filling boolean status. */ - protected abstract get full (): boolean + protected get full (): boolean { + return this.workerNodes.length >= this.maxSize + } /** * Whether the pool is busy or not. @@ -340,18 +381,20 @@ export abstract class AbstractPool< /** @inheritDoc */ public async execute (data?: Data, name?: string): Promise { - const [workerNodeKey, workerNode] = this.chooseWorkerNode() + 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: workerNode.worker + worker: this.workerNodes[workerNodeKey].worker }) }) if ( @@ -376,6 +419,7 @@ export abstract class AbstractPool< await Promise.all( this.workerNodes.map(async (workerNode, workerNodeKey) => { this.flushTasksQueue(workerNodeKey) + // FIXME: wait for tasks to be finished await this.destroyWorker(workerNode.worker) }) ) @@ -424,42 +468,98 @@ export abstract class AbstractPool< worker: Worker, message: MessageValue ): void { - const workerNodeKey = this.getWorkerNodeKey(worker) - const workerTasksUsage = this.workerNodes[workerNodeKey].tasksUsage + const workerTasksUsage = + this.workerNodes[this.getWorkerNodeKey(worker)].tasksUsage --workerTasksUsage.running - ++workerTasksUsage.run + ++workerTasksUsage.ran if (message.error != null) { ++workerTasksUsage.error } - if (this.workerChoiceStrategyContext.getRequiredStatistics().runTime) { - workerTasksUsage.runTime += message.runTime ?? 0 + this.updateRunTimeTasksUsage(workerTasksUsage, message) + this.updateWaitTimeTasksUsage(workerTasksUsage, message) + this.updateEluTasksUsage(workerTasksUsage, message) + } + + private updateRunTimeTasksUsage ( + workerTasksUsage: TasksUsage, + message: MessageValue + ): void { + if (this.workerChoiceStrategyContext.getTaskStatistics().runTime) { + workerTasksUsage.runTime += message.taskPerformance?.runTime ?? 0 if ( - this.workerChoiceStrategyContext.getRequiredStatistics().avgRunTime && - workerTasksUsage.run !== 0 + this.workerChoiceStrategyContext.getTaskStatistics().avgRunTime && + workerTasksUsage.ran !== 0 ) { workerTasksUsage.avgRunTime = - workerTasksUsage.runTime / workerTasksUsage.run + workerTasksUsage.runTime / workerTasksUsage.ran } if ( - this.workerChoiceStrategyContext.getRequiredStatistics().medRunTime && - message.runTime != null + this.workerChoiceStrategyContext.getTaskStatistics().medRunTime && + message.taskPerformance?.runTime != null ) { - workerTasksUsage.runTimeHistory.push(message.runTime) + workerTasksUsage.runTimeHistory.push(message.taskPerformance.runTime) workerTasksUsage.medRunTime = median(workerTasksUsage.runTimeHistory) } } } + private updateWaitTimeTasksUsage ( + workerTasksUsage: TasksUsage, + message: MessageValue + ): void { + if (this.workerChoiceStrategyContext.getTaskStatistics().waitTime) { + workerTasksUsage.waitTime += message.taskPerformance?.waitTime ?? 0 + if ( + this.workerChoiceStrategyContext.getTaskStatistics().avgWaitTime && + workerTasksUsage.ran !== 0 + ) { + workerTasksUsage.avgWaitTime = + workerTasksUsage.waitTime / workerTasksUsage.ran + } + if ( + this.workerChoiceStrategyContext.getTaskStatistics().medWaitTime && + message.taskPerformance?.waitTime != null + ) { + workerTasksUsage.waitTimeHistory.push(message.taskPerformance.waitTime) + workerTasksUsage.medWaitTime = median(workerTasksUsage.waitTimeHistory) + } + } + } + + private updateEluTasksUsage ( + workerTasksUsage: TasksUsage, + 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 + } + } + } + /** * Chooses a worker node for the next task. * - * The default 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 node key, worker node]. + * @returns The worker node key */ - protected chooseWorkerNode (): [number, WorkerNode] { + protected chooseWorkerNode (): number { let workerNodeKey: number - if (this.type === PoolType.DYNAMIC && !this.full && this.internalBusy()) { + if (this.type === PoolTypes.dynamic && !this.full && this.internalBusy()) { const workerCreated = this.createAndSetupWorker() this.registerWorkerMessageListener(workerCreated, message => { const currentWorkerNodeKey = this.getWorkerNodeKey(workerCreated) @@ -470,6 +570,7 @@ export abstract class AbstractPool< ) { // 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) } }) @@ -477,7 +578,7 @@ export abstract class AbstractPool< } else { workerNodeKey = this.workerChoiceStrategyContext.execute() } - return [workerNodeKey, this.workerNodes[workerNodeKey]] + return workerNodeKey } /** @@ -525,6 +626,16 @@ export abstract class AbstractPool< 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', () => { @@ -533,6 +644,8 @@ export abstract class AbstractPool< this.pushWorkerNode(worker) + this.setWorkerStatistics(worker) + this.afterWorkerSetup(worker) return worker @@ -551,6 +664,12 @@ export abstract class AbstractPool< if (promiseResponse != null) { if (message.error != null) { promiseResponse.reject(message.error) + if (this.emitter != null) { + this.emitter.emit(PoolEvents.taskError, { + error: message.error, + errorData: message.errorData + }) + } } else { promiseResponse.resolve(message.data as Response) } @@ -572,12 +691,12 @@ export abstract class AbstractPool< } private checkAndEmitEvents (): void { - if (this.opts.enableEvents === true) { + if (this.emitter != null) { if (this.busy) { - this.emitter?.emit(PoolEvents.busy) + this.emitter?.emit(PoolEvents.busy, this.info) } - if (this.type === PoolType.DYNAMIC && this.full) { - this.emitter?.emit(PoolEvents.full) + if (this.type === PoolTypes.dynamic && this.full) { + this.emitter?.emit(PoolEvents.full, this.info) } } } @@ -605,13 +724,18 @@ export abstract class AbstractPool< return this.workerNodes.push({ worker, tasksUsage: { - run: 0, + ran: 0, running: 0, runTime: 0, runTimeHistory: new CircularArray(), avgRunTime: 0, medRunTime: 0, - error: 0 + waitTime: 0, + waitTimeHistory: new CircularArray(), + avgWaitTime: 0, + medWaitTime: 0, + error: 0, + elu: undefined }, tasksQueue: new Queue>() }) @@ -645,8 +769,10 @@ export abstract class AbstractPool< */ private removeWorkerNode (worker: Worker): void { const workerNodeKey = this.getWorkerNodeKey(worker) - this.workerNodes.splice(workerNodeKey, 1) - this.workerChoiceStrategyContext.remove(workerNodeKey) + if (workerNodeKey !== -1) { + this.workerNodes.splice(workerNodeKey, 1) + this.workerChoiceStrategyContext.remove(workerNodeKey) + } } private executeTask (workerNodeKey: number, task: Task): void { @@ -682,4 +808,14 @@ export abstract class AbstractPool< 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 + } + }) + } }