X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=a092dffde443b35d3c09fb8212b159ede3851c58;hb=767e23e80a540dcedab8a2aa5203b8526e3df7b1;hp=7944606d9c84dbcc7dc32a9547c8a6e425b48e01;hpb=a35560bac09e829e1e19f88f8fd1d71a64c9d50b;p=poolifier.git diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index 7944606d..a092dffd 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -1,19 +1,17 @@ -import type { MessageValue } from '../utility-types' +import type { + MessageValue, + PromiseWorkerResponseWrapper +} from '../utility-types' +import { EMPTY_FUNCTION } from '../utils' +import { isKillBehavior, KillBehaviors } from '../worker/worker-options' import type { IPoolInternal } from './pool-internal' -import { PoolEmitter } from './pool-internal' +import { PoolEmitter, PoolType } from './pool-internal' import type { WorkerChoiceStrategy } from './selection-strategies' import { WorkerChoiceStrategies, WorkerChoiceStrategyContext } from './selection-strategies' -/** - * An intentional empty function. - */ -const EMPTY_FUNCTION: () => void = () => { - /* Intentionally empty */ -} - /** * Callback invoked if the worker raised an error. */ @@ -79,19 +77,16 @@ export interface PoolOptions { * A function that will listen for exit event on each worker. */ exitHandler?: ExitHandler - /** - * This is just to avoid non-useful warning messages. - * - * Will be used to set `maxListeners` on event emitters (workers are event emitters). - * - * @default 1000 - * @see [Node events emitter.setMaxListeners(n)](https://nodejs.org/api/events.html#events_emitter_setmaxlisteners_n) - */ - maxTasks?: number /** * The work choice strategy to use in this pool. */ workerChoiceStrategy?: WorkerChoiceStrategy + /** + * Pool events emission. + * + * Default to true. + */ + enableEvents?: boolean } /** @@ -105,7 +100,8 @@ export abstract class AbstractPool< Worker extends IWorker, Data = unknown, Response = unknown -> implements IPoolInternal { +> implements IPoolInternal +{ /** @inheritdoc */ public readonly workers: Worker[] = [] @@ -113,10 +109,26 @@ export abstract class AbstractPool< public readonly tasks: Map = new Map() /** @inheritdoc */ - public readonly emitter: PoolEmitter + public readonly emitter?: PoolEmitter + + /** @inheritdoc */ + public readonly max?: number + + /** + * The promise map. + * + * - `key`: This is the message Id of each submitted task. + * - `value`: An object that contains the worker, the resolve function and the reject function. + * + * 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 + > = new Map>() /** - * ID of the next message. + * Id of the next message. */ protected nextMessageId: number = 0 @@ -136,27 +148,45 @@ export abstract class AbstractPool< * * @param numberOfWorkers Number of workers that this pool should manage. * @param filePath Path to the worker-file. - * @param opts Options for the pool. Default: `{ maxTasks: 1000 }` + * @param opts Options for the pool. */ public constructor ( public readonly numberOfWorkers: number, public readonly filePath: string, - public readonly opts: PoolOptions = { maxTasks: 1000 } + public readonly opts: PoolOptions ) { if (!this.isMain()) { throw new Error('Cannot start a pool from a worker!') } + this.checkNumberOfWorkers(this.numberOfWorkers) this.checkFilePath(this.filePath) + this.checkPoolOptions(this.opts) this.setupHook() for (let i = 1; i <= this.numberOfWorkers; i++) { this.createAndSetupWorker() } - this.emitter = new PoolEmitter() + if (this.opts.enableEvents) { + this.emitter = new PoolEmitter() + } this.workerChoiceStrategyContext = new WorkerChoiceStrategyContext( this, - opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN + () => { + const workerCreated = this.createAndSetupWorker() + this.registerWorkerMessageListener(workerCreated, async message => { + const tasksInProgress = this.tasks.get(workerCreated) + if ( + isKillBehavior(KillBehaviors.HARD, message.kill) || + tasksInProgress === 0 + ) { + // Kill received from the worker, means that no new tasks are submitted to that worker for a while ( > maxInactiveTime) + await this.destroyWorker(workerCreated) + } + }) + return workerCreated + }, + this.opts.workerChoiceStrategy ) } @@ -166,27 +196,76 @@ export abstract class AbstractPool< } } + private checkNumberOfWorkers (numberOfWorkers: number): void { + if (numberOfWorkers == null) { + throw new Error( + 'Cannot instantiate a pool without specifying the number of workers' + ) + } else if (!Number.isSafeInteger(numberOfWorkers)) { + throw new Error( + 'Cannot instantiate a pool with a non integer number of workers' + ) + } else if (numberOfWorkers < 0) { + throw new Error( + 'Cannot instantiate a pool with a negative number of workers' + ) + } else if (this.type === PoolType.FIXED && numberOfWorkers === 0) { + throw new Error('Cannot instantiate a fixed pool with no worker') + } + } + + private checkPoolOptions (opts: PoolOptions): void { + this.opts.workerChoiceStrategy = + opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN + this.opts.enableEvents = opts.enableEvents ?? true + } + /** @inheritdoc */ - public isDynamic (): boolean { - return false + public abstract get type (): PoolType + + /** @inheritdoc */ + public get numberOfRunningTasks (): number { + return this.promiseMap.size } /** @inheritdoc */ public setWorkerChoiceStrategy ( workerChoiceStrategy: WorkerChoiceStrategy ): void { + this.opts.workerChoiceStrategy = workerChoiceStrategy this.workerChoiceStrategyContext.setWorkerChoiceStrategy( workerChoiceStrategy ) } + /** @inheritdoc */ + public abstract get busy (): boolean + + protected internalGetBusyStatus (): boolean { + return ( + this.numberOfRunningTasks >= this.numberOfWorkers && + this.findFreeTasksMapEntry() === false + ) + } + + /** @inheritdoc */ + public findFreeTasksMapEntry (): [Worker, number] | false { + for (const [worker, numberOfTasks] of this.tasks) { + if (numberOfTasks === 0) { + // A worker is free, return the matching tasks map entry + return [worker, numberOfTasks] + } + } + return false + } + /** @inheritdoc */ public execute (data: Data): Promise { // Configure worker to handle message with the specified task const worker = this.chooseWorker() - this.increaseWorkersTask(worker) const messageId = ++this.nextMessageId const res = this.internalExecute(worker, messageId) + this.checkAndEmitBusy() this.sendToWorker(worker, { data: data || ({} as Data), id: messageId }) return res } @@ -196,8 +275,12 @@ export abstract class AbstractPool< await Promise.all(this.workers.map(worker => this.destroyWorker(worker))) } - /** @inheritdoc */ - public abstract destroyWorker (worker: Worker): void | Promise + /** + * Shut down given worker. + * + * @param worker A worker within `workers`. + */ + protected abstract destroyWorker (worker: Worker): void | Promise /** * Setup hook that can be overridden by a Poolifier pool implementation @@ -213,7 +296,7 @@ export abstract class AbstractPool< protected abstract isMain (): boolean /** - * Increase the number of tasks that the given workers has done. + * Increase the number of tasks that the given workers has applied. * * @param worker Worker whose tasks are increased. */ @@ -222,7 +305,7 @@ export abstract class AbstractPool< } /** - * Decrease the number of tasks that the given workers has done. + * Decrease the number of tasks that the given workers has applied. * * @param worker Worker whose tasks are decreased. */ @@ -231,7 +314,7 @@ export abstract class AbstractPool< } /** - * Step the number of tasks that the given workers has done. + * Step the number of tasks that the given workers has applied. * * @param worker Worker whose tasks are set. * @param step Worker number of tasks step. @@ -279,12 +362,13 @@ export abstract class AbstractPool< message: MessageValue ): void - /** @inheritdoc */ - public abstract registerWorkerMessageListener< - Message extends Data | Response - > (worker: Worker, listener: (message: MessageValue) => void): void - - protected abstract unregisterWorkerMessageListener< + /** + * Register a listener callback on a given worker. + * + * @param worker A worker. + * @param listener A message listener callback. + */ + protected abstract registerWorkerMessageListener< Message extends Data | Response > (worker: Worker, listener: (message: MessageValue) => void): void @@ -292,16 +376,9 @@ export abstract class AbstractPool< worker: Worker, messageId: number ): Promise { - return new Promise((resolve, reject) => { - const listener: (message: MessageValue) => void = message => { - if (message.id === messageId) { - this.unregisterWorkerMessageListener(worker, listener) - this.decreaseWorkersTasks(worker) - if (message.error) reject(message.error) - else resolve(message.data as Response) - } - } - this.registerWorkerMessageListener(worker, listener) + this.increaseWorkersTask(worker) + return new Promise((resolve, reject) => { + this.promiseMap.set(messageId, { resolve, reject, worker }) }) } @@ -319,8 +396,12 @@ export abstract class AbstractPool< */ protected abstract afterWorkerSetup (worker: Worker): void - /** @inheritdoc */ - public createAndSetupWorker (): Worker { + /** + * Creates a new worker for this pool and sets it up completely. + * + * @returns New, completely set up worker. + */ + protected createAndSetupWorker (): Worker { const worker: Worker = this.createWorker() worker.on('error', this.opts.errorHandler ?? EMPTY_FUNCTION) @@ -337,4 +418,29 @@ export abstract class AbstractPool< return worker } + + /** + * This function is the listener registered for each worker. + * + * @returns The listener function to execute when a message is sent from a worker. + */ + protected workerListener (): (message: MessageValue) => void { + return message => { + if (message.id) { + const value = this.promiseMap.get(message.id) + if (value) { + this.decreaseWorkersTasks(value.worker) + if (message.error) value.reject(message.error) + else value.resolve(message.data as Response) + this.promiseMap.delete(message.id) + } + } + } + } + + private checkAndEmitBusy (): void { + if (this.opts.enableEvents && this.busy) { + this.emitter?.emit('busy') + } + } }