tests/pools/cluster/fixed.test.mjs

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