-
-
Notifications
You must be signed in to change notification settings - Fork 13
/
worker-choice-strategy-context.ts
230 lines (221 loc) · 7.27 KB
/
worker-choice-strategy-context.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
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 { InterleavedWeightedRoundRobinWorkerChoiceStrategy } from './interleaved-weighted-round-robin-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,
StrategyPolicy,
TaskStatisticsRequirements,
WorkerChoiceStrategy,
WorkerChoiceStrategyOptions
} 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 structured-cloneable data.
* @typeParam Response - Type of execution response. This can only be structured-cloneable data.
*/
export class WorkerChoiceStrategyContext<
Worker extends IWorker,
Data = unknown,
Response = unknown
> {
private readonly workerChoiceStrategies: Map<
WorkerChoiceStrategy,
IWorkerChoiceStrategy
>
/**
* Worker choice strategy context constructor.
*
* @param pool - The pool instance.
* @param workerChoiceStrategy - The worker choice strategy.
* @param opts - The worker choice strategy options.
*/
public constructor (
pool: IPool<Worker, Data, Response>,
private workerChoiceStrategy: WorkerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN,
private opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
) {
this.opts = { ...DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS, ...opts }
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)
]
])
}
/**
* Gets the strategy policy in the context.
*
* @returns The strategy policy.
*/
public getStrategyPolicy (): StrategyPolicy {
return (
this.workerChoiceStrategies.get(
this.workerChoiceStrategy
) as IWorkerChoiceStrategy
).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
}
/**
* Sets the worker choice strategy to use in the context.
*
* @param workerChoiceStrategy - The worker choice strategy to set.
*/
public setWorkerChoiceStrategy (
workerChoiceStrategy: WorkerChoiceStrategy
): void {
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 {
return (
this.workerChoiceStrategies.get(
this.workerChoiceStrategy
) as IWorkerChoiceStrategy
).update(workerNodeKey)
}
/**
* Executes the worker choice strategy in the context algorithm.
*
* @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.
* @throws {@link https://nodejs.org/api/errors.html#class-rangeerror} If the maximum consecutive worker choice strategy executions has been reached.
*/
public execute (): number {
const workerChoiceStrategy = this.workerChoiceStrategies.get(
this.workerChoiceStrategy
) as IWorkerChoiceStrategy
let workerNodeKey: number | undefined
const maxExecutionCount = 10000
let executionCount = 0
let chooseCount = 0
let retriesCount = 0
do {
if (workerChoiceStrategy.hasPoolWorkerNodesReady()) {
workerNodeKey = workerChoiceStrategy.choose()
if (chooseCount > 0) {
retriesCount++
}
chooseCount++
}
executionCount++
} while (
executionCount < maxExecutionCount &&
(!workerChoiceStrategy.hasPoolWorkerNodesReady() ||
(workerNodeKey == null && retriesCount < (this.opts.retries as number)))
)
if (executionCount >= maxExecutionCount) {
throw new RangeError(
`Worker choice strategy consecutive executions has exceeded the maximum of ${maxExecutionCount}`
)
}
if (workerNodeKey == null) {
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 worker node key.
* @returns `true` if the removal is successful, `false` otherwise.
*/
public remove (workerNodeKey: number): boolean {
return (
this.workerChoiceStrategies.get(
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 {
this.opts = { ...DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS, ...opts }
for (const workerChoiceStrategy of this.workerChoiceStrategies.values()) {
workerChoiceStrategy.setOptions(opts)
}
}
}