Commit | Line | Data |
---|---|---|
a61a0724 | 1 | const { expect } = require('expect') |
e843b904 | 2 | const { |
70a4f5ea | 3 | DynamicClusterPool, |
9e619829 | 4 | DynamicThreadPool, |
aee46736 | 5 | FixedClusterPool, |
e843b904 | 6 | FixedThreadPool, |
aee46736 | 7 | PoolEvents, |
184855e6 | 8 | PoolTypes, |
3d6dd312 | 9 | WorkerChoiceStrategies, |
184855e6 | 10 | WorkerTypes |
cdace0e5 | 11 | } = require('../../../lib') |
78099a15 | 12 | const { CircularArray } = require('../../../lib/circular-array') |
29ee7e9a | 13 | const { Queue } = require('../../../lib/queue') |
23ccf9d7 | 14 | const { version } = require('../../../package.json') |
2431bdb4 | 15 | const { waitPoolEvents } = require('../../test-utils') |
e1ffb94f JB |
16 | |
17 | describe('Abstract pool test suite', () => { | |
fc027381 | 18 | const numberOfWorkers = 2 |
a8884ffd | 19 | class StubPoolWithIsMain extends FixedThreadPool { |
e1ffb94f JB |
20 | isMain () { |
21 | return false | |
22 | } | |
3ec964d6 | 23 | } |
3ec964d6 | 24 | |
3ec964d6 | 25 | it('Simulate pool creation from a non main thread/process', () => { |
8d3782fa JB |
26 | expect( |
27 | () => | |
a8884ffd | 28 | new StubPoolWithIsMain( |
7c0ba920 | 29 | numberOfWorkers, |
8d3782fa JB |
30 | './tests/worker-files/thread/testWorker.js', |
31 | { | |
8ebe6c30 | 32 | errorHandler: (e) => console.error(e) |
8d3782fa JB |
33 | } |
34 | ) | |
04f45163 | 35 | ).toThrowError( |
8c6d4acf | 36 | 'Cannot start a pool from a worker with the same type as the pool' |
04f45163 | 37 | ) |
3ec964d6 | 38 | }) |
c510fea7 APA |
39 | |
40 | it('Verify that filePath is checked', () => { | |
292ad316 JB |
41 | const expectedError = new Error( |
42 | 'Please specify a file with a worker implementation' | |
43 | ) | |
7c0ba920 | 44 | expect(() => new FixedThreadPool(numberOfWorkers)).toThrowError( |
292ad316 | 45 | expectedError |
8d3782fa | 46 | ) |
7c0ba920 | 47 | expect(() => new FixedThreadPool(numberOfWorkers, '')).toThrowError( |
292ad316 | 48 | expectedError |
8d3782fa | 49 | ) |
3d6dd312 JB |
50 | expect(() => new FixedThreadPool(numberOfWorkers, 0)).toThrowError( |
51 | expectedError | |
52 | ) | |
53 | expect(() => new FixedThreadPool(numberOfWorkers, true)).toThrowError( | |
54 | expectedError | |
55 | ) | |
56 | expect( | |
57 | () => new FixedThreadPool(numberOfWorkers, './dummyWorker.ts') | |
58 | ).toThrowError(new Error("Cannot find the worker file './dummyWorker.ts'")) | |
8d3782fa JB |
59 | }) |
60 | ||
61 | it('Verify that numberOfWorkers is checked', () => { | |
62 | expect(() => new FixedThreadPool()).toThrowError( | |
d4aeae5a | 63 | 'Cannot instantiate a pool without specifying the number of workers' |
8d3782fa JB |
64 | ) |
65 | }) | |
66 | ||
67 | it('Verify that a negative number of workers is checked', () => { | |
68 | expect( | |
69 | () => | |
70 | new FixedClusterPool(-1, './tests/worker-files/cluster/testWorker.js') | |
71 | ).toThrowError( | |
473c717a JB |
72 | new RangeError( |
73 | 'Cannot instantiate a pool with a negative number of workers' | |
74 | ) | |
8d3782fa JB |
75 | ) |
76 | }) | |
77 | ||
78 | it('Verify that a non integer number of workers is checked', () => { | |
79 | expect( | |
80 | () => | |
81 | new FixedThreadPool(0.25, './tests/worker-files/thread/testWorker.js') | |
82 | ).toThrowError( | |
473c717a | 83 | new TypeError( |
0d80593b | 84 | 'Cannot instantiate a pool with a non safe integer number of workers' |
8d3782fa JB |
85 | ) |
86 | ) | |
c510fea7 | 87 | }) |
7c0ba920 | 88 | |
216541b6 | 89 | it('Verify that dynamic pool sizing is checked', () => { |
a5ed75b7 JB |
90 | expect( |
91 | () => | |
92 | new DynamicClusterPool( | |
93 | 1, | |
94 | undefined, | |
95 | './tests/worker-files/cluster/testWorker.js' | |
96 | ) | |
97 | ).toThrowError( | |
98 | new TypeError( | |
99 | 'Cannot instantiate a dynamic pool without specifying the maximum pool size' | |
100 | ) | |
101 | ) | |
2761efb4 JB |
102 | expect( |
103 | () => | |
104 | new DynamicThreadPool( | |
105 | 0.5, | |
106 | 1, | |
107 | './tests/worker-files/thread/testWorker.js' | |
108 | ) | |
109 | ).toThrowError( | |
110 | new TypeError( | |
111 | 'Cannot instantiate a pool with a non safe integer number of workers' | |
112 | ) | |
113 | ) | |
114 | expect( | |
115 | () => | |
116 | new DynamicClusterPool( | |
117 | 0, | |
118 | 0.5, | |
a5ed75b7 | 119 | './tests/worker-files/cluster/testWorker.js' |
2761efb4 JB |
120 | ) |
121 | ).toThrowError( | |
122 | new TypeError( | |
123 | 'Cannot instantiate a dynamic pool with a non safe integer maximum pool size' | |
124 | ) | |
125 | ) | |
2431bdb4 JB |
126 | expect( |
127 | () => | |
128 | new DynamicThreadPool(2, 1, './tests/worker-files/thread/testWorker.js') | |
129 | ).toThrowError( | |
130 | new RangeError( | |
131 | 'Cannot instantiate a dynamic pool with a maximum pool size inferior to the minimum pool size' | |
132 | ) | |
133 | ) | |
134 | expect( | |
135 | () => | |
2761efb4 JB |
136 | new DynamicClusterPool( |
137 | 1, | |
138 | 1, | |
a5ed75b7 | 139 | './tests/worker-files/cluster/testWorker.js' |
2761efb4 | 140 | ) |
2431bdb4 JB |
141 | ).toThrowError( |
142 | new RangeError( | |
143 | 'Cannot instantiate a dynamic pool with a minimum pool size equal to the maximum pool size. Use a fixed pool instead' | |
144 | ) | |
145 | ) | |
21f710aa JB |
146 | expect( |
147 | () => | |
148 | new DynamicThreadPool(0, 0, './tests/worker-files/thread/testWorker.js') | |
149 | ).toThrowError( | |
150 | new RangeError( | |
d640b48b | 151 | 'Cannot instantiate a dynamic pool with a maximum pool size equal to zero' |
21f710aa JB |
152 | ) |
153 | ) | |
2431bdb4 JB |
154 | }) |
155 | ||
fd7ebd49 | 156 | it('Verify that pool options are checked', async () => { |
7c0ba920 JB |
157 | let pool = new FixedThreadPool( |
158 | numberOfWorkers, | |
159 | './tests/worker-files/thread/testWorker.js' | |
160 | ) | |
7c0ba920 | 161 | expect(pool.emitter).toBeDefined() |
1f68cede JB |
162 | expect(pool.opts.enableEvents).toBe(true) |
163 | expect(pool.opts.restartWorkerOnError).toBe(true) | |
ff733df7 | 164 | expect(pool.opts.enableTasksQueue).toBe(false) |
d4aeae5a | 165 | expect(pool.opts.tasksQueueOptions).toBeUndefined() |
e843b904 JB |
166 | expect(pool.opts.workerChoiceStrategy).toBe( |
167 | WorkerChoiceStrategies.ROUND_ROBIN | |
168 | ) | |
da309861 | 169 | expect(pool.opts.workerChoiceStrategyOptions).toStrictEqual({ |
932fc8be | 170 | runTime: { median: false }, |
5df69fab JB |
171 | waitTime: { median: false }, |
172 | elu: { median: false } | |
da309861 | 173 | }) |
35cf1c03 JB |
174 | expect(pool.opts.messageHandler).toBeUndefined() |
175 | expect(pool.opts.errorHandler).toBeUndefined() | |
176 | expect(pool.opts.onlineHandler).toBeUndefined() | |
177 | expect(pool.opts.exitHandler).toBeUndefined() | |
fd7ebd49 | 178 | await pool.destroy() |
73bfd59d | 179 | const testHandler = () => console.info('test handler executed') |
7c0ba920 JB |
180 | pool = new FixedThreadPool( |
181 | numberOfWorkers, | |
182 | './tests/worker-files/thread/testWorker.js', | |
183 | { | |
e4543b14 | 184 | workerChoiceStrategy: WorkerChoiceStrategies.LEAST_USED, |
49be33fe | 185 | workerChoiceStrategyOptions: { |
932fc8be | 186 | runTime: { median: true }, |
fc027381 | 187 | weights: { 0: 300, 1: 200 } |
49be33fe | 188 | }, |
35cf1c03 | 189 | enableEvents: false, |
1f68cede | 190 | restartWorkerOnError: false, |
ff733df7 | 191 | enableTasksQueue: true, |
d4aeae5a | 192 | tasksQueueOptions: { concurrency: 2 }, |
35cf1c03 JB |
193 | messageHandler: testHandler, |
194 | errorHandler: testHandler, | |
195 | onlineHandler: testHandler, | |
196 | exitHandler: testHandler | |
7c0ba920 JB |
197 | } |
198 | ) | |
7c0ba920 | 199 | expect(pool.emitter).toBeUndefined() |
1f68cede JB |
200 | expect(pool.opts.enableEvents).toBe(false) |
201 | expect(pool.opts.restartWorkerOnError).toBe(false) | |
ff733df7 | 202 | expect(pool.opts.enableTasksQueue).toBe(true) |
d4aeae5a | 203 | expect(pool.opts.tasksQueueOptions).toStrictEqual({ concurrency: 2 }) |
e843b904 | 204 | expect(pool.opts.workerChoiceStrategy).toBe( |
e4543b14 | 205 | WorkerChoiceStrategies.LEAST_USED |
e843b904 | 206 | ) |
da309861 | 207 | expect(pool.opts.workerChoiceStrategyOptions).toStrictEqual({ |
932fc8be | 208 | runTime: { median: true }, |
fc027381 | 209 | weights: { 0: 300, 1: 200 } |
da309861 | 210 | }) |
35cf1c03 JB |
211 | expect(pool.opts.messageHandler).toStrictEqual(testHandler) |
212 | expect(pool.opts.errorHandler).toStrictEqual(testHandler) | |
213 | expect(pool.opts.onlineHandler).toStrictEqual(testHandler) | |
214 | expect(pool.opts.exitHandler).toStrictEqual(testHandler) | |
fd7ebd49 | 215 | await pool.destroy() |
7c0ba920 JB |
216 | }) |
217 | ||
a20f0ba5 | 218 | it('Verify that pool options are validated', async () => { |
d4aeae5a JB |
219 | expect( |
220 | () => | |
221 | new FixedThreadPool( | |
222 | numberOfWorkers, | |
223 | './tests/worker-files/thread/testWorker.js', | |
224 | { | |
f0d7f803 | 225 | workerChoiceStrategy: 'invalidStrategy' |
d4aeae5a JB |
226 | } |
227 | ) | |
f0d7f803 | 228 | ).toThrowError("Invalid worker choice strategy 'invalidStrategy'") |
d4aeae5a JB |
229 | expect( |
230 | () => | |
231 | new FixedThreadPool( | |
232 | numberOfWorkers, | |
233 | './tests/worker-files/thread/testWorker.js', | |
234 | { | |
f0d7f803 | 235 | workerChoiceStrategyOptions: 'invalidOptions' |
d4aeae5a JB |
236 | } |
237 | ) | |
f0d7f803 JB |
238 | ).toThrowError( |
239 | 'Invalid worker choice strategy options: must be a plain object' | |
240 | ) | |
49be33fe JB |
241 | expect( |
242 | () => | |
243 | new FixedThreadPool( | |
244 | numberOfWorkers, | |
245 | './tests/worker-files/thread/testWorker.js', | |
246 | { | |
247 | workerChoiceStrategyOptions: { weights: {} } | |
248 | } | |
249 | ) | |
250 | ).toThrowError( | |
251 | 'Invalid worker choice strategy options: must have a weight for each worker node' | |
252 | ) | |
f0d7f803 JB |
253 | expect( |
254 | () => | |
255 | new FixedThreadPool( | |
256 | numberOfWorkers, | |
257 | './tests/worker-files/thread/testWorker.js', | |
258 | { | |
259 | workerChoiceStrategyOptions: { measurement: 'invalidMeasurement' } | |
260 | } | |
261 | ) | |
262 | ).toThrowError( | |
263 | "Invalid worker choice strategy options: invalid measurement 'invalidMeasurement'" | |
264 | ) | |
265 | expect( | |
266 | () => | |
267 | new FixedThreadPool( | |
268 | numberOfWorkers, | |
269 | './tests/worker-files/thread/testWorker.js', | |
270 | { | |
271 | enableTasksQueue: true, | |
272 | tasksQueueOptions: { concurrency: 0 } | |
273 | } | |
274 | ) | |
275 | ).toThrowError("Invalid worker tasks concurrency '0'") | |
276 | expect( | |
277 | () => | |
278 | new FixedThreadPool( | |
279 | numberOfWorkers, | |
280 | './tests/worker-files/thread/testWorker.js', | |
281 | { | |
282 | enableTasksQueue: true, | |
283 | tasksQueueOptions: 'invalidTasksQueueOptions' | |
284 | } | |
285 | ) | |
286 | ).toThrowError('Invalid tasks queue options: must be a plain object') | |
287 | expect( | |
288 | () => | |
289 | new FixedThreadPool( | |
290 | numberOfWorkers, | |
291 | './tests/worker-files/thread/testWorker.js', | |
292 | { | |
293 | enableTasksQueue: true, | |
294 | tasksQueueOptions: { concurrency: 0.2 } | |
295 | } | |
296 | ) | |
297 | ).toThrowError('Invalid worker tasks concurrency: must be an integer') | |
d4aeae5a JB |
298 | }) |
299 | ||
2431bdb4 | 300 | it('Verify that pool worker choice strategy options can be set', async () => { |
a20f0ba5 JB |
301 | const pool = new FixedThreadPool( |
302 | numberOfWorkers, | |
303 | './tests/worker-files/thread/testWorker.js', | |
304 | { workerChoiceStrategy: WorkerChoiceStrategies.FAIR_SHARE } | |
305 | ) | |
306 | expect(pool.opts.workerChoiceStrategyOptions).toStrictEqual({ | |
932fc8be | 307 | runTime: { median: false }, |
5df69fab JB |
308 | waitTime: { median: false }, |
309 | elu: { median: false } | |
a20f0ba5 JB |
310 | }) |
311 | for (const [, workerChoiceStrategy] of pool.workerChoiceStrategyContext | |
312 | .workerChoiceStrategies) { | |
86bf340d | 313 | expect(workerChoiceStrategy.opts).toStrictEqual({ |
932fc8be | 314 | runTime: { median: false }, |
5df69fab JB |
315 | waitTime: { median: false }, |
316 | elu: { median: false } | |
86bf340d | 317 | }) |
a20f0ba5 | 318 | } |
87de9ff5 JB |
319 | expect( |
320 | pool.workerChoiceStrategyContext.getTaskStatisticsRequirements() | |
321 | ).toStrictEqual({ | |
932fc8be JB |
322 | runTime: { |
323 | aggregate: true, | |
324 | average: true, | |
325 | median: false | |
326 | }, | |
327 | waitTime: { | |
328 | aggregate: false, | |
329 | average: false, | |
330 | median: false | |
331 | }, | |
5df69fab | 332 | elu: { |
9adcefab JB |
333 | aggregate: true, |
334 | average: true, | |
5df69fab JB |
335 | median: false |
336 | } | |
86bf340d | 337 | }) |
9adcefab JB |
338 | pool.setWorkerChoiceStrategyOptions({ |
339 | runTime: { median: true }, | |
340 | elu: { median: true } | |
341 | }) | |
a20f0ba5 | 342 | expect(pool.opts.workerChoiceStrategyOptions).toStrictEqual({ |
9adcefab JB |
343 | runTime: { median: true }, |
344 | elu: { median: true } | |
a20f0ba5 JB |
345 | }) |
346 | for (const [, workerChoiceStrategy] of pool.workerChoiceStrategyContext | |
347 | .workerChoiceStrategies) { | |
932fc8be | 348 | expect(workerChoiceStrategy.opts).toStrictEqual({ |
9adcefab JB |
349 | runTime: { median: true }, |
350 | elu: { median: true } | |
932fc8be | 351 | }) |
a20f0ba5 | 352 | } |
87de9ff5 JB |
353 | expect( |
354 | pool.workerChoiceStrategyContext.getTaskStatisticsRequirements() | |
355 | ).toStrictEqual({ | |
932fc8be JB |
356 | runTime: { |
357 | aggregate: true, | |
358 | average: false, | |
359 | median: true | |
360 | }, | |
361 | waitTime: { | |
362 | aggregate: false, | |
363 | average: false, | |
364 | median: false | |
365 | }, | |
5df69fab | 366 | elu: { |
9adcefab | 367 | aggregate: true, |
5df69fab | 368 | average: false, |
9adcefab | 369 | median: true |
5df69fab | 370 | } |
86bf340d | 371 | }) |
9adcefab JB |
372 | pool.setWorkerChoiceStrategyOptions({ |
373 | runTime: { median: false }, | |
374 | elu: { median: false } | |
375 | }) | |
a20f0ba5 | 376 | expect(pool.opts.workerChoiceStrategyOptions).toStrictEqual({ |
9adcefab JB |
377 | runTime: { median: false }, |
378 | elu: { median: false } | |
a20f0ba5 JB |
379 | }) |
380 | for (const [, workerChoiceStrategy] of pool.workerChoiceStrategyContext | |
381 | .workerChoiceStrategies) { | |
932fc8be | 382 | expect(workerChoiceStrategy.opts).toStrictEqual({ |
9adcefab JB |
383 | runTime: { median: false }, |
384 | elu: { median: false } | |
932fc8be | 385 | }) |
a20f0ba5 | 386 | } |
87de9ff5 JB |
387 | expect( |
388 | pool.workerChoiceStrategyContext.getTaskStatisticsRequirements() | |
389 | ).toStrictEqual({ | |
932fc8be JB |
390 | runTime: { |
391 | aggregate: true, | |
392 | average: true, | |
393 | median: false | |
394 | }, | |
395 | waitTime: { | |
396 | aggregate: false, | |
397 | average: false, | |
398 | median: false | |
399 | }, | |
5df69fab | 400 | elu: { |
9adcefab JB |
401 | aggregate: true, |
402 | average: true, | |
5df69fab JB |
403 | median: false |
404 | } | |
86bf340d | 405 | }) |
1f95d544 JB |
406 | expect(() => |
407 | pool.setWorkerChoiceStrategyOptions('invalidWorkerChoiceStrategyOptions') | |
408 | ).toThrowError( | |
409 | 'Invalid worker choice strategy options: must be a plain object' | |
410 | ) | |
411 | expect(() => | |
412 | pool.setWorkerChoiceStrategyOptions({ weights: {} }) | |
413 | ).toThrowError( | |
414 | 'Invalid worker choice strategy options: must have a weight for each worker node' | |
415 | ) | |
416 | expect(() => | |
417 | pool.setWorkerChoiceStrategyOptions({ measurement: 'invalidMeasurement' }) | |
418 | ).toThrowError( | |
419 | "Invalid worker choice strategy options: invalid measurement 'invalidMeasurement'" | |
420 | ) | |
a20f0ba5 JB |
421 | await pool.destroy() |
422 | }) | |
423 | ||
2431bdb4 | 424 | it('Verify that pool tasks queue can be enabled/disabled', async () => { |
a20f0ba5 JB |
425 | const pool = new FixedThreadPool( |
426 | numberOfWorkers, | |
427 | './tests/worker-files/thread/testWorker.js' | |
428 | ) | |
429 | expect(pool.opts.enableTasksQueue).toBe(false) | |
430 | expect(pool.opts.tasksQueueOptions).toBeUndefined() | |
431 | pool.enableTasksQueue(true) | |
432 | expect(pool.opts.enableTasksQueue).toBe(true) | |
433 | expect(pool.opts.tasksQueueOptions).toStrictEqual({ concurrency: 1 }) | |
434 | pool.enableTasksQueue(true, { concurrency: 2 }) | |
435 | expect(pool.opts.enableTasksQueue).toBe(true) | |
436 | expect(pool.opts.tasksQueueOptions).toStrictEqual({ concurrency: 2 }) | |
437 | pool.enableTasksQueue(false) | |
438 | expect(pool.opts.enableTasksQueue).toBe(false) | |
439 | expect(pool.opts.tasksQueueOptions).toBeUndefined() | |
440 | await pool.destroy() | |
441 | }) | |
442 | ||
2431bdb4 | 443 | it('Verify that pool tasks queue options can be set', async () => { |
a20f0ba5 JB |
444 | const pool = new FixedThreadPool( |
445 | numberOfWorkers, | |
446 | './tests/worker-files/thread/testWorker.js', | |
447 | { enableTasksQueue: true } | |
448 | ) | |
449 | expect(pool.opts.tasksQueueOptions).toStrictEqual({ concurrency: 1 }) | |
450 | pool.setTasksQueueOptions({ concurrency: 2 }) | |
451 | expect(pool.opts.tasksQueueOptions).toStrictEqual({ concurrency: 2 }) | |
f0d7f803 JB |
452 | expect(() => |
453 | pool.setTasksQueueOptions('invalidTasksQueueOptions') | |
454 | ).toThrowError('Invalid tasks queue options: must be a plain object') | |
a20f0ba5 JB |
455 | expect(() => pool.setTasksQueueOptions({ concurrency: 0 })).toThrowError( |
456 | "Invalid worker tasks concurrency '0'" | |
457 | ) | |
f0d7f803 JB |
458 | expect(() => pool.setTasksQueueOptions({ concurrency: 0.2 })).toThrowError( |
459 | 'Invalid worker tasks concurrency: must be an integer' | |
460 | ) | |
a20f0ba5 JB |
461 | await pool.destroy() |
462 | }) | |
463 | ||
6b27d407 JB |
464 | it('Verify that pool info is set', async () => { |
465 | let pool = new FixedThreadPool( | |
466 | numberOfWorkers, | |
467 | './tests/worker-files/thread/testWorker.js' | |
468 | ) | |
2dca6cab JB |
469 | expect(pool.info).toStrictEqual({ |
470 | version, | |
471 | type: PoolTypes.fixed, | |
472 | worker: WorkerTypes.thread, | |
473 | ready: true, | |
474 | strategy: WorkerChoiceStrategies.ROUND_ROBIN, | |
475 | minSize: numberOfWorkers, | |
476 | maxSize: numberOfWorkers, | |
477 | workerNodes: numberOfWorkers, | |
478 | idleWorkerNodes: numberOfWorkers, | |
479 | busyWorkerNodes: 0, | |
480 | executedTasks: 0, | |
481 | executingTasks: 0, | |
2dca6cab JB |
482 | failedTasks: 0 |
483 | }) | |
6b27d407 JB |
484 | await pool.destroy() |
485 | pool = new DynamicClusterPool( | |
2431bdb4 | 486 | Math.floor(numberOfWorkers / 2), |
6b27d407 | 487 | numberOfWorkers, |
ecdfbdc0 | 488 | './tests/worker-files/cluster/testWorker.js' |
6b27d407 | 489 | ) |
2dca6cab JB |
490 | expect(pool.info).toStrictEqual({ |
491 | version, | |
492 | type: PoolTypes.dynamic, | |
493 | worker: WorkerTypes.cluster, | |
494 | ready: true, | |
495 | strategy: WorkerChoiceStrategies.ROUND_ROBIN, | |
496 | minSize: Math.floor(numberOfWorkers / 2), | |
497 | maxSize: numberOfWorkers, | |
498 | workerNodes: Math.floor(numberOfWorkers / 2), | |
499 | idleWorkerNodes: Math.floor(numberOfWorkers / 2), | |
500 | busyWorkerNodes: 0, | |
501 | executedTasks: 0, | |
502 | executingTasks: 0, | |
2dca6cab JB |
503 | failedTasks: 0 |
504 | }) | |
6b27d407 JB |
505 | await pool.destroy() |
506 | }) | |
507 | ||
2431bdb4 | 508 | it('Verify that pool worker tasks usage are initialized', async () => { |
bf9549ae JB |
509 | const pool = new FixedClusterPool( |
510 | numberOfWorkers, | |
511 | './tests/worker-files/cluster/testWorker.js' | |
512 | ) | |
f06e48d8 | 513 | for (const workerNode of pool.workerNodes) { |
465b2940 | 514 | expect(workerNode.usage).toStrictEqual({ |
a4e07f72 JB |
515 | tasks: { |
516 | executed: 0, | |
517 | executing: 0, | |
518 | queued: 0, | |
df593701 | 519 | maxQueued: 0, |
a4e07f72 JB |
520 | failed: 0 |
521 | }, | |
522 | runTime: { | |
a4e07f72 JB |
523 | history: expect.any(CircularArray) |
524 | }, | |
525 | waitTime: { | |
a4e07f72 JB |
526 | history: expect.any(CircularArray) |
527 | }, | |
5df69fab JB |
528 | elu: { |
529 | idle: { | |
5df69fab JB |
530 | history: expect.any(CircularArray) |
531 | }, | |
532 | active: { | |
5df69fab | 533 | history: expect.any(CircularArray) |
f7510105 | 534 | } |
5df69fab | 535 | } |
86bf340d | 536 | }) |
f06e48d8 JB |
537 | } |
538 | await pool.destroy() | |
539 | }) | |
540 | ||
2431bdb4 JB |
541 | it('Verify that pool worker tasks queue are initialized', async () => { |
542 | let pool = new FixedClusterPool( | |
f06e48d8 JB |
543 | numberOfWorkers, |
544 | './tests/worker-files/cluster/testWorker.js' | |
545 | ) | |
546 | for (const workerNode of pool.workerNodes) { | |
547 | expect(workerNode.tasksQueue).toBeDefined() | |
29ee7e9a | 548 | expect(workerNode.tasksQueue).toBeInstanceOf(Queue) |
4d8bf9e4 | 549 | expect(workerNode.tasksQueue.size).toBe(0) |
9c16fb4b | 550 | expect(workerNode.tasksQueue.maxSize).toBe(0) |
bf9549ae | 551 | } |
fd7ebd49 | 552 | await pool.destroy() |
2431bdb4 JB |
553 | pool = new DynamicThreadPool( |
554 | Math.floor(numberOfWorkers / 2), | |
555 | numberOfWorkers, | |
556 | './tests/worker-files/thread/testWorker.js' | |
557 | ) | |
558 | for (const workerNode of pool.workerNodes) { | |
559 | expect(workerNode.tasksQueue).toBeDefined() | |
560 | expect(workerNode.tasksQueue).toBeInstanceOf(Queue) | |
561 | expect(workerNode.tasksQueue.size).toBe(0) | |
562 | expect(workerNode.tasksQueue.maxSize).toBe(0) | |
563 | } | |
564 | }) | |
565 | ||
566 | it('Verify that pool worker info are initialized', async () => { | |
567 | let pool = new FixedClusterPool( | |
568 | numberOfWorkers, | |
569 | './tests/worker-files/cluster/testWorker.js' | |
570 | ) | |
2dca6cab JB |
571 | for (const workerNode of pool.workerNodes) { |
572 | expect(workerNode.info).toStrictEqual({ | |
573 | id: expect.any(Number), | |
574 | type: WorkerTypes.cluster, | |
575 | dynamic: false, | |
576 | ready: true | |
577 | }) | |
578 | } | |
2431bdb4 JB |
579 | await pool.destroy() |
580 | pool = new DynamicThreadPool( | |
581 | Math.floor(numberOfWorkers / 2), | |
582 | numberOfWorkers, | |
583 | './tests/worker-files/thread/testWorker.js' | |
584 | ) | |
2dca6cab JB |
585 | for (const workerNode of pool.workerNodes) { |
586 | expect(workerNode.info).toStrictEqual({ | |
587 | id: expect.any(Number), | |
588 | type: WorkerTypes.thread, | |
589 | dynamic: false, | |
7884d183 | 590 | ready: true |
2dca6cab JB |
591 | }) |
592 | } | |
bf9549ae JB |
593 | }) |
594 | ||
2431bdb4 | 595 | it('Verify that pool worker tasks usage are computed', async () => { |
bf9549ae JB |
596 | const pool = new FixedClusterPool( |
597 | numberOfWorkers, | |
598 | './tests/worker-files/cluster/testWorker.js' | |
599 | ) | |
09c2d0d3 | 600 | const promises = new Set() |
fc027381 JB |
601 | const maxMultiplier = 2 |
602 | for (let i = 0; i < numberOfWorkers * maxMultiplier; i++) { | |
09c2d0d3 | 603 | promises.add(pool.execute()) |
bf9549ae | 604 | } |
f06e48d8 | 605 | for (const workerNode of pool.workerNodes) { |
465b2940 | 606 | expect(workerNode.usage).toStrictEqual({ |
a4e07f72 JB |
607 | tasks: { |
608 | executed: 0, | |
609 | executing: maxMultiplier, | |
610 | queued: 0, | |
df593701 | 611 | maxQueued: 0, |
a4e07f72 JB |
612 | failed: 0 |
613 | }, | |
614 | runTime: { | |
a4e07f72 JB |
615 | history: expect.any(CircularArray) |
616 | }, | |
617 | waitTime: { | |
a4e07f72 JB |
618 | history: expect.any(CircularArray) |
619 | }, | |
5df69fab JB |
620 | elu: { |
621 | idle: { | |
5df69fab JB |
622 | history: expect.any(CircularArray) |
623 | }, | |
624 | active: { | |
5df69fab | 625 | history: expect.any(CircularArray) |
f7510105 | 626 | } |
5df69fab | 627 | } |
86bf340d | 628 | }) |
bf9549ae JB |
629 | } |
630 | await Promise.all(promises) | |
f06e48d8 | 631 | for (const workerNode of pool.workerNodes) { |
465b2940 | 632 | expect(workerNode.usage).toStrictEqual({ |
a4e07f72 JB |
633 | tasks: { |
634 | executed: maxMultiplier, | |
635 | executing: 0, | |
636 | queued: 0, | |
df593701 | 637 | maxQueued: 0, |
a4e07f72 JB |
638 | failed: 0 |
639 | }, | |
640 | runTime: { | |
a4e07f72 JB |
641 | history: expect.any(CircularArray) |
642 | }, | |
643 | waitTime: { | |
a4e07f72 JB |
644 | history: expect.any(CircularArray) |
645 | }, | |
5df69fab JB |
646 | elu: { |
647 | idle: { | |
5df69fab JB |
648 | history: expect.any(CircularArray) |
649 | }, | |
650 | active: { | |
5df69fab | 651 | history: expect.any(CircularArray) |
f7510105 | 652 | } |
5df69fab | 653 | } |
86bf340d | 654 | }) |
bf9549ae | 655 | } |
fd7ebd49 | 656 | await pool.destroy() |
bf9549ae JB |
657 | }) |
658 | ||
2431bdb4 | 659 | it('Verify that pool worker tasks usage are reset at worker choice strategy change', async () => { |
7fd82a1c | 660 | const pool = new DynamicThreadPool( |
2431bdb4 | 661 | Math.floor(numberOfWorkers / 2), |
8f4878b7 | 662 | numberOfWorkers, |
9e619829 JB |
663 | './tests/worker-files/thread/testWorker.js' |
664 | ) | |
09c2d0d3 | 665 | const promises = new Set() |
ee9f5295 JB |
666 | const maxMultiplier = 2 |
667 | for (let i = 0; i < numberOfWorkers * maxMultiplier; i++) { | |
09c2d0d3 | 668 | promises.add(pool.execute()) |
9e619829 JB |
669 | } |
670 | await Promise.all(promises) | |
f06e48d8 | 671 | for (const workerNode of pool.workerNodes) { |
465b2940 | 672 | expect(workerNode.usage).toStrictEqual({ |
a4e07f72 JB |
673 | tasks: { |
674 | executed: expect.any(Number), | |
675 | executing: 0, | |
676 | queued: 0, | |
df593701 | 677 | maxQueued: 0, |
a4e07f72 JB |
678 | failed: 0 |
679 | }, | |
680 | runTime: { | |
a4e07f72 JB |
681 | history: expect.any(CircularArray) |
682 | }, | |
683 | waitTime: { | |
a4e07f72 JB |
684 | history: expect.any(CircularArray) |
685 | }, | |
5df69fab JB |
686 | elu: { |
687 | idle: { | |
5df69fab JB |
688 | history: expect.any(CircularArray) |
689 | }, | |
690 | active: { | |
5df69fab | 691 | history: expect.any(CircularArray) |
f7510105 | 692 | } |
5df69fab | 693 | } |
86bf340d | 694 | }) |
465b2940 | 695 | expect(workerNode.usage.tasks.executed).toBeGreaterThan(0) |
b56c2ee5 | 696 | expect(workerNode.usage.tasks.executed).toBeLessThanOrEqual(maxMultiplier) |
b97d82d8 JB |
697 | expect(workerNode.usage.runTime.history.length).toBe(0) |
698 | expect(workerNode.usage.waitTime.history.length).toBe(0) | |
699 | expect(workerNode.usage.elu.idle.history.length).toBe(0) | |
700 | expect(workerNode.usage.elu.active.history.length).toBe(0) | |
9e619829 JB |
701 | } |
702 | pool.setWorkerChoiceStrategy(WorkerChoiceStrategies.FAIR_SHARE) | |
f06e48d8 | 703 | for (const workerNode of pool.workerNodes) { |
465b2940 | 704 | expect(workerNode.usage).toStrictEqual({ |
a4e07f72 JB |
705 | tasks: { |
706 | executed: 0, | |
707 | executing: 0, | |
708 | queued: 0, | |
df593701 | 709 | maxQueued: 0, |
a4e07f72 JB |
710 | failed: 0 |
711 | }, | |
712 | runTime: { | |
a4e07f72 JB |
713 | history: expect.any(CircularArray) |
714 | }, | |
715 | waitTime: { | |
a4e07f72 JB |
716 | history: expect.any(CircularArray) |
717 | }, | |
5df69fab JB |
718 | elu: { |
719 | idle: { | |
5df69fab JB |
720 | history: expect.any(CircularArray) |
721 | }, | |
722 | active: { | |
5df69fab | 723 | history: expect.any(CircularArray) |
f7510105 | 724 | } |
5df69fab | 725 | } |
86bf340d | 726 | }) |
465b2940 JB |
727 | expect(workerNode.usage.runTime.history.length).toBe(0) |
728 | expect(workerNode.usage.waitTime.history.length).toBe(0) | |
b97d82d8 JB |
729 | expect(workerNode.usage.elu.idle.history.length).toBe(0) |
730 | expect(workerNode.usage.elu.active.history.length).toBe(0) | |
ee11a4a2 | 731 | } |
fd7ebd49 | 732 | await pool.destroy() |
ee11a4a2 JB |
733 | }) |
734 | ||
164d950a JB |
735 | it("Verify that pool event emitter 'full' event can register a callback", async () => { |
736 | const pool = new DynamicThreadPool( | |
2431bdb4 | 737 | Math.floor(numberOfWorkers / 2), |
164d950a JB |
738 | numberOfWorkers, |
739 | './tests/worker-files/thread/testWorker.js' | |
740 | ) | |
09c2d0d3 | 741 | const promises = new Set() |
164d950a | 742 | let poolFull = 0 |
d46660cd | 743 | let poolInfo |
8ebe6c30 | 744 | pool.emitter.on(PoolEvents.full, (info) => { |
d46660cd JB |
745 | ++poolFull |
746 | poolInfo = info | |
747 | }) | |
164d950a | 748 | for (let i = 0; i < numberOfWorkers * 2; i++) { |
f5d14e90 | 749 | promises.add(pool.execute()) |
164d950a JB |
750 | } |
751 | await Promise.all(promises) | |
2431bdb4 JB |
752 | // The `full` event is triggered when the number of submitted tasks at once reach the maximum number of workers in the dynamic pool. |
753 | // So in total numberOfWorkers * 2 - 1 times for a loop submitting up to numberOfWorkers * 2 tasks to the dynamic pool with min = (max = numberOfWorkers) / 2. | |
754 | expect(poolFull).toBe(numberOfWorkers * 2 - 1) | |
d46660cd | 755 | expect(poolInfo).toStrictEqual({ |
23ccf9d7 | 756 | version, |
d46660cd JB |
757 | type: PoolTypes.dynamic, |
758 | worker: WorkerTypes.thread, | |
2431bdb4 JB |
759 | ready: expect.any(Boolean), |
760 | strategy: WorkerChoiceStrategies.ROUND_ROBIN, | |
761 | minSize: expect.any(Number), | |
762 | maxSize: expect.any(Number), | |
763 | workerNodes: expect.any(Number), | |
764 | idleWorkerNodes: expect.any(Number), | |
765 | busyWorkerNodes: expect.any(Number), | |
766 | executedTasks: expect.any(Number), | |
767 | executingTasks: expect.any(Number), | |
2431bdb4 JB |
768 | failedTasks: expect.any(Number) |
769 | }) | |
770 | await pool.destroy() | |
771 | }) | |
772 | ||
773 | it("Verify that pool event emitter 'ready' event can register a callback", async () => { | |
d5024c00 JB |
774 | const pool = new DynamicClusterPool( |
775 | Math.floor(numberOfWorkers / 2), | |
2431bdb4 JB |
776 | numberOfWorkers, |
777 | './tests/worker-files/cluster/testWorker.js' | |
778 | ) | |
2431bdb4 | 779 | let poolInfo |
cc3ab78b | 780 | let poolReady = 0 |
8ebe6c30 | 781 | pool.emitter.on(PoolEvents.ready, (info) => { |
2431bdb4 JB |
782 | ++poolReady |
783 | poolInfo = info | |
784 | }) | |
785 | await waitPoolEvents(pool, PoolEvents.ready, 1) | |
786 | expect(poolReady).toBe(1) | |
787 | expect(poolInfo).toStrictEqual({ | |
788 | version, | |
d5024c00 | 789 | type: PoolTypes.dynamic, |
2431bdb4 JB |
790 | worker: WorkerTypes.cluster, |
791 | ready: true, | |
792 | strategy: WorkerChoiceStrategies.ROUND_ROBIN, | |
d46660cd JB |
793 | minSize: expect.any(Number), |
794 | maxSize: expect.any(Number), | |
795 | workerNodes: expect.any(Number), | |
796 | idleWorkerNodes: expect.any(Number), | |
797 | busyWorkerNodes: expect.any(Number), | |
a4e07f72 JB |
798 | executedTasks: expect.any(Number), |
799 | executingTasks: expect.any(Number), | |
a4e07f72 | 800 | failedTasks: expect.any(Number) |
d46660cd | 801 | }) |
164d950a JB |
802 | await pool.destroy() |
803 | }) | |
804 | ||
cf597bc5 | 805 | it("Verify that pool event emitter 'busy' event can register a callback", async () => { |
7c0ba920 JB |
806 | const pool = new FixedThreadPool( |
807 | numberOfWorkers, | |
808 | './tests/worker-files/thread/testWorker.js' | |
809 | ) | |
09c2d0d3 | 810 | const promises = new Set() |
7c0ba920 | 811 | let poolBusy = 0 |
d46660cd | 812 | let poolInfo |
8ebe6c30 | 813 | pool.emitter.on(PoolEvents.busy, (info) => { |
d46660cd JB |
814 | ++poolBusy |
815 | poolInfo = info | |
816 | }) | |
7c0ba920 | 817 | for (let i = 0; i < numberOfWorkers * 2; i++) { |
f5d14e90 | 818 | promises.add(pool.execute()) |
7c0ba920 | 819 | } |
cf597bc5 | 820 | await Promise.all(promises) |
14916bf9 JB |
821 | // The `busy` event is triggered when the number of submitted tasks at once reach the number of fixed pool workers. |
822 | // So in total numberOfWorkers + 1 times for a loop submitting up to numberOfWorkers * 2 tasks to the fixed pool. | |
823 | expect(poolBusy).toBe(numberOfWorkers + 1) | |
d46660cd | 824 | expect(poolInfo).toStrictEqual({ |
23ccf9d7 | 825 | version, |
d46660cd JB |
826 | type: PoolTypes.fixed, |
827 | worker: WorkerTypes.thread, | |
2431bdb4 JB |
828 | ready: expect.any(Boolean), |
829 | strategy: WorkerChoiceStrategies.ROUND_ROBIN, | |
d46660cd JB |
830 | minSize: expect.any(Number), |
831 | maxSize: expect.any(Number), | |
832 | workerNodes: expect.any(Number), | |
833 | idleWorkerNodes: expect.any(Number), | |
834 | busyWorkerNodes: expect.any(Number), | |
a4e07f72 JB |
835 | executedTasks: expect.any(Number), |
836 | executingTasks: expect.any(Number), | |
a4e07f72 | 837 | failedTasks: expect.any(Number) |
d46660cd | 838 | }) |
fd7ebd49 | 839 | await pool.destroy() |
7c0ba920 | 840 | }) |
70a4f5ea | 841 | |
90d7d101 JB |
842 | it('Verify that listTaskFunctions() is working', async () => { |
843 | const dynamicThreadPool = new DynamicThreadPool( | |
844 | Math.floor(numberOfWorkers / 2), | |
845 | numberOfWorkers, | |
846 | './tests/worker-files/thread/testMultipleTaskFunctionsWorker.js' | |
847 | ) | |
848 | await waitPoolEvents(dynamicThreadPool, PoolEvents.ready, 1) | |
849 | expect(dynamicThreadPool.listTaskFunctions()).toStrictEqual([ | |
850 | 'default', | |
851 | 'jsonIntegerSerialization', | |
852 | 'factorial', | |
853 | 'fibonacci' | |
854 | ]) | |
855 | const fixedClusterPool = new FixedClusterPool( | |
856 | numberOfWorkers, | |
857 | './tests/worker-files/cluster/testMultipleTaskFunctionsWorker.js' | |
858 | ) | |
859 | await waitPoolEvents(fixedClusterPool, PoolEvents.ready, 1) | |
860 | expect(fixedClusterPool.listTaskFunctions()).toStrictEqual([ | |
861 | 'default', | |
862 | 'jsonIntegerSerialization', | |
863 | 'factorial', | |
864 | 'fibonacci' | |
865 | ]) | |
866 | }) | |
867 | ||
868 | it('Verify that multiple task functions worker is working', async () => { | |
70a4f5ea | 869 | const pool = new DynamicClusterPool( |
2431bdb4 | 870 | Math.floor(numberOfWorkers / 2), |
70a4f5ea | 871 | numberOfWorkers, |
90d7d101 | 872 | './tests/worker-files/cluster/testMultipleTaskFunctionsWorker.js' |
70a4f5ea JB |
873 | ) |
874 | const data = { n: 10 } | |
82888165 | 875 | const result0 = await pool.execute(data) |
30b963d4 | 876 | expect(result0).toStrictEqual({ ok: 1 }) |
70a4f5ea | 877 | const result1 = await pool.execute(data, 'jsonIntegerSerialization') |
30b963d4 | 878 | expect(result1).toStrictEqual({ ok: 1 }) |
70a4f5ea JB |
879 | const result2 = await pool.execute(data, 'factorial') |
880 | expect(result2).toBe(3628800) | |
881 | const result3 = await pool.execute(data, 'fibonacci') | |
024daf59 | 882 | expect(result3).toBe(55) |
70a4f5ea | 883 | }) |
3ec964d6 | 884 | }) |