-import type {
- MessageValue,
- PromiseWorkerResponseWrapper
-} from '../utility-types'
+import crypto from 'node:crypto'
+import type { MessageValue, PromiseResponseWrapper } from '../utility-types'
import { EMPTY_FUNCTION } from '../utils'
import { KillBehaviors, isKillBehavior } from '../worker/worker-options'
import type { PoolOptions } from './pool'
Data = unknown,
Response = unknown
> implements IPoolInternal<Worker, Data, Response> {
- /** {@inheritDoc} */
- public readonly workers: Map<number, WorkerType<Worker>> = new Map<
- number,
- WorkerType<Worker>
- >()
+ /** @inheritDoc */
+ public readonly workers: Array<WorkerType<Worker>> = []
- /** {@inheritDoc} */
+ /** @inheritDoc */
public readonly emitter?: PoolEmitter
/**
- * Id of the next worker.
- */
- protected nextWorkerId: number = 0
-
- /**
- * The promise map.
+ * The promise response 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.
+ * - `key`: The message id of each submitted task.
+ * - `value`: An object that contains the worker, the promise resolve and reject callbacks.
*
- * When we receive a message from the worker we get a map entry and resolve/reject the promise based on the message.
+ * When we receive a message from the worker we get a map entry with the promise resolve/reject bound to the message.
*/
- protected promiseMap: Map<
+ protected promiseResponseMap: Map<
string,
- PromiseWorkerResponseWrapper<Worker, Response>
- > = new Map<string, PromiseWorkerResponseWrapper<Worker, Response>>()
+ PromiseResponseWrapper<Worker, Response>
+ > = new Map<string, PromiseResponseWrapper<Worker, Response>>()
/**
- * Worker choice strategy instance implementing the worker choice algorithm.
+ * Worker choice strategy context referencing a worker choice algorithm implementation.
*
- * Default to a strategy implementing a round robin algorithm.
+ * Default to a round robin algorithm.
*/
protected workerChoiceStrategyContext: WorkerChoiceStrategyContext<
Worker,
this.checkNumberOfWorkers(this.numberOfWorkers)
this.checkFilePath(this.filePath)
this.checkPoolOptions(this.opts)
+
+ this.chooseWorker.bind(this)
+ this.internalExecute.bind(this)
+ this.checkAndEmitFull.bind(this)
+ this.checkAndEmitBusy.bind(this)
+ this.sendToWorker.bind(this)
+
this.setupHook()
for (let i = 1; i <= this.numberOfWorkers; i++) {
if (this.opts.enableEvents === true) {
this.emitter = new PoolEmitter()
}
- this.workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
+ this.workerChoiceStrategyContext = new WorkerChoiceStrategyContext<
+ Worker,
+ Data,
+ Response
+ >(
this,
() => {
- const workerCreated = this.createAndSetupWorker()
- this.registerWorkerMessageListener(workerCreated, message => {
+ const createdWorker = this.createAndSetupWorker()
+ this.registerWorkerMessageListener(createdWorker, message => {
if (
isKillBehavior(KillBehaviors.HARD, message.kill) ||
- this.getWorkerRunningTasks(workerCreated) === 0
+ this.getWorkerTasksUsage(createdWorker)?.running === 0
) {
// Kill received from the worker, means that no new tasks are submitted to that worker for a while ( > maxInactiveTime)
- void this.destroyWorker(workerCreated)
+ void this.destroyWorker(createdWorker)
}
})
- return workerCreated
+ return this.getWorkerKey(createdWorker)
},
this.opts.workerChoiceStrategy
)
private checkPoolOptions (opts: PoolOptions<Worker>): void {
this.opts.workerChoiceStrategy =
opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN
+ if (
+ !Object.values(WorkerChoiceStrategies).includes(
+ this.opts.workerChoiceStrategy
+ )
+ ) {
+ throw new Error(
+ `Invalid worker choice strategy '${this.opts.workerChoiceStrategy}'`
+ )
+ }
this.opts.enableEvents = opts.enableEvents ?? true
}
- /** {@inheritDoc} */
+ /** @inheritDoc */
public abstract get type (): PoolType
- /** {@inheritDoc} */
- public get numberOfRunningTasks (): number {
- return this.promiseMap.size
+ /**
+ * Number of tasks concurrently running in the pool.
+ */
+ private get numberOfRunningTasks (): number {
+ return this.promiseResponseMap.size
}
/**
* Gets the given worker key.
*
* @param worker - The worker.
- * @returns The worker key.
+ * @returns The worker key if the worker is found in the pool, `-1` otherwise.
*/
- private getWorkerKey (worker: Worker): number | undefined {
- return [...this.workers].find(([, value]) => value.worker === worker)?.[0]
- }
-
- /** {@inheritDoc} */
- public getWorkerRunningTasks (worker: Worker): number | undefined {
- return this.workers.get(this.getWorkerKey(worker) as number)?.tasksUsage
- ?.running
- }
-
- /** {@inheritDoc} */
- public getWorkerAverageTasksRunTime (worker: Worker): number | undefined {
- return this.workers.get(this.getWorkerKey(worker) as number)?.tasksUsage
- ?.avgRunTime
+ private getWorkerKey (worker: Worker): number {
+ return this.workers.findIndex(workerItem => workerItem.worker === worker)
}
- /** {@inheritDoc} */
+ /** @inheritDoc */
public setWorkerChoiceStrategy (
workerChoiceStrategy: WorkerChoiceStrategy
): void {
this.opts.workerChoiceStrategy = workerChoiceStrategy
- for (const [key, value] of this.workers) {
- this.setWorker(key, value.worker, {
+ for (const [index, workerItem] of this.workers.entries()) {
+ this.setWorker(index, workerItem.worker, {
run: 0,
running: 0,
runTime: 0,
- avgRunTime: 0
+ avgRunTime: 0,
+ error: 0
})
}
this.workerChoiceStrategyContext.setWorkerChoiceStrategy(
)
}
- /** {@inheritDoc} */
+ /** @inheritDoc */
+ public abstract get full (): boolean
+
+ /** @inheritDoc */
public abstract get busy (): boolean
- protected internalGetBusyStatus (): boolean {
+ protected internalBusy (): boolean {
return (
this.numberOfRunningTasks >= this.numberOfWorkers &&
- this.findFreeWorker() === false
+ this.findFreeWorkerKey() === -1
)
}
- /** {@inheritDoc} */
- public findFreeWorker (): Worker | false {
- for (const value of this.workers.values()) {
- if (value.tasksUsage.running === 0) {
- // A worker is free, return the matching worker
- return value.worker
- }
- }
- return false
+ /** @inheritDoc */
+ public findFreeWorkerKey (): number {
+ return this.workers.findIndex(workerItem => {
+ return workerItem.tasksUsage.running === 0
+ })
}
- /** {@inheritDoc} */
+ /** @inheritDoc */
public async execute (data: Data): Promise<Response> {
- const worker = this.chooseWorker()
+ const [workerKey, worker] = this.chooseWorker()
const messageId = crypto.randomUUID()
- const res = this.internalExecute(worker, messageId)
+ const res = this.internalExecute(workerKey, worker, messageId)
+ this.checkAndEmitFull()
this.checkAndEmitBusy()
this.sendToWorker(worker, {
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
return res
}
- /** {@inheritDoc} */
+ /** @inheritDoc */
public async destroy (): Promise<void> {
await Promise.all(
- [...this.workers].map(async ([, value]) => {
- await this.destroyWorker(value.worker)
+ this.workers.map(async workerItem => {
+ await this.destroyWorker(workerItem.worker)
})
)
}
/**
- * Shutdowns given worker.
+ * Shutdowns given worker in the pool.
*
* @param worker - A worker within `workers`.
*/
/**
* Setup hook that can be overridden by a Poolifier pool implementation
* to run code before workers are created in the abstract constructor.
+ * Can be overridden
+ *
+ * @virtual
*/
protected setupHook (): void {
- // Can be overridden
+ // Intentionally empty
}
/**
* Hook executed before the worker task promise resolution.
* Can be overridden.
*
- * @param worker - The worker.
+ * @param workerKey - The worker key.
*/
- protected beforePromiseWorkerResponseHook (worker: Worker): void {
- this.increaseWorkerRunningTasks(worker)
+ protected beforePromiseResponseHook (workerKey: number): void {
+ ++this.workers[workerKey].tasksUsage.running
}
/**
* Hook executed after the worker task promise resolution.
* Can be overridden.
*
+ * @param worker - The worker.
* @param message - The received message.
- * @param promise - The Promise response.
*/
- protected afterPromiseWorkerResponseHook (
- message: MessageValue<Response>,
- promise: PromiseWorkerResponseWrapper<Worker, Response>
+ protected afterPromiseResponseHook (
+ worker: Worker,
+ message: MessageValue<Response>
): void {
- this.decreaseWorkerRunningTasks(promise.worker)
- this.stepWorkerRunTasks(promise.worker, 1)
- this.updateWorkerTasksRunTime(promise.worker, message.taskRunTime)
- }
-
- /**
- * Removes the given worker from the pool.
- *
- * @param worker - The worker that will be removed.
- */
- protected removeWorker (worker: Worker): void {
- this.workers.delete(this.getWorkerKey(worker) as number)
- --this.nextWorkerId
+ const workerTasksUsage = this.getWorkerTasksUsage(worker) as TasksUsage
+ --workerTasksUsage.running
+ ++workerTasksUsage.run
+ if (message.error != null) {
+ ++workerTasksUsage.error
+ }
+ if (this.workerChoiceStrategyContext.getRequiredStatistics().runTime) {
+ workerTasksUsage.runTime += message.taskRunTime ?? 0
+ if (
+ this.workerChoiceStrategyContext.getRequiredStatistics().avgRunTime &&
+ workerTasksUsage.run !== 0
+ ) {
+ workerTasksUsage.avgRunTime =
+ workerTasksUsage.runTime / workerTasksUsage.run
+ }
+ }
}
/**
* Chooses a worker for the next task.
*
- * The default implementation uses a round robin algorithm to distribute the load.
+ * The default uses a round robin algorithm to distribute the load.
*
- * @returns Worker.
+ * @returns [worker key, worker].
*/
- protected chooseWorker (): Worker {
- return this.workerChoiceStrategyContext.execute()
+ protected chooseWorker (): [number, Worker] {
+ const workerKey = this.workerChoiceStrategyContext.execute()
+ return [workerKey, this.workers[workerKey].worker]
}
/**
* 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.
+ * @virtual
*/
protected abstract afterWorkerSetup (worker: Worker): void
this.removeWorker(worker)
})
- this.setWorker(this.nextWorkerId, worker, {
+ this.pushWorker(worker, {
run: 0,
running: 0,
runTime: 0,
- avgRunTime: 0
+ avgRunTime: 0,
+ error: 0
})
- ++this.nextWorkerId
this.afterWorkerSetup(worker)
*/
protected workerListener (): (message: MessageValue<Response>) => void {
return message => {
- if (message.id !== undefined) {
- const promise = this.promiseMap.get(message.id)
- if (promise !== undefined) {
+ if (message.id != null) {
+ const promiseResponse = this.promiseResponseMap.get(message.id)
+ if (promiseResponse != null) {
if (message.error != null) {
- promise.reject(message.error)
+ promiseResponse.reject(message.error)
} else {
- promise.resolve(message.data as Response)
+ promiseResponse.resolve(message.data as Response)
}
- this.afterPromiseWorkerResponseHook(message, promise)
- this.promiseMap.delete(message.id)
+ this.afterPromiseResponseHook(promiseResponse.worker, message)
+ this.promiseResponseMap.delete(message.id)
}
}
}
}
private async internalExecute (
+ workerKey: number,
worker: Worker,
messageId: string
): Promise<Response> {
- this.beforePromiseWorkerResponseHook(worker)
+ this.beforePromiseResponseHook(workerKey)
return await new Promise<Response>((resolve, reject) => {
- this.promiseMap.set(messageId, { resolve, reject, worker })
+ this.promiseResponseMap.set(messageId, { resolve, reject, worker })
})
}
}
}
- /**
- * Increases the number of tasks that the given worker has applied.
- *
- * @param worker - Worker which running tasks is increased.
- */
- private increaseWorkerRunningTasks (worker: Worker): void {
- this.stepWorkerRunningTasks(worker, 1)
- }
-
- /**
- * Decreases the number of tasks that the given worker has applied.
- *
- * @param worker - Worker which running tasks is decreased.
- */
- private decreaseWorkerRunningTasks (worker: Worker): void {
- this.stepWorkerRunningTasks(worker, -1)
+ private checkAndEmitFull (): void {
+ if (
+ this.type === PoolType.DYNAMIC &&
+ this.opts.enableEvents === true &&
+ this.full
+ ) {
+ this.emitter?.emit('full')
+ }
}
/**
- * Gets tasks usage of the given worker.
+ * Gets the given worker tasks usage in the pool.
*
- * @param worker - Worker which tasks usage is returned.
+ * @param worker - The worker.
+ * @returns The worker tasks usage.
*/
private getWorkerTasksUsage (worker: Worker): TasksUsage | undefined {
- if (this.checkWorker(worker)) {
- const workerKey = this.getWorkerKey(worker) as number
- const workerEntry = this.workers.get(workerKey) as WorkerType<Worker>
- return workerEntry.tasksUsage
+ const workerKey = this.getWorkerKey(worker)
+ if (workerKey !== -1) {
+ return this.workers[workerKey].tasksUsage
}
+ throw new Error('Worker could not be found in the pool')
}
/**
- * 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.
- */
- private stepWorkerRunningTasks (worker: Worker, step: number): void {
- // prettier-ignore
- (this.getWorkerTasksUsage(worker) as TasksUsage).running += step
- }
-
- /**
- * 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.
- */
- private stepWorkerRunTasks (worker: Worker, step: number): void {
- // prettier-ignore
- (this.getWorkerTasksUsage(worker) as TasksUsage).run += step
- }
-
- /**
- * Updates tasks runtime for the given worker.
+ * Pushes the given worker in the pool.
*
- * @param worker - Worker which run the task.
- * @param taskRunTime - Worker task runtime.
+ * @param worker - The worker.
+ * @param tasksUsage - The worker tasks usage.
*/
- private updateWorkerTasksRunTime (
- worker: Worker,
- taskRunTime: number | undefined
- ): void {
- if (
- this.workerChoiceStrategyContext.getWorkerChoiceStrategy()
- .requiredStatistics.runTime
- ) {
- const workerTasksUsage = this.getWorkerTasksUsage(worker) as TasksUsage
- workerTasksUsage.runTime += taskRunTime ?? 0
- if (workerTasksUsage.run !== 0) {
- workerTasksUsage.avgRunTime =
- workerTasksUsage.runTime / workerTasksUsage.run
- }
- }
+ private pushWorker (worker: Worker, tasksUsage: TasksUsage): void {
+ this.workers.push({
+ worker,
+ tasksUsage
+ })
}
/**
- * Sets the given worker.
+ * Sets the given worker in the pool.
*
* @param workerKey - The worker key.
* @param worker - The worker.
worker: Worker,
tasksUsage: TasksUsage
): void {
- this.workers.set(workerKey, {
+ this.workers[workerKey] = {
worker,
tasksUsage
- })
+ }
}
/**
- * Checks if the given worker is registered in the pool.
+ * Removes the given worker from the pool.
*
- * @param worker - Worker to check.
- * @returns `true` if the worker is registered in the pool.
+ * @param worker - The worker that will be removed.
*/
- private checkWorker (worker: Worker): boolean {
- if (this.getWorkerKey(worker) == null) {
- throw new Error('Worker could not be found in the pool')
- }
- return true
+ protected removeWorker (worker: Worker): void {
+ const workerKey = this.getWorkerKey(worker)
+ this.workers.splice(workerKey, 1)
+ this.workerChoiceStrategyContext.remove(workerKey)
}
}
repositories / poolifier.git / blobdiff