X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=122e9fa5c9dbbad12f7eaf01b1db4f0b38ab35e4;hb=a9d9ea34ae4621d0babc235b10614c7c8c37d88b;hp=0921f45644446c18512f876a0a13b3379f8026fb;hpb=bf9549aef8a23a3931e19040dadb7f1e8e6422b5;p=poolifier.git diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index 0921f456..122e9fa5 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -3,52 +3,42 @@ import type { PromiseWorkerResponseWrapper } from '../utility-types' import { EMPTY_FUNCTION } from '../utils' -import { isKillBehavior, KillBehaviors } from '../worker/worker-options' -import type { AbstractPoolWorker } from './abstract-pool-worker' +import { KillBehaviors, isKillBehavior } from '../worker/worker-options' import type { PoolOptions } from './pool' +import { PoolEmitter } from './pool' import type { IPoolInternal, TasksUsage } from './pool-internal' -import { PoolEmitter, PoolType } from './pool-internal' +import { PoolType } from './pool-internal' +import type { IPoolWorker } from './pool-worker' import { WorkerChoiceStrategies, - WorkerChoiceStrategy + type 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. + * @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 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 { - /** @inheritDoc */ + /** {@inheritDoc} */ public readonly workers: Worker[] = [] - /** - * The workers tasks usage map. - * - * `key`: The `Worker` - * `value`: Worker tasks usage statistics. - */ - protected workersTasksUsage: Map = new Map< - Worker, - TasksUsage + /** {@inheritDoc} */ + public readonly workersTasksUsage: Map = new Map< + Worker, + TasksUsage >() - /** @inheritDoc */ + /** {@inheritDoc} */ public readonly emitter?: PoolEmitter - /** @inheritDoc */ - public readonly max?: number - /** * The promise map. * @@ -58,8 +48,8 @@ export abstract class AbstractPool< * When we receive a message from the worker we get a map entry and resolve/reject the promise based on the message. */ protected promiseMap: Map< - number, - PromiseWorkerResponseWrapper + number, + PromiseWorkerResponseWrapper > = new Map>() /** @@ -73,17 +63,17 @@ export abstract class AbstractPool< * Default to a strategy implementing 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. + * @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, @@ -102,7 +92,7 @@ export abstract class AbstractPool< this.createAndSetupWorker() } - if (this.opts.enableEvents) { + if (this.opts.enableEvents === true) { this.emitter = new PoolEmitter() } this.workerChoiceStrategyContext = new WorkerChoiceStrategyContext( @@ -115,7 +105,7 @@ export abstract class AbstractPool< this.getWorkerRunningTasks(workerCreated) === 0 ) { // Kill received from the worker, means that no new tasks are submitted to that worker for a while ( > maxInactiveTime) - this.destroyWorker(workerCreated) as void + void this.destroyWorker(workerCreated) } }) return workerCreated @@ -125,7 +115,7 @@ export abstract class AbstractPool< } private checkFilePath (filePath: string): void { - if (!filePath) { + if (filePath == null || filePath.length === 0) { throw new Error('Please specify a file with a worker implementation') } } @@ -136,11 +126,11 @@ export abstract class AbstractPool< 'Cannot instantiate a pool without specifying the number of workers' ) } else if (!Number.isSafeInteger(numberOfWorkers)) { - throw new Error( + throw new TypeError( 'Cannot instantiate a pool with a non integer number of workers' ) } else if (numberOfWorkers < 0) { - throw new Error( + throw new RangeError( 'Cannot instantiate a pool with a negative number of workers' ) } else if (this.type === PoolType.FIXED && numberOfWorkers === 0) { @@ -154,40 +144,43 @@ 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 */ + /** {@inheritDoc} */ public getWorkerRunningTasks (worker: Worker): number | undefined { return this.workersTasksUsage.get(worker)?.running } - /** @inheritDoc */ + /** {@inheritDoc} */ public getWorkerAverageTasksRunTime (worker: Worker): number | undefined { return this.workersTasksUsage.get(worker)?.avgRunTime } - /** @inheritDoc */ + /** {@inheritDoc} */ public setWorkerChoiceStrategy ( workerChoiceStrategy: WorkerChoiceStrategy ): void { this.opts.workerChoiceStrategy = workerChoiceStrategy + for (const worker of this.workers) { + this.resetWorkerTasksUsage(worker) + } this.workerChoiceStrategyContext.setWorkerChoiceStrategy( workerChoiceStrategy ) } - /** @inheritDoc */ + /** {@inheritDoc} */ public abstract get busy (): boolean protected internalGetBusyStatus (): boolean { @@ -197,7 +190,7 @@ export abstract class AbstractPool< ) } - /** @inheritDoc */ + /** {@inheritDoc} */ public findFreeWorker (): Worker | false { for (const worker of this.workers) { if (this.getWorkerRunningTasks(worker) === 0) { @@ -208,27 +201,35 @@ export abstract class AbstractPool< return false } - /** @inheritDoc */ - public execute (data: Data): Promise { + /** {@inheritDoc} */ + public async execute (data: Data): Promise { // Configure worker to handle message with the specified task const worker = this.chooseWorker() - const messageId = ++this.nextMessageId - const res = this.internalExecute(worker, messageId) + const res = this.internalExecute(worker, this.nextMessageId) this.checkAndEmitBusy() - data = data ?? ({} as Data) - this.sendToWorker(worker, { data, id: messageId }) + this.sendToWorker(worker, { + // eslint-disable-next-line @typescript-eslint/consistent-type-assertions + data: data ?? ({} as Data), + id: this.nextMessageId + }) + ++this.nextMessageId + // eslint-disable-next-line @typescript-eslint/return-await return res } - /** @inheritDoc */ + /** {@inheritDoc} */ public async destroy (): Promise { - await Promise.all(this.workers.map(worker => this.destroyWorker(worker))) + await Promise.all( + this.workers.map(async worker => { + await this.destroyWorker(worker) + }) + ) } /** - * Shut down given worker. + * Shutdowns given worker. * - * @param worker A worker within `workers`. + * @param worker - A worker within `workers`. */ protected abstract destroyWorker (worker: Worker): void | Promise @@ -249,7 +250,7 @@ export abstract class AbstractPool< * Hook executed before the worker task promise resolution. * Can be overridden. * - * @param worker The worker. + * @param worker - The worker. */ protected beforePromiseWorkerResponseHook (worker: Worker): void { this.increaseWorkerRunningTasks(worker) @@ -259,8 +260,8 @@ export abstract class AbstractPool< * Hook executed after the worker task promise resolution. * Can be overridden. * - * @param message The received message. - * @param promise The Promise response. + * @param message - The received message. + * @param promise - The Promise response. */ protected afterPromiseWorkerResponseHook ( message: MessageValue, @@ -274,16 +275,16 @@ export abstract class AbstractPool< /** * 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.resetWorkerTasksUsage(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. * @@ -294,10 +295,10 @@ 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. + * @param worker - The worker which should receive the message. + * @param message - The message. */ protected abstract sendToWorker ( worker: Worker, @@ -305,24 +306,14 @@ 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 - > (worker: Worker, listener: (message: MessageValue) => void): void - - protected internalExecute ( - worker: Worker, - messageId: number - ): Promise { - this.beforePromiseWorkerResponseHook(worker) - return new Promise((resolve, reject) => { - this.promiseMap.set(messageId, { resolve, reject, worker }) - }) - } + >(worker: Worker, listener: (message: MessageValue) => void): void /** * Returns a newly created worker. @@ -332,9 +323,9 @@ export abstract class AbstractPool< /** * Function that can be hooked up when a worker has been newly created and moved to the workers registry. * - * 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 @@ -350,17 +341,14 @@ export abstract class AbstractPool< worker.on('error', this.opts.errorHandler ?? EMPTY_FUNCTION) 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.removeWorker(worker) + }) this.workers.push(worker) // Init worker tasks usage map - this.workersTasksUsage.set(worker, { - run: 0, - running: 0, - runTime: 0, - avgRunTime: 0 - }) + this.initWorkerTasksUsage(worker) this.afterWorkerSetup(worker) @@ -377,97 +365,148 @@ export abstract class AbstractPool< if (message.id !== undefined) { const promise = this.promiseMap.get(message.id) if (promise !== undefined) { + if (message.error != null) { + promise.reject(message.error) + } else { + promise.resolve(message.data as Response) + } this.afterPromiseWorkerResponseHook(message, promise) - if (message.error) promise.reject(message.error) - else promise.resolve(message.data as Response) this.promiseMap.delete(message.id) } } } } + private async internalExecute ( + worker: Worker, + messageId: number + ): Promise { + this.beforePromiseWorkerResponseHook(worker) + return await new Promise((resolve, reject) => { + this.promiseMap.set(messageId, { resolve, reject, worker }) + }) + } + private checkAndEmitBusy (): void { - if (this.opts.enableEvents && this.busy) { + if (this.opts.enableEvents === true && this.busy) { this.emitter?.emit('busy') } } /** - * Increase the number of tasks that the given worker has applied. + * Increases the number of tasks that the given worker has applied. * - * @param worker Worker which running tasks is increased. + * @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. + * Decreases the number of tasks that the given worker has applied. * - * @param worker Worker which running tasks is decreased. + * @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. + * 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. + * @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) { + if (this.checkWorkerTasksUsage(worker)) { + const tasksUsage = this.workersTasksUsage.get(worker) as TasksUsage 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. + * 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. + * @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) { + private stepWorkerRunTasks (worker: Worker, step: number): void { + if (this.checkWorkerTasksUsage(worker)) { + const tasksUsage = this.workersTasksUsage.get(worker) as TasksUsage 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. + * Updates tasks runtime for the given worker. * - * @param worker Worker which run the task. - * @param taskRunTime Worker task run time. + * @param worker - Worker which run the task. + * @param taskRunTime - Worker task runtime. */ private updateWorkerTasksRunTime ( worker: Worker, taskRunTime: number | undefined - ) { - const tasksUsage = this.workersTasksUsage.get(worker) - if (tasksUsage !== undefined && tasksUsage.run !== 0) { + ): void { + if ( + this.workerChoiceStrategyContext.getWorkerChoiceStrategy() + .requiredStatistics.runTime && + this.checkWorkerTasksUsage(worker) + ) { + const tasksUsage = this.workersTasksUsage.get(worker) as TasksUsage tasksUsage.runTime += taskRunTime ?? 0 - tasksUsage.avgRunTime = tasksUsage.runTime / tasksUsage.run + 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) } } /** - * Reset worker tasks usage statistics. + * Checks if the given worker is registered in the workers tasks usage map. * - * @param worker The worker. + * @param worker - Worker to check. + * @returns `true` if the worker is registered in the workers tasks usage map. `false` otherwise. */ - private resetWorkerTasksUsage (worker: Worker): void { + private checkWorkerTasksUsage (worker: Worker): boolean { + const hasTasksUsage = this.workersTasksUsage.has(worker) + if (!hasTasksUsage) { + throw new Error('Worker could not be found in workers tasks usage map') + } + return hasTasksUsage + } + + /** + * Initializes tasks usage statistics. + * + * @param worker - The worker. + */ + private 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) + } }