Data = unknown,
Response = unknown
> implements IPoolInternal<Worker, Data, Response> {
- /** {@inheritDoc} */
+ /** @inheritDoc */
public readonly workers: Array<WorkerType<Worker>> = []
- /** {@inheritDoc} */
+ /** @inheritDoc */
public readonly emitter?: PoolEmitter
/**
> = 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 createdWorker = this.createAndSetupWorker()
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 {
+ /**
+ * Number of tasks concurrently running in the pool.
+ */
+ private get numberOfRunningTasks (): number {
return this.promiseResponseMap.size
}
return this.workers.findIndex(workerItem => workerItem.worker === worker)
}
- /** {@inheritDoc} */
+ /** @inheritDoc */
public setWorkerChoiceStrategy (
workerChoiceStrategy: WorkerChoiceStrategy
): void {
)
}
- /** {@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.findFreeWorkerKey() === -1
)
}
- /** {@inheritDoc} */
+ /** @inheritDoc */
public findFreeWorkerKey (): number {
return this.workers.findIndex(workerItem => {
return workerItem.tasksUsage.running === 0
})
}
- /** {@inheritDoc} */
+ /** @inheritDoc */
public async execute (data: Data): Promise<Response> {
const [workerKey, worker] = this.chooseWorker()
const messageId = crypto.randomUUID()
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 workerItem => {
}
/**
- * 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
}
/**
}
}
- /**
- * Removes the given worker from the pool.
- *
- * @param worker - The worker that will be removed.
- */
- protected removeWorker (worker: Worker): void {
- const workerKey = this.getWorkerKey(worker)
- this.workers.splice(workerKey, 1)
- this.workerChoiceStrategyContext.remove(workerKey)
- }
-
/**
* 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 key, 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
*/
protected workerListener (): (message: MessageValue<Response>) => void {
return message => {
- if (message.id !== undefined) {
+ if (message.id != null) {
const promiseResponse = this.promiseResponseMap.get(message.id)
- if (promiseResponse !== undefined) {
+ if (promiseResponse != null) {
if (message.error != null) {
promiseResponse.reject(message.error)
} else {
}
}
+ private checkAndEmitFull (): void {
+ if (
+ this.type === PoolType.DYNAMIC &&
+ this.opts.enableEvents === true &&
+ this.full
+ ) {
+ this.emitter?.emit('full')
+ }
+ }
+
/**
- * Gets worker tasks usage.
+ * Gets the given worker tasks usage in the pool.
*
* @param worker - The worker.
* @returns The worker tasks usage.
}
/**
- * Pushes the given worker.
+ * Pushes the given worker in the pool.
*
* @param worker - The worker.
* @param tasksUsage - The worker tasks usage.
}
/**
- * Sets the given worker.
+ * Sets the given worker in the pool.
*
* @param workerKey - The worker key.
* @param worker - The worker.
tasksUsage
}
}
+
+ /**
+ * Removes the given worker from the pool.
+ *
+ * @param worker - The worker that will be removed.
+ */
+ protected removeWorker (worker: Worker): void {
+ const workerKey = this.getWorkerKey(worker)
+ this.workers.splice(workerKey, 1)
+ this.workerChoiceStrategyContext.remove(workerKey)
+ }
}
repositories / poolifier.git / blobdiff