-import type { IPoolInternal } from '../pool-internal'
-import type { IPoolWorker } from '../pool-worker'
+import type { IPool } from '../pool.js'
+import { getWorkerChoiceStrategyRetries } from '../utils.js'
+import type { IWorker } from '../worker.js'
+import { FairShareWorkerChoiceStrategy } from './fair-share-worker-choice-strategy.js'
+import { InterleavedWeightedRoundRobinWorkerChoiceStrategy } from './interleaved-weighted-round-robin-worker-choice-strategy.js'
+import { LeastBusyWorkerChoiceStrategy } from './least-busy-worker-choice-strategy.js'
+import { LeastEluWorkerChoiceStrategy } from './least-elu-worker-choice-strategy.js'
+import { LeastUsedWorkerChoiceStrategy } from './least-used-worker-choice-strategy.js'
+import { RoundRobinWorkerChoiceStrategy } from './round-robin-worker-choice-strategy.js'
import type {
IWorkerChoiceStrategy,
- RequiredStatistics,
- WorkerChoiceStrategy
-} from './selection-strategies-types'
-import { WorkerChoiceStrategies } from './selection-strategies-types'
-import { getWorkerChoiceStrategy } from './selection-strategies-utils'
+ StrategyPolicy,
+ TaskStatisticsRequirements,
+ WorkerChoiceStrategy,
+ WorkerChoiceStrategyOptions
+} from './selection-strategies-types.js'
+import { WorkerChoiceStrategies } from './selection-strategies-types.js'
+import { WeightedRoundRobinWorkerChoiceStrategy } from './weighted-round-robin-worker-choice-strategy.js'
/**
* 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 response of execution. 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 IPoolWorker,
- Data,
- Response
+ Worker extends IWorker,
+ Data = unknown,
+ Response = unknown
> {
- private workerChoiceStrategy: IWorkerChoiceStrategy<Worker, Data, Response>
+ /**
+ * The number of worker choice strategy execution retries.
+ */
+ public retriesCount: number
+
+ /**
+ * The worker choice strategy instances registered in the context.
+ */
+ private readonly workerChoiceStrategies: Map<
+ WorkerChoiceStrategy,
+ IWorkerChoiceStrategy
+ >
+
+ /**
+ * The maximum number of worker choice strategy execution retries.
+ */
+ private readonly retries: number
/**
* 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,
- workerChoiceStrategy: WorkerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN
+ pool: IPool<Worker, Data, Response>,
+ private workerChoiceStrategy: WorkerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN,
+ opts?: WorkerChoiceStrategyOptions
) {
- this.execute.bind(this)
- this.workerChoiceStrategy = getWorkerChoiceStrategy<Worker, Data, Response>(
- pool,
- workerChoiceStrategy
- )
+ this.execute = this.execute.bind(this)
+ this.workerChoiceStrategies = new Map<
+ WorkerChoiceStrategy,
+ IWorkerChoiceStrategy
+ >([
+ [
+ WorkerChoiceStrategies.ROUND_ROBIN,
+ new (RoundRobinWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
+ pool,
+ opts
+ )
+ ],
+ [
+ WorkerChoiceStrategies.LEAST_USED,
+ new (LeastUsedWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
+ pool,
+ opts
+ )
+ ],
+ [
+ WorkerChoiceStrategies.LEAST_BUSY,
+ new (LeastBusyWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
+ pool,
+ opts
+ )
+ ],
+ [
+ WorkerChoiceStrategies.LEAST_ELU,
+ new (LeastEluWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
+ pool,
+ opts
+ )
+ ],
+ [
+ WorkerChoiceStrategies.FAIR_SHARE,
+ new (FairShareWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
+ pool,
+ opts
+ )
+ ],
+ [
+ WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN,
+ new (WeightedRoundRobinWorkerChoiceStrategy.bind(this))<
+ Worker,
+ Data,
+ Response
+ >(pool, opts)
+ ],
+ [
+ WorkerChoiceStrategies.INTERLEAVED_WEIGHTED_ROUND_ROBIN,
+ new (InterleavedWeightedRoundRobinWorkerChoiceStrategy.bind(this))<
+ Worker,
+ Data,
+ Response
+ >(pool, opts)
+ ]
+ ])
+ this.retriesCount = 0
+ this.retries = getWorkerChoiceStrategyRetries(pool, opts)
}
/**
- * Gets the worker choice strategy required statistics.
+ * Gets the strategy policy in the context.
*
- * @returns The required statistics.
+ * @returns The strategy policy.
*/
- public getRequiredStatistics (): RequiredStatistics {
- return this.workerChoiceStrategy.requiredStatistics
+ public getStrategyPolicy (): StrategyPolicy {
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ return this.workerChoiceStrategies.get(this.workerChoiceStrategy)!
+ .strategyPolicy
+ }
+
+ /**
+ * Gets the worker choice strategy in the context task statistics requirements.
+ *
+ * @returns The task statistics requirements.
+ */
+ public getTaskStatisticsRequirements (): TaskStatisticsRequirements {
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ return this.workerChoiceStrategies.get(this.workerChoiceStrategy)!
+ .taskStatisticsRequirements
}
/**
* @param workerChoiceStrategy - The worker choice strategy to set.
*/
public setWorkerChoiceStrategy (
- pool: IPoolInternal<Worker, Data, Response>,
workerChoiceStrategy: WorkerChoiceStrategy
): void {
- this.workerChoiceStrategy?.reset()
- this.workerChoiceStrategy = getWorkerChoiceStrategy<Worker, Data, Response>(
- pool,
- workerChoiceStrategy
- )
+ if (this.workerChoiceStrategy !== workerChoiceStrategy) {
+ this.workerChoiceStrategy = workerChoiceStrategy
+ }
+ this.workerChoiceStrategies.get(this.workerChoiceStrategy)?.reset()
+ }
+
+ /**
+ * Updates the worker node key in the worker choice strategy in the context internals.
+ *
+ * @returns `true` if the update is successful, `false` otherwise.
+ */
+ public update (workerNodeKey: number): boolean {
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ return this.workerChoiceStrategies
+ .get(this.workerChoiceStrategy)!
+ .update(workerNodeKey)
}
/**
- * Chooses a worker with the worker choice strategy.
+ * Executes the worker choice strategy in the context algorithm.
*
- * @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 after computed retries the worker node key is null or undefined.
*/
public execute (): number {
- if (
- this.workerChoiceStrategy.isDynamicPool &&
- !this.workerChoiceStrategy.pool.full &&
- this.workerChoiceStrategy.pool.findFreeWorkerKey() === -1
- ) {
- return this.createWorkerCallback()
+ return this.executeStrategy(
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.workerChoiceStrategies.get(this.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 computed 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
+ ++this.retriesCount
+ }
+ ++chooseCount
+ } while (workerNodeKey == null && retriesCount < this.retries)
+ if (workerNodeKey == null) {
+ throw new Error(
+ `Worker node key chosen is null or undefined after ${retriesCount} retries`
+ )
}
- return this.workerChoiceStrategy.choose()
+ return workerNodeKey
}
/**
- * Removes a worker in the worker choice strategy internals.
+ * 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 worker node key.
* @returns `true` if the removal is successful, `false` otherwise.
*/
- public remove (workerKey: number): boolean {
- return this.workerChoiceStrategy.remove(workerKey)
+ public remove (workerNodeKey: number): boolean {
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ return this.workerChoiceStrategies
+ .get(this.workerChoiceStrategy)!
+ .remove(workerNodeKey)
+ }
+
+ /**
+ * Sets the worker choice strategies in the context options.
+ *
+ * @param opts - The worker choice strategy options.
+ */
+ public setOptions (opts: WorkerChoiceStrategyOptions | undefined): void {
+ for (const workerChoiceStrategy of this.workerChoiceStrategies.values()) {
+ workerChoiceStrategy.setOptions(opts)
+ }
}
}
repositories / poolifier.git / blobdiff