-import type { Worker } from 'cluster'
-import type { JSONValue, MessageValue } from '../../utility-types'
-import type { ClusterPoolOptions } from './fixed'
-import { FixedClusterPool } from './fixed'
+import { checkDynamicPoolSize } from '../utils.js'
+import { PoolEvents, type PoolType, PoolTypes } from '../pool.js'
+import { type ClusterPoolOptions, FixedClusterPool } from './fixed.js'
/**
- * A cluster pool with a min/max number of workers, is possible to execute tasks in sync or async mode as you prefer.
+ * A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.
*
- * This cluster pool will create new workers when the other ones are busy, until the max number of workers,
- * when the max number of workers is reached, an event will be emitted, if you want to listen this event use the emitter method.
+ * This cluster pool creates new workers when the others are busy, up to the maximum number of workers.
+ * When the maximum number of workers is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's `emitter`.
*
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
* @author [Christopher Quadflieg](https://github.com/Shinigami92)
* @since 2.0.0
*/
export class DynamicClusterPool<
- Data extends JSONValue = JSONValue,
- Response extends JSONValue = JSONValue
+ Data = unknown,
+ Response = unknown
> extends FixedClusterPool<Data, Response> {
/**
- * @param min Min number of workers that will be always active
- * @param max Max number of workers that will be active
- * @param filename A file path with implementation of `ClusterWorker` class, relative path is fine.
- * @param opts An object with possible options for example `errorHandler`, `onlineHandler`. Default: `{ maxTasks: 1000 }`
+ * Constructs a new poolifier dynamic cluster pool.
+ *
+ * @param min - Minimum number of workers which are always active.
+ * @param max - Maximum number of workers that can be created by this pool.
+ * @param filePath - Path to an implementation of a `ClusterWorker` file, which can be relative or absolute.
+ * @param opts - Options for this dynamic cluster pool.
*/
public constructor (
min: number,
- public readonly max: number,
- filename: string,
- opts: ClusterPoolOptions = { maxTasks: 1000 }
+ max: number,
+ filePath: string,
+ opts: ClusterPoolOptions = {}
) {
- super(min, filename, opts)
+ super(min, filePath, opts, max)
+ checkDynamicPoolSize(
+ this.minimumNumberOfWorkers,
+ this.maximumNumberOfWorkers
+ )
}
- protected chooseWorker (): Worker {
- let worker: Worker | undefined
- for (const entry of this.tasks) {
- if (entry[1] === 0) {
- worker = entry[0]
- break
- }
- }
+ /** @inheritDoc */
+ protected shallCreateDynamicWorker (): boolean {
+ return (
+ (!this.full && this.internalBusy()) ||
+ (this.minimumNumberOfWorkers === 0 && this.workerNodes.length === 0)
+ )
+ }
- if (worker) {
- // a worker is free, use it
- return worker
- } else {
- if (this.workers.length === this.max) {
- this.emitter.emit('FullPool')
- return super.chooseWorker()
- }
- // all workers are busy create a new worker
- const worker = this.internalNewWorker()
- worker.on('message', (message: MessageValue<Data>) => {
- if (message.kill) {
- this.sendToWorker(worker, { kill: 1 })
- void this.destroyWorker(worker)
- // clean workers from data structures
- const workerIndex = this.workers.indexOf(worker)
- this.workers.splice(workerIndex, 1)
- this.tasks.delete(worker)
- }
- })
- return worker
+ /** @inheritDoc */
+ protected checkAndEmitDynamicWorkerCreationEvents (): void {
+ if (this.full) {
+ this.emitter?.emit(PoolEvents.full, this.info)
}
}
+
+ /** @inheritDoc */
+ protected get type (): PoolType {
+ return PoolTypes.dynamic
+ }
+
+ /** @inheritDoc */
+ protected get busy (): boolean {
+ return this.full && this.internalBusy()
+ }
}