build(deps-dev): apply updates
[poolifier.git] / tests / pools / abstract-pool.test.mjs
1 // eslint-disable-next-line n/no-unsupported-features/node-builtins
2 import { createHook, executionAsyncId } from 'node:async_hooks'
3 import { EventEmitterAsyncResource } from 'node:events'
4 import { readFileSync } from 'node:fs'
5 import { dirname, join } from 'node:path'
6 import { fileURLToPath } from 'node:url'
7
8 import { expect } from 'expect'
9 import { restore, stub } from 'sinon'
10
11 import { CircularArray } from '../../lib/circular-array.cjs'
12 import {
13 DynamicClusterPool,
14 DynamicThreadPool,
15 FixedClusterPool,
16 FixedThreadPool,
17 PoolEvents,
18 PoolTypes,
19 WorkerChoiceStrategies,
20 WorkerTypes
21 } from '../../lib/index.cjs'
22 import { WorkerNode } from '../../lib/pools/worker-node.cjs'
23 import { PriorityQueue } from '../../lib/priority-queue.cjs'
24 import { DEFAULT_TASK_NAME } from '../../lib/utils.cjs'
25 import { waitPoolEvents } from '../test-utils.cjs'
26
27 describe('Abstract pool test suite', () => {
28 const version = JSON.parse(
29 readFileSync(
30 join(dirname(fileURLToPath(import.meta.url)), '../..', 'package.json'),
31 'utf8'
32 )
33 ).version
34 const numberOfWorkers = 2
35 class StubPoolWithIsMain extends FixedThreadPool {
36 isMain () {
37 return false
38 }
39 }
40
41 afterEach(() => {
42 restore()
43 })
44
45 it('Verify that pool can be created and destroyed', async () => {
46 const pool = new FixedThreadPool(
47 numberOfWorkers,
48 './tests/worker-files/thread/testWorker.mjs'
49 )
50 expect(pool).toBeInstanceOf(FixedThreadPool)
51 await pool.destroy()
52 })
53
54 it('Verify that pool cannot be created from a non main thread/process', () => {
55 expect(
56 () =>
57 new StubPoolWithIsMain(
58 numberOfWorkers,
59 './tests/worker-files/thread/testWorker.mjs',
60 {
61 errorHandler: e => console.error(e)
62 }
63 )
64 ).toThrow(
65 new Error(
66 'Cannot start a pool from a worker with the same type as the pool'
67 )
68 )
69 })
70
71 it('Verify that pool statuses properties are set', async () => {
72 const pool = new FixedThreadPool(
73 numberOfWorkers,
74 './tests/worker-files/thread/testWorker.mjs'
75 )
76 expect(pool.started).toBe(true)
77 expect(pool.starting).toBe(false)
78 expect(pool.destroying).toBe(false)
79 await pool.destroy()
80 })
81
82 it('Verify that filePath is checked', () => {
83 expect(() => new FixedThreadPool(numberOfWorkers)).toThrow(
84 new TypeError('The worker file path must be specified')
85 )
86 expect(() => new FixedThreadPool(numberOfWorkers, 0)).toThrow(
87 new TypeError('The worker file path must be a string')
88 )
89 expect(
90 () => new FixedThreadPool(numberOfWorkers, './dummyWorker.ts')
91 ).toThrow(new Error("Cannot find the worker file './dummyWorker.ts'"))
92 })
93
94 it('Verify that numberOfWorkers is checked', () => {
95 expect(
96 () =>
97 new FixedThreadPool(
98 undefined,
99 './tests/worker-files/thread/testWorker.mjs'
100 )
101 ).toThrow(
102 new Error(
103 'Cannot instantiate a pool without specifying the number of workers'
104 )
105 )
106 })
107
108 it('Verify that a negative number of workers is checked', () => {
109 expect(
110 () =>
111 new FixedClusterPool(-1, './tests/worker-files/cluster/testWorker.cjs')
112 ).toThrow(
113 new RangeError(
114 'Cannot instantiate a pool with a negative number of workers'
115 )
116 )
117 })
118
119 it('Verify that a non integer number of workers is checked', () => {
120 expect(
121 () =>
122 new FixedThreadPool(0.25, './tests/worker-files/thread/testWorker.mjs')
123 ).toThrow(
124 new TypeError(
125 'Cannot instantiate a pool with a non safe integer number of workers'
126 )
127 )
128 })
129
130 it('Verify that pool arguments number and pool type are checked', () => {
131 expect(
132 () =>
133 new FixedThreadPool(
134 numberOfWorkers,
135 './tests/worker-files/thread/testWorker.mjs',
136 undefined,
137 numberOfWorkers * 2
138 )
139 ).toThrow(
140 new Error(
141 'Cannot instantiate a fixed pool with a maximum number of workers specified at initialization'
142 )
143 )
144 })
145
146 it('Verify that dynamic pool sizing is checked', () => {
147 expect(
148 () =>
149 new DynamicClusterPool(
150 1,
151 undefined,
152 './tests/worker-files/cluster/testWorker.cjs'
153 )
154 ).toThrow(
155 new TypeError(
156 'Cannot instantiate a dynamic pool without specifying the maximum pool size'
157 )
158 )
159 expect(
160 () =>
161 new DynamicThreadPool(
162 0.5,
163 1,
164 './tests/worker-files/thread/testWorker.mjs'
165 )
166 ).toThrow(
167 new TypeError(
168 'Cannot instantiate a pool with a non safe integer number of workers'
169 )
170 )
171 expect(
172 () =>
173 new DynamicClusterPool(
174 0,
175 0.5,
176 './tests/worker-files/cluster/testWorker.cjs'
177 )
178 ).toThrow(
179 new TypeError(
180 'Cannot instantiate a dynamic pool with a non safe integer maximum pool size'
181 )
182 )
183 expect(
184 () =>
185 new DynamicThreadPool(
186 2,
187 1,
188 './tests/worker-files/thread/testWorker.mjs'
189 )
190 ).toThrow(
191 new RangeError(
192 'Cannot instantiate a dynamic pool with a maximum pool size inferior to the minimum pool size'
193 )
194 )
195 expect(
196 () =>
197 new DynamicThreadPool(
198 0,
199 0,
200 './tests/worker-files/thread/testWorker.mjs'
201 )
202 ).toThrow(
203 new RangeError(
204 'Cannot instantiate a dynamic pool with a maximum pool size equal to zero'
205 )
206 )
207 expect(
208 () =>
209 new DynamicClusterPool(
210 1,
211 1,
212 './tests/worker-files/cluster/testWorker.cjs'
213 )
214 ).toThrow(
215 new RangeError(
216 'Cannot instantiate a dynamic pool with a minimum pool size equal to the maximum pool size. Use a fixed pool instead'
217 )
218 )
219 })
220
221 it('Verify that pool options are checked', async () => {
222 let pool = new FixedThreadPool(
223 numberOfWorkers,
224 './tests/worker-files/thread/testWorker.mjs'
225 )
226 expect(pool.emitter).toBeInstanceOf(EventEmitterAsyncResource)
227 expect(pool.emitter.eventNames()).toStrictEqual([])
228 expect(pool.opts).toStrictEqual({
229 startWorkers: true,
230 enableEvents: true,
231 restartWorkerOnError: true,
232 enableTasksQueue: false,
233 workerChoiceStrategy: WorkerChoiceStrategies.ROUND_ROBIN
234 })
235 for (const [, workerChoiceStrategy] of pool.workerChoiceStrategiesContext
236 .workerChoiceStrategies) {
237 expect(workerChoiceStrategy.opts).toStrictEqual({
238 runTime: { median: false },
239 waitTime: { median: false },
240 elu: { median: false },
241 weights: expect.objectContaining({
242 0: expect.any(Number),
243 [pool.info.maxSize - 1]: expect.any(Number)
244 })
245 })
246 }
247 await pool.destroy()
248 const testHandler = () => console.info('test handler executed')
249 pool = new FixedThreadPool(
250 numberOfWorkers,
251 './tests/worker-files/thread/testWorker.mjs',
252 {
253 workerChoiceStrategy: WorkerChoiceStrategies.LEAST_USED,
254 workerChoiceStrategyOptions: {
255 runTime: { median: true },
256 weights: { 0: 300, 1: 200 }
257 },
258 enableEvents: false,
259 restartWorkerOnError: false,
260 enableTasksQueue: true,
261 tasksQueueOptions: { concurrency: 2 },
262 messageHandler: testHandler,
263 errorHandler: testHandler,
264 onlineHandler: testHandler,
265 exitHandler: testHandler
266 }
267 )
268 expect(pool.emitter).toBeUndefined()
269 expect(pool.opts).toStrictEqual({
270 startWorkers: true,
271 enableEvents: false,
272 restartWorkerOnError: false,
273 enableTasksQueue: true,
274 tasksQueueOptions: {
275 concurrency: 2,
276 size: Math.pow(numberOfWorkers, 2),
277 taskStealing: true,
278 tasksStealingOnBackPressure: true,
279 tasksFinishedTimeout: 2000
280 },
281 workerChoiceStrategy: WorkerChoiceStrategies.LEAST_USED,
282 workerChoiceStrategyOptions: {
283 runTime: { median: true },
284 weights: { 0: 300, 1: 200 }
285 },
286 onlineHandler: testHandler,
287 messageHandler: testHandler,
288 errorHandler: testHandler,
289 exitHandler: testHandler
290 })
291 for (const [, workerChoiceStrategy] of pool.workerChoiceStrategiesContext
292 .workerChoiceStrategies) {
293 expect(workerChoiceStrategy.opts).toStrictEqual({
294 runTime: { median: true },
295 waitTime: { median: false },
296 elu: { median: false },
297 weights: { 0: 300, 1: 200 }
298 })
299 }
300 await pool.destroy()
301 })
302
303 it('Verify that pool options are validated', () => {
304 expect(
305 () =>
306 new FixedThreadPool(
307 numberOfWorkers,
308 './tests/worker-files/thread/testWorker.mjs',
309 {
310 workerChoiceStrategy: 'invalidStrategy'
311 }
312 )
313 ).toThrow(new Error("Invalid worker choice strategy 'invalidStrategy'"))
314 expect(
315 () =>
316 new FixedThreadPool(
317 numberOfWorkers,
318 './tests/worker-files/thread/testWorker.mjs',
319 {
320 workerChoiceStrategyOptions: { weights: {} }
321 }
322 )
323 ).toThrow(
324 new Error(
325 'Invalid worker choice strategy options: must have a weight for each worker node'
326 )
327 )
328 expect(
329 () =>
330 new FixedThreadPool(
331 numberOfWorkers,
332 './tests/worker-files/thread/testWorker.mjs',
333 {
334 workerChoiceStrategyOptions: { measurement: 'invalidMeasurement' }
335 }
336 )
337 ).toThrow(
338 new Error(
339 "Invalid worker choice strategy options: invalid measurement 'invalidMeasurement'"
340 )
341 )
342 expect(
343 () =>
344 new FixedThreadPool(
345 numberOfWorkers,
346 './tests/worker-files/thread/testWorker.mjs',
347 {
348 enableTasksQueue: true,
349 tasksQueueOptions: 'invalidTasksQueueOptions'
350 }
351 )
352 ).toThrow(
353 new TypeError('Invalid tasks queue options: must be a plain object')
354 )
355 expect(
356 () =>
357 new FixedThreadPool(
358 numberOfWorkers,
359 './tests/worker-files/thread/testWorker.mjs',
360 {
361 enableTasksQueue: true,
362 tasksQueueOptions: { concurrency: 0 }
363 }
364 )
365 ).toThrow(
366 new RangeError(
367 'Invalid worker node tasks concurrency: 0 is a negative integer or zero'
368 )
369 )
370 expect(
371 () =>
372 new FixedThreadPool(
373 numberOfWorkers,
374 './tests/worker-files/thread/testWorker.mjs',
375 {
376 enableTasksQueue: true,
377 tasksQueueOptions: { concurrency: -1 }
378 }
379 )
380 ).toThrow(
381 new RangeError(
382 'Invalid worker node tasks concurrency: -1 is a negative integer or zero'
383 )
384 )
385 expect(
386 () =>
387 new FixedThreadPool(
388 numberOfWorkers,
389 './tests/worker-files/thread/testWorker.mjs',
390 {
391 enableTasksQueue: true,
392 tasksQueueOptions: { concurrency: 0.2 }
393 }
394 )
395 ).toThrow(
396 new TypeError('Invalid worker node tasks concurrency: must be an integer')
397 )
398 expect(
399 () =>
400 new FixedThreadPool(
401 numberOfWorkers,
402 './tests/worker-files/thread/testWorker.mjs',
403 {
404 enableTasksQueue: true,
405 tasksQueueOptions: { size: 0 }
406 }
407 )
408 ).toThrow(
409 new RangeError(
410 'Invalid worker node tasks queue size: 0 is a negative integer or zero'
411 )
412 )
413 expect(
414 () =>
415 new FixedThreadPool(
416 numberOfWorkers,
417 './tests/worker-files/thread/testWorker.mjs',
418 {
419 enableTasksQueue: true,
420 tasksQueueOptions: { size: -1 }
421 }
422 )
423 ).toThrow(
424 new RangeError(
425 'Invalid worker node tasks queue size: -1 is a negative integer or zero'
426 )
427 )
428 expect(
429 () =>
430 new FixedThreadPool(
431 numberOfWorkers,
432 './tests/worker-files/thread/testWorker.mjs',
433 {
434 enableTasksQueue: true,
435 tasksQueueOptions: { size: 0.2 }
436 }
437 )
438 ).toThrow(
439 new TypeError('Invalid worker node tasks queue size: must be an integer')
440 )
441 })
442
443 it('Verify that pool worker choice strategy options can be set', async () => {
444 const pool = new FixedThreadPool(
445 numberOfWorkers,
446 './tests/worker-files/thread/testWorker.mjs',
447 { workerChoiceStrategy: WorkerChoiceStrategies.FAIR_SHARE }
448 )
449 expect(pool.opts.workerChoiceStrategyOptions).toBeUndefined()
450 for (const [, workerChoiceStrategy] of pool.workerChoiceStrategiesContext
451 .workerChoiceStrategies) {
452 expect(workerChoiceStrategy.opts).toStrictEqual({
453 runTime: { median: false },
454 waitTime: { median: false },
455 elu: { median: false },
456 weights: expect.objectContaining({
457 0: expect.any(Number),
458 [pool.info.maxSize - 1]: expect.any(Number)
459 })
460 })
461 }
462 expect(
463 pool.workerChoiceStrategiesContext.getTaskStatisticsRequirements()
464 ).toStrictEqual({
465 runTime: {
466 aggregate: true,
467 average: true,
468 median: false
469 },
470 waitTime: {
471 aggregate: true,
472 average: true,
473 median: false
474 },
475 elu: {
476 aggregate: true,
477 average: true,
478 median: false
479 }
480 })
481 pool.setWorkerChoiceStrategyOptions({
482 runTime: { median: true },
483 elu: { median: true }
484 })
485 expect(pool.opts.workerChoiceStrategyOptions).toStrictEqual({
486 runTime: { median: true },
487 elu: { median: true }
488 })
489 for (const [, workerChoiceStrategy] of pool.workerChoiceStrategiesContext
490 .workerChoiceStrategies) {
491 expect(workerChoiceStrategy.opts).toStrictEqual({
492 runTime: { median: true },
493 waitTime: { median: false },
494 elu: { median: true },
495 weights: expect.objectContaining({
496 0: expect.any(Number),
497 [pool.info.maxSize - 1]: expect.any(Number)
498 })
499 })
500 }
501 expect(
502 pool.workerChoiceStrategiesContext.getTaskStatisticsRequirements()
503 ).toStrictEqual({
504 runTime: {
505 aggregate: true,
506 average: false,
507 median: true
508 },
509 waitTime: {
510 aggregate: true,
511 average: true,
512 median: false
513 },
514 elu: {
515 aggregate: true,
516 average: false,
517 median: true
518 }
519 })
520 pool.setWorkerChoiceStrategyOptions({
521 runTime: { median: false },
522 elu: { median: false }
523 })
524 expect(pool.opts.workerChoiceStrategyOptions).toStrictEqual({
525 runTime: { median: false },
526 elu: { median: false }
527 })
528 for (const [, workerChoiceStrategy] of pool.workerChoiceStrategiesContext
529 .workerChoiceStrategies) {
530 expect(workerChoiceStrategy.opts).toStrictEqual({
531 runTime: { median: false },
532 waitTime: { median: false },
533 elu: { median: false },
534 weights: expect.objectContaining({
535 0: expect.any(Number),
536 [pool.info.maxSize - 1]: expect.any(Number)
537 })
538 })
539 }
540 expect(
541 pool.workerChoiceStrategiesContext.getTaskStatisticsRequirements()
542 ).toStrictEqual({
543 runTime: {
544 aggregate: true,
545 average: true,
546 median: false
547 },
548 waitTime: {
549 aggregate: true,
550 average: true,
551 median: false
552 },
553 elu: {
554 aggregate: true,
555 average: true,
556 median: false
557 }
558 })
559 expect(() =>
560 pool.setWorkerChoiceStrategyOptions('invalidWorkerChoiceStrategyOptions')
561 ).toThrow(
562 new TypeError(
563 'Invalid worker choice strategy options: must be a plain object'
564 )
565 )
566 expect(() => pool.setWorkerChoiceStrategyOptions({ weights: {} })).toThrow(
567 new Error(
568 'Invalid worker choice strategy options: must have a weight for each worker node'
569 )
570 )
571 expect(() =>
572 pool.setWorkerChoiceStrategyOptions({ measurement: 'invalidMeasurement' })
573 ).toThrow(
574 new Error(
575 "Invalid worker choice strategy options: invalid measurement 'invalidMeasurement'"
576 )
577 )
578 await pool.destroy()
579 })
580
581 it('Verify that pool tasks queue can be enabled/disabled', async () => {
582 const pool = new FixedThreadPool(
583 numberOfWorkers,
584 './tests/worker-files/thread/testWorker.mjs'
585 )
586 expect(pool.opts.enableTasksQueue).toBe(false)
587 expect(pool.opts.tasksQueueOptions).toBeUndefined()
588 pool.enableTasksQueue(true)
589 expect(pool.opts.enableTasksQueue).toBe(true)
590 expect(pool.opts.tasksQueueOptions).toStrictEqual({
591 concurrency: 1,
592 size: Math.pow(numberOfWorkers, 2),
593 taskStealing: true,
594 tasksStealingOnBackPressure: true,
595 tasksFinishedTimeout: 2000
596 })
597 pool.enableTasksQueue(true, { concurrency: 2 })
598 expect(pool.opts.enableTasksQueue).toBe(true)
599 expect(pool.opts.tasksQueueOptions).toStrictEqual({
600 concurrency: 2,
601 size: Math.pow(numberOfWorkers, 2),
602 taskStealing: true,
603 tasksStealingOnBackPressure: true,
604 tasksFinishedTimeout: 2000
605 })
606 pool.enableTasksQueue(false)
607 expect(pool.opts.enableTasksQueue).toBe(false)
608 expect(pool.opts.tasksQueueOptions).toBeUndefined()
609 await pool.destroy()
610 })
611
612 it('Verify that pool tasks queue options can be set', async () => {
613 const pool = new FixedThreadPool(
614 numberOfWorkers,
615 './tests/worker-files/thread/testWorker.mjs',
616 { enableTasksQueue: true }
617 )
618 expect(pool.opts.tasksQueueOptions).toStrictEqual({
619 concurrency: 1,
620 size: Math.pow(numberOfWorkers, 2),
621 taskStealing: true,
622 tasksStealingOnBackPressure: true,
623 tasksFinishedTimeout: 2000
624 })
625 for (const workerNode of pool.workerNodes) {
626 expect(workerNode.tasksQueueBackPressureSize).toBe(
627 pool.opts.tasksQueueOptions.size
628 )
629 }
630 pool.setTasksQueueOptions({
631 concurrency: 2,
632 size: 2,
633 taskStealing: false,
634 tasksStealingOnBackPressure: false,
635 tasksFinishedTimeout: 3000
636 })
637 expect(pool.opts.tasksQueueOptions).toStrictEqual({
638 concurrency: 2,
639 size: 2,
640 taskStealing: false,
641 tasksStealingOnBackPressure: false,
642 tasksFinishedTimeout: 3000
643 })
644 for (const workerNode of pool.workerNodes) {
645 expect(workerNode.tasksQueueBackPressureSize).toBe(
646 pool.opts.tasksQueueOptions.size
647 )
648 }
649 pool.setTasksQueueOptions({
650 concurrency: 1,
651 taskStealing: true,
652 tasksStealingOnBackPressure: true
653 })
654 expect(pool.opts.tasksQueueOptions).toStrictEqual({
655 concurrency: 1,
656 size: Math.pow(numberOfWorkers, 2),
657 taskStealing: true,
658 tasksStealingOnBackPressure: true,
659 tasksFinishedTimeout: 2000
660 })
661 for (const workerNode of pool.workerNodes) {
662 expect(workerNode.tasksQueueBackPressureSize).toBe(
663 pool.opts.tasksQueueOptions.size
664 )
665 }
666 expect(() => pool.setTasksQueueOptions('invalidTasksQueueOptions')).toThrow(
667 new TypeError('Invalid tasks queue options: must be a plain object')
668 )
669 expect(() => pool.setTasksQueueOptions({ concurrency: 0 })).toThrow(
670 new RangeError(
671 'Invalid worker node tasks concurrency: 0 is a negative integer or zero'
672 )
673 )
674 expect(() => pool.setTasksQueueOptions({ concurrency: -1 })).toThrow(
675 new RangeError(
676 'Invalid worker node tasks concurrency: -1 is a negative integer or zero'
677 )
678 )
679 expect(() => pool.setTasksQueueOptions({ concurrency: 0.2 })).toThrow(
680 new TypeError('Invalid worker node tasks concurrency: must be an integer')
681 )
682 expect(() => pool.setTasksQueueOptions({ size: 0 })).toThrow(
683 new RangeError(
684 'Invalid worker node tasks queue size: 0 is a negative integer or zero'
685 )
686 )
687 expect(() => pool.setTasksQueueOptions({ size: -1 })).toThrow(
688 new RangeError(
689 'Invalid worker node tasks queue size: -1 is a negative integer or zero'
690 )
691 )
692 expect(() => pool.setTasksQueueOptions({ size: 0.2 })).toThrow(
693 new TypeError('Invalid worker node tasks queue size: must be an integer')
694 )
695 await pool.destroy()
696 })
697
698 it('Verify that pool info is set', async () => {
699 let pool = new FixedThreadPool(
700 numberOfWorkers,
701 './tests/worker-files/thread/testWorker.mjs'
702 )
703 expect(pool.info).toStrictEqual({
704 version,
705 type: PoolTypes.fixed,
706 worker: WorkerTypes.thread,
707 started: true,
708 ready: true,
709 defaultStrategy: WorkerChoiceStrategies.ROUND_ROBIN,
710 strategyRetries: 0,
711 minSize: numberOfWorkers,
712 maxSize: numberOfWorkers,
713 workerNodes: numberOfWorkers,
714 idleWorkerNodes: numberOfWorkers,
715 busyWorkerNodes: 0,
716 executedTasks: 0,
717 executingTasks: 0,
718 failedTasks: 0
719 })
720 await pool.destroy()
721 pool = new DynamicClusterPool(
722 Math.floor(numberOfWorkers / 2),
723 numberOfWorkers,
724 './tests/worker-files/cluster/testWorker.cjs'
725 )
726 expect(pool.info).toStrictEqual({
727 version,
728 type: PoolTypes.dynamic,
729 worker: WorkerTypes.cluster,
730 started: true,
731 ready: true,
732 defaultStrategy: WorkerChoiceStrategies.ROUND_ROBIN,
733 strategyRetries: 0,
734 minSize: Math.floor(numberOfWorkers / 2),
735 maxSize: numberOfWorkers,
736 workerNodes: Math.floor(numberOfWorkers / 2),
737 idleWorkerNodes: Math.floor(numberOfWorkers / 2),
738 busyWorkerNodes: 0,
739 executedTasks: 0,
740 executingTasks: 0,
741 failedTasks: 0
742 })
743 await pool.destroy()
744 })
745
746 it('Verify that pool worker tasks usage are initialized', async () => {
747 const pool = new FixedClusterPool(
748 numberOfWorkers,
749 './tests/worker-files/cluster/testWorker.cjs'
750 )
751 for (const workerNode of pool.workerNodes) {
752 expect(workerNode).toBeInstanceOf(WorkerNode)
753 expect(workerNode.usage).toStrictEqual({
754 tasks: {
755 executed: 0,
756 executing: 0,
757 queued: 0,
758 maxQueued: 0,
759 sequentiallyStolen: 0,
760 stolen: 0,
761 failed: 0
762 },
763 runTime: {
764 history: new CircularArray()
765 },
766 waitTime: {
767 history: new CircularArray()
768 },
769 elu: {
770 idle: {
771 history: new CircularArray()
772 },
773 active: {
774 history: new CircularArray()
775 }
776 }
777 })
778 }
779 await pool.destroy()
780 })
781
782 it('Verify that pool worker tasks queue are initialized', async () => {
783 let pool = new FixedClusterPool(
784 numberOfWorkers,
785 './tests/worker-files/cluster/testWorker.cjs'
786 )
787 for (const workerNode of pool.workerNodes) {
788 expect(workerNode).toBeInstanceOf(WorkerNode)
789 expect(workerNode.tasksQueue).toBeInstanceOf(PriorityQueue)
790 expect(workerNode.tasksQueue.size).toBe(0)
791 expect(workerNode.tasksQueue.maxSize).toBe(0)
792 }
793 await pool.destroy()
794 pool = new DynamicThreadPool(
795 Math.floor(numberOfWorkers / 2),
796 numberOfWorkers,
797 './tests/worker-files/thread/testWorker.mjs'
798 )
799 for (const workerNode of pool.workerNodes) {
800 expect(workerNode).toBeInstanceOf(WorkerNode)
801 expect(workerNode.tasksQueue).toBeInstanceOf(PriorityQueue)
802 expect(workerNode.tasksQueue.size).toBe(0)
803 expect(workerNode.tasksQueue.maxSize).toBe(0)
804 }
805 await pool.destroy()
806 })
807
808 it('Verify that pool worker info are initialized', async () => {
809 let pool = new FixedClusterPool(
810 numberOfWorkers,
811 './tests/worker-files/cluster/testWorker.cjs'
812 )
813 for (const workerNode of pool.workerNodes) {
814 expect(workerNode).toBeInstanceOf(WorkerNode)
815 expect(workerNode.info).toStrictEqual({
816 id: expect.any(Number),
817 type: WorkerTypes.cluster,
818 dynamic: false,
819 ready: true,
820 stealing: false
821 })
822 }
823 await pool.destroy()
824 pool = new DynamicThreadPool(
825 Math.floor(numberOfWorkers / 2),
826 numberOfWorkers,
827 './tests/worker-files/thread/testWorker.mjs'
828 )
829 for (const workerNode of pool.workerNodes) {
830 expect(workerNode).toBeInstanceOf(WorkerNode)
831 expect(workerNode.info).toStrictEqual({
832 id: expect.any(Number),
833 type: WorkerTypes.thread,
834 dynamic: false,
835 ready: true,
836 stealing: false
837 })
838 }
839 await pool.destroy()
840 })
841
842 it('Verify that pool statuses are checked at start or destroy', async () => {
843 const pool = new FixedThreadPool(
844 numberOfWorkers,
845 './tests/worker-files/thread/testWorker.mjs'
846 )
847 expect(pool.info.started).toBe(true)
848 expect(pool.info.ready).toBe(true)
849 expect(() => pool.start()).toThrow(
850 new Error('Cannot start an already started pool')
851 )
852 await pool.destroy()
853 expect(pool.info.started).toBe(false)
854 expect(pool.info.ready).toBe(false)
855 await expect(pool.destroy()).rejects.toThrow(
856 new Error('Cannot destroy an already destroyed pool')
857 )
858 })
859
860 it('Verify that pool can be started after initialization', async () => {
861 const pool = new FixedClusterPool(
862 numberOfWorkers,
863 './tests/worker-files/cluster/testWorker.cjs',
864 {
865 startWorkers: false
866 }
867 )
868 expect(pool.info.started).toBe(false)
869 expect(pool.info.ready).toBe(false)
870 expect(pool.workerNodes).toStrictEqual([])
871 expect(pool.readyEventEmitted).toBe(false)
872 await expect(pool.execute()).rejects.toThrow(
873 new Error('Cannot execute a task on not started pool')
874 )
875 pool.start()
876 expect(pool.info.started).toBe(true)
877 expect(pool.info.ready).toBe(true)
878 await waitPoolEvents(pool, PoolEvents.ready, 1)
879 expect(pool.readyEventEmitted).toBe(true)
880 expect(pool.workerNodes.length).toBe(numberOfWorkers)
881 for (const workerNode of pool.workerNodes) {
882 expect(workerNode).toBeInstanceOf(WorkerNode)
883 }
884 await pool.destroy()
885 })
886
887 it('Verify that pool execute() arguments are checked', async () => {
888 const pool = new FixedClusterPool(
889 numberOfWorkers,
890 './tests/worker-files/cluster/testWorker.cjs'
891 )
892 await expect(pool.execute(undefined, 0)).rejects.toThrow(
893 new TypeError('name argument must be a string')
894 )
895 await expect(pool.execute(undefined, '')).rejects.toThrow(
896 new TypeError('name argument must not be an empty string')
897 )
898 await expect(pool.execute(undefined, undefined, {})).rejects.toThrow(
899 new TypeError('transferList argument must be an array')
900 )
901 await expect(pool.execute(undefined, 'unknown')).rejects.toBe(
902 "Task function 'unknown' not found"
903 )
904 await pool.destroy()
905 await expect(pool.execute()).rejects.toThrow(
906 new Error('Cannot execute a task on not started pool')
907 )
908 })
909
910 it('Verify that pool worker tasks usage are computed', async () => {
911 const pool = new FixedClusterPool(
912 numberOfWorkers,
913 './tests/worker-files/cluster/testWorker.cjs'
914 )
915 const promises = new Set()
916 const maxMultiplier = 2
917 for (let i = 0; i < numberOfWorkers * maxMultiplier; i++) {
918 promises.add(pool.execute())
919 }
920 for (const workerNode of pool.workerNodes) {
921 expect(workerNode.usage).toStrictEqual({
922 tasks: {
923 executed: 0,
924 executing: maxMultiplier,
925 queued: 0,
926 maxQueued: 0,
927 sequentiallyStolen: 0,
928 stolen: 0,
929 failed: 0
930 },
931 runTime: {
932 history: expect.any(CircularArray)
933 },
934 waitTime: {
935 history: expect.any(CircularArray)
936 },
937 elu: {
938 idle: {
939 history: expect.any(CircularArray)
940 },
941 active: {
942 history: expect.any(CircularArray)
943 }
944 }
945 })
946 }
947 await Promise.all(promises)
948 for (const workerNode of pool.workerNodes) {
949 expect(workerNode.usage).toStrictEqual({
950 tasks: {
951 executed: maxMultiplier,
952 executing: 0,
953 queued: 0,
954 maxQueued: 0,
955 sequentiallyStolen: 0,
956 stolen: 0,
957 failed: 0
958 },
959 runTime: {
960 history: expect.any(CircularArray)
961 },
962 waitTime: {
963 history: expect.any(CircularArray)
964 },
965 elu: {
966 idle: {
967 history: expect.any(CircularArray)
968 },
969 active: {
970 history: expect.any(CircularArray)
971 }
972 }
973 })
974 }
975 await pool.destroy()
976 })
977
978 it("Verify that pool worker tasks usage aren't reset at worker choice strategy change", async () => {
979 const pool = new DynamicThreadPool(
980 Math.floor(numberOfWorkers / 2),
981 numberOfWorkers,
982 './tests/worker-files/thread/testWorker.mjs'
983 )
984 const promises = new Set()
985 const maxMultiplier = 2
986 for (let i = 0; i < numberOfWorkers * maxMultiplier; i++) {
987 promises.add(pool.execute())
988 }
989 await Promise.all(promises)
990 for (const workerNode of pool.workerNodes) {
991 expect(workerNode.usage).toStrictEqual({
992 tasks: {
993 executed: expect.any(Number),
994 executing: 0,
995 queued: 0,
996 maxQueued: 0,
997 sequentiallyStolen: 0,
998 stolen: 0,
999 failed: 0
1000 },
1001 runTime: {
1002 history: expect.any(CircularArray)
1003 },
1004 waitTime: {
1005 history: expect.any(CircularArray)
1006 },
1007 elu: {
1008 idle: {
1009 history: expect.any(CircularArray)
1010 },
1011 active: {
1012 history: expect.any(CircularArray)
1013 }
1014 }
1015 })
1016 expect(workerNode.usage.tasks.executed).toBeGreaterThan(0)
1017 expect(workerNode.usage.tasks.executed).toBeLessThanOrEqual(
1018 numberOfWorkers * maxMultiplier
1019 )
1020 expect(workerNode.usage.runTime.history.length).toBe(0)
1021 expect(workerNode.usage.waitTime.history.length).toBe(0)
1022 expect(workerNode.usage.elu.idle.history.length).toBe(0)
1023 expect(workerNode.usage.elu.active.history.length).toBe(0)
1024 }
1025 pool.setWorkerChoiceStrategy(WorkerChoiceStrategies.FAIR_SHARE)
1026 for (const workerNode of pool.workerNodes) {
1027 expect(workerNode.usage).toStrictEqual({
1028 tasks: {
1029 executed: expect.any(Number),
1030 executing: 0,
1031 queued: 0,
1032 maxQueued: 0,
1033 sequentiallyStolen: 0,
1034 stolen: 0,
1035 failed: 0
1036 },
1037 runTime: {
1038 history: expect.any(CircularArray)
1039 },
1040 waitTime: {
1041 history: expect.any(CircularArray)
1042 },
1043 elu: {
1044 idle: {
1045 history: expect.any(CircularArray)
1046 },
1047 active: {
1048 history: expect.any(CircularArray)
1049 }
1050 }
1051 })
1052 expect(workerNode.usage.tasks.executed).toBeGreaterThan(0)
1053 expect(workerNode.usage.tasks.executed).toBeLessThanOrEqual(
1054 numberOfWorkers * maxMultiplier
1055 )
1056 expect(workerNode.usage.runTime.history.length).toBe(0)
1057 expect(workerNode.usage.waitTime.history.length).toBe(0)
1058 expect(workerNode.usage.elu.idle.history.length).toBe(0)
1059 expect(workerNode.usage.elu.active.history.length).toBe(0)
1060 }
1061 await pool.destroy()
1062 })
1063
1064 it("Verify that pool event emitter 'ready' event can register a callback", async () => {
1065 const pool = new DynamicClusterPool(
1066 Math.floor(numberOfWorkers / 2),
1067 numberOfWorkers,
1068 './tests/worker-files/cluster/testWorker.cjs'
1069 )
1070 expect(pool.emitter.eventNames()).toStrictEqual([])
1071 let poolInfo
1072 let poolReady = 0
1073 pool.emitter.on(PoolEvents.ready, info => {
1074 ++poolReady
1075 poolInfo = info
1076 })
1077 await waitPoolEvents(pool, PoolEvents.ready, 1)
1078 expect(pool.emitter.eventNames()).toStrictEqual([PoolEvents.ready])
1079 expect(poolReady).toBe(1)
1080 expect(poolInfo).toStrictEqual({
1081 version,
1082 type: PoolTypes.dynamic,
1083 worker: WorkerTypes.cluster,
1084 started: true,
1085 ready: true,
1086 defaultStrategy: WorkerChoiceStrategies.ROUND_ROBIN,
1087 strategyRetries: expect.any(Number),
1088 minSize: expect.any(Number),
1089 maxSize: expect.any(Number),
1090 workerNodes: expect.any(Number),
1091 idleWorkerNodes: expect.any(Number),
1092 busyWorkerNodes: expect.any(Number),
1093 executedTasks: expect.any(Number),
1094 executingTasks: expect.any(Number),
1095 failedTasks: expect.any(Number)
1096 })
1097 await pool.destroy()
1098 })
1099
1100 it("Verify that pool event emitter 'busy' event can register a callback", async () => {
1101 const pool = new FixedThreadPool(
1102 numberOfWorkers,
1103 './tests/worker-files/thread/testWorker.mjs'
1104 )
1105 expect(pool.emitter.eventNames()).toStrictEqual([])
1106 const promises = new Set()
1107 let poolBusy = 0
1108 let poolInfo
1109 pool.emitter.on(PoolEvents.busy, info => {
1110 ++poolBusy
1111 poolInfo = info
1112 })
1113 expect(pool.emitter.eventNames()).toStrictEqual([PoolEvents.busy])
1114 for (let i = 0; i < numberOfWorkers * 2; i++) {
1115 promises.add(pool.execute())
1116 }
1117 await Promise.all(promises)
1118 // The `busy` event is triggered when the number of submitted tasks at once reach the number of fixed pool workers.
1119 // So in total numberOfWorkers + 1 times for a loop submitting up to numberOfWorkers * 2 tasks to the fixed pool.
1120 expect(poolBusy).toBe(numberOfWorkers + 1)
1121 expect(poolInfo).toStrictEqual({
1122 version,
1123 type: PoolTypes.fixed,
1124 worker: WorkerTypes.thread,
1125 started: true,
1126 ready: true,
1127 defaultStrategy: WorkerChoiceStrategies.ROUND_ROBIN,
1128 strategyRetries: expect.any(Number),
1129 minSize: expect.any(Number),
1130 maxSize: expect.any(Number),
1131 workerNodes: expect.any(Number),
1132 idleWorkerNodes: expect.any(Number),
1133 busyWorkerNodes: expect.any(Number),
1134 executedTasks: expect.any(Number),
1135 executingTasks: expect.any(Number),
1136 failedTasks: expect.any(Number)
1137 })
1138 await pool.destroy()
1139 })
1140
1141 it("Verify that pool event emitter 'full' event can register a callback", async () => {
1142 const pool = new DynamicThreadPool(
1143 Math.floor(numberOfWorkers / 2),
1144 numberOfWorkers,
1145 './tests/worker-files/thread/testWorker.mjs'
1146 )
1147 expect(pool.emitter.eventNames()).toStrictEqual([])
1148 const promises = new Set()
1149 let poolFull = 0
1150 let poolInfo
1151 pool.emitter.on(PoolEvents.full, info => {
1152 ++poolFull
1153 poolInfo = info
1154 })
1155 expect(pool.emitter.eventNames()).toStrictEqual([PoolEvents.full])
1156 for (let i = 0; i < numberOfWorkers * 2; i++) {
1157 promises.add(pool.execute())
1158 }
1159 await Promise.all(promises)
1160 expect(poolFull).toBe(1)
1161 expect(poolInfo).toStrictEqual({
1162 version,
1163 type: PoolTypes.dynamic,
1164 worker: WorkerTypes.thread,
1165 started: true,
1166 ready: true,
1167 defaultStrategy: WorkerChoiceStrategies.ROUND_ROBIN,
1168 strategyRetries: expect.any(Number),
1169 minSize: expect.any(Number),
1170 maxSize: expect.any(Number),
1171 workerNodes: expect.any(Number),
1172 idleWorkerNodes: expect.any(Number),
1173 busyWorkerNodes: expect.any(Number),
1174 executedTasks: expect.any(Number),
1175 executingTasks: expect.any(Number),
1176 failedTasks: expect.any(Number)
1177 })
1178 await pool.destroy()
1179 })
1180
1181 it("Verify that pool event emitter 'backPressure' event can register a callback", async () => {
1182 const pool = new FixedThreadPool(
1183 numberOfWorkers,
1184 './tests/worker-files/thread/testWorker.mjs',
1185 {
1186 enableTasksQueue: true
1187 }
1188 )
1189 stub(pool, 'hasBackPressure').returns(true)
1190 expect(pool.emitter.eventNames()).toStrictEqual([])
1191 const promises = new Set()
1192 let poolBackPressure = 0
1193 let poolInfo
1194 pool.emitter.on(PoolEvents.backPressure, info => {
1195 ++poolBackPressure
1196 poolInfo = info
1197 })
1198 expect(pool.emitter.eventNames()).toStrictEqual([PoolEvents.backPressure])
1199 for (let i = 0; i < numberOfWorkers + 1; i++) {
1200 promises.add(pool.execute())
1201 }
1202 await Promise.all(promises)
1203 expect(poolBackPressure).toBe(1)
1204 expect(poolInfo).toStrictEqual({
1205 version,
1206 type: PoolTypes.fixed,
1207 worker: WorkerTypes.thread,
1208 started: true,
1209 ready: true,
1210 defaultStrategy: WorkerChoiceStrategies.ROUND_ROBIN,
1211 strategyRetries: expect.any(Number),
1212 minSize: expect.any(Number),
1213 maxSize: expect.any(Number),
1214 workerNodes: expect.any(Number),
1215 idleWorkerNodes: expect.any(Number),
1216 stealingWorkerNodes: expect.any(Number),
1217 busyWorkerNodes: expect.any(Number),
1218 executedTasks: expect.any(Number),
1219 executingTasks: expect.any(Number),
1220 maxQueuedTasks: expect.any(Number),
1221 queuedTasks: expect.any(Number),
1222 backPressure: true,
1223 stolenTasks: expect.any(Number),
1224 failedTasks: expect.any(Number)
1225 })
1226 expect(pool.hasBackPressure.callCount).toBeGreaterThanOrEqual(7)
1227 await pool.destroy()
1228 })
1229
1230 it('Verify that destroy() waits for queued tasks to finish', async () => {
1231 const tasksFinishedTimeout = 2500
1232 const pool = new FixedThreadPool(
1233 numberOfWorkers,
1234 './tests/worker-files/thread/asyncWorker.mjs',
1235 {
1236 enableTasksQueue: true,
1237 tasksQueueOptions: { tasksFinishedTimeout }
1238 }
1239 )
1240 const maxMultiplier = 4
1241 let tasksFinished = 0
1242 for (const workerNode of pool.workerNodes) {
1243 workerNode.on('taskFinished', () => {
1244 ++tasksFinished
1245 })
1246 }
1247 for (let i = 0; i < numberOfWorkers * maxMultiplier; i++) {
1248 pool.execute()
1249 }
1250 expect(pool.info.queuedTasks).toBeGreaterThan(0)
1251 const startTime = performance.now()
1252 await pool.destroy()
1253 const elapsedTime = performance.now() - startTime
1254 expect(tasksFinished).toBeLessThanOrEqual(numberOfWorkers * maxMultiplier)
1255 expect(elapsedTime).toBeGreaterThanOrEqual(2000)
1256 expect(elapsedTime).toBeLessThanOrEqual(tasksFinishedTimeout + 800)
1257 })
1258
1259 it('Verify that destroy() waits until the tasks finished timeout is reached', async () => {
1260 const tasksFinishedTimeout = 1000
1261 const pool = new FixedThreadPool(
1262 numberOfWorkers,
1263 './tests/worker-files/thread/asyncWorker.mjs',
1264 {
1265 enableTasksQueue: true,
1266 tasksQueueOptions: { tasksFinishedTimeout }
1267 }
1268 )
1269 const maxMultiplier = 4
1270 let tasksFinished = 0
1271 for (const workerNode of pool.workerNodes) {
1272 workerNode.on('taskFinished', () => {
1273 ++tasksFinished
1274 })
1275 }
1276 for (let i = 0; i < numberOfWorkers * maxMultiplier; i++) {
1277 pool.execute()
1278 }
1279 expect(pool.info.queuedTasks).toBeGreaterThan(0)
1280 const startTime = performance.now()
1281 await pool.destroy()
1282 const elapsedTime = performance.now() - startTime
1283 expect(tasksFinished).toBe(0)
1284 expect(elapsedTime).toBeLessThanOrEqual(tasksFinishedTimeout + 800)
1285 })
1286
1287 it('Verify that pool asynchronous resource track tasks execution', async () => {
1288 let taskAsyncId
1289 let initCalls = 0
1290 let beforeCalls = 0
1291 let afterCalls = 0
1292 let resolveCalls = 0
1293 const hook = createHook({
1294 init (asyncId, type) {
1295 if (type === 'poolifier:task') {
1296 initCalls++
1297 taskAsyncId = asyncId
1298 }
1299 },
1300 before (asyncId) {
1301 if (asyncId === taskAsyncId) beforeCalls++
1302 },
1303 after (asyncId) {
1304 if (asyncId === taskAsyncId) afterCalls++
1305 },
1306 promiseResolve () {
1307 if (executionAsyncId() === taskAsyncId) resolveCalls++
1308 }
1309 })
1310 const pool = new FixedThreadPool(
1311 numberOfWorkers,
1312 './tests/worker-files/thread/testWorker.mjs'
1313 )
1314 hook.enable()
1315 await pool.execute()
1316 hook.disable()
1317 expect(initCalls).toBe(1)
1318 expect(beforeCalls).toBe(1)
1319 expect(afterCalls).toBe(1)
1320 expect(resolveCalls).toBe(1)
1321 await pool.destroy()
1322 })
1323
1324 it('Verify that hasTaskFunction() is working', async () => {
1325 const dynamicThreadPool = new DynamicThreadPool(
1326 Math.floor(numberOfWorkers / 2),
1327 numberOfWorkers,
1328 './tests/worker-files/thread/testMultipleTaskFunctionsWorker.mjs'
1329 )
1330 await waitPoolEvents(dynamicThreadPool, PoolEvents.ready, 1)
1331 expect(dynamicThreadPool.hasTaskFunction(DEFAULT_TASK_NAME)).toBe(true)
1332 expect(dynamicThreadPool.hasTaskFunction('jsonIntegerSerialization')).toBe(
1333 true
1334 )
1335 expect(dynamicThreadPool.hasTaskFunction('factorial')).toBe(true)
1336 expect(dynamicThreadPool.hasTaskFunction('fibonacci')).toBe(true)
1337 expect(dynamicThreadPool.hasTaskFunction('unknown')).toBe(false)
1338 await dynamicThreadPool.destroy()
1339 const fixedClusterPool = new FixedClusterPool(
1340 numberOfWorkers,
1341 './tests/worker-files/cluster/testMultipleTaskFunctionsWorker.cjs'
1342 )
1343 await waitPoolEvents(fixedClusterPool, PoolEvents.ready, 1)
1344 expect(fixedClusterPool.hasTaskFunction(DEFAULT_TASK_NAME)).toBe(true)
1345 expect(fixedClusterPool.hasTaskFunction('jsonIntegerSerialization')).toBe(
1346 true
1347 )
1348 expect(fixedClusterPool.hasTaskFunction('factorial')).toBe(true)
1349 expect(fixedClusterPool.hasTaskFunction('fibonacci')).toBe(true)
1350 expect(fixedClusterPool.hasTaskFunction('unknown')).toBe(false)
1351 await fixedClusterPool.destroy()
1352 })
1353
1354 it('Verify that addTaskFunction() is working', async () => {
1355 const dynamicThreadPool = new DynamicThreadPool(
1356 Math.floor(numberOfWorkers / 2),
1357 numberOfWorkers,
1358 './tests/worker-files/thread/testWorker.mjs'
1359 )
1360 await waitPoolEvents(dynamicThreadPool, PoolEvents.ready, 1)
1361 await expect(
1362 dynamicThreadPool.addTaskFunction(0, () => {})
1363 ).rejects.toThrow(new TypeError('name argument must be a string'))
1364 await expect(
1365 dynamicThreadPool.addTaskFunction('', () => {})
1366 ).rejects.toThrow(
1367 new TypeError('name argument must not be an empty string')
1368 )
1369 await expect(dynamicThreadPool.addTaskFunction('test', 0)).rejects.toThrow(
1370 new TypeError('taskFunction property must be a function')
1371 )
1372 await expect(dynamicThreadPool.addTaskFunction('test', '')).rejects.toThrow(
1373 new TypeError('taskFunction property must be a function')
1374 )
1375 await expect(
1376 dynamicThreadPool.addTaskFunction('test', { taskFunction: 0 })
1377 ).rejects.toThrow(new TypeError('taskFunction property must be a function'))
1378 await expect(
1379 dynamicThreadPool.addTaskFunction('test', { taskFunction: '' })
1380 ).rejects.toThrow(new TypeError('taskFunction property must be a function'))
1381 await expect(
1382 dynamicThreadPool.addTaskFunction('test', {
1383 taskFunction: () => {},
1384 priority: -21
1385 })
1386 ).rejects.toThrow(
1387 new RangeError("Property 'priority' must be between -20 and 19")
1388 )
1389 await expect(
1390 dynamicThreadPool.addTaskFunction('test', {
1391 taskFunction: () => {},
1392 priority: 20
1393 })
1394 ).rejects.toThrow(
1395 new RangeError("Property 'priority' must be between -20 and 19")
1396 )
1397 await expect(
1398 dynamicThreadPool.addTaskFunction('test', {
1399 taskFunction: () => {},
1400 strategy: 'invalidStrategy'
1401 })
1402 ).rejects.toThrow(
1403 new Error("Invalid worker choice strategy 'invalidStrategy'")
1404 )
1405 expect(dynamicThreadPool.listTaskFunctionsProperties()).toStrictEqual([
1406 { name: DEFAULT_TASK_NAME },
1407 { name: 'test' }
1408 ])
1409 expect([
1410 ...dynamicThreadPool.workerChoiceStrategiesContext.workerChoiceStrategies.keys()
1411 ]).toStrictEqual([WorkerChoiceStrategies.ROUND_ROBIN])
1412 const echoTaskFunction = data => {
1413 return data
1414 }
1415 await expect(
1416 dynamicThreadPool.addTaskFunction('echo', {
1417 taskFunction: echoTaskFunction,
1418 strategy: WorkerChoiceStrategies.LEAST_ELU
1419 })
1420 ).resolves.toBe(true)
1421 expect(dynamicThreadPool.taskFunctions.size).toBe(1)
1422 expect(dynamicThreadPool.taskFunctions.get('echo')).toStrictEqual({
1423 taskFunction: echoTaskFunction,
1424 strategy: WorkerChoiceStrategies.LEAST_ELU
1425 })
1426 expect([
1427 ...dynamicThreadPool.workerChoiceStrategiesContext.workerChoiceStrategies.keys()
1428 ]).toStrictEqual([
1429 WorkerChoiceStrategies.ROUND_ROBIN,
1430 WorkerChoiceStrategies.LEAST_ELU
1431 ])
1432 expect(dynamicThreadPool.listTaskFunctionsProperties()).toStrictEqual([
1433 { name: DEFAULT_TASK_NAME },
1434 { name: 'test' },
1435 { name: 'echo', strategy: WorkerChoiceStrategies.LEAST_ELU }
1436 ])
1437 const taskFunctionData = { test: 'test' }
1438 const echoResult = await dynamicThreadPool.execute(taskFunctionData, 'echo')
1439 expect(echoResult).toStrictEqual(taskFunctionData)
1440 for (const workerNode of dynamicThreadPool.workerNodes) {
1441 expect(workerNode.getTaskFunctionWorkerUsage('echo')).toStrictEqual({
1442 tasks: {
1443 executed: expect.any(Number),
1444 executing: 0,
1445 queued: 0,
1446 sequentiallyStolen: 0,
1447 stolen: 0,
1448 failed: 0
1449 },
1450 runTime: {
1451 history: new CircularArray()
1452 },
1453 waitTime: {
1454 history: new CircularArray()
1455 },
1456 elu: {
1457 idle: {
1458 aggregate: 0,
1459 maximum: 0,
1460 minimum: 0,
1461 history: new CircularArray()
1462 },
1463 active: {
1464 aggregate: 0,
1465 maximum: 0,
1466 minimum: 0,
1467 history: new CircularArray()
1468 }
1469 }
1470 })
1471 }
1472 await dynamicThreadPool.destroy()
1473 })
1474
1475 it('Verify that removeTaskFunction() is working', async () => {
1476 const dynamicThreadPool = new DynamicThreadPool(
1477 Math.floor(numberOfWorkers / 2),
1478 numberOfWorkers,
1479 './tests/worker-files/thread/testWorker.mjs'
1480 )
1481 await waitPoolEvents(dynamicThreadPool, PoolEvents.ready, 1)
1482 expect(dynamicThreadPool.listTaskFunctionsProperties()).toStrictEqual([
1483 { name: DEFAULT_TASK_NAME },
1484 { name: 'test' }
1485 ])
1486 await expect(dynamicThreadPool.removeTaskFunction('test')).rejects.toThrow(
1487 new Error('Cannot remove a task function not handled on the pool side')
1488 )
1489 const echoTaskFunction = data => {
1490 return data
1491 }
1492 await dynamicThreadPool.addTaskFunction('echo', {
1493 taskFunction: echoTaskFunction,
1494 strategy: WorkerChoiceStrategies.LEAST_ELU
1495 })
1496 expect(dynamicThreadPool.taskFunctions.size).toBe(1)
1497 expect(dynamicThreadPool.taskFunctions.get('echo')).toStrictEqual({
1498 taskFunction: echoTaskFunction,
1499 strategy: WorkerChoiceStrategies.LEAST_ELU
1500 })
1501 expect([
1502 ...dynamicThreadPool.workerChoiceStrategiesContext.workerChoiceStrategies.keys()
1503 ]).toStrictEqual([
1504 WorkerChoiceStrategies.ROUND_ROBIN,
1505 WorkerChoiceStrategies.LEAST_ELU
1506 ])
1507 expect(dynamicThreadPool.listTaskFunctionsProperties()).toStrictEqual([
1508 { name: DEFAULT_TASK_NAME },
1509 { name: 'test' },
1510 { name: 'echo', strategy: WorkerChoiceStrategies.LEAST_ELU }
1511 ])
1512 await expect(dynamicThreadPool.removeTaskFunction('echo')).resolves.toBe(
1513 true
1514 )
1515 expect(dynamicThreadPool.taskFunctions.size).toBe(0)
1516 expect(dynamicThreadPool.taskFunctions.get('echo')).toBeUndefined()
1517 expect([
1518 ...dynamicThreadPool.workerChoiceStrategiesContext.workerChoiceStrategies.keys()
1519 ]).toStrictEqual([WorkerChoiceStrategies.ROUND_ROBIN])
1520 expect(dynamicThreadPool.listTaskFunctionsProperties()).toStrictEqual([
1521 { name: DEFAULT_TASK_NAME },
1522 { name: 'test' }
1523 ])
1524 await dynamicThreadPool.destroy()
1525 })
1526
1527 it('Verify that listTaskFunctionsProperties() is working', async () => {
1528 const dynamicThreadPool = new DynamicThreadPool(
1529 Math.floor(numberOfWorkers / 2),
1530 numberOfWorkers,
1531 './tests/worker-files/thread/testMultipleTaskFunctionsWorker.mjs'
1532 )
1533 await waitPoolEvents(dynamicThreadPool, PoolEvents.ready, 1)
1534 expect(dynamicThreadPool.listTaskFunctionsProperties()).toStrictEqual([
1535 { name: DEFAULT_TASK_NAME },
1536 { name: 'jsonIntegerSerialization' },
1537 { name: 'factorial' },
1538 { name: 'fibonacci' }
1539 ])
1540 await dynamicThreadPool.destroy()
1541 const fixedClusterPool = new FixedClusterPool(
1542 numberOfWorkers,
1543 './tests/worker-files/cluster/testMultipleTaskFunctionsWorker.cjs'
1544 )
1545 await waitPoolEvents(fixedClusterPool, PoolEvents.ready, 1)
1546 expect(fixedClusterPool.listTaskFunctionsProperties()).toStrictEqual([
1547 { name: DEFAULT_TASK_NAME },
1548 { name: 'jsonIntegerSerialization' },
1549 { name: 'factorial' },
1550 { name: 'fibonacci' }
1551 ])
1552 await fixedClusterPool.destroy()
1553 })
1554
1555 it('Verify that setDefaultTaskFunction() is working', async () => {
1556 const dynamicThreadPool = new DynamicThreadPool(
1557 Math.floor(numberOfWorkers / 2),
1558 numberOfWorkers,
1559 './tests/worker-files/thread/testMultipleTaskFunctionsWorker.mjs'
1560 )
1561 await waitPoolEvents(dynamicThreadPool, PoolEvents.ready, 1)
1562 const workerId = dynamicThreadPool.workerNodes[0].info.id
1563 await expect(dynamicThreadPool.setDefaultTaskFunction(0)).rejects.toThrow(
1564 new Error(
1565 `Task function operation 'default' failed on worker ${workerId} with error: 'TypeError: name parameter is not a string'`
1566 )
1567 )
1568 await expect(
1569 dynamicThreadPool.setDefaultTaskFunction(DEFAULT_TASK_NAME)
1570 ).rejects.toThrow(
1571 new Error(
1572 `Task function operation 'default' failed on worker ${workerId} with error: 'Error: Cannot set the default task function reserved name as the default task function'`
1573 )
1574 )
1575 await expect(
1576 dynamicThreadPool.setDefaultTaskFunction('unknown')
1577 ).rejects.toThrow(
1578 new Error(
1579 `Task function operation 'default' failed on worker ${workerId} with error: 'Error: Cannot set the default task function to a non-existing task function'`
1580 )
1581 )
1582 expect(dynamicThreadPool.listTaskFunctionsProperties()).toStrictEqual([
1583 { name: DEFAULT_TASK_NAME },
1584 { name: 'jsonIntegerSerialization' },
1585 { name: 'factorial' },
1586 { name: 'fibonacci' }
1587 ])
1588 await expect(
1589 dynamicThreadPool.setDefaultTaskFunction('factorial')
1590 ).resolves.toBe(true)
1591 expect(dynamicThreadPool.listTaskFunctionsProperties()).toStrictEqual([
1592 { name: DEFAULT_TASK_NAME },
1593 { name: 'factorial' },
1594 { name: 'jsonIntegerSerialization' },
1595 { name: 'fibonacci' }
1596 ])
1597 await expect(
1598 dynamicThreadPool.setDefaultTaskFunction('fibonacci')
1599 ).resolves.toBe(true)
1600 expect(dynamicThreadPool.listTaskFunctionsProperties()).toStrictEqual([
1601 { name: DEFAULT_TASK_NAME },
1602 { name: 'fibonacci' },
1603 { name: 'jsonIntegerSerialization' },
1604 { name: 'factorial' }
1605 ])
1606 await dynamicThreadPool.destroy()
1607 })
1608
1609 it('Verify that multiple task functions worker is working', async () => {
1610 const pool = new DynamicClusterPool(
1611 Math.floor(numberOfWorkers / 2),
1612 numberOfWorkers,
1613 './tests/worker-files/cluster/testMultipleTaskFunctionsWorker.cjs'
1614 )
1615 const data = { n: 10 }
1616 const result0 = await pool.execute(data)
1617 expect(result0).toStrictEqual({ ok: 1 })
1618 const result1 = await pool.execute(data, 'jsonIntegerSerialization')
1619 expect(result1).toStrictEqual({ ok: 1 })
1620 const result2 = await pool.execute(data, 'factorial')
1621 expect(result2).toBe(3628800)
1622 const result3 = await pool.execute(data, 'fibonacci')
1623 expect(result3).toBe(55)
1624 expect(pool.info.executingTasks).toBe(0)
1625 expect(pool.info.executedTasks).toBe(4)
1626 for (const workerNode of pool.workerNodes) {
1627 expect(workerNode.info.taskFunctionsProperties).toStrictEqual([
1628 { name: DEFAULT_TASK_NAME },
1629 { name: 'jsonIntegerSerialization' },
1630 { name: 'factorial' },
1631 { name: 'fibonacci' }
1632 ])
1633 expect(workerNode.taskFunctionsUsage.size).toBe(3)
1634 for (const taskFunctionProperties of pool.listTaskFunctionsProperties()) {
1635 expect(
1636 workerNode.getTaskFunctionWorkerUsage(taskFunctionProperties.name)
1637 ).toStrictEqual({
1638 tasks: {
1639 executed: expect.any(Number),
1640 executing: 0,
1641 failed: 0,
1642 queued: 0,
1643 sequentiallyStolen: 0,
1644 stolen: 0
1645 },
1646 runTime: {
1647 history: expect.any(CircularArray)
1648 },
1649 waitTime: {
1650 history: expect.any(CircularArray)
1651 },
1652 elu: {
1653 idle: {
1654 history: expect.any(CircularArray)
1655 },
1656 active: {
1657 history: expect.any(CircularArray)
1658 }
1659 }
1660 })
1661 expect(
1662 workerNode.getTaskFunctionWorkerUsage(taskFunctionProperties.name)
1663 .tasks.executed
1664 ).toBeGreaterThan(0)
1665 }
1666 expect(
1667 workerNode.getTaskFunctionWorkerUsage(DEFAULT_TASK_NAME)
1668 ).toStrictEqual(
1669 workerNode.getTaskFunctionWorkerUsage(
1670 workerNode.info.taskFunctionsProperties[1].name
1671 )
1672 )
1673 }
1674 await pool.destroy()
1675 })
1676
1677 it('Verify sendKillMessageToWorker()', async () => {
1678 const pool = new DynamicClusterPool(
1679 Math.floor(numberOfWorkers / 2),
1680 numberOfWorkers,
1681 './tests/worker-files/cluster/testWorker.cjs'
1682 )
1683 const workerNodeKey = 0
1684 await expect(
1685 pool.sendKillMessageToWorker(workerNodeKey)
1686 ).resolves.toBeUndefined()
1687 await pool.destroy()
1688 })
1689
1690 it('Verify sendTaskFunctionOperationToWorker()', async () => {
1691 const pool = new DynamicClusterPool(
1692 Math.floor(numberOfWorkers / 2),
1693 numberOfWorkers,
1694 './tests/worker-files/cluster/testWorker.cjs'
1695 )
1696 const workerNodeKey = 0
1697 await expect(
1698 pool.sendTaskFunctionOperationToWorker(workerNodeKey, {
1699 taskFunctionOperation: 'add',
1700 taskFunctionProperties: { name: 'empty' },
1701 taskFunction: (() => {}).toString()
1702 })
1703 ).resolves.toBe(true)
1704 expect(
1705 pool.workerNodes[workerNodeKey].info.taskFunctionsProperties
1706 ).toStrictEqual([
1707 { name: DEFAULT_TASK_NAME },
1708 { name: 'test' },
1709 { name: 'empty' }
1710 ])
1711 await pool.destroy()
1712 })
1713
1714 it('Verify sendTaskFunctionOperationToWorkers()', async () => {
1715 const pool = new DynamicClusterPool(
1716 Math.floor(numberOfWorkers / 2),
1717 numberOfWorkers,
1718 './tests/worker-files/cluster/testWorker.cjs'
1719 )
1720 await expect(
1721 pool.sendTaskFunctionOperationToWorkers({
1722 taskFunctionOperation: 'add',
1723 taskFunctionProperties: { name: 'empty' },
1724 taskFunction: (() => {}).toString()
1725 })
1726 ).resolves.toBe(true)
1727 for (const workerNode of pool.workerNodes) {
1728 expect(workerNode.info.taskFunctionsProperties).toStrictEqual([
1729 { name: DEFAULT_TASK_NAME },
1730 { name: 'test' },
1731 { name: 'empty' }
1732 ])
1733 }
1734 await pool.destroy()
1735 })
1736 })