tests/pools/cluster/fixed.test.js

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