Enchance benchmarking code
[poolifier.git] / tests / pools / thread / fixed.test.js
1 const { expect } = require('expect')
2 const { FixedThreadPool } = require('../../../lib/index')
3 const { WorkerFunctions } = require('../../test-types')
4 const TestUtils = require('../../test-utils')
5
6 describe('Fixed thread pool test suite', () => {
7 const numberOfThreads = 6
8 const pool = new FixedThreadPool(
9 numberOfThreads,
10 './tests/worker-files/thread/testWorker.js',
11 {
12 errorHandler: e => console.error(e)
13 }
14 )
15 const emptyPool = new FixedThreadPool(
16 numberOfThreads,
17 './tests/worker-files/thread/emptyWorker.js',
18 { exitHandler: () => console.log('empty pool worker exited') }
19 )
20 const echoPool = new FixedThreadPool(
21 numberOfThreads,
22 './tests/worker-files/thread/echoWorker.js'
23 )
24 const errorPool = new FixedThreadPool(
25 numberOfThreads,
26 './tests/worker-files/thread/errorWorker.js',
27 {
28 errorHandler: e => console.error(e)
29 }
30 )
31 const asyncErrorPool = new FixedThreadPool(
32 numberOfThreads,
33 './tests/worker-files/thread/asyncErrorWorker.js',
34 {
35 errorHandler: e => console.error(e)
36 }
37 )
38 const asyncPool = new FixedThreadPool(
39 numberOfThreads,
40 './tests/worker-files/thread/asyncWorker.js'
41 )
42
43 after('Destroy all pools', async () => {
44 // We need to clean up the resources after our test
45 await echoPool.destroy()
46 await asyncPool.destroy()
47 await errorPool.destroy()
48 await asyncErrorPool.destroy()
49 await emptyPool.destroy()
50 })
51
52 it('Choose worker round robin test', async () => {
53 const results = new Set()
54 for (let i = 0; i < numberOfThreads; i++) {
55 results.add(pool.chooseWorker().threadId)
56 }
57 expect(results.size).toBe(numberOfThreads)
58 })
59
60 it('Verify that the function is executed in a worker thread', async () => {
61 let result = await pool.execute({
62 function: WorkerFunctions.fibonacci
63 })
64 expect(result).toBe(false)
65 result = await pool.execute({
66 function: WorkerFunctions.factorial
67 })
68 expect(result).toBe(false)
69 })
70
71 it('Verify that is possible to invoke the execute method without input', async () => {
72 const result = await pool.execute()
73 expect(result).toBe(false)
74 })
75
76 it('Verify that busy event is emitted', async () => {
77 const promises = []
78 let poolBusy = 0
79 pool.emitter.on('busy', () => poolBusy++)
80 for (let i = 0; i < numberOfThreads * 2; i++) {
81 promises.push(pool.execute())
82 }
83 // The `busy` event is triggered when the number of submitted tasks at once reach the number of fixed pool workers.
84 // So in total numberOfThreads + 1 times for a loop submitting up to numberOfThreads * 2 tasks to the fixed pool.
85 expect(poolBusy).toBe(numberOfThreads + 1)
86 })
87
88 it('Verify that is possible to have a worker that return undefined', async () => {
89 const result = await emptyPool.execute()
90 expect(result).toBeUndefined()
91 })
92
93 it('Verify that data are sent to the worker correctly', async () => {
94 const data = { f: 10 }
95 const result = await echoPool.execute(data)
96 expect(result).toStrictEqual(data)
97 })
98
99 it('Verify that error handling is working properly:sync', async () => {
100 const data = { f: 10 }
101 let inError
102 try {
103 await errorPool.execute(data)
104 } catch (e) {
105 inError = e
106 }
107 expect(inError).toBeDefined()
108 expect(inError).toBeInstanceOf(Error)
109 expect(inError.message).toBeDefined()
110 expect(typeof inError.message === 'string').toBe(true)
111 expect(inError.message).toBe('Error Message from ThreadWorker')
112 })
113
114 it('Verify that error handling is working properly:async', async () => {
115 const data = { f: 10 }
116 let inError
117 try {
118 await asyncErrorPool.execute(data)
119 } catch (e) {
120 inError = e
121 }
122 expect(inError).toBeDefined()
123 expect(inError).toBeInstanceOf(Error)
124 expect(inError.message).toBeDefined()
125 expect(typeof inError.message === 'string').toBe(true)
126 expect(inError.message).toBe('Error Message from ThreadWorker:async')
127 })
128
129 it('Verify that async function is working properly', async () => {
130 const data = { f: 10 }
131 const startTime = Date.now()
132 const result = await asyncPool.execute(data)
133 const usedTime = Date.now() - startTime
134 expect(result).toStrictEqual(data)
135 expect(usedTime).toBeGreaterThanOrEqual(2000)
136 })
137
138 it('Shutdown test', async () => {
139 const exitPromise = TestUtils.waitExits(pool, numberOfThreads)
140 await pool.destroy()
141 const numberOfExitEvents = await exitPromise
142 expect(numberOfExitEvents).toBe(numberOfThreads)
143 })
144
145 it('Should work even without opts in input', async () => {
146 const pool1 = new FixedThreadPool(
147 numberOfThreads,
148 './tests/worker-files/thread/testWorker.js'
149 )
150 const res = await pool1.execute()
151 expect(res).toBe(false)
152 // We need to clean up the resources after our test
153 await pool1.destroy()
154 })
155
156 it('Verify that a pool with zero worker fails', async () => {
157 expect(
158 () => new FixedThreadPool(0, './tests/worker-files/thread/testWorker.js')
159 ).toThrowError(new Error('Cannot instantiate a fixed pool with no worker'))
160 })
161 })