X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=0921f45644446c18512f876a0a13b3379f8026fb;hb=bf9549aef8a23a3931e19040dadb7f1e8e6422b5;hp=928b24c65832a38ef625b7b07d498ce9f3ad504b;hpb=bdaf31cd0e637aa466c78d54a49f157899a2cb3f;p=poolifier.git diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index 928b24c6..0921f456 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -6,7 +6,7 @@ import { EMPTY_FUNCTION } from '../utils' import { isKillBehavior, KillBehaviors } from '../worker/worker-options' import type { AbstractPoolWorker } from './abstract-pool-worker' import type { PoolOptions } from './pool' -import type { IPoolInternal } from './pool-internal' +import type { IPoolInternal, TasksUsage } from './pool-internal' import { PoolEmitter, PoolType } from './pool-internal' import { WorkerChoiceStrategies, @@ -14,6 +14,9 @@ import { } from './selection-strategies/selection-strategies-types' import { WorkerChoiceStrategyContext } from './selection-strategies/worker-choice-strategy-context' +const WORKER_NOT_FOUND_TASKS_USAGE_MAP = + 'Worker could not be found in worker tasks usage map' + /** * Base class containing some shared logic for all poolifier pools. * @@ -26,16 +29,24 @@ export abstract class AbstractPool< Data = unknown, Response = unknown > implements IPoolInternal { - /** @inheritdoc */ + /** @inheritDoc */ public readonly workers: Worker[] = [] - /** @inheritdoc */ - public readonly tasks: Map = new Map() + /** + * The workers tasks usage map. + * + * `key`: The `Worker` + * `value`: Worker tasks usage statistics. + */ + protected workersTasksUsage: Map = new Map< + Worker, + TasksUsage + >() - /** @inheritdoc */ + /** @inheritDoc */ public readonly emitter?: PoolEmitter - /** @inheritdoc */ + /** @inheritDoc */ public readonly max?: number /** @@ -143,25 +154,30 @@ export abstract class AbstractPool< this.opts.enableEvents = opts.enableEvents ?? true } - /** @inheritdoc */ + /** @inheritDoc */ public abstract get type (): PoolType - /** @inheritdoc */ + /** @inheritDoc */ public get numberOfRunningTasks (): number { return this.promiseMap.size } - /** @inheritdoc */ + /** @inheritDoc */ + public getWorkerIndex (worker: Worker): number { + return this.workers.indexOf(worker) + } + + /** @inheritDoc */ public getWorkerRunningTasks (worker: Worker): number | undefined { - return this.tasks.get(worker) + return this.workersTasksUsage.get(worker)?.running } - /** @inheritdoc */ - public getWorkerIndex (worker: Worker): number { - return this.workers.indexOf(worker) + /** @inheritDoc */ + public getWorkerAverageTasksRunTime (worker: Worker): number | undefined { + return this.workersTasksUsage.get(worker)?.avgRunTime } - /** @inheritdoc */ + /** @inheritDoc */ public setWorkerChoiceStrategy ( workerChoiceStrategy: WorkerChoiceStrategy ): void { @@ -171,7 +187,7 @@ export abstract class AbstractPool< ) } - /** @inheritdoc */ + /** @inheritDoc */ public abstract get busy (): boolean protected internalGetBusyStatus (): boolean { @@ -181,7 +197,7 @@ export abstract class AbstractPool< ) } - /** @inheritdoc */ + /** @inheritDoc */ public findFreeWorker (): Worker | false { for (const worker of this.workers) { if (this.getWorkerRunningTasks(worker) === 0) { @@ -192,7 +208,7 @@ export abstract class AbstractPool< return false } - /** @inheritdoc */ + /** @inheritDoc */ public execute (data: Data): Promise { // Configure worker to handle message with the specified task const worker = this.chooseWorker() @@ -204,7 +220,7 @@ export abstract class AbstractPool< return res } - /** @inheritdoc */ + /** @inheritDoc */ public async destroy (): Promise { await Promise.all(this.workers.map(worker => this.destroyWorker(worker))) } @@ -230,36 +246,29 @@ export abstract class AbstractPool< protected abstract isMain (): boolean /** - * Increase the number of tasks that the given worker has applied. - * - * @param worker Worker whose tasks are increased. - */ - protected increaseWorkersTask (worker: Worker): void { - this.stepWorkerNumberOfTasks(worker, 1) - } - - /** - * Decrease the number of tasks that the given worker has applied. + * Hook executed before the worker task promise resolution. + * Can be overridden. * - * @param worker Worker whose tasks are decreased. + * @param worker The worker. */ - protected decreaseWorkersTasks (worker: Worker): void { - this.stepWorkerNumberOfTasks(worker, -1) + protected beforePromiseWorkerResponseHook (worker: Worker): void { + this.increaseWorkerRunningTasks(worker) } /** - * Step the number of tasks that the given worker has applied. + * Hook executed after the worker task promise resolution. + * Can be overridden. * - * @param worker Worker whose tasks are set. - * @param step Worker number of tasks step. + * @param message The received message. + * @param promise The Promise response. */ - 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 afterPromiseWorkerResponseHook ( + message: MessageValue, + promise: PromiseWorkerResponseWrapper + ): void { + this.decreaseWorkerRunningTasks(promise.worker) + this.stepWorkerRunTasks(promise.worker, 1) + this.updateWorkerTasksRunTime(promise.worker, message.taskRunTime) } /** @@ -270,7 +279,7 @@ export abstract class AbstractPool< protected removeWorker (worker: Worker): void { // Clean worker from data structure this.workers.splice(this.getWorkerIndex(worker), 1) - this.tasks.delete(worker) + this.resetWorkerTasksUsage(worker) } /** @@ -309,7 +318,7 @@ export abstract class AbstractPool< worker: Worker, messageId: number ): Promise { - this.increaseWorkersTask(worker) + this.beforePromiseWorkerResponseHook(worker) return new Promise((resolve, reject) => { this.promiseMap.set(messageId, { resolve, reject, worker }) }) @@ -345,8 +354,13 @@ export abstract class AbstractPool< this.workers.push(worker) - // Init tasks map - this.tasks.set(worker, 0) + // Init worker tasks usage map + this.workersTasksUsage.set(worker, { + run: 0, + running: 0, + runTime: 0, + avgRunTime: 0 + }) this.afterWorkerSetup(worker) @@ -363,7 +377,7 @@ export abstract class AbstractPool< if (message.id !== undefined) { const promise = this.promiseMap.get(message.id) if (promise !== undefined) { - this.decreaseWorkersTasks(promise.worker) + this.afterPromiseWorkerResponseHook(message, promise) if (message.error) promise.reject(message.error) else promise.resolve(message.data as Response) this.promiseMap.delete(message.id) @@ -377,4 +391,83 @@ export abstract class AbstractPool< this.emitter?.emit('busy') } } + + /** + * Increase the number of tasks that the given worker has applied. + * + * @param worker Worker which running tasks is increased. + */ + private increaseWorkerRunningTasks (worker: Worker): void { + this.stepWorkerRunningTasks(worker, 1) + } + + /** + * Decrease the number of tasks that the given worker has applied. + * + * @param worker Worker which running tasks is decreased. + */ + private decreaseWorkerRunningTasks (worker: Worker): void { + this.stepWorkerRunningTasks(worker, -1) + } + + /** + * Step the number of tasks that the given worker has applied. + * + * @param worker Worker which running tasks are stepped. + * @param step Number of running tasks step. + */ + private stepWorkerRunningTasks (worker: Worker, step: number): void { + const tasksUsage = this.workersTasksUsage.get(worker) + if (tasksUsage !== undefined) { + tasksUsage.running = tasksUsage.running + step + this.workersTasksUsage.set(worker, tasksUsage) + } else { + throw new Error(WORKER_NOT_FOUND_TASKS_USAGE_MAP) + } + } + + /** + * Step the number of tasks that the given worker has run. + * + * @param worker Worker which has run tasks. + * @param step Number of run tasks step. + */ + private stepWorkerRunTasks (worker: Worker, step: number) { + const tasksUsage = this.workersTasksUsage.get(worker) + if (tasksUsage !== undefined) { + tasksUsage.run = tasksUsage.run + step + this.workersTasksUsage.set(worker, tasksUsage) + } else { + throw new Error(WORKER_NOT_FOUND_TASKS_USAGE_MAP) + } + } + + /** + * Update tasks run time for the given worker. + * + * @param worker Worker which run the task. + * @param taskRunTime Worker task run time. + */ + private updateWorkerTasksRunTime ( + worker: Worker, + taskRunTime: number | undefined + ) { + const tasksUsage = this.workersTasksUsage.get(worker) + if (tasksUsage !== undefined && tasksUsage.run !== 0) { + tasksUsage.runTime += taskRunTime ?? 0 + tasksUsage.avgRunTime = tasksUsage.runTime / tasksUsage.run + this.workersTasksUsage.set(worker, tasksUsage) + } else { + throw new Error(WORKER_NOT_FOUND_TASKS_USAGE_MAP) + } + } + + /** + * Reset worker tasks usage statistics. + * + * @param worker The worker. + */ + private resetWorkerTasksUsage (worker: Worker): void { + this.workersTasksUsage.delete(worker) + } }