X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=346eb6d1fdb02cdf992f84b91502ae21f465800e;hb=97c16550808cdcc2350561d6b369efdea3f5263d;hp=10fe128170b5363b0b04d58b82e451369a0f9d3d;hpb=a76fac14098cf2138cf8d6997ac7c89d8c3ae508;p=poolifier.git diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index 10fe1281..346eb6d1 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -4,25 +4,28 @@ import type { } from '../utility-types' 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 type { IPoolWorker } from './pool-worker' import { WorkerChoiceStrategies, WorkerChoiceStrategy } 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. + * 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. */ export abstract class AbstractPool< - Worker extends AbstractPoolWorker, + Worker extends IPoolWorker, Data = unknown, Response = unknown > implements IPoolInternal { @@ -30,7 +33,10 @@ export abstract class AbstractPool< public readonly workers: Worker[] = [] /** @inheritDoc */ - public readonly tasks: Map = new Map() + public readonly workersTasksUsage: Map = new Map< + Worker, + TasksUsage + >() /** @inheritDoc */ public readonly emitter?: PoolEmitter @@ -79,7 +85,7 @@ export abstract class AbstractPool< public readonly filePath: string, public readonly opts: PoolOptions ) { - if (!this.isMain()) { + if (this.isMain() === false) { throw new Error('Cannot start a pool from a worker!') } this.checkNumberOfWorkers(this.numberOfWorkers) @@ -91,7 +97,7 @@ export abstract class AbstractPool< this.createAndSetupWorker() } - if (this.opts.enableEvents) { + if (this.opts.enableEvents === true) { this.emitter = new PoolEmitter() } this.workerChoiceStrategyContext = new WorkerChoiceStrategyContext( @@ -124,7 +130,7 @@ export abstract class AbstractPool< throw new Error( 'Cannot instantiate a pool without specifying the number of workers' ) - } else if (!Number.isSafeInteger(numberOfWorkers)) { + } else if (Number.isSafeInteger(numberOfWorkers) === false) { throw new Error( 'Cannot instantiate a pool with a non integer number of workers' ) @@ -151,14 +157,19 @@ export abstract class AbstractPool< return this.promiseMap.size } + /** @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) + public getWorkerAverageTasksRunTime (worker: Worker): number | undefined { + return this.workersTasksUsage.get(worker)?.avgRunTime } /** @inheritDoc */ @@ -166,6 +177,9 @@ export abstract class AbstractPool< workerChoiceStrategy: WorkerChoiceStrategy ): void { this.opts.workerChoiceStrategy = workerChoiceStrategy + for (const worker of this.workers) { + this.resetWorkerTasksUsage(worker) + } this.workerChoiceStrategyContext.setWorkerChoiceStrategy( workerChoiceStrategy ) @@ -210,7 +224,7 @@ export abstract class AbstractPool< } /** - * Shut down given worker. + * Shutdowns given worker. * * @param worker A worker within `workers`. */ @@ -230,51 +244,44 @@ export abstract class AbstractPool< protected abstract isMain (): boolean /** - * Increase 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 increased. + * @param worker The worker. */ - protected increaseWorkersTask (worker: Worker): void { - this.stepWorkerNumberOfTasks(worker, 1) + protected beforePromiseWorkerResponseHook (worker: Worker): void { + this.increaseWorkerRunningTasks(worker) } /** - * Decrease 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 decreased. + * @param message The received message. + * @param promise The Promise response. */ - protected decreaseWorkersTasks (worker: Worker): void { - this.stepWorkerNumberOfTasks(worker, -1) - } - - /** - * Step the number of tasks that the given worker has applied. - * - * @param worker Worker whose tasks are set. - * @param step Worker number of tasks step. - */ - 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) } /** * Removes the given worker from the pool. * - * @param worker Worker that will be removed. + * @param worker The worker that will be removed. */ protected removeWorker (worker: Worker): void { // Clean worker from data structure this.workers.splice(this.getWorkerIndex(worker), 1) - this.tasks.delete(worker) + this.removeWorkerTasksUsage(worker) } /** - * Choose a worker for the next task. + * Chooses a worker for the next task. * * The default implementation uses a round robin algorithm to distribute the load. * @@ -285,7 +292,7 @@ export abstract class AbstractPool< } /** - * 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. @@ -296,10 +303,10 @@ export abstract class AbstractPool< ): void /** - * Register a listener callback on a given worker. + * Registers a listener callback on a given worker. * - * @param worker A worker. - * @param listener A message listener callback. + * @param worker The worker which should register a listener. + * @param listener The message listener callback. */ protected abstract registerWorkerMessageListener< Message extends Data | Response @@ -309,7 +316,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 +352,8 @@ export abstract class AbstractPool< this.workers.push(worker) - // Init tasks map - this.tasks.set(worker, 0) + // Init worker tasks usage map + this.initWorkerTasksUsage(worker) this.afterWorkerSetup(worker) @@ -363,7 +370,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) @@ -373,8 +380,118 @@ export abstract class AbstractPool< } private checkAndEmitBusy (): void { - if (this.opts.enableEvents && this.busy) { + if (this.opts.enableEvents === true && this.busy === true) { this.emitter?.emit('busy') } } + + /** + * Increases 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) + } + + /** + * Decreases 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) + } + + /** + * Steps 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) + } + } + + /** + * Steps 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): void { + 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) + } + } + + /** + * Updates tasks runtime for the given worker. + * + * @param worker Worker which run the task. + * @param taskRunTime Worker task runtime. + */ + private updateWorkerTasksRunTime ( + worker: Worker, + taskRunTime: number | undefined + ): void { + if ( + this.workerChoiceStrategyContext.getWorkerChoiceStrategy() + .requiredStatistics.runTime === true + ) { + const tasksUsage = this.workersTasksUsage.get(worker) + if (tasksUsage !== undefined) { + tasksUsage.runTime += taskRunTime ?? 0 + if (tasksUsage.run !== 0) { + tasksUsage.avgRunTime = tasksUsage.runTime / tasksUsage.run + } + this.workersTasksUsage.set(worker, tasksUsage) + } else { + throw new Error(WORKER_NOT_FOUND_TASKS_USAGE_MAP) + } + } + } + + /** + * Initializes tasks usage statistics. + * + * @param worker The worker. + */ + initWorkerTasksUsage (worker: Worker): void { + this.workersTasksUsage.set(worker, { + run: 0, + running: 0, + runTime: 0, + avgRunTime: 0 + }) + } + + /** + * Removes worker tasks usage statistics. + * + * @param worker The worker. + */ + private removeWorkerTasksUsage (worker: Worker): void { + this.workersTasksUsage.delete(worker) + } + + /** + * Resets worker tasks usage statistics. + * + * @param worker The worker. + */ + private resetWorkerTasksUsage (worker: Worker): void { + this.removeWorkerTasksUsage(worker) + this.initWorkerTasksUsage(worker) + } }