-
-
Notifications
You must be signed in to change notification settings - Fork 13
/
worker-choice-strategies-context.ts
280 lines (262 loc) · 9.11 KB
/
worker-choice-strategies-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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
import type { IPool } from '../pool.js'
import type { IWorker } from '../worker.js'
import type {
IWorkerChoiceStrategy,
StrategyPolicy,
TaskStatisticsRequirements,
WorkerChoiceStrategy,
WorkerChoiceStrategyOptions
} from './selection-strategies-types.js'
import { WorkerChoiceStrategies } from './selection-strategies-types.js'
import {
buildWorkerChoiceStrategiesPolicy,
buildWorkerChoiceStrategiesTaskStatisticsRequirements,
getWorkerChoiceStrategiesRetries,
getWorkerChoiceStrategy
} from './selection-strategies-utils.js'
/**
* The worker choice strategies 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 WorkerChoiceStrategiesContext<
Worker extends IWorker,
Data = unknown,
Response = unknown
> {
/**
* The number of worker choice strategies execution retries.
*/
public retriesCount: number
/**
* The default worker choice strategy in the context.
*/
private defaultWorkerChoiceStrategy: WorkerChoiceStrategy
/**
* The worker choice strategies registered in the context.
*/
private readonly workerChoiceStrategies: Map<
WorkerChoiceStrategy,
IWorkerChoiceStrategy
>
/**
* The active worker choice strategies in the context policy.
*/
private workerChoiceStrategiesPolicy: StrategyPolicy
/**
* The active worker choice strategies in the context task statistics requirements.
*/
private workerChoiceStrategiesTaskStatisticsRequirements: TaskStatisticsRequirements
/**
* The maximum number of worker choice strategies execution retries.
*/
private readonly retries: number
/**
* Worker choice strategies context constructor.
*
* @param pool - The pool instance.
* @param workerChoiceStrategies - The worker choice strategies. @defaultValue [WorkerChoiceStrategies.ROUND_ROBIN]
* @param opts - The worker choice strategy options.
*/
public constructor (
private readonly pool: IPool<Worker, Data, Response>,
workerChoiceStrategies: WorkerChoiceStrategy[] = [
WorkerChoiceStrategies.ROUND_ROBIN
],
opts?: WorkerChoiceStrategyOptions
) {
this.execute = this.execute.bind(this)
this.defaultWorkerChoiceStrategy = workerChoiceStrategies[0]
this.workerChoiceStrategies = new Map<
WorkerChoiceStrategy,
IWorkerChoiceStrategy
>()
for (const workerChoiceStrategy of workerChoiceStrategies) {
this.addWorkerChoiceStrategy(workerChoiceStrategy, this.pool, opts)
}
this.workerChoiceStrategiesPolicy = buildWorkerChoiceStrategiesPolicy(
this.workerChoiceStrategies
)
this.workerChoiceStrategiesTaskStatisticsRequirements =
buildWorkerChoiceStrategiesTaskStatisticsRequirements(
this.workerChoiceStrategies
)
this.retriesCount = 0
this.retries = getWorkerChoiceStrategiesRetries<Worker, Data, Response>(
this.pool,
opts
)
}
/**
* Gets the active worker choice strategies in the context policy.
*
* @returns The strategies policy.
*/
public getPolicy (): StrategyPolicy {
return this.workerChoiceStrategiesPolicy
}
/**
* Gets the active worker choice strategies in the context task statistics requirements.
*
* @returns The strategies task statistics requirements.
*/
public getTaskStatisticsRequirements (): TaskStatisticsRequirements {
return this.workerChoiceStrategiesTaskStatisticsRequirements
}
/**
* Sets the default worker choice strategy to use in the context.
*
* @param workerChoiceStrategy - The default worker choice strategy to set.
* @param opts - The worker choice strategy options.
*/
public setDefaultWorkerChoiceStrategy (
workerChoiceStrategy: WorkerChoiceStrategy,
opts?: WorkerChoiceStrategyOptions
): void {
if (workerChoiceStrategy !== this.defaultWorkerChoiceStrategy) {
this.defaultWorkerChoiceStrategy = workerChoiceStrategy
this.addWorkerChoiceStrategy(workerChoiceStrategy, this.pool, opts)
}
}
/**
* Updates the worker node key in the active worker choice strategies in the context internals.
*
* @returns `true` if the update is successful, `false` otherwise.
*/
public update (workerNodeKey: number): boolean {
return Array.from(
this.workerChoiceStrategies,
([_, workerChoiceStrategy]) => workerChoiceStrategy.update(workerNodeKey)
).every(r => r)
}
/**
* Executes the given worker choice strategy in the context algorithm.
*
* @param workerChoiceStrategy - The worker choice strategy algorithm to execute. @defaultValue this.defaultWorkerChoiceStrategy
* @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 (
workerChoiceStrategy: WorkerChoiceStrategy = this
.defaultWorkerChoiceStrategy
): number {
return this.executeStrategy(
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
this.workerChoiceStrategies.get(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 workerNodeKey
}
/**
* Removes the worker node key from the active worker choice strategies in the context.
*
* @param workerNodeKey - The worker node key.
* @returns `true` if the removal is successful, `false` otherwise.
*/
public remove (workerNodeKey: number): boolean {
return Array.from(
this.workerChoiceStrategies,
([_, workerChoiceStrategy]) => workerChoiceStrategy.remove(workerNodeKey)
).every(r => r)
}
/**
* Sets the active 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)
}
}
/**
* Synchronizes the active worker choice strategies in the context with the given worker choice strategies.
*
* @param workerChoiceStrategies - The worker choice strategies to synchronize.
* @param opts - The worker choice strategy options.
*/
public syncWorkerChoiceStrategies (
workerChoiceStrategies: Set<WorkerChoiceStrategy>,
opts?: WorkerChoiceStrategyOptions
): void {
for (const workerChoiceStrategy of this.workerChoiceStrategies.keys()) {
if (!workerChoiceStrategies.has(workerChoiceStrategy)) {
this.removeWorkerChoiceStrategy(workerChoiceStrategy)
}
}
for (const workerChoiceStrategy of workerChoiceStrategies) {
if (!this.workerChoiceStrategies.has(workerChoiceStrategy)) {
this.addWorkerChoiceStrategy(workerChoiceStrategy, this.pool, opts)
}
}
this.workerChoiceStrategiesPolicy = buildWorkerChoiceStrategiesPolicy(
this.workerChoiceStrategies
)
this.workerChoiceStrategiesTaskStatisticsRequirements =
buildWorkerChoiceStrategiesTaskStatisticsRequirements(
this.workerChoiceStrategies
)
}
/**
* Adds a worker choice strategy to the context.
*
* @param workerChoiceStrategy - The worker choice strategy to add.
* @param opts - The worker choice strategy options.
* @returns The worker choice strategies.
*/
private addWorkerChoiceStrategy (
workerChoiceStrategy: WorkerChoiceStrategy,
pool: IPool<Worker, Data, Response>,
opts?: WorkerChoiceStrategyOptions
): Map<WorkerChoiceStrategy, IWorkerChoiceStrategy> {
if (!this.workerChoiceStrategies.has(workerChoiceStrategy)) {
return this.workerChoiceStrategies.set(
workerChoiceStrategy,
getWorkerChoiceStrategy<Worker, Data, Response>(
workerChoiceStrategy,
pool,
this,
opts
)
)
}
return this.workerChoiceStrategies
}
/**
* Removes a worker choice strategy from the context.
*
* @param workerChoiceStrategy - The worker choice strategy to remove.
* @returns `true` if the worker choice strategy is removed, `false` otherwise.
*/
private removeWorkerChoiceStrategy (
workerChoiceStrategy: WorkerChoiceStrategy
): boolean {
return this.workerChoiceStrategies.delete(workerChoiceStrategy)
}
}