2 DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS
,
3 buildWorkerChoiceStrategyOptions
4 } from
'../../utils.js'
5 import type { IPool
} from
'../pool.js'
6 import type { IWorker
} from
'../worker.js'
9 MeasurementStatisticsRequirements
,
11 TaskStatisticsRequirements
,
12 WorkerChoiceStrategyOptions
13 } from
'./selection-strategies-types.js'
16 * Worker choice strategy abstract base class.
18 * @typeParam Worker - Type of worker which manages the strategy.
19 * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
20 * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
22 export abstract class AbstractWorkerChoiceStrategy
<
23 Worker
extends IWorker
,
26 > implements IWorkerChoiceStrategy
{
28 * The next worker node key.
30 protected nextWorkerNodeKey
: number | undefined = 0
33 * The previous worker node key.
35 protected previousWorkerNodeKey
: number = 0
38 public readonly strategyPolicy
: StrategyPolicy
= {
39 dynamicWorkerUsage
: false,
40 dynamicWorkerReady
: true
44 public readonly taskStatisticsRequirements
: TaskStatisticsRequirements
= {
45 runTime
: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS
,
46 waitTime
: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS
,
47 elu
: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS
51 * Constructs a worker choice strategy bound to the pool.
53 * @param pool - The pool instance.
54 * @param opts - The worker choice strategy options.
57 protected readonly pool
: IPool
<Worker
, Data
, Response
>,
58 protected opts
?: WorkerChoiceStrategyOptions
60 this.opts
= buildWorkerChoiceStrategyOptions
<Worker
, Data
, Response
>(
64 this.setTaskStatisticsRequirements(this.opts
)
65 this.choose
= this.choose
.bind(this)
68 protected setTaskStatisticsRequirements (
69 opts
: WorkerChoiceStrategyOptions
| undefined
71 this.toggleMedianMeasurementStatisticsRequirements(
72 this.taskStatisticsRequirements
.runTime
,
73 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
76 this.toggleMedianMeasurementStatisticsRequirements(
77 this.taskStatisticsRequirements
.waitTime
,
78 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
79 opts
!.waitTime
!.median
81 this.toggleMedianMeasurementStatisticsRequirements(
82 this.taskStatisticsRequirements
.elu
,
83 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
88 private toggleMedianMeasurementStatisticsRequirements (
89 measurementStatisticsRequirements
: MeasurementStatisticsRequirements
,
92 if (measurementStatisticsRequirements
.average
&& toggleMedian
) {
93 measurementStatisticsRequirements
.average
= false
94 measurementStatisticsRequirements
.median
= toggleMedian
96 if (measurementStatisticsRequirements
.median
&& !toggleMedian
) {
97 measurementStatisticsRequirements
.average
= true
98 measurementStatisticsRequirements
.median
= toggleMedian
102 protected resetWorkerNodeKeyProperties (): void {
103 this.nextWorkerNodeKey
= 0
104 this.previousWorkerNodeKey
= 0
108 public abstract reset (): boolean
111 public abstract update (workerNodeKey
: number): boolean
114 public abstract choose (): number | undefined
117 public abstract remove (workerNodeKey
: number): boolean
120 public setOptions (opts
: WorkerChoiceStrategyOptions
| undefined): void {
121 this.opts
= buildWorkerChoiceStrategyOptions
<Worker
, Data
, Response
>(
125 this.setTaskStatisticsRequirements(this.opts
)
129 public hasPoolWorkerNodesReady (): boolean {
130 return this.pool
.workerNodes
.some(workerNode
=> workerNode
.info
.ready
)
134 * Whether the worker node is ready or not.
136 * @param workerNodeKey - The worker node key.
137 * @returns Whether the worker node is ready or not.
139 protected isWorkerNodeReady (workerNodeKey
: number): boolean {
140 return this.pool
.workerNodes
[workerNodeKey
]?.info
?.ready
?? false
144 * Check the next worker node readiness.
146 protected checkNextWorkerNodeReadiness (): void {
147 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
148 if (!this.isWorkerNodeReady(this.nextWorkerNodeKey
!)) {
149 delete this.nextWorkerNodeKey
154 * Gets the worker node task runtime.
155 * If the task statistics require the average runtime, the average runtime is returned.
156 * If the task statistics require the median runtime , the median runtime is returned.
158 * @param workerNodeKey - The worker node key.
159 * @returns The worker node task runtime.
161 protected getWorkerNodeTaskRunTime (workerNodeKey
: number): number {
162 return this.taskStatisticsRequirements
.runTime
.median
163 ? this.pool
.workerNodes
[workerNodeKey
].usage
.runTime
.median
?? 0
164 : this.pool
.workerNodes
[workerNodeKey
].usage
.runTime
.average
?? 0
168 * Gets the worker node task wait time.
169 * If the task statistics require the average wait time, the average wait time is returned.
170 * If the task statistics require the median wait time, the median wait time is returned.
172 * @param workerNodeKey - The worker node key.
173 * @returns The worker node task wait time.
175 protected getWorkerNodeTaskWaitTime (workerNodeKey
: number): number {
176 return this.taskStatisticsRequirements
.waitTime
.median
177 ? this.pool
.workerNodes
[workerNodeKey
].usage
.waitTime
.median
?? 0
178 : this.pool
.workerNodes
[workerNodeKey
].usage
.waitTime
.average
?? 0
182 * Gets the worker node task ELU.
183 * If the task statistics require the average ELU, the average ELU is returned.
184 * If the task statistics require the median ELU, the median ELU is returned.
186 * @param workerNodeKey - The worker node key.
187 * @returns The worker node task ELU.
189 protected getWorkerNodeTaskElu (workerNodeKey
: number): number {
190 return this.taskStatisticsRequirements
.elu
.median
191 ? this.pool
.workerNodes
[workerNodeKey
].usage
.elu
.active
.median
?? 0
192 : this.pool
.workerNodes
[workerNodeKey
].usage
.elu
.active
.average
?? 0
196 * Sets safely the previous worker node key.
198 * @param workerNodeKey - The worker node key.
200 protected setPreviousWorkerNodeKey (workerNodeKey
: number | undefined): void {
201 this.previousWorkerNodeKey
= workerNodeKey
?? this.previousWorkerNodeKey