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