Commit | Line | Data |
---|---|---|
a61a0724 | 1 | const { expect } = require('expect') |
cdace0e5 | 2 | const { FixedThreadPool, PoolEvents } = require('../../../lib') |
2d2e32c2 | 3 | const { WorkerFunctions } = require('../../test-types') |
85a3f8a7 | 4 | const TestUtils = require('../../test-utils') |
506c2a14 | 5 | |
a35560ba | 6 | describe('Fixed thread pool test suite', () => { |
e1ffb94f JB |
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 | ) | |
594bfb84 JB |
15 | const queuePool = new FixedThreadPool( |
16 | numberOfThreads, | |
17 | './tests/worker-files/thread/testWorker.js', | |
18 | { | |
19 | enableTasksQueue: true, | |
20 | tasksQueueOptions: { | |
21 | concurrency: 2 | |
22 | }, | |
23 | errorHandler: e => console.error(e) | |
24 | } | |
25 | ) | |
e1ffb94f JB |
26 | const emptyPool = new FixedThreadPool( |
27 | numberOfThreads, | |
28 | './tests/worker-files/thread/emptyWorker.js', | |
29 | { exitHandler: () => console.log('empty pool worker exited') } | |
30 | ) | |
31 | const echoPool = new FixedThreadPool( | |
32 | numberOfThreads, | |
33 | './tests/worker-files/thread/echoWorker.js' | |
34 | ) | |
35 | const errorPool = new FixedThreadPool( | |
36 | numberOfThreads, | |
37 | './tests/worker-files/thread/errorWorker.js', | |
38 | { | |
39 | errorHandler: e => console.error(e) | |
40 | } | |
41 | ) | |
42 | const asyncErrorPool = new FixedThreadPool( | |
43 | numberOfThreads, | |
44 | './tests/worker-files/thread/asyncErrorWorker.js', | |
45 | { | |
46 | errorHandler: e => console.error(e) | |
47 | } | |
48 | ) | |
49 | const asyncPool = new FixedThreadPool( | |
50 | numberOfThreads, | |
51 | './tests/worker-files/thread/asyncWorker.js' | |
52 | ) | |
53 | ||
0e2503fc JB |
54 | after('Destroy all pools', async () => { |
55 | // We need to clean up the resources after our test | |
56 | await echoPool.destroy() | |
57 | await asyncPool.destroy() | |
58 | await errorPool.destroy() | |
7c0ba920 | 59 | await asyncErrorPool.destroy() |
0e2503fc | 60 | await emptyPool.destroy() |
594bfb84 | 61 | await queuePool.destroy() |
0e2503fc JB |
62 | }) |
63 | ||
506c2a14 | 64 | it('Verify that the function is executed in a worker thread', async () => { |
6db75ad9 JB |
65 | let result = await pool.execute({ |
66 | function: WorkerFunctions.fibonacci | |
67 | }) | |
70a4f5ea | 68 | expect(result).toBe(121393) |
6db75ad9 JB |
69 | result = await pool.execute({ |
70 | function: WorkerFunctions.factorial | |
71 | }) | |
70a4f5ea | 72 | expect(result).toBe(9.33262154439441e157) |
506c2a14 | 73 | }) |
74 | ||
318d4156 | 75 | it('Verify that is possible to invoke the execute() method without input', async () => { |
106744f7 | 76 | const result = await pool.execute() |
6db75ad9 | 77 | expect(result).toBe(false) |
106744f7 | 78 | }) |
79 | ||
aee46736 | 80 | it("Verify that 'busy' event is emitted", async () => { |
7c0ba920 | 81 | let poolBusy = 0 |
aee46736 | 82 | pool.emitter.on(PoolEvents.busy, () => ++poolBusy) |
7c0ba920 | 83 | for (let i = 0; i < numberOfThreads * 2; i++) { |
8cbb82eb | 84 | pool.execute() |
7c0ba920 | 85 | } |
14916bf9 JB |
86 | // The `busy` event is triggered when the number of submitted tasks at once reach the number of fixed pool workers. |
87 | // So in total numberOfThreads + 1 times for a loop submitting up to numberOfThreads * 2 tasks to the fixed pool. | |
88 | expect(poolBusy).toBe(numberOfThreads + 1) | |
7c0ba920 JB |
89 | }) |
90 | ||
594bfb84 | 91 | it('Verify that tasks queuing is working', async () => { |
d3d4b67d | 92 | const promises = new Set() |
ee9f5295 | 93 | const maxMultiplier = 2 |
594bfb84 | 94 | for (let i = 0; i < numberOfThreads * maxMultiplier; i++) { |
d3d4b67d | 95 | promises.add(queuePool.execute()) |
594bfb84 | 96 | } |
d3d4b67d | 97 | expect(promises.size).toBe(numberOfThreads * maxMultiplier) |
594bfb84 JB |
98 | for (const workerNode of queuePool.workerNodes) { |
99 | expect(workerNode.tasksUsage.running).toBeLessThanOrEqual( | |
100 | queuePool.opts.tasksQueueOptions.concurrency | |
101 | ) | |
1ab50fe5 | 102 | expect(workerNode.tasksUsage.ran).toBe(0) |
4d8bf9e4 | 103 | expect(workerNode.tasksQueue.size).toBeGreaterThan(0) |
594bfb84 | 104 | } |
6b27d407 JB |
105 | expect(queuePool.info.runningTasks).toBe(numberOfThreads) |
106 | expect(queuePool.info.queuedTasks).toBe( | |
107 | numberOfThreads * maxMultiplier - numberOfThreads | |
108 | ) | |
109 | expect(queuePool.info.maxQueuedTasks).toBe( | |
d3d4b67d JB |
110 | numberOfThreads * maxMultiplier - numberOfThreads |
111 | ) | |
594bfb84 JB |
112 | await Promise.all(promises) |
113 | for (const workerNode of queuePool.workerNodes) { | |
114 | expect(workerNode.tasksUsage.running).toBe(0) | |
1ab50fe5 JB |
115 | expect(workerNode.tasksUsage.ran).toBeGreaterThan(0) |
116 | expect(workerNode.tasksUsage.ran).toBeLessThanOrEqual(maxMultiplier) | |
4d8bf9e4 | 117 | expect(workerNode.tasksQueue.size).toBe(0) |
594bfb84 JB |
118 | } |
119 | }) | |
120 | ||
106744f7 | 121 | it('Verify that is possible to have a worker that return undefined', async () => { |
122 | const result = await emptyPool.execute() | |
6db75ad9 | 123 | expect(result).toBeUndefined() |
106744f7 | 124 | }) |
125 | ||
126 | it('Verify that data are sent to the worker correctly', async () => { | |
127 | const data = { f: 10 } | |
128 | const result = await echoPool.execute(data) | |
e1ffb94f | 129 | expect(result).toStrictEqual(data) |
106744f7 | 130 | }) |
131 | ||
7c0ba920 | 132 | it('Verify that error handling is working properly:sync', async () => { |
106744f7 | 133 | const data = { f: 10 } |
d46660cd JB |
134 | let taskError |
135 | errorPool.emitter.on(PoolEvents.taskError, e => { | |
136 | taskError = e | |
137 | }) | |
106744f7 | 138 | let inError |
139 | try { | |
140 | await errorPool.execute(data) | |
141 | } catch (e) { | |
142 | inError = e | |
143 | } | |
7c0ba920 JB |
144 | expect(inError).toBeDefined() |
145 | expect(inError).toBeInstanceOf(Error) | |
146 | expect(inError.message).toBeDefined() | |
8620fb25 | 147 | expect(typeof inError.message === 'string').toBe(true) |
0302f8ec | 148 | expect(inError.message).toBe('Error Message from ThreadWorker') |
d46660cd JB |
149 | expect(taskError).toStrictEqual({ |
150 | error: new Error('Error Message from ThreadWorker'), | |
151 | errorData: data | |
152 | }) | |
18482cec JB |
153 | expect( |
154 | errorPool.workerNodes.some( | |
155 | workerNode => workerNode.tasksUsage.error === 1 | |
156 | ) | |
157 | ).toBe(true) | |
7c0ba920 JB |
158 | }) |
159 | ||
160 | it('Verify that error handling is working properly:async', async () => { | |
161 | const data = { f: 10 } | |
4f0b85b3 JB |
162 | let taskError |
163 | asyncErrorPool.emitter.on(PoolEvents.taskError, e => { | |
164 | taskError = e | |
165 | }) | |
7c0ba920 JB |
166 | let inError |
167 | try { | |
168 | await asyncErrorPool.execute(data) | |
169 | } catch (e) { | |
170 | inError = e | |
171 | } | |
172 | expect(inError).toBeDefined() | |
173 | expect(inError).toBeInstanceOf(Error) | |
174 | expect(inError.message).toBeDefined() | |
8620fb25 | 175 | expect(typeof inError.message === 'string').toBe(true) |
0302f8ec | 176 | expect(inError.message).toBe('Error Message from ThreadWorker:async') |
4f0b85b3 JB |
177 | expect(taskError).toStrictEqual({ |
178 | error: new Error('Error Message from ThreadWorker:async'), | |
179 | errorData: data | |
180 | }) | |
18482cec JB |
181 | expect( |
182 | asyncErrorPool.workerNodes.some( | |
183 | workerNode => workerNode.tasksUsage.error === 1 | |
184 | ) | |
185 | ).toBe(true) | |
106744f7 | 186 | }) |
187 | ||
7784f548 | 188 | it('Verify that async function is working properly', async () => { |
189 | const data = { f: 10 } | |
15e5141f | 190 | const startTime = performance.now() |
7784f548 | 191 | const result = await asyncPool.execute(data) |
15e5141f | 192 | const usedTime = performance.now() - startTime |
e1ffb94f | 193 | expect(result).toStrictEqual(data) |
32d490eb | 194 | expect(usedTime).toBeGreaterThanOrEqual(2000) |
7784f548 | 195 | }) |
196 | ||
506c2a14 | 197 | it('Shutdown test', async () => { |
4f0b85b3 | 198 | const exitPromise = TestUtils.waitWorkerExits(pool, numberOfThreads) |
1f9a5a44 | 199 | await pool.destroy() |
bdacc2d2 JB |
200 | const numberOfExitEvents = await exitPromise |
201 | expect(numberOfExitEvents).toBe(numberOfThreads) | |
506c2a14 | 202 | }) |
203 | ||
90082c8c JB |
204 | it('Verify that thread pool options are checked', async () => { |
205 | const workerFilePath = './tests/worker-files/cluster/testWorker.js' | |
206 | let pool1 = new FixedThreadPool(numberOfThreads, workerFilePath) | |
207 | expect(pool1.opts.workerOptions).toBeUndefined() | |
208 | await pool1.destroy() | |
209 | pool1 = new FixedThreadPool(numberOfThreads, workerFilePath, { | |
210 | workerOptions: { | |
211 | env: { TEST: 'test' }, | |
212 | name: 'test' | |
213 | } | |
214 | }) | |
215 | expect(pool1.opts.workerOptions).toStrictEqual({ | |
216 | env: { TEST: 'test' }, | |
217 | name: 'test' | |
218 | }) | |
219 | await pool1.destroy() | |
220 | }) | |
221 | ||
506c2a14 | 222 | it('Should work even without opts in input', async () => { |
76b1e974 | 223 | const pool1 = new FixedThreadPool( |
e1ffb94f | 224 | numberOfThreads, |
76b1e974 S |
225 | './tests/worker-files/thread/testWorker.js' |
226 | ) | |
6db75ad9 JB |
227 | const res = await pool1.execute() |
228 | expect(res).toBe(false) | |
0e2503fc JB |
229 | // We need to clean up the resources after our test |
230 | await pool1.destroy() | |
506c2a14 | 231 | }) |
8d3782fa JB |
232 | |
233 | it('Verify that a pool with zero worker fails', async () => { | |
234 | expect( | |
235 | () => new FixedThreadPool(0, './tests/worker-files/thread/testWorker.js') | |
d4aeae5a | 236 | ).toThrowError('Cannot instantiate a fixed pool with no worker') |
8d3782fa | 237 | }) |
506c2a14 | 238 | }) |