tests/pools/thread/fixed.test.js

   1 const { expect } = require('expect')
   2 const { FixedThreadPool, PoolEvents } = require('../../../lib')
   3 const { WorkerFunctions } = require('../../test-types')
   4 const { waitWorkerEvents } = 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 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   )
  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
  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 thread', async () => {
  65     let result = await pool.execute({
  66       function: WorkerFunctions.fibonacci
  67     })
  68     expect(result).toBe(75025)
  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).toStrictEqual({ ok: 1 })
  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 < numberOfThreads * 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 numberOfThreads + 1 times for a loop submitting up to numberOfThreads * 2 tasks to the fixed pool.
  88     expect(poolBusy).toBe(numberOfThreads + 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 < numberOfThreads * maxMultiplier; i++) {
  95       promises.add(queuePool.execute())
  96     }
  97     expect(promises.size).toBe(numberOfThreads * maxMultiplier)
  98     for (const workerNode of queuePool.workerNodes) {
  99       expect(workerNode.usage.tasks.executing).toBeLessThanOrEqual(
 100         queuePool.opts.tasksQueueOptions.concurrency
 101       )
 102       expect(workerNode.usage.tasks.executed).toBe(0)
 103       expect(workerNode.usage.tasks.queued).toBeGreaterThan(0)
 104       expect(workerNode.usage.tasks.maxQueued).toBeGreaterThan(0)
 105     }
 106     expect(queuePool.info.executingTasks).toBe(numberOfThreads)
 107     expect(queuePool.info.queuedTasks).toBe(
 108       numberOfThreads * maxMultiplier - numberOfThreads
 109     )
 110     expect(queuePool.info.maxQueuedTasks).toBe(
 111       numberOfThreads * maxMultiplier - numberOfThreads
 112     )
 113     await Promise.all(promises)
 114     for (const workerNode of queuePool.workerNodes) {
 115       expect(workerNode.usage.tasks.executing).toBe(0)
 116       expect(workerNode.usage.tasks.executed).toBeGreaterThan(0)
 117       expect(workerNode.usage.tasks.executed).toBeLessThanOrEqual(maxMultiplier)
 118       expect(workerNode.usage.tasks.queued).toBe(0)
 119       expect(workerNode.usage.tasks.maxQueued).toBe(1)
 120     }
 121   })
 122
 123   it('Verify that is possible to have a worker that return undefined', async () => {
 124     const result = await emptyPool.execute()
 125     expect(result).toBeUndefined()
 126   })
 127
 128   it('Verify that data are sent to the worker correctly', async () => {
 129     const data = { f: 10 }
 130     const result = await echoPool.execute(data)
 131     expect(result).toStrictEqual(data)
 132   })
 133
 134   it('Verify that error handling is working properly:sync', async () => {
 135     const data = { f: 10 }
 136     let taskError
 137     errorPool.emitter.on(PoolEvents.taskError, e => {
 138       taskError = e
 139     })
 140     let inError
 141     try {
 142       await errorPool.execute(data)
 143     } catch (e) {
 144       inError = e
 145     }
 146     expect(inError).toBeDefined()
 147     expect(inError).toBeInstanceOf(Error)
 148     expect(inError.message).toBeDefined()
 149     expect(typeof inError.message === 'string').toBe(true)
 150     expect(inError.message).toBe('Error Message from ThreadWorker')
 151     expect(taskError).toStrictEqual({
 152       workerId: expect.any(Number),
 153       message: new Error('Error Message from ThreadWorker'),
 154       data
 155     })
 156     expect(
 157       errorPool.workerNodes.some(
 158         workerNode => workerNode.usage.tasks.failed === 1
 159       )
 160     ).toBe(true)
 161   })
 162
 163   it('Verify that error handling is working properly:async', async () => {
 164     const data = { f: 10 }
 165     let taskError
 166     asyncErrorPool.emitter.on(PoolEvents.taskError, e => {
 167       taskError = e
 168     })
 169     let inError
 170     try {
 171       await asyncErrorPool.execute(data)
 172     } catch (e) {
 173       inError = e
 174     }
 175     expect(inError).toBeDefined()
 176     expect(inError).toBeInstanceOf(Error)
 177     expect(inError.message).toBeDefined()
 178     expect(typeof inError.message === 'string').toBe(true)
 179     expect(inError.message).toBe('Error Message from ThreadWorker:async')
 180     expect(taskError).toStrictEqual({
 181       workerId: expect.any(Number),
 182       message: new Error('Error Message from ThreadWorker:async'),
 183       data
 184     })
 185     expect(
 186       asyncErrorPool.workerNodes.some(
 187         workerNode => workerNode.usage.tasks.failed === 1
 188       )
 189     ).toBe(true)
 190   })
 191
 192   it('Verify that async function is working properly', async () => {
 193     const data = { f: 10 }
 194     const startTime = performance.now()
 195     const result = await asyncPool.execute(data)
 196     const usedTime = performance.now() - startTime
 197     expect(result).toStrictEqual(data)
 198     expect(usedTime).toBeGreaterThanOrEqual(2000)
 199   })
 200
 201   it('Shutdown test', async () => {
 202     const exitPromise = waitWorkerEvents(pool, 'exit', numberOfThreads)
 203     await pool.destroy()
 204     const numberOfExitEvents = await exitPromise
 205     expect(numberOfExitEvents).toBe(numberOfThreads)
 206   })
 207
 208   it('Verify that thread pool options are checked', async () => {
 209     const workerFilePath = './tests/worker-files/thread/testWorker.js'
 210     let pool1 = new FixedThreadPool(numberOfThreads, workerFilePath)
 211     expect(pool1.opts.workerOptions).toBeUndefined()
 212     await pool1.destroy()
 213     pool1 = new FixedThreadPool(numberOfThreads, workerFilePath, {
 214       workerOptions: {
 215         env: { TEST: 'test' },
 216         name: 'test'
 217       }
 218     })
 219     expect(pool1.opts.workerOptions).toStrictEqual({
 220       env: { TEST: 'test' },
 221       name: 'test'
 222     })
 223     await pool1.destroy()
 224   })
 225
 226   it('Should work even without opts in input', async () => {
 227     const pool1 = new FixedThreadPool(
 228       numberOfThreads,
 229       './tests/worker-files/thread/testWorker.js'
 230     )
 231     const res = await pool1.execute()
 232     expect(res).toStrictEqual({ ok: 1 })
 233     // We need to clean up the resources after our test
 234     await pool1.destroy()
 235   })
 236
 237   it('Verify that a pool with zero worker fails', async () => {
 238     expect(
 239       () => new FixedThreadPool(0, './tests/worker-files/thread/testWorker.js')
 240     ).toThrowError('Cannot instantiate a fixed pool with zero worker')
 241   })
 242 })