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