X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=76f5bfdc24d47820f9cb2aaaac8ca387a4670a55;hb=4e94da3a0cd5bfe961c73babead4262134f8770f;hp=346eb6d1fdb02cdf992f84b91502ae21f465800e;hpb=6bd72cd09232827a710b41952254cab597664247;p=poolifier.git diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index 346eb6d1..76f5bfdc 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -2,48 +2,43 @@ import type { MessageValue, PromiseWorkerResponseWrapper } from '../utility-types' -import { EMPTY_FUNCTION } from '../utils' +import { EMPTY_FUNCTION, EMPTY_LITERAL } from '../utils' import { isKillBehavior, KillBehaviors } 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 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 IPoolWorker, Data = unknown, Response = unknown > implements IPoolInternal { - /** @inheritDoc */ + /** {@inheritDoc} */ public readonly workers: Worker[] = [] - /** @inheritDoc */ + /** {@inheritDoc} */ public readonly workersTasksUsage: Map = new Map< - Worker, - TasksUsage + Worker, + TasksUsage >() - /** @inheritDoc */ + /** {@inheritDoc} */ public readonly emitter?: PoolEmitter - /** @inheritDoc */ - public readonly max?: number - /** * The promise map. * @@ -53,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>() /** @@ -68,24 +63,24 @@ 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, public readonly filePath: string, public readonly opts: PoolOptions ) { - if (this.isMain() === false) { + if (!this.isMain()) { throw new Error('Cannot start a pool from a worker!') } this.checkNumberOfWorkers(this.numberOfWorkers) @@ -110,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) as Promise) } }) return workerCreated @@ -120,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') } } @@ -130,12 +125,12 @@ export abstract class AbstractPool< throw new Error( 'Cannot instantiate a pool without specifying the number of workers' ) - } else if (Number.isSafeInteger(numberOfWorkers) === false) { - throw new Error( + } else if (!Number.isSafeInteger(numberOfWorkers)) { + 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) { @@ -149,30 +144,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 */ + /** {@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 { @@ -185,7 +180,7 @@ export abstract class AbstractPool< ) } - /** @inheritDoc */ + /** {@inheritDoc} */ public abstract get busy (): boolean protected internalGetBusyStatus (): boolean { @@ -195,7 +190,7 @@ export abstract class AbstractPool< ) } - /** @inheritDoc */ + /** {@inheritDoc} */ public findFreeWorker (): Worker | false { for (const worker of this.workers) { if (this.getWorkerRunningTasks(worker) === 0) { @@ -206,19 +201,22 @@ 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, { + data: data ?? (EMPTY_LITERAL 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))) } @@ -226,7 +224,7 @@ export abstract class AbstractPool< /** * Shutdowns given worker. * - * @param worker A worker within `workers`. + * @param worker - A worker within `workers`. */ protected abstract destroyWorker (worker: Worker): void | Promise @@ -247,7 +245,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) @@ -257,8 +255,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, @@ -272,7 +270,7 @@ export abstract class AbstractPool< /** * Removes the given worker from the pool. * - * @param worker The worker that will be removed. + * @param worker - The worker that will be removed. */ protected removeWorker (worker: Worker): void { // Clean worker from data structure @@ -294,8 +292,8 @@ export abstract class AbstractPool< /** * 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,22 +303,12 @@ export abstract class AbstractPool< /** * Registers a listener callback on a given worker. * - * @param worker The worker which should register a listener. - * @param listener The 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. @@ -330,9 +318,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 @@ -348,7 +336,9 @@ 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) @@ -370,17 +360,30 @@ 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 === true && this.busy === true) { + if (this.opts.enableEvents === true && this.busy) { this.emitter?.emit('busy') } } @@ -388,7 +391,7 @@ export abstract class AbstractPool< /** * 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) @@ -397,7 +400,7 @@ export abstract class AbstractPool< /** * 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) @@ -406,40 +409,36 @@ export abstract class AbstractPool< /** * 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) } } /** * 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): void { - const tasksUsage = this.workersTasksUsage.get(worker) - if (tasksUsage !== undefined) { + 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) } } /** * Updates tasks runtime for the given worker. * - * @param worker Worker which run the task. - * @param taskRunTime Worker task runtime. + * @param worker - Worker which run the task. + * @param taskRunTime - Worker task runtime. */ private updateWorkerTasksRunTime ( worker: Worker, @@ -447,27 +446,38 @@ export abstract class AbstractPool< ): void { if ( this.workerChoiceStrategyContext.getWorkerChoiceStrategy() - .requiredStatistics.runTime === true + .requiredStatistics.runTime && + this.checkWorkerTasksUsage(worker) ) { - 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) + const tasksUsage = this.workersTasksUsage.get(worker) as TasksUsage + tasksUsage.runTime += taskRunTime ?? 0 + if (tasksUsage.run !== 0) { + tasksUsage.avgRunTime = tasksUsage.runTime / tasksUsage.run } + this.workersTasksUsage.set(worker, tasksUsage) + } + } + + /** + * Checks if the given worker is registered in the workers tasks usage map. + * + * @param worker - Worker to check. + * @returns `true` if the worker is registered in the workers tasks usage map. `false` otherwise. + */ + 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. + * @param worker - The worker. */ - initWorkerTasksUsage (worker: Worker): void { + private initWorkerTasksUsage (worker: Worker): void { this.workersTasksUsage.set(worker, { run: 0, running: 0, @@ -479,7 +489,7 @@ export abstract class AbstractPool< /** * Removes worker tasks usage statistics. * - * @param worker The worker. + * @param worker - The worker. */ private removeWorkerTasksUsage (worker: Worker): void { this.workersTasksUsage.delete(worker) @@ -488,7 +498,7 @@ export abstract class AbstractPool< /** * Resets worker tasks usage statistics. * - * @param worker The worker. + * @param worker - The worker. */ private resetWorkerTasksUsage (worker: Worker): void { this.removeWorkerTasksUsage(worker)