Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluste...
[poolifier.git] / tests / pools / cluster / fixed.test.js
1 const { expect } = require('expect')
2 const { FixedClusterPool } = require('../../../lib/index')
3 const { WorkerFunctions } = require('../../test-types')
4 const TestUtils = require('../../test-utils')
5
6 describe('Fixed cluster pool test suite', () => {
7 const numberOfWorkers = 6
8 const pool = new FixedClusterPool(
9 numberOfWorkers,
10 './tests/worker-files/cluster/testWorker.js',
11 {
12 errorHandler: e => console.error(e)
13 }
14 )
15 const emptyPool = new FixedClusterPool(
16 numberOfWorkers,
17 './tests/worker-files/cluster/emptyWorker.js',
18 { exitHandler: () => console.log('empty pool worker exited') }
19 )
20 const echoPool = new FixedClusterPool(
21 numberOfWorkers,
22 './tests/worker-files/cluster/echoWorker.js'
23 )
24 const errorPool = new FixedClusterPool(
25 numberOfWorkers,
26 './tests/worker-files/cluster/errorWorker.js',
27 {
28 errorHandler: e => console.error(e)
29 }
30 )
31 const asyncErrorPool = new FixedClusterPool(
32 numberOfWorkers,
33 './tests/worker-files/cluster/asyncErrorWorker.js',
34 {
35 errorHandler: e => console.error(e)
36 }
37 )
38 const asyncPool = new FixedClusterPool(
39 numberOfWorkers,
40 './tests/worker-files/cluster/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 < numberOfWorkers; i++) {
55 results.add(pool.chooseWorker().id)
56 }
57 expect(results.size).toBe(numberOfWorkers)
58 })
59
60 it('Verify that the function is executed in a worker cluster', 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 let poolBusy = 0
78 pool.emitter.on('busy', () => poolBusy++)
79 for (let i = 0; i < numberOfWorkers * 2; i++) {
80 pool.execute()
81 }
82 // The `busy` event is triggered when the number of submitted tasks at once reach the number of fixed pool workers.
83 // So in total numberOfWorkers + 1 times for a loop submitting up to numberOfWorkers * 2 tasks to the fixed pool.
84 expect(poolBusy).toBe(numberOfWorkers + 1)
85 })
86
87 it('Verify that is possible to have a worker that return undefined', async () => {
88 const result = await emptyPool.execute()
89 expect(result).toBeUndefined()
90 })
91
92 it('Verify that data are sent to the worker correctly', async () => {
93 const data = { f: 10 }
94 const result = await echoPool.execute(data)
95 expect(result).toStrictEqual(data)
96 })
97
98 it('Verify that error handling is working properly:sync', async () => {
99 const data = { f: 10 }
100 let inError
101 try {
102 await errorPool.execute(data)
103 } catch (e) {
104 inError = e
105 }
106 expect(inError).toBeDefined()
107 expect(typeof inError === 'string').toBe(true)
108 expect(inError).toBe('Error Message from ClusterWorker')
109 })
110
111 it('Verify that error handling is working properly:async', async () => {
112 const data = { f: 10 }
113 let inError
114 try {
115 await asyncErrorPool.execute(data)
116 } catch (e) {
117 inError = e
118 }
119 expect(inError).toBeDefined()
120 expect(typeof inError === 'string').toBe(true)
121 expect(inError).toBe('Error Message from ClusterWorker:async')
122 })
123
124 it('Verify that async function is working properly', async () => {
125 const data = { f: 10 }
126 const startTime = Date.now()
127 const result = await asyncPool.execute(data)
128 const usedTime = Date.now() - startTime
129 expect(result).toStrictEqual(data)
130 expect(usedTime).toBeGreaterThanOrEqual(2000)
131 })
132
133 it('Shutdown test', async () => {
134 const exitPromise = TestUtils.waitExits(pool, numberOfWorkers)
135 await pool.destroy()
136 const numberOfExitEvents = await exitPromise
137 expect(numberOfExitEvents).toBe(numberOfWorkers)
138 })
139
140 it('Verify that cluster pool options are checked', async () => {
141 const workerFilePath = './tests/worker-files/cluster/testWorker.js'
142 let pool1 = new FixedClusterPool(numberOfWorkers, workerFilePath)
143 expect(pool1.opts.env).toBeUndefined()
144 expect(pool1.opts.settings).toBeUndefined()
145 await pool1.destroy()
146 pool1 = new FixedClusterPool(numberOfWorkers, workerFilePath, {
147 env: { TEST: 'test' },
148 settings: { args: ['--use', 'http'], silent: true }
149 })
150 expect(pool1.opts.env).toStrictEqual({ TEST: 'test' })
151 expect(pool1.opts.settings).toStrictEqual({
152 args: ['--use', 'http'],
153 silent: true
154 })
155 expect({ ...pool1.opts.settings, exec: workerFilePath }).toStrictEqual({
156 args: ['--use', 'http'],
157 silent: true,
158 exec: workerFilePath
159 })
160 await pool1.destroy()
161 })
162
163 it('Should work even without opts in input', async () => {
164 const pool1 = new FixedClusterPool(
165 numberOfWorkers,
166 './tests/worker-files/cluster/testWorker.js'
167 )
168 const res = await pool1.execute()
169 expect(res).toBe(false)
170 // We need to clean up the resources after our test
171 await pool1.destroy()
172 })
173
174 it('Verify that a pool with zero worker fails', async () => {
175 expect(
176 () =>
177 new FixedClusterPool(0, './tests/worker-files/cluster/testWorker.js')
178 ).toThrowError(new Error('Cannot instantiate a fixed pool with no worker'))
179 })
180 })