X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=3c690fb819e9c718163e86badcde28786a5dd849;hb=230fcf18603f74badb3446048ed9feaf24afa54a;hp=065b228ada73e6d21f6fb8238bddf403cc04ac83;hpb=62c15a687b812a5404f64867adbd14320444af99;p=poolifier.git diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index 065b228a..3c690fb8 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -21,7 +21,13 @@ import { type TasksQueueOptions, type WorkerType } from './pool' -import type { IWorker, Task, TasksUsage, WorkerNode } from './worker' +import type { + IWorker, + Task, + TaskStatistics, + WorkerNode, + WorkerUsage +} from './worker' import { WorkerChoiceStrategies, type WorkerChoiceStrategy, @@ -95,12 +101,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() } @@ -113,6 +113,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 { @@ -222,17 +228,26 @@ export abstract class AbstractPool< workerNodes: this.workerNodes.length, idleWorkerNodes: this.workerNodes.reduce( (accumulator, workerNode) => - workerNode.tasksUsage.running === 0 ? accumulator + 1 : accumulator, + workerNode.workerUsage.tasks.executing === 0 + ? accumulator + 1 + : accumulator, 0 ), busyWorkerNodes: this.workerNodes.reduce( (accumulator, workerNode) => - workerNode.tasksUsage.running > 0 ? accumulator + 1 : accumulator, + workerNode.workerUsage.tasks.executing > 0 + ? accumulator + 1 + : accumulator, + 0 + ), + executedTasks: this.workerNodes.reduce( + (accumulator, workerNode) => + accumulator + workerNode.workerUsage.tasks.executed, 0 ), - runningTasks: this.workerNodes.reduce( + executingTasks: this.workerNodes.reduce( (accumulator, workerNode) => - accumulator + workerNode.tasksUsage.running, + accumulator + workerNode.workerUsage.tasks.executing, 0 ), queuedTasks: this.workerNodes.reduce( @@ -243,6 +258,11 @@ export abstract class AbstractPool< (accumulator, workerNode) => accumulator + workerNode.tasksQueue.maxSize, 0 + ), + failedTasks: this.workerNodes.reduce( + (accumulator, workerNode) => + accumulator + workerNode.workerUsage.tasks.failed, + 0 ) } } @@ -288,28 +308,19 @@ export abstract class AbstractPool< ): void { this.checkValidWorkerChoiceStrategy(workerChoiceStrategy) this.opts.workerChoiceStrategy = workerChoiceStrategy - for (const workerNode of this.workerNodes) { - this.setWorkerNodeTasksUsage(workerNode, { - ran: 0, - running: 0, - runTime: 0, - runTimeHistory: new CircularArray(), - avgRunTime: 0, - medRunTime: 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) } + for (const workerNode of this.workerNodes) { + this.setWorkerNodeTasksUsage( + workerNode, + this.getWorkerUsage(workerNode.worker) + ) + this.setWorkerStatistics(workerNode.worker) + } } /** @inheritDoc */ @@ -341,7 +352,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 } } @@ -373,20 +384,20 @@ export abstract class AbstractPool< protected internalBusy (): boolean { return ( this.workerNodes.findIndex(workerNode => { - return workerNode.tasksUsage.running === 0 + return workerNode.workerUsage.tasks.executing === 0 }) === -1 ) } /** @inheritDoc */ public async execute (data?: Data, name?: string): Promise { - const submissionTimestamp = performance.now() + 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), - submissionTimestamp, + timestamp, id: crypto.randomUUID() } const res = new Promise((resolve, reject) => { @@ -399,7 +410,7 @@ export abstract class AbstractPool< if ( this.opts.enableTasksQueue === true && (this.busy || - this.workerNodes[workerNodeKey].tasksUsage.running >= + this.workerNodes[workerNodeKey].workerUsage.tasks.executing >= ((this.opts.tasksQueueOptions as TasksQueueOptions) .concurrency as number)) ) { @@ -451,9 +462,15 @@ export abstract class AbstractPool< * Can be overridden. * * @param workerNodeKey - The worker node key. + * @param task - The task to execute. */ - protected beforeTaskExecutionHook (workerNodeKey: number): void { - ++this.workerNodes[workerNodeKey].tasksUsage.running + protected beforeTaskExecutionHook ( + workerNodeKey: number, + task: Task + ): void { + const workerUsage = this.workerNodes[workerNodeKey].workerUsage + ++workerUsage.tasks.executing + this.updateWaitTimeWorkerUsage(workerUsage, task) } /** @@ -467,79 +484,96 @@ export abstract class AbstractPool< worker: Worker, message: MessageValue ): void { - const workerTasksUsage = - this.workerNodes[this.getWorkerNodeKey(worker)].tasksUsage - --workerTasksUsage.running - ++workerTasksUsage.ran - if (message.error != null) { - ++workerTasksUsage.error + const workerUsage = + this.workerNodes[this.getWorkerNodeKey(worker)].workerUsage + const workerTaskStatistics = workerUsage.tasks + --workerTaskStatistics.executing + ++workerTaskStatistics.executed + if (message.taskError != null) { + ++workerTaskStatistics.failed } - this.updateRunTimeTasksUsage(workerTasksUsage, message) - this.updateWaitTimeTasksUsage(workerTasksUsage, message) - this.updateEluTasksUsage(workerTasksUsage, message) + this.updateRunTimeWorkerUsage(workerUsage, message) + this.updateEluWorkerUsage(workerUsage, message) } - private updateRunTimeTasksUsage ( - workerTasksUsage: TasksUsage, + private updateRunTimeWorkerUsage ( + workerUsage: WorkerUsage, message: MessageValue ): void { - if (this.workerChoiceStrategyContext.getRequiredStatistics().runTime) { - workerTasksUsage.runTime += message.runTime ?? 0 + if ( + this.workerChoiceStrategyContext.getTaskStatisticsRequirements().runTime + .aggregate + ) { + workerUsage.runTime.aggregate += message.taskPerformance?.runTime ?? 0 if ( - this.workerChoiceStrategyContext.getRequiredStatistics().avgRunTime && - workerTasksUsage.ran !== 0 + this.workerChoiceStrategyContext.getTaskStatisticsRequirements().runTime + .average && + workerUsage.tasks.executed !== 0 ) { - workerTasksUsage.avgRunTime = - workerTasksUsage.runTime / workerTasksUsage.ran + workerUsage.runTime.average = + workerUsage.runTime.aggregate / workerUsage.tasks.executed } if ( - this.workerChoiceStrategyContext.getRequiredStatistics().medRunTime && - message.runTime != null + this.workerChoiceStrategyContext.getTaskStatisticsRequirements().runTime + .median && + message.taskPerformance?.runTime != null ) { - workerTasksUsage.runTimeHistory.push(message.runTime) - workerTasksUsage.medRunTime = median(workerTasksUsage.runTimeHistory) + workerUsage.runTime.history.push(message.taskPerformance.runTime) + workerUsage.runTime.median = median(workerUsage.runTime.history) } } } - private updateWaitTimeTasksUsage ( - workerTasksUsage: TasksUsage, - message: MessageValue + private updateWaitTimeWorkerUsage ( + workerUsage: WorkerUsage, + task: Task ): void { - if (this.workerChoiceStrategyContext.getRequiredStatistics().waitTime) { - workerTasksUsage.waitTime += message.waitTime ?? 0 + const timestamp = performance.now() + const taskWaitTime = timestamp - (task.timestamp ?? timestamp) + if ( + this.workerChoiceStrategyContext.getTaskStatisticsRequirements().waitTime + .aggregate + ) { + workerUsage.waitTime.aggregate += taskWaitTime ?? 0 if ( - this.workerChoiceStrategyContext.getRequiredStatistics().avgWaitTime && - workerTasksUsage.ran !== 0 + this.workerChoiceStrategyContext.getTaskStatisticsRequirements() + .waitTime.average && + workerUsage.tasks.executed !== 0 ) { - workerTasksUsage.avgWaitTime = - workerTasksUsage.waitTime / workerTasksUsage.ran + workerUsage.waitTime.average = + workerUsage.waitTime.aggregate / workerUsage.tasks.executed } if ( - this.workerChoiceStrategyContext.getRequiredStatistics().medWaitTime && - message.waitTime != null + this.workerChoiceStrategyContext.getTaskStatisticsRequirements() + .waitTime.median && + taskWaitTime != null ) { - workerTasksUsage.waitTimeHistory.push(message.waitTime) - workerTasksUsage.medWaitTime = median(workerTasksUsage.waitTimeHistory) + workerUsage.waitTime.history.push(taskWaitTime) + workerUsage.waitTime.median = median(workerUsage.waitTime.history) } } } - private updateEluTasksUsage ( - workerTasksUsage: TasksUsage, + private updateEluWorkerUsage ( + workerTasksUsage: WorkerUsage, message: MessageValue ): void { - if (this.workerChoiceStrategyContext.getRequiredStatistics().elu) { - if (workerTasksUsage.elu != null && message.elu != null) { - // TODO: cumulative or delta? + if (this.workerChoiceStrategyContext.getTaskStatisticsRequirements().elu) { + if ( + workerTasksUsage.elu != null && + message.taskPerformance?.elu != null + ) { workerTasksUsage.elu = { - idle: workerTasksUsage.elu.idle + message.elu.idle, - active: workerTasksUsage.elu.active + message.elu.active, + idle: workerTasksUsage.elu.idle + message.taskPerformance.elu.idle, + active: + workerTasksUsage.elu.active + message.taskPerformance.elu.active, utilization: - workerTasksUsage.elu.utilization + message.elu.utilization + (workerTasksUsage.elu.utilization + + message.taskPerformance.elu.utilization) / + 2 } - } else if (message.elu != null) { - workerTasksUsage.elu = message.elu + } else if (message.taskPerformance?.elu != null) { + workerTasksUsage.elu = message.taskPerformance.elu } } } @@ -560,7 +594,8 @@ export abstract class AbstractPool< if ( isKillBehavior(KillBehaviors.HARD, message.kill) || (message.kill != null && - this.workerNodes[currentWorkerNodeKey].tasksUsage.running === 0) + 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) @@ -625,11 +660,11 @@ export abstract class AbstractPool< this.emitter.emit(PoolEvents.error, error) } }) - if (this.opts.restartWorkerOnError === true) { - worker.on('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', () => { @@ -638,6 +673,8 @@ export abstract class AbstractPool< this.pushWorkerNode(worker) + this.setWorkerStatistics(worker) + this.afterWorkerSetup(worker) return worker @@ -654,13 +691,10 @@ export abstract class AbstractPool< // Task execution response received const promiseResponse = this.promiseResponseMap.get(message.id) if (promiseResponse != null) { - if (message.error != null) { - promiseResponse.reject(message.error) + if (message.taskError != null) { + promiseResponse.reject(message.taskError.message) if (this.emitter != null) { - this.emitter.emit(PoolEvents.taskError, { - error: message.error, - errorData: message.errorData - }) + this.emitter.emit(PoolEvents.taskError, message.taskError) } } else { promiseResponse.resolve(message.data as Response) @@ -697,13 +731,13 @@ export abstract class AbstractPool< * Sets the given worker node its tasks usage in the pool. * * @param workerNode - The worker node. - * @param tasksUsage - The worker node tasks usage. + * @param workerUsage - The worker usage. */ private setWorkerNodeTasksUsage ( workerNode: WorkerNode, - tasksUsage: TasksUsage + workerUsage: WorkerUsage ): void { - workerNode.tasksUsage = tasksUsage + workerNode.workerUsage = workerUsage } /** @@ -715,44 +749,31 @@ export abstract class AbstractPool< private pushWorkerNode (worker: Worker): number { return this.workerNodes.push({ worker, - tasksUsage: { - ran: 0, - running: 0, - runTime: 0, - runTimeHistory: new CircularArray(), - avgRunTime: 0, - medRunTime: 0, - waitTime: 0, - waitTimeHistory: new CircularArray(), - avgWaitTime: 0, - medWaitTime: 0, - error: 0, - elu: undefined - }, + workerUsage: this.getWorkerUsage(worker), tasksQueue: new Queue>() }) } - /** - * Sets the given worker in the pool worker nodes. - * - * @param workerNodeKey - The worker node key. - * @param worker - The worker. - * @param tasksUsage - The worker tasks usage. - * @param tasksQueue - The worker task queue. - */ - private setWorkerNode ( - workerNodeKey: number, - worker: Worker, - tasksUsage: TasksUsage, - tasksQueue: Queue> - ): void { - this.workerNodes[workerNodeKey] = { - worker, - tasksUsage, - tasksQueue - } - } + // /** + // * 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. @@ -768,7 +789,7 @@ export abstract class AbstractPool< } private executeTask (workerNodeKey: number, task: Task): void { - this.beforeTaskExecutionHook(workerNodeKey) + this.beforeTaskExecutionHook(workerNodeKey, task) this.sendToWorker(this.workerNodes[workerNodeKey].worker, task) } @@ -800,4 +821,48 @@ 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 + } + }) + } + + private getWorkerUsage (worker: Worker): WorkerUsage { + return { + tasks: this.getTaskStatistics(worker), + runTime: { + aggregate: 0, + average: 0, + median: 0, + history: new CircularArray() + }, + waitTime: { + aggregate: 0, + average: 0, + median: 0, + history: new CircularArray() + }, + elu: undefined + } + } + + private getTaskStatistics (worker: Worker): TaskStatistics { + const queueSize = + this.workerNodes[this.getWorkerNodeKey(worker)]?.tasksQueue?.size + return { + executed: 0, + executing: 0, + get queued (): number { + return queueSize ?? 0 + }, + failed: 0 + } + } }