tests/pools/thread/fixed.test.js

   1 const { expect } = require('expect')
   2 const { FixedThreadPool, PoolEvents } = require('../../../lib')
   3 const { TaskFunctions } = require('../../test-types')
   4 const { waitPoolEvents, waitWorkerEvents } = require('../../test-utils')
   5
   6 describe('Fixed thread pool test suite', () => {
   7   const numberOfThreads = 6
   8   const tasksConcurrency = 2
   9   const pool = new FixedThreadPool(
  10     numberOfThreads,
  11     './tests/worker-files/thread/testWorker.js',
  12     {
  13       errorHandler: e => console.error(e)
  14     }
  15   )
  16   const queuePool = new FixedThreadPool(
  17     numberOfThreads,
  18     './tests/worker-files/thread/testWorker.js',
  19     {
  20       enableTasksQueue: true,
  21       tasksQueueOptions: {
  22         concurrency: tasksConcurrency
  23       },
  24       errorHandler: e => console.error(e)
  25     }
  26   )
  27   const emptyPool = new FixedThreadPool(
  28     numberOfThreads,
  29     './tests/worker-files/thread/emptyWorker.js',
  30     { exitHandler: () => console.info('empty pool worker exited') }
  31   )
  32   const echoPool = new FixedThreadPool(
  33     numberOfThreads,
  34     './tests/worker-files/thread/echoWorker.js'
  35   )
  36   const errorPool = new FixedThreadPool(
  37     numberOfThreads,
  38     './tests/worker-files/thread/errorWorker.js',
  39     {
  40       errorHandler: e => console.error(e)
  41     }
  42   )
  43   const asyncErrorPool = new FixedThreadPool(
  44     numberOfThreads,
  45     './tests/worker-files/thread/asyncErrorWorker.js',
  46     {
  47       errorHandler: e => console.error(e)
  48     }
  49   )
  50   const asyncPool = new FixedThreadPool(
  51     numberOfThreads,
  52     './tests/worker-files/thread/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 thread', 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 FixedThreadPool(
  83       numberOfThreads,
  84       './tests/worker-files/thread/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, '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 < numberOfThreads * 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 numberOfThreads + 1 times for a loop submitting up to numberOfThreads * 2 tasks to the fixed pool.
 103     expect(poolBusy).toBe(numberOfThreads + 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 < numberOfThreads * maxMultiplier; i++) {
 110       promises.add(queuePool.execute())
 111     }
 112     expect(promises.size).toBe(numberOfThreads * 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       numberOfThreads * queuePool.opts.tasksQueueOptions.concurrency
 127     )
 128     expect(queuePool.info.queuedTasks).toBe(
 129       numberOfThreads *
 130         (maxMultiplier - queuePool.opts.tasksQueueOptions.concurrency)
 131     )
 132     expect(queuePool.info.maxQueuedTasks).toBe(
 133       numberOfThreads *
 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 transferable objects are sent to the worker correctly', async () => {
 159     const transferList = [new ArrayBuffer(16), new MessageChannel().port1]
 160     let error
 161     let result
 162     try {
 163       result = await pool.execute(undefined, undefined, transferList)
 164     } catch (e) {
 165       error = e
 166     }
 167     expect(result).toStrictEqual({ ok: 1 })
 168     expect(error).toBeUndefined()
 169   })
 170
 171   it('Verify that error handling is working properly:sync', async () => {
 172     const data = { f: 10 }
 173     let taskError
 174     errorPool.emitter.on(PoolEvents.taskError, e => {
 175       taskError = e
 176     })
 177     let inError
 178     try {
 179       await errorPool.execute(data)
 180     } catch (e) {
 181       inError = e
 182     }
 183     expect(inError).toBeDefined()
 184     expect(inError).toBeInstanceOf(Error)
 185     expect(inError.message).toBeDefined()
 186     expect(typeof inError.message === 'string').toBe(true)
 187     expect(inError.message).toBe('Error Message from ThreadWorker')
 188     expect(taskError).toStrictEqual({
 189       name: 'default',
 190       message: new Error('Error Message from ThreadWorker'),
 191       data
 192     })
 193     expect(
 194       errorPool.workerNodes.some(
 195         workerNode => workerNode.usage.tasks.failed === 1
 196       )
 197     ).toBe(true)
 198   })
 199
 200   it('Verify that error handling is working properly:async', async () => {
 201     const data = { f: 10 }
 202     let taskError
 203     asyncErrorPool.emitter.on(PoolEvents.taskError, e => {
 204       taskError = e
 205     })
 206     let inError
 207     try {
 208       await asyncErrorPool.execute(data)
 209     } catch (e) {
 210       inError = e
 211     }
 212     expect(inError).toBeDefined()
 213     expect(inError).toBeInstanceOf(Error)
 214     expect(inError.message).toBeDefined()
 215     expect(typeof inError.message === 'string').toBe(true)
 216     expect(inError.message).toBe('Error Message from ThreadWorker:async')
 217     expect(taskError).toStrictEqual({
 218       name: 'default',
 219       message: new Error('Error Message from ThreadWorker:async'),
 220       data
 221     })
 222     expect(
 223       asyncErrorPool.workerNodes.some(
 224         workerNode => workerNode.usage.tasks.failed === 1
 225       )
 226     ).toBe(true)
 227   })
 228
 229   it('Verify that async function is working properly', async () => {
 230     const data = { f: 10 }
 231     const startTime = performance.now()
 232     const result = await asyncPool.execute(data)
 233     const usedTime = performance.now() - startTime
 234     expect(result).toStrictEqual(data)
 235     expect(usedTime).toBeGreaterThanOrEqual(2000)
 236   })
 237
 238   it('Shutdown test', async () => {
 239     const exitPromise = waitWorkerEvents(pool, 'exit', numberOfThreads)
 240     await pool.destroy()
 241     const numberOfExitEvents = await exitPromise
 242     expect(numberOfExitEvents).toBe(numberOfThreads)
 243   })
 244
 245   it('Verify that thread pool options are checked', async () => {
 246     const workerFilePath = './tests/worker-files/thread/testWorker.js'
 247     let pool1 = new FixedThreadPool(numberOfThreads, workerFilePath)
 248     expect(pool1.opts.workerOptions).toBeUndefined()
 249     await pool1.destroy()
 250     pool1 = new FixedThreadPool(numberOfThreads, workerFilePath, {
 251       workerOptions: {
 252         env: { TEST: 'test' },
 253         name: 'test'
 254       }
 255     })
 256     expect(pool1.opts.workerOptions).toStrictEqual({
 257       env: { TEST: 'test' },
 258       name: 'test'
 259     })
 260     await pool1.destroy()
 261   })
 262
 263   it('Should work even without opts in input', async () => {
 264     const pool1 = new FixedThreadPool(
 265       numberOfThreads,
 266       './tests/worker-files/thread/testWorker.js'
 267     )
 268     const res = await pool1.execute()
 269     expect(res).toStrictEqual({ ok: 1 })
 270     // We need to clean up the resources after our test
 271     await pool1.destroy()
 272   })
 273
 274   it('Verify that a pool with zero worker fails', async () => {
 275     expect(
 276       () => new FixedThreadPool(0, './tests/worker-files/thread/testWorker.js')
 277     ).toThrowError('Cannot instantiate a fixed pool with zero worker')
 278   })
 279 })