import crypto from 'node:crypto'
+import { performance } from 'node:perf_hooks'
import type { MessageValue, PromiseResponseWrapper } from '../utility-types'
import {
DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS,
EMPTY_FUNCTION,
+ isPlainObject,
median
} from '../utils'
import { KillBehaviors, isKillBehavior } from '../worker/worker-options'
type IPool,
PoolEmitter,
PoolEvents,
+ type PoolInfo,
type PoolOptions,
- PoolType,
- type TasksQueueOptions
+ type PoolType,
+ PoolTypes,
+ type TasksQueueOptions,
+ type WorkerType
} from './pool'
import type { IWorker, Task, TasksUsage, WorkerNode } from './worker'
import {
* @param opts - Options for the pool.
*/
public constructor (
- public readonly numberOfWorkers: number,
- public readonly filePath: string,
- public readonly opts: PoolOptions<Worker>
+ protected readonly numberOfWorkers: number,
+ protected readonly filePath: string,
+ protected readonly opts: PoolOptions<Worker>
) {
if (!this.isMain()) {
throw new Error('Cannot start a pool from a worker!')
this.enqueueTask = this.enqueueTask.bind(this)
this.checkAndEmitEvents = this.checkAndEmitEvents.bind(this)
- this.setupHook()
-
- for (let i = 1; i <= this.numberOfWorkers; i++) {
- this.createAndSetupWorker()
- }
-
if (this.opts.enableEvents === true) {
this.emitter = new PoolEmitter()
}
this.opts.workerChoiceStrategy,
this.opts.workerChoiceStrategyOptions
)
+
+ this.setupHook()
+
+ for (let i = 1; i <= this.numberOfWorkers; i++) {
+ this.createAndSetupWorker()
+ }
}
private checkFilePath (filePath: string): void {
)
} else if (!Number.isSafeInteger(numberOfWorkers)) {
throw new TypeError(
- 'Cannot instantiate a pool with a non integer number of workers'
+ 'Cannot instantiate a pool with a non safe integer number of workers'
)
} else if (numberOfWorkers < 0) {
throw new RangeError(
'Cannot instantiate a pool with a negative number of workers'
)
- } else if (this.type === PoolType.FIXED && numberOfWorkers === 0) {
+ } else if (this.type === PoolTypes.fixed && numberOfWorkers === 0) {
throw new Error('Cannot instantiate a fixed pool with no worker')
}
}
private checkPoolOptions (opts: PoolOptions<Worker>): void {
- this.opts.workerChoiceStrategy =
- opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN
- this.checkValidWorkerChoiceStrategy(this.opts.workerChoiceStrategy)
- this.opts.workerChoiceStrategyOptions =
- opts.workerChoiceStrategyOptions ?? DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
- this.opts.enableEvents = opts.enableEvents ?? true
- this.opts.enableTasksQueue = opts.enableTasksQueue ?? false
- if (this.opts.enableTasksQueue) {
- this.checkValidTasksQueueOptions(
- opts.tasksQueueOptions as TasksQueueOptions
- )
- this.opts.tasksQueueOptions = this.buildTasksQueueOptions(
- opts.tasksQueueOptions as TasksQueueOptions
+ if (isPlainObject(opts)) {
+ this.opts.workerChoiceStrategy =
+ opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN
+ this.checkValidWorkerChoiceStrategy(this.opts.workerChoiceStrategy)
+ this.opts.workerChoiceStrategyOptions =
+ opts.workerChoiceStrategyOptions ??
+ DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+ this.checkValidWorkerChoiceStrategyOptions(
+ this.opts.workerChoiceStrategyOptions
)
+ this.opts.restartWorkerOnError = opts.restartWorkerOnError ?? true
+ this.opts.enableEvents = opts.enableEvents ?? true
+ this.opts.enableTasksQueue = opts.enableTasksQueue ?? false
+ if (this.opts.enableTasksQueue) {
+ this.checkValidTasksQueueOptions(
+ opts.tasksQueueOptions as TasksQueueOptions
+ )
+ this.opts.tasksQueueOptions = this.buildTasksQueueOptions(
+ opts.tasksQueueOptions as TasksQueueOptions
+ )
+ }
+ } else {
+ throw new TypeError('Invalid pool options: must be a plain object')
}
}
}
}
+ private checkValidWorkerChoiceStrategyOptions (
+ workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
+ ): void {
+ if (!isPlainObject(workerChoiceStrategyOptions)) {
+ throw new TypeError(
+ 'Invalid worker choice strategy options: must be a plain object'
+ )
+ }
+ if (
+ workerChoiceStrategyOptions.weights != null &&
+ Object.keys(workerChoiceStrategyOptions.weights).length !== this.maxSize
+ ) {
+ throw new Error(
+ 'Invalid worker choice strategy options: must have a weight for each worker node'
+ )
+ }
+ }
+
private checkValidTasksQueueOptions (
tasksQueueOptions: TasksQueueOptions
): void {
+ if (tasksQueueOptions != null && !isPlainObject(tasksQueueOptions)) {
+ throw new TypeError('Invalid tasks queue options: must be a plain object')
+ }
if ((tasksQueueOptions?.concurrency as number) <= 0) {
throw new Error(
`Invalid worker tasks concurrency '${
}
/** @inheritDoc */
- public abstract get type (): PoolType
+ public get info (): PoolInfo {
+ return {
+ type: this.type,
+ worker: this.worker,
+ minSize: this.minSize,
+ maxSize: this.maxSize,
+ workerNodes: this.workerNodes.length,
+ idleWorkerNodes: this.workerNodes.reduce(
+ (accumulator, workerNode) =>
+ workerNode.tasksUsage.running === 0 ? accumulator + 1 : accumulator,
+ 0
+ ),
+ busyWorkerNodes: this.workerNodes.reduce(
+ (accumulator, workerNode) =>
+ workerNode.tasksUsage.running > 0 ? accumulator + 1 : accumulator,
+ 0
+ ),
+ runningTasks: this.workerNodes.reduce(
+ (accumulator, workerNode) =>
+ accumulator + workerNode.tasksUsage.running,
+ 0
+ ),
+ queuedTasks: this.workerNodes.reduce(
+ (accumulator, workerNode) => accumulator + workerNode.tasksQueue.size,
+ 0
+ ),
+ maxQueuedTasks: this.workerNodes.reduce(
+ (accumulator, workerNode) =>
+ accumulator + workerNode.tasksQueue.maxSize,
+ 0
+ )
+ }
+ }
/**
- * Number of tasks running in the pool.
+ * Pool type.
+ *
+ * If it is `'dynamic'`, it provides the `max` property.
*/
- private get numberOfRunningTasks (): number {
- return this.workerNodes.reduce(
- (accumulator, workerNode) => accumulator + workerNode.tasksUsage.running,
- 0
- )
- }
+ protected abstract get type (): PoolType
/**
- * Number of tasks queued in the pool.
+ * Gets the worker type.
*/
- private get numberOfQueuedTasks (): number {
- if (this.opts.enableTasksQueue === false) {
- return 0
- }
- return this.workerNodes.reduce(
- (accumulator, workerNode) => accumulator + workerNode.tasksQueue.size,
- 0
- )
- }
+ protected abstract get worker (): WorkerType
+
+ /**
+ * Pool minimum size.
+ */
+ protected abstract get minSize (): number
+
+ /**
+ * Pool maximum size.
+ */
+ protected abstract get maxSize (): number
/**
* Gets the given worker its worker node key.
): void {
this.checkValidWorkerChoiceStrategy(workerChoiceStrategy)
this.opts.workerChoiceStrategy = workerChoiceStrategy
+ this.workerChoiceStrategyContext.setWorkerChoiceStrategy(
+ this.opts.workerChoiceStrategy
+ )
+ if (workerChoiceStrategyOptions != null) {
+ this.setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions)
+ }
for (const workerNode of this.workerNodes) {
this.setWorkerNodeTasksUsage(workerNode, {
- run: 0,
+ ran: 0,
running: 0,
runTime: 0,
runTimeHistory: new CircularArray(),
avgRunTime: 0,
medRunTime: 0,
- error: 0
+ waitTime: 0,
+ waitTimeHistory: new CircularArray(),
+ avgWaitTime: 0,
+ medWaitTime: 0,
+ error: 0,
+ elu: undefined
})
- }
- this.workerChoiceStrategyContext.setWorkerChoiceStrategy(
- this.opts.workerChoiceStrategy
- )
- if (workerChoiceStrategyOptions != null) {
- this.setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions)
+ this.setWorkerStatistics(workerNode.worker)
}
}
public setWorkerChoiceStrategyOptions (
workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
): void {
+ this.checkValidWorkerChoiceStrategyOptions(workerChoiceStrategyOptions)
this.opts.workerChoiceStrategyOptions = workerChoiceStrategyOptions
this.workerChoiceStrategyContext.setOptions(
this.opts.workerChoiceStrategyOptions
this.checkValidTasksQueueOptions(tasksQueueOptions)
this.opts.tasksQueueOptions =
this.buildTasksQueueOptions(tasksQueueOptions)
- } else {
+ } else if (this.opts.tasksQueueOptions != null) {
delete this.opts.tasksQueueOptions
}
}
*
* The pool filling boolean status.
*/
- protected abstract get full (): boolean
+ protected get full (): boolean {
+ return this.workerNodes.length >= this.maxSize
+ }
/**
* Whether the pool is busy or not.
protected internalBusy (): boolean {
return (
this.workerNodes.findIndex(workerNode => {
- return workerNode.tasksUsage?.running === 0
+ return workerNode.tasksUsage.running === 0
}) === -1
)
}
/** @inheritDoc */
public async execute (data?: Data, name?: string): Promise<Response> {
- const [workerNodeKey, workerNode] = this.chooseWorkerNode()
+ const timestamp = performance.now()
+ const workerNodeKey = this.chooseWorkerNode()
const submittedTask: Task<Data> = {
name,
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
data: data ?? ({} as Data),
+ timestamp,
id: crypto.randomUUID()
}
const res = new Promise<Response>((resolve, reject) => {
this.promiseResponseMap.set(submittedTask.id as string, {
resolve,
reject,
- worker: workerNode.worker
+ worker: this.workerNodes[workerNodeKey].worker
})
})
if (
} else {
this.executeTask(workerNodeKey, submittedTask)
}
+ this.workerChoiceStrategyContext.update(workerNodeKey)
this.checkAndEmitEvents()
// eslint-disable-next-line @typescript-eslint/return-await
return res
await Promise.all(
this.workerNodes.map(async (workerNode, workerNodeKey) => {
this.flushTasksQueue(workerNodeKey)
+ // FIXME: wait for tasks to be finished
await this.destroyWorker(workerNode.worker)
})
)
worker: Worker,
message: MessageValue<Response>
): void {
- const workerTasksUsage = this.getWorkerTasksUsage(worker)
+ const workerTasksUsage =
+ this.workerNodes[this.getWorkerNodeKey(worker)].tasksUsage
--workerTasksUsage.running
- ++workerTasksUsage.run
+ ++workerTasksUsage.ran
if (message.error != null) {
++workerTasksUsage.error
}
- if (this.workerChoiceStrategyContext.getRequiredStatistics().runTime) {
- workerTasksUsage.runTime += message.runTime ?? 0
+ this.updateRunTimeTasksUsage(workerTasksUsage, message)
+ this.updateWaitTimeTasksUsage(workerTasksUsage, message)
+ this.updateEluTasksUsage(workerTasksUsage, message)
+ }
+
+ private updateRunTimeTasksUsage (
+ workerTasksUsage: TasksUsage,
+ message: MessageValue<Response>
+ ): void {
+ if (this.workerChoiceStrategyContext.getTaskStatistics().runTime) {
+ workerTasksUsage.runTime += message.taskPerformance?.runTime ?? 0
if (
- this.workerChoiceStrategyContext.getRequiredStatistics().avgRunTime &&
- workerTasksUsage.run !== 0
+ this.workerChoiceStrategyContext.getTaskStatistics().avgRunTime &&
+ workerTasksUsage.ran !== 0
) {
workerTasksUsage.avgRunTime =
- workerTasksUsage.runTime / workerTasksUsage.run
+ workerTasksUsage.runTime / workerTasksUsage.ran
}
- if (this.workerChoiceStrategyContext.getRequiredStatistics().medRunTime) {
- workerTasksUsage.runTimeHistory.push(message.runTime ?? 0)
+ if (
+ this.workerChoiceStrategyContext.getTaskStatistics().medRunTime &&
+ message.taskPerformance?.runTime != null
+ ) {
+ workerTasksUsage.runTimeHistory.push(message.taskPerformance.runTime)
workerTasksUsage.medRunTime = median(workerTasksUsage.runTimeHistory)
}
}
}
+ private updateWaitTimeTasksUsage (
+ workerTasksUsage: TasksUsage,
+ message: MessageValue<Response>
+ ): void {
+ if (this.workerChoiceStrategyContext.getTaskStatistics().waitTime) {
+ workerTasksUsage.waitTime += message.taskPerformance?.waitTime ?? 0
+ if (
+ this.workerChoiceStrategyContext.getTaskStatistics().avgWaitTime &&
+ workerTasksUsage.ran !== 0
+ ) {
+ workerTasksUsage.avgWaitTime =
+ workerTasksUsage.waitTime / workerTasksUsage.ran
+ }
+ if (
+ this.workerChoiceStrategyContext.getTaskStatistics().medWaitTime &&
+ message.taskPerformance?.waitTime != null
+ ) {
+ workerTasksUsage.waitTimeHistory.push(message.taskPerformance.waitTime)
+ workerTasksUsage.medWaitTime = median(workerTasksUsage.waitTimeHistory)
+ }
+ }
+ }
+
+ private updateEluTasksUsage (
+ workerTasksUsage: TasksUsage,
+ message: MessageValue<Response>
+ ): void {
+ if (this.workerChoiceStrategyContext.getTaskStatistics().elu) {
+ if (
+ workerTasksUsage.elu != null &&
+ message.taskPerformance?.elu != null
+ ) {
+ workerTasksUsage.elu = {
+ idle: workerTasksUsage.elu.idle + message.taskPerformance.elu.idle,
+ active:
+ workerTasksUsage.elu.active + message.taskPerformance.elu.active,
+ utilization:
+ (workerTasksUsage.elu.utilization +
+ message.taskPerformance.elu.utilization) /
+ 2
+ }
+ } else if (message.taskPerformance?.elu != null) {
+ workerTasksUsage.elu = message.taskPerformance.elu
+ }
+ }
+ }
+
/**
* Chooses a worker node for the next task.
*
- * The default uses a round robin algorithm to distribute the load.
+ * The default worker choice strategy uses a round robin algorithm to distribute the load.
*
- * @returns [worker node key, worker node].
+ * @returns The worker node key
*/
- protected chooseWorkerNode (): [number, WorkerNode<Worker, Data>] {
+ protected chooseWorkerNode (): number {
let workerNodeKey: number
- if (this.type === PoolType.DYNAMIC && !this.full && this.internalBusy()) {
+ if (this.type === PoolTypes.dynamic && !this.full && this.internalBusy()) {
const workerCreated = this.createAndSetupWorker()
this.registerWorkerMessageListener(workerCreated, message => {
+ const currentWorkerNodeKey = this.getWorkerNodeKey(workerCreated)
if (
isKillBehavior(KillBehaviors.HARD, message.kill) ||
(message.kill != null &&
- this.getWorkerTasksUsage(workerCreated)?.running === 0)
+ this.workerNodes[currentWorkerNodeKey].tasksUsage.running === 0)
) {
// Kill message received from the worker: no new tasks are submitted to that worker for a while ( > maxInactiveTime)
- this.flushTasksQueueByWorker(workerCreated)
+ this.flushTasksQueue(currentWorkerNodeKey)
+ // FIXME: wait for tasks to be finished
void (this.destroyWorker(workerCreated) as Promise<void>)
}
})
} else {
workerNodeKey = this.workerChoiceStrategyContext.execute()
}
- return [workerNodeKey, this.workerNodes[workerNodeKey]]
+ return workerNodeKey
}
/**
worker.on('message', this.opts.messageHandler ?? EMPTY_FUNCTION)
worker.on('error', this.opts.errorHandler ?? EMPTY_FUNCTION)
+ worker.on('error', error => {
+ if (this.emitter != null) {
+ this.emitter.emit(PoolEvents.error, error)
+ }
+ })
+ worker.on('error', () => {
+ if (this.opts.restartWorkerOnError === true) {
+ this.createAndSetupWorker()
+ }
+ })
worker.on('online', this.opts.onlineHandler ?? EMPTY_FUNCTION)
worker.on('exit', this.opts.exitHandler ?? EMPTY_FUNCTION)
worker.once('exit', () => {
this.pushWorkerNode(worker)
+ this.setWorkerStatistics(worker)
+
this.afterWorkerSetup(worker)
return worker
if (promiseResponse != null) {
if (message.error != null) {
promiseResponse.reject(message.error)
+ if (this.emitter != null) {
+ this.emitter.emit(PoolEvents.taskError, {
+ error: message.error,
+ errorData: message.errorData
+ })
+ }
} else {
promiseResponse.resolve(message.data as Response)
}
}
private checkAndEmitEvents (): void {
- if (this.opts.enableEvents === true) {
+ if (this.emitter != null) {
if (this.busy) {
- this.emitter?.emit(PoolEvents.busy)
+ this.emitter?.emit(PoolEvents.busy, this.info)
}
- if (this.type === PoolType.DYNAMIC && this.full) {
- this.emitter?.emit(PoolEvents.full)
+ if (this.type === PoolTypes.dynamic && this.full) {
+ this.emitter?.emit(PoolEvents.full, this.info)
}
}
}
workerNode.tasksUsage = tasksUsage
}
- /**
- * Gets the given worker its tasks usage in the pool.
- *
- * @param worker - The worker.
- * @throws Error if the worker is not found in the pool worker nodes.
- * @returns The worker tasks usage.
- */
- private getWorkerTasksUsage (worker: Worker): TasksUsage {
- const workerNodeKey = this.getWorkerNodeKey(worker)
- if (workerNodeKey !== -1) {
- return this.workerNodes[workerNodeKey].tasksUsage
- }
- throw new Error('Worker could not be found in the pool worker nodes')
- }
-
/**
* Pushes the given worker in the pool worker nodes.
*
return this.workerNodes.push({
worker,
tasksUsage: {
- run: 0,
+ ran: 0,
running: 0,
runTime: 0,
runTimeHistory: new CircularArray(),
avgRunTime: 0,
medRunTime: 0,
- error: 0
+ waitTime: 0,
+ waitTimeHistory: new CircularArray(),
+ avgWaitTime: 0,
+ medWaitTime: 0,
+ error: 0,
+ elu: undefined
},
tasksQueue: new Queue<Task<Data>>()
})
*/
private removeWorkerNode (worker: Worker): void {
const workerNodeKey = this.getWorkerNodeKey(worker)
- this.workerNodes.splice(workerNodeKey, 1)
- this.workerChoiceStrategyContext.remove(workerNodeKey)
+ if (workerNodeKey !== -1) {
+ this.workerNodes.splice(workerNodeKey, 1)
+ this.workerChoiceStrategyContext.remove(workerNodeKey)
+ }
}
private executeTask (workerNodeKey: number, task: Task<Data>): void {
}
}
- private flushTasksQueueByWorker (worker: Worker): void {
- const workerNodeKey = this.getWorkerNodeKey(worker)
- this.flushTasksQueue(workerNodeKey)
- }
-
private flushTasksQueues (): void {
for (const [workerNodeKey] of this.workerNodes.entries()) {
this.flushTasksQueue(workerNodeKey)
}
}
+
+ private setWorkerStatistics (worker: Worker): void {
+ this.sendToWorker(worker, {
+ statistics: {
+ runTime: this.workerChoiceStrategyContext.getTaskStatistics().runTime,
+ waitTime: this.workerChoiceStrategyContext.getTaskStatistics().waitTime,
+ elu: this.workerChoiceStrategyContext.getTaskStatistics().elu
+ }
+ })
+ }
}
repositories / poolifier.git / blobdiff