-import type { IPoolInternal } from '../pool-internal'
-import type { IPoolWorker } from '../pool-worker'
+import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils'
+import type { IPool } from '../pool'
+import type { IWorker } from '../worker'
import { FairShareWorkerChoiceStrategy } from './fair-share-worker-choice-strategy'
import { LessBusyWorkerChoiceStrategy } from './less-busy-worker-choice-strategy'
import { LessUsedWorkerChoiceStrategy } from './less-used-worker-choice-strategy'
import type {
IWorkerChoiceStrategy,
RequiredStatistics,
- WorkerChoiceStrategy
+ WorkerChoiceStrategy,
+ WorkerChoiceStrategyOptions
} from './selection-strategies-types'
import { WorkerChoiceStrategies } from './selection-strategies-types'
import { WeightedRoundRobinWorkerChoiceStrategy } from './weighted-round-robin-worker-choice-strategy'
*
* @typeParam Worker - Type of worker.
* @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam Response - Type of response of execution. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
*/
export class WorkerChoiceStrategyContext<
- Worker extends IPoolWorker,
+ Worker extends IWorker,
Data = unknown,
Response = unknown
> {
private readonly workerChoiceStrategies: Map<
WorkerChoiceStrategy,
- IWorkerChoiceStrategy<Worker, Data, Response>
+ IWorkerChoiceStrategy
>
/**
* Worker choice strategy context constructor.
*
* @param pool - The pool instance.
- * @param createWorkerCallback - The worker creation callback for dynamic pool.
* @param workerChoiceStrategy - The worker choice strategy.
+ * @param opts - The worker choice strategy options.
*/
public constructor (
- pool: IPoolInternal<Worker, Data, Response>,
- private readonly createWorkerCallback: () => number,
- private workerChoiceStrategyType: WorkerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN
+ pool: IPool<Worker, Data, Response>,
+ private workerChoiceStrategy: WorkerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN,
+ opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
) {
- this.execute.bind(this)
+ this.execute = this.execute.bind(this)
this.workerChoiceStrategies = new Map<
WorkerChoiceStrategy,
- IWorkerChoiceStrategy<Worker, Data, Response>
+ IWorkerChoiceStrategy
>([
[
WorkerChoiceStrategies.ROUND_ROBIN,
- new RoundRobinWorkerChoiceStrategy<Worker, Data, Response>(pool)
+ new (RoundRobinWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
+ pool,
+ opts
+ )
],
[
WorkerChoiceStrategies.LESS_USED,
- new LessUsedWorkerChoiceStrategy<Worker, Data, Response>(pool)
+ new (LessUsedWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
+ pool,
+ opts
+ )
],
[
WorkerChoiceStrategies.LESS_BUSY,
- new LessBusyWorkerChoiceStrategy<Worker, Data, Response>(pool)
+ new (LessBusyWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
+ pool,
+ opts
+ )
],
[
WorkerChoiceStrategies.FAIR_SHARE,
- new FairShareWorkerChoiceStrategy<Worker, Data, Response>(pool)
+ new (FairShareWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
+ pool,
+ opts
+ )
],
[
WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN,
- new WeightedRoundRobinWorkerChoiceStrategy<Worker, Data, Response>(pool)
+ new (WeightedRoundRobinWorkerChoiceStrategy.bind(this))<
+ Worker,
+ Data,
+ Response
+ >(pool, opts)
]
])
}
public getRequiredStatistics (): RequiredStatistics {
return (
this.workerChoiceStrategies.get(
- this.workerChoiceStrategyType
- ) as IWorkerChoiceStrategy<Worker, Data, Response>
+ this.workerChoiceStrategy
+ ) as IWorkerChoiceStrategy
).requiredStatistics
}
public setWorkerChoiceStrategy (
workerChoiceStrategy: WorkerChoiceStrategy
): void {
- if (this.workerChoiceStrategyType === workerChoiceStrategy) {
- this.workerChoiceStrategies.get(workerChoiceStrategy)?.reset()
- } else {
- this.workerChoiceStrategyType = workerChoiceStrategy
+ if (this.workerChoiceStrategy !== workerChoiceStrategy) {
+ this.workerChoiceStrategy = workerChoiceStrategy
}
+ this.workerChoiceStrategies.get(this.workerChoiceStrategy)?.reset()
+ }
+
+ /**
+ * Updates the worker node key in the worker choice strategy internals in the context.
+ *
+ * @returns `true` if the update is successful, `false` otherwise.
+ */
+ public update (workerNodeKey: number): boolean {
+ return (
+ this.workerChoiceStrategies.get(
+ this.workerChoiceStrategy
+ ) as IWorkerChoiceStrategy
+ ).update(workerNodeKey)
}
/**
* Executes the worker choice strategy algorithm in the context.
*
- * @returns The key of the chosen one.
+ * @returns The key of the worker node.
+ * @throws {@link https://nodejs.org/api/errors.html#class-error} If the worker node key is null or undefined.
*/
public execute (): number {
- const workerChoiceStrategy = this.workerChoiceStrategies.get(
- this.workerChoiceStrategyType
- ) as IWorkerChoiceStrategy<Worker, Data, Response>
- if (
- workerChoiceStrategy.isDynamicPool &&
- !workerChoiceStrategy.pool.full &&
- workerChoiceStrategy.pool.findFreeWorkerKey() === -1
- ) {
- return this.createWorkerCallback()
+ const workerNodeKey = (
+ this.workerChoiceStrategies.get(
+ this.workerChoiceStrategy
+ ) as IWorkerChoiceStrategy
+ ).choose()
+ if (workerNodeKey == null) {
+ throw new Error('Worker node key chosen is null or undefined')
}
- return workerChoiceStrategy.choose()
+ return workerNodeKey
}
/**
- * Removes a worker from the worker choice strategy in the context.
+ * Removes the worker node key from the worker choice strategy in the context.
*
- * @param workerKey - The key of the worker to remove.
+ * @param workerNodeKey - The key of the worker node.
* @returns `true` if the removal is successful, `false` otherwise.
*/
- public remove (workerKey: number): boolean {
+ public remove (workerNodeKey: number): boolean {
return (
this.workerChoiceStrategies.get(
- this.workerChoiceStrategyType
- ) as IWorkerChoiceStrategy<Worker, Data, Response>
- ).remove(workerKey)
+ this.workerChoiceStrategy
+ ) as IWorkerChoiceStrategy
+ ).remove(workerNodeKey)
+ }
+
+ /**
+ * Sets the worker choice strategies in the context options.
+ *
+ * @param opts - The worker choice strategy options.
+ */
+ public setOptions (opts: WorkerChoiceStrategyOptions): void {
+ for (const workerChoiceStrategy of this.workerChoiceStrategies.values()) {
+ workerChoiceStrategy.setOptions(opts)
+ }
}
}
repositories / poolifier.git / blobdiff