X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=f3a8c1c6c9a7bb0a730b6b3b10dcd9a766b64e5e;hb=4f4ae1cb3c33228a023ea599c2648268d15e6c0f;hp=f1ac76ed587b8059c87430edcf1bddea18264577;hpb=8d3782faec08afef3370aaaadd06de2c1cb270fd;p=poolifier.git diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index f1ac76ed..f3a8c1c6 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -2,8 +2,10 @@ 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, @@ -11,11 +13,9 @@ import { } from './selection-strategies' /** - * An intentional empty function. + * Callback invoked if the worker has received a message. */ -const EMPTY_FUNCTION: () => void = () => { - /* Intentionally empty */ -} +export type MessageHandler = (this: Worker, m: unknown) => void /** * Callback invoked if the worker raised an error. @@ -36,6 +36,13 @@ export type ExitHandler = (this: Worker, code: number) => void * Basic interface that describes the minimum required implementation of listener events for a pool-worker. */ export interface IWorker { + /** + * Register a listener to the message event. + * + * @param event `'message'`. + * @param handler The message handler. + */ + on(event: 'message', handler: MessageHandler): void /** * Register a listener to the error event. * @@ -70,6 +77,10 @@ export interface IWorker { * Options for a poolifier pool. */ export interface PoolOptions { + /** + * A function that will listen for message event on each worker. + */ + messageHandler?: MessageHandler /** * A function that will listen for error event on each worker. */ @@ -82,19 +93,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 true + */ + enableEvents?: boolean } /** @@ -109,10 +117,22 @@ export abstract class AbstractPool< Data = unknown, Response = unknown > implements IPoolInternal { + /** @inheritdoc */ + public readonly workers: Worker[] = [] + + /** @inheritdoc */ + public readonly tasks: Map = new Map() + + /** @inheritdoc */ + public readonly emitter?: PoolEmitter + + /** @inheritdoc */ + public readonly max?: number + /** * The promise map. * - * - `key`: This is the message ID of each submitted task. + * - `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. @@ -122,17 +142,8 @@ export abstract class AbstractPool< PromiseWorkerResponseWrapper > = new Map>() - /** @inheritdoc */ - public readonly workers: Worker[] = [] - - /** @inheritdoc */ - public readonly tasks: Map = new Map() - - /** @inheritdoc */ - public readonly emitter: PoolEmitter - /** - * ID of the next message. + * Id of the next message. */ protected nextMessageId: number = 0 @@ -152,28 +163,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 ) } @@ -196,32 +224,63 @@ export abstract class AbstractPool< throw new Error( 'Cannot instantiate a pool with a negative number of workers' ) - } else if (!this.isDynamic() && numberOfWorkers === 0) { + } 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 } @@ -231,8 +290,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 @@ -248,7 +311,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 worker has applied. * * @param worker Worker whose tasks are increased. */ @@ -257,7 +320,7 @@ export abstract class AbstractPool< } /** - * Decrease the number of tasks that the given workers has done. + * Decrease the number of tasks that the given worker has applied. * * @param worker Worker whose tasks are decreased. */ @@ -266,7 +329,7 @@ export abstract class AbstractPool< } /** - * Step the number of tasks that the given workers has done. + * 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. @@ -314,8 +377,13 @@ export abstract class AbstractPool< message: MessageValue ): void - /** @inheritdoc */ - public abstract registerWorkerMessageListener< + /** + * 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 @@ -323,6 +391,7 @@ export abstract class AbstractPool< worker: Worker, messageId: number ): Promise { + this.increaseWorkersTask(worker) return new Promise((resolve, reject) => { this.promiseMap.set(messageId, { resolve, reject, worker }) }) @@ -342,10 +411,15 @@ 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('message', this.opts.messageHandler ?? EMPTY_FUNCTION) worker.on('error', this.opts.errorHandler ?? EMPTY_FUNCTION) worker.on('online', this.opts.onlineHandler ?? EMPTY_FUNCTION) worker.on('exit', this.opts.exitHandler ?? EMPTY_FUNCTION) @@ -367,7 +441,7 @@ export abstract class AbstractPool< * @returns The listener function to execute when a message is sent from a worker. */ protected workerListener (): (message: MessageValue) => void { - const listener: (message: MessageValue) => void = message => { + return message => { if (message.id) { const value = this.promiseMap.get(message.id) if (value) { @@ -378,6 +452,11 @@ export abstract class AbstractPool< } } } - return listener + } + + private checkAndEmitBusy (): void { + if (this.opts.enableEvents && this.busy) { + this.emitter?.emit('busy') + } } }