MessageValue,
PromiseWorkerResponseWrapper
} from '../utility-types'
-import { EMPTY_FUNCTION } from '../utils'
+import { EMPTY_FUNCTION, EMPTY_LITERAL } from '../utils'
import { isKillBehavior, KillBehaviors } from '../worker/worker-options'
-import type { AbstractPoolWorker } from './abstract-pool-worker'
import type { PoolOptions } from './pool'
+import { PoolEmitter } from './pool'
import type { IPoolInternal, TasksUsage } from './pool-internal'
-import { PoolEmitter, PoolType } from './pool-internal'
+import { PoolType } from './pool-internal'
+import type { IPoolWorker } from './pool-worker'
import {
WorkerChoiceStrategies,
WorkerChoiceStrategy
} from './selection-strategies/selection-strategies-types'
import { WorkerChoiceStrategyContext } from './selection-strategies/worker-choice-strategy-context'
-const WORKER_NOT_FOUND_TASKS_USAGE_MAP =
- 'Worker could not be found in worker tasks usage map'
-
/**
- * Base class containing some shared logic for all poolifier pools.
+ * Base class that implements some shared logic for all poolifier pools.
*
* @template Worker Type of worker which manages this pool.
* @template Data Type of data sent to the worker. This can only be serializable data.
* @template Response Type of response of execution. This can only be serializable data.
*/
export abstract class AbstractPool<
- Worker extends AbstractPoolWorker,
+ Worker extends IPoolWorker,
Data = unknown,
Response = unknown
> implements IPoolInternal<Worker, Data, Response> {
/** @inheritDoc */
public readonly workers: Worker[] = []
- /**
- * The workers tasks usage map.
- *
- * `key`: The `Worker`
- * `value`: Worker tasks usage statistics.
- */
- protected workersTasksUsage: Map<Worker, TasksUsage> = new Map<
- Worker,
- TasksUsage
+ /** @inheritDoc */
+ public readonly workersTasksUsage: Map<Worker, TasksUsage> = new Map<
+ Worker,
+ TasksUsage
>()
/** @inheritDoc */
public readonly emitter?: PoolEmitter
- /** @inheritDoc */
- public readonly max?: number
-
/**
* The promise map.
*
* 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>
+ number,
+ PromiseWorkerResponseWrapper<Worker, Response>
> = new Map<number, PromiseWorkerResponseWrapper<Worker, Response>>()
/**
* Default to a strategy implementing a round robin algorithm.
*/
protected workerChoiceStrategyContext: WorkerChoiceStrategyContext<
- Worker,
- Data,
- Response
+ Worker,
+ Data,
+ Response
>
/**
this.createAndSetupWorker()
}
- if (this.opts.enableEvents) {
+ if (this.opts.enableEvents === true) {
this.emitter = new PoolEmitter()
}
this.workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
this.getWorkerRunningTasks(workerCreated) === 0
) {
// Kill received from the worker, means that no new tasks are submitted to that worker for a while ( > maxInactiveTime)
- this.destroyWorker(workerCreated) as void
+ void (this.destroyWorker(workerCreated) as Promise<void>)
}
})
return workerCreated
}
private checkFilePath (filePath: string): void {
- if (!filePath) {
+ if (filePath == null || filePath.length === 0) {
throw new Error('Please specify a file with a worker implementation')
}
}
throw new Error(
'Cannot instantiate a pool without specifying the number of workers'
)
- } else if (Number.isSafeInteger(numberOfWorkers) === false) {
- throw new Error(
+ } else if (!Number.isSafeInteger(numberOfWorkers)) {
+ throw new TypeError(
'Cannot instantiate a pool with a non integer number of workers'
)
} else if (numberOfWorkers < 0) {
- throw new Error(
+ throw new RangeError(
'Cannot instantiate a pool with a negative number of workers'
)
} else if (this.type === PoolType.FIXED && numberOfWorkers === 0) {
workerChoiceStrategy: WorkerChoiceStrategy
): void {
this.opts.workerChoiceStrategy = workerChoiceStrategy
+ for (const worker of this.workers) {
+ this.resetWorkerTasksUsage(worker)
+ }
this.workerChoiceStrategyContext.setWorkerChoiceStrategy(
workerChoiceStrategy
)
}
/** @inheritDoc */
- public execute (data: Data): Promise<Response> {
+ public async execute (data: Data): Promise<Response> {
// Configure worker to handle message with the specified task
const worker = this.chooseWorker()
- const messageId = ++this.nextMessageId
- const res = this.internalExecute(worker, messageId)
+ const res = this.internalExecute(worker, this.nextMessageId)
this.checkAndEmitBusy()
- data = data ?? ({} as Data)
- this.sendToWorker(worker, { data, id: messageId })
+ this.sendToWorker(worker, {
+ data: data ?? (EMPTY_LITERAL as Data),
+ id: this.nextMessageId
+ })
+ ++this.nextMessageId
+ // eslint-disable-next-line @typescript-eslint/return-await
return res
}
/**
* Removes the given worker from the pool.
*
- * @param worker Worker that will be removed.
+ * @param worker The worker that will be removed.
*/
protected removeWorker (worker: Worker): void {
// Clean worker from data structure
): void
/**
- * Register a listener callback on a given worker.
+ * Registers a listener callback on a given worker.
*
- * @param worker A worker.
- * @param listener A message listener callback.
+ * @param worker The worker which should register a listener.
+ * @param listener The message listener callback.
*/
protected abstract registerWorkerMessageListener<
Message extends Data | Response
- > (worker: Worker, listener: (message: MessageValue<Message>) => void): void
-
- protected internalExecute (
- worker: Worker,
- messageId: number
- ): Promise<Response> {
- this.beforePromiseWorkerResponseHook(worker)
- return new Promise<Response>((resolve, reject) => {
- this.promiseMap.set(messageId, { resolve, reject, worker })
- })
- }
+ >(worker: Worker, listener: (message: MessageValue<Message>) => void): void
/**
* Returns a newly created worker.
this.workers.push(worker)
// Init worker tasks usage map
- this.workersTasksUsage.set(worker, {
- run: 0,
- running: 0,
- runTime: 0,
- avgRunTime: 0
- })
+ this.initWorkerTasksUsage(worker)
this.afterWorkerSetup(worker)
if (message.id !== undefined) {
const promise = this.promiseMap.get(message.id)
if (promise !== undefined) {
+ if (message.error != null) {
+ promise.reject(message.error)
+ } else {
+ promise.resolve(message.data as Response)
+ }
this.afterPromiseWorkerResponseHook(message, promise)
- if (message.error) promise.reject(message.error)
- else promise.resolve(message.data as Response)
this.promiseMap.delete(message.id)
}
}
}
}
+ private async internalExecute (
+ worker: Worker,
+ messageId: number
+ ): Promise<Response> {
+ this.beforePromiseWorkerResponseHook(worker)
+ return await new Promise<Response>((resolve, reject) => {
+ this.promiseMap.set(messageId, { resolve, reject, worker })
+ })
+ }
+
private checkAndEmitBusy (): void {
- if (this.opts.enableEvents && this.busy) {
+ if (this.opts.enableEvents === true && this.busy) {
this.emitter?.emit('busy')
}
}
* @param step Number of running tasks step.
*/
private stepWorkerRunningTasks (worker: Worker, step: number): void {
- const tasksUsage = this.workersTasksUsage.get(worker)
- if (tasksUsage !== undefined) {
+ if (this.checkWorkerTasksUsage(worker)) {
+ const tasksUsage = this.workersTasksUsage.get(worker) as TasksUsage
tasksUsage.running = tasksUsage.running + step
this.workersTasksUsage.set(worker, tasksUsage)
- } else {
- throw new Error(WORKER_NOT_FOUND_TASKS_USAGE_MAP)
}
}
* @param step Number of run tasks step.
*/
private stepWorkerRunTasks (worker: Worker, step: number): void {
- const tasksUsage = this.workersTasksUsage.get(worker)
- if (tasksUsage !== undefined) {
+ if (this.checkWorkerTasksUsage(worker)) {
+ const tasksUsage = this.workersTasksUsage.get(worker) as TasksUsage
tasksUsage.run = tasksUsage.run + step
this.workersTasksUsage.set(worker, tasksUsage)
- } else {
- throw new Error(WORKER_NOT_FOUND_TASKS_USAGE_MAP)
}
}
): void {
if (
this.workerChoiceStrategyContext.getWorkerChoiceStrategy()
- .requiredStatistics.runTime === true
+ .requiredStatistics.runTime &&
+ this.checkWorkerTasksUsage(worker)
) {
- const tasksUsage = this.workersTasksUsage.get(worker)
- if (tasksUsage !== undefined) {
- tasksUsage.runTime += taskRunTime ?? 0
- if (tasksUsage.run !== 0) {
- tasksUsage.avgRunTime = tasksUsage.runTime / tasksUsage.run
- }
- this.workersTasksUsage.set(worker, tasksUsage)
- } else {
- throw new Error(WORKER_NOT_FOUND_TASKS_USAGE_MAP)
+ const tasksUsage = this.workersTasksUsage.get(worker) as TasksUsage
+ tasksUsage.runTime += taskRunTime ?? 0
+ if (tasksUsage.run !== 0) {
+ tasksUsage.avgRunTime = tasksUsage.runTime / tasksUsage.run
}
+ this.workersTasksUsage.set(worker, tasksUsage)
+ }
+ }
+
+ /**
+ * Checks if the given worker is registered in the workers tasks usage map.
+ *
+ * @param worker Worker to check.
+ * @returns `true` if the worker is registered in the workers tasks usage map. `false` otherwise.
+ */
+ private checkWorkerTasksUsage (worker: Worker): boolean {
+ const hasTasksUsage = this.workersTasksUsage.has(worker)
+ if (!hasTasksUsage) {
+ throw new Error('Worker could not be found in workers tasks usage map')
}
+ return hasTasksUsage
+ }
+
+ /**
+ * Initializes tasks usage statistics.
+ *
+ * @param worker The worker.
+ */
+ private initWorkerTasksUsage (worker: Worker): void {
+ this.workersTasksUsage.set(worker, {
+ run: 0,
+ running: 0,
+ runTime: 0,
+ avgRunTime: 0
+ })
}
/**
private removeWorkerTasksUsage (worker: Worker): void {
this.workersTasksUsage.delete(worker)
}
+
+ /**
+ * Resets worker tasks usage statistics.
+ *
+ * @param worker The worker.
+ */
+ private resetWorkerTasksUsage (worker: Worker): void {
+ this.removeWorkerTasksUsage(worker)
+ this.initWorkerTasksUsage(worker)
+ }
}
repositories / poolifier.git / blobdiff