-import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils'
+import { buildInternalWorkerChoiceStrategyOptions } from '../../utils'
import type { IPool } from '../pool'
import type { IWorker } from '../worker'
import { FairShareWorkerChoiceStrategy } from './fair-share-worker-choice-strategy'
import { InterleavedWeightedRoundRobinWorkerChoiceStrategy } from './interleaved-weighted-round-robin-worker-choice-strategy'
-import { LessBusyWorkerChoiceStrategy } from './less-busy-worker-choice-strategy'
-import { LessUsedWorkerChoiceStrategy } from './less-used-worker-choice-strategy'
+import { LeastBusyWorkerChoiceStrategy } from './least-busy-worker-choice-strategy'
+import { LeastUsedWorkerChoiceStrategy } from './least-used-worker-choice-strategy'
+import { LeastEluWorkerChoiceStrategy } from './least-elu-worker-choice-strategy'
import { RoundRobinWorkerChoiceStrategy } from './round-robin-worker-choice-strategy'
import type {
IWorkerChoiceStrategy,
- RequiredStatistics,
- WorkerChoiceStrategy,
- WorkerChoiceStrategyOptions
+ InternalWorkerChoiceStrategyOptions,
+ StrategyPolicy,
+ TaskStatisticsRequirements,
+ WorkerChoiceStrategy
} from './selection-strategies-types'
import { WorkerChoiceStrategies } from './selection-strategies-types'
import { WeightedRoundRobinWorkerChoiceStrategy } from './weighted-round-robin-worker-choice-strategy'
* The worker choice strategy context.
*
* @typeParam Worker - Type of worker.
- * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam Response - Type of execution response. This can only be serializable data.
+ * @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.
*/
export class WorkerChoiceStrategyContext<
Worker extends IWorker,
public constructor (
pool: IPool<Worker, Data, Response>,
private workerChoiceStrategy: WorkerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN,
- opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+ private opts?: InternalWorkerChoiceStrategyOptions
) {
+ this.opts = buildInternalWorkerChoiceStrategyOptions(
+ pool.info.maxSize,
+ this.opts
+ )
this.execute = this.execute.bind(this)
this.workerChoiceStrategies = new Map<
WorkerChoiceStrategy,
WorkerChoiceStrategies.ROUND_ROBIN,
new (RoundRobinWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
pool,
- opts
+ this.opts
+ )
+ ],
+ [
+ WorkerChoiceStrategies.LEAST_USED,
+ new (LeastUsedWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
+ pool,
+ this.opts
)
],
[
- WorkerChoiceStrategies.LESS_USED,
- new (LessUsedWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
+ WorkerChoiceStrategies.LEAST_BUSY,
+ new (LeastBusyWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
pool,
- opts
+ this.opts
)
],
[
- WorkerChoiceStrategies.LESS_BUSY,
- new (LessBusyWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
+ WorkerChoiceStrategies.LEAST_ELU,
+ new (LeastEluWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
pool,
- opts
+ this.opts
)
],
[
WorkerChoiceStrategies.FAIR_SHARE,
new (FairShareWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
pool,
- opts
+ this.opts
)
],
[
Worker,
Data,
Response
- >(pool, opts)
+ >(pool, this.opts)
],
[
WorkerChoiceStrategies.INTERLEAVED_WEIGHTED_ROUND_ROBIN,
Worker,
Data,
Response
- >(pool, opts)
+ >(pool, this.opts)
]
])
}
/**
- * Gets the worker choice strategy in the context required statistics.
+ * Gets the strategy policy in the context.
*
- * @returns The required statistics.
+ * @returns The strategy policy.
*/
- public getRequiredStatistics (): RequiredStatistics {
+ public getStrategyPolicy (): StrategyPolicy {
return (
this.workerChoiceStrategies.get(
this.workerChoiceStrategy
) as IWorkerChoiceStrategy
- ).requiredStatistics
+ ).strategyPolicy
+ }
+
+ /**
+ * Gets the worker choice strategy in the context task statistics requirements.
+ *
+ * @returns The task statistics requirements.
+ */
+ public getTaskStatisticsRequirements (): TaskStatisticsRequirements {
+ return (
+ this.workerChoiceStrategies.get(
+ this.workerChoiceStrategy
+ ) as IWorkerChoiceStrategy
+ ).taskStatisticsRequirements
}
/**
}
/**
- * Updates the worker node key in the worker choice strategy internals in the context.
+ * Updates the worker node key in the worker choice strategy in the context internals.
*
* @returns `true` if the update is successful, `false` otherwise.
*/
}
/**
- * Executes the worker choice strategy algorithm in the context.
+ * Executes the worker choice strategy in the context algorithm.
*
* @returns The key of the worker node.
- * @throws {@link Error} If the worker node key is null or undefined.
+ * @throws {@link https://nodejs.org/api/errors.html#class-error} If after configured retries the worker node key is null or undefined.
*/
public execute (): number {
- const workerNodeKey = (
- this.workerChoiceStrategies.get(
- this.workerChoiceStrategy
- ) as IWorkerChoiceStrategy
- ).choose()
+ const workerChoiceStrategy = this.workerChoiceStrategies.get(
+ this.workerChoiceStrategy
+ ) as IWorkerChoiceStrategy
+ if (!workerChoiceStrategy.hasPoolWorkerNodesReady()) {
+ return this.execute()
+ }
+ return this.executeStrategy(workerChoiceStrategy)
+ }
+
+ /**
+ * Executes the given worker choice strategy.
+ *
+ * @param workerChoiceStrategy - The worker choice strategy.
+ * @returns The key of the worker node.
+ * @throws {@link https://nodejs.org/api/errors.html#class-error} If after configured retries the worker node key is null or undefined.
+ */
+ private executeStrategy (workerChoiceStrategy: IWorkerChoiceStrategy): number {
+ let workerNodeKey: number | undefined
+ let chooseCount = 0
+ let retriesCount = 0
+ do {
+ workerNodeKey = workerChoiceStrategy.choose()
+ if (workerNodeKey == null && chooseCount > 0) {
+ retriesCount++
+ }
+ chooseCount++
+ } while (
+ workerNodeKey == null &&
+ retriesCount < (this.opts?.retries as number)
+ )
if (workerNodeKey == null) {
- throw new Error('Worker node key chosen is null or undefined')
+ throw new Error(
+ `Worker node key chosen is null or undefined after ${retriesCount} retries`
+ )
}
return workerNodeKey
}
/**
* Removes the worker node key from the worker choice strategy in the context.
*
- * @param workerNodeKey - The key of the worker node.
+ * @param workerNodeKey - The worker node key.
* @returns `true` if the removal is successful, `false` otherwise.
*/
public remove (workerNodeKey: number): boolean {
/**
* Sets the worker choice strategies in the context options.
*
+ * @param pool - The pool instance.
* @param opts - The worker choice strategy options.
*/
- public setOptions (opts: WorkerChoiceStrategyOptions): void {
- this.workerChoiceStrategies.forEach(workerChoiceStrategy => {
- workerChoiceStrategy.setOptions(opts)
- })
+ public setOptions (
+ pool: IPool<Worker, Data, Response>,
+ opts?: InternalWorkerChoiceStrategyOptions
+ ): void {
+ this.opts = buildInternalWorkerChoiceStrategyOptions(
+ pool.info.maxSize,
+ opts
+ )
+ for (const workerChoiceStrategy of this.workerChoiceStrategies.values()) {
+ workerChoiceStrategy.setOptions(this.opts)
+ }
}
}
repositories / poolifier.git / blobdiff