-import type { MessageValue } from '../utility-types'
+import type {
+ MessageValue,
+ PromiseWorkerResponseWrapper
+} from '../utility-types'
+import { isKillBehavior, KillBehaviors } from '../worker/worker-options'
import type { IPoolInternal } from './pool-internal'
import { PoolEmitter } from './pool-internal'
import type { WorkerChoiceStrategy } from './selection-strategies'
* A function that will listen for exit event on each worker.
*/
exitHandler?: ExitHandler<Worker>
- /**
- * 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.
*/
/** @inheritdoc */
public readonly emitter: PoolEmitter
+ /**
+ * 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<Worker, Response>
+ > = new Map<number, PromiseWorkerResponseWrapper<Worker, Response>>()
+
/**
* ID of the next message.
*/
*
* @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<Worker> = { maxTasks: 1000 }
+ public readonly opts: PoolOptions<Worker>
) {
if (!this.isMain()) {
throw new Error('Cannot start a pool from a worker!')
}
+ this.checkNumberOfWorkers(this.numberOfWorkers)
this.checkFilePath(this.filePath)
this.setupHook()
this.emitter = new PoolEmitter()
this.workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
this,
+ () => {
+ const workerCreated = this.createAndSetupWorker()
+ this.registerWorkerMessageListener(workerCreated, 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)
+ void this.destroyWorker(workerCreated)
+ }
+ })
+ return workerCreated
+ },
opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN
)
}
}
}
+ 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.dynamic && numberOfWorkers === 0) {
+ throw new Error('Cannot instantiate a fixed pool with no worker')
+ }
+ }
+
/** @inheritdoc */
- public isDynamic (): boolean {
+ public get dynamic (): boolean {
return false
}
public setWorkerChoiceStrategy (
workerChoiceStrategy: WorkerChoiceStrategy
): void {
+ this.opts.workerChoiceStrategy = workerChoiceStrategy
this.workerChoiceStrategyContext.setWorkerChoiceStrategy(
workerChoiceStrategy
)
await Promise.all(this.workers.map(worker => this.destroyWorker(worker)))
}
- /** @inheritdoc */
- public abstract destroyWorker (worker: Worker): void | Promise<void>
+ /**
+ * Shut down given worker.
+ *
+ * @param worker A worker within `workers`.
+ */
+ protected abstract destroyWorker (worker: Worker): void | Promise<void>
/**
* Setup hook that can be overridden by a Poolifier pool implementation
message: MessageValue<Data>
): void
- /** @inheritdoc */
- public abstract registerWorkerMessageListener<
- Message extends Data | Response
- > (worker: Worker, listener: (message: MessageValue<Message>) => 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<Message>) => void): void
worker: Worker,
messageId: number
): Promise<Response> {
- return new Promise((resolve, reject) => {
- const listener: (message: MessageValue<Response>) => 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)
+ return new Promise<Response>((resolve, reject) => {
+ this.promiseMap.set(messageId, { resolve, reject, worker })
})
}
*/
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)
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<Response>) => 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)
+ }
+ }
+ }
+ }
}
repositories / poolifier.git / blobdiff