tests/pools/cluster/fixed.test.js

   1 const { expect } = require('expect')
   2 const { FixedClusterPool, PoolEvents } = require('../../../lib')
   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 queuePool = new FixedClusterPool(
  16     numberOfWorkers,
  17     './tests/worker-files/cluster/testWorker.js',
  18     {
  19       enableTasksQueue: true,
  20       tasksQueueOptions: {
  21         concurrency: 2
  22       },
  23       errorHandler: e => console.error(e)
  24     }
  25   )
  26   const emptyPool = new FixedClusterPool(
  27     numberOfWorkers,
  28     './tests/worker-files/cluster/emptyWorker.js',
  29     { exitHandler: () => console.log('empty pool worker exited') }
  30   )
  31   const echoPool = new FixedClusterPool(
  32     numberOfWorkers,
  33     './tests/worker-files/cluster/echoWorker.js'
  34   )
  35   const errorPool = new FixedClusterPool(
  36     numberOfWorkers,
  37     './tests/worker-files/cluster/errorWorker.js',
  38     {
  39       errorHandler: e => console.error(e)
  40     }
  41   )
  42   const asyncErrorPool = new FixedClusterPool(
  43     numberOfWorkers,
  44     './tests/worker-files/cluster/asyncErrorWorker.js',
  45     {
  46       errorHandler: e => console.error(e)
  47     }
  48   )
  49   const asyncPool = new FixedClusterPool(
  50     numberOfWorkers,
  51     './tests/worker-files/cluster/asyncWorker.js'
  52   )
  53
  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()
  59     await asyncErrorPool.destroy()
  60     await emptyPool.destroy()
  61     await queuePool.destroy()
  62   })
  63
  64   it('Verify that the function is executed in a worker cluster', async () => {
  65     let result = await pool.execute({
  66       function: WorkerFunctions.fibonacci
  67     })
  68     expect(result).toBe(121393)
  69     result = await pool.execute({
  70       function: WorkerFunctions.factorial
  71     })
  72     expect(result).toBe(9.33262154439441e157)
  73   })
  74
  75   it('Verify that is possible to invoke the execute() method without input', async () => {
  76     const result = await pool.execute()
  77     expect(result).toBe(false)
  78   })
  79
  80   it("Verify that 'busy' event is emitted", async () => {
  81     let poolBusy = 0
  82     pool.emitter.on(PoolEvents.busy, () => ++poolBusy)
  83     for (let i = 0; i < numberOfWorkers * 2; i++) {
  84       pool.execute()
  85     }
  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 numberOfWorkers + 1 times for a loop submitting up to numberOfWorkers * 2 tasks to the fixed pool.
  88     expect(poolBusy).toBe(numberOfWorkers + 1)
  89   })
  90
  91   it('Verify that tasks queuing is working', async () => {
  92     const promises = new Set()
  93     const maxMultiplier = 2
  94     for (let i = 0; i < numberOfWorkers * maxMultiplier; i++) {
  95       promises.add(queuePool.execute())
  96     }
  97     expect(promises.size).toBe(numberOfWorkers * maxMultiplier)
  98     for (const workerNode of queuePool.workerNodes) {
  99       expect(workerNode.workerUsage.tasks.executing).toBeLessThanOrEqual(
 100         queuePool.opts.tasksQueueOptions.concurrency
 101       )
 102       expect(workerNode.workerUsage.tasks.executed).toBe(0)
 103       expect(workerNode.workerUsage.tasks.queued).toBeGreaterThan(0)
 104       expect(workerNode.workerUsage.tasks.maxQueued).toBeGreaterThan(0)
 105     }
 106     expect(queuePool.info.executingTasks).toBe(numberOfWorkers)
 107     expect(queuePool.info.queuedTasks).toBe(
 108       numberOfWorkers * maxMultiplier - numberOfWorkers
 109     )
 110     expect(queuePool.info.maxQueuedTasks).toBe(
 111       numberOfWorkers * maxMultiplier - numberOfWorkers
 112     )
 113     await Promise.all(promises)
 114     for (const workerNode of queuePool.workerNodes) {
 115       expect(workerNode.workerUsage.tasks.executing).toBe(0)
 116       expect(workerNode.workerUsage.tasks.executed).toBeGreaterThan(0)
 117       expect(workerNode.workerUsage.tasks.executed).toBeLessThanOrEqual(
 118         maxMultiplier
 119       )
 120       expect(workerNode.workerUsage.tasks.queued).toBe(0)
 121       expect(workerNode.workerUsage.tasks.maxQueued).toBe(1)
 122     }
 123   })
 124
 125   it('Verify that is possible to have a worker that return undefined', async () => {
 126     const result = await emptyPool.execute()
 127     expect(result).toBeUndefined()
 128   })
 129
 130   it('Verify that data are sent to the worker correctly', async () => {
 131     const data = { f: 10 }
 132     const result = await echoPool.execute(data)
 133     expect(result).toStrictEqual(data)
 134   })
 135
 136   it('Verify that error handling is working properly:sync', async () => {
 137     const data = { f: 10 }
 138     let taskError
 139     errorPool.emitter.on(PoolEvents.taskError, e => {
 140       taskError = e
 141     })
 142     let inError
 143     try {
 144       await errorPool.execute(data)
 145     } catch (e) {
 146       inError = e
 147     }
 148     expect(inError).toBeDefined()
 149     expect(typeof inError === 'string').toBe(true)
 150     expect(inError).toBe('Error Message from ClusterWorker')
 151     expect(taskError).toStrictEqual({
 152       message: 'Error Message from ClusterWorker',
 153       data
 154     })
 155     expect(
 156       errorPool.workerNodes.some(
 157         workerNode => workerNode.workerUsage.tasks.failed === 1
 158       )
 159     ).toBe(true)
 160   })
 161
 162   it('Verify that error handling is working properly:async', async () => {
 163     const data = { f: 10 }
 164     let taskError
 165     asyncErrorPool.emitter.on(PoolEvents.taskError, e => {
 166       taskError = e
 167     })
 168     let inError
 169     try {
 170       await asyncErrorPool.execute(data)
 171     } catch (e) {
 172       inError = e
 173     }
 174     expect(inError).toBeDefined()
 175     expect(typeof inError === 'string').toBe(true)
 176     expect(inError).toBe('Error Message from ClusterWorker:async')
 177     expect(taskError).toStrictEqual({
 178       message: 'Error Message from ClusterWorker:async',
 179       data
 180     })
 181     expect(
 182       asyncErrorPool.workerNodes.some(
 183         workerNode => workerNode.workerUsage.tasks.failed === 1
 184       )
 185     ).toBe(true)
 186   })
 187
 188   it('Verify that async function is working properly', async () => {
 189     const data = { f: 10 }
 190     const startTime = performance.now()
 191     const result = await asyncPool.execute(data)
 192     const usedTime = performance.now() - startTime
 193     expect(result).toStrictEqual(data)
 194     expect(usedTime).toBeGreaterThanOrEqual(2000)
 195   })
 196
 197   it('Shutdown test', async () => {
 198     const exitPromise = TestUtils.waitWorkerEvents(
 199       pool,
 200       'exit',
 201       numberOfWorkers
 202     )
 203     await pool.destroy()
 204     const numberOfExitEvents = await exitPromise
 205     expect(numberOfExitEvents).toBe(numberOfWorkers)
 206   })
 207
 208   it('Verify that cluster pool options are checked', async () => {
 209     const workerFilePath = './tests/worker-files/cluster/testWorker.js'
 210     let pool1 = new FixedClusterPool(numberOfWorkers, workerFilePath)
 211     expect(pool1.opts.env).toBeUndefined()
 212     expect(pool1.opts.settings).toBeUndefined()
 213     await pool1.destroy()
 214     pool1 = new FixedClusterPool(numberOfWorkers, workerFilePath, {
 215       env: { TEST: 'test' },
 216       settings: { args: ['--use', 'http'], silent: true }
 217     })
 218     expect(pool1.opts.env).toStrictEqual({ TEST: 'test' })
 219     expect(pool1.opts.settings).toStrictEqual({
 220       args: ['--use', 'http'],
 221       silent: true
 222     })
 223     expect({ ...pool1.opts.settings, exec: workerFilePath }).toStrictEqual({
 224       args: ['--use', 'http'],
 225       silent: true,
 226       exec: workerFilePath
 227     })
 228     await pool1.destroy()
 229   })
 230
 231   it('Should work even without opts in input', async () => {
 232     const pool1 = new FixedClusterPool(
 233       numberOfWorkers,
 234       './tests/worker-files/cluster/testWorker.js'
 235     )
 236     const res = await pool1.execute()
 237     expect(res).toBe(false)
 238     // We need to clean up the resources after our test
 239     await pool1.destroy()
 240   })
 241
 242   it('Verify that a pool with zero worker fails', async () => {
 243     expect(
 244       () =>
 245         new FixedClusterPool(0, './tests/worker-files/cluster/testWorker.js')
 246     ).toThrowError('Cannot instantiate a fixed pool with no worker')
 247   })
 248 })