test: improve UTs
[poolifier.git] / tests / pools / cluster / fixed.test.js
index 42f03b893d7c4f950e1950d3a23a5aec64fb88f4..6edfcd67b8c53517b7f4d635b3738ca43131a76b 100644 (file)
@@ -1,15 +1,17 @@
 const { expect } = require('expect')
 const { FixedClusterPool, PoolEvents } = require('../../../lib')
-const { WorkerFunctions } = require('../../test-types')
-const TestUtils = require('../../test-utils')
+const { TaskFunctions } = require('../../test-types')
+const { waitPoolEvents, waitWorkerEvents } = require('../../test-utils')
+const { DEFAULT_TASK_NAME } = require('../../../lib/utils')
 
 describe('Fixed cluster pool test suite', () => {
-  const numberOfWorkers = 6
+  const numberOfWorkers = 8
+  const tasksConcurrency = 2
   const pool = new FixedClusterPool(
     numberOfWorkers,
     './tests/worker-files/cluster/testWorker.js',
     {
-      errorHandler: e => console.error(e)
+      errorHandler: (e) => console.error(e)
     }
   )
   const queuePool = new FixedClusterPool(
@@ -18,15 +20,15 @@ describe('Fixed cluster pool test suite', () => {
     {
       enableTasksQueue: true,
       tasksQueueOptions: {
-        concurrency: 2
+        concurrency: tasksConcurrency
       },
-      errorHandler: e => console.error(e)
+      errorHandler: (e) => console.error(e)
     }
   )
   const emptyPool = new FixedClusterPool(
     numberOfWorkers,
     './tests/worker-files/cluster/emptyWorker.js',
-    { exitHandler: () => console.log('empty pool worker exited') }
+    { exitHandler: () => console.info('empty pool worker exited') }
   )
   const echoPool = new FixedClusterPool(
     numberOfWorkers,
@@ -36,14 +38,14 @@ describe('Fixed cluster pool test suite', () => {
     numberOfWorkers,
     './tests/worker-files/cluster/errorWorker.js',
     {
-      errorHandler: e => console.error(e)
+      errorHandler: (e) => console.error(e)
     }
   )
   const asyncErrorPool = new FixedClusterPool(
     numberOfWorkers,
     './tests/worker-files/cluster/asyncErrorWorker.js',
     {
-      errorHandler: e => console.error(e)
+      errorHandler: (e) => console.error(e)
     }
   )
   const asyncPool = new FixedClusterPool(
@@ -63,56 +65,105 @@ describe('Fixed cluster pool test suite', () => {
 
   it('Verify that the function is executed in a worker cluster', async () => {
     let result = await pool.execute({
-      function: WorkerFunctions.fibonacci
+      function: TaskFunctions.fibonacci
     })
-    expect(result).toBe(121393)
+    expect(result).toBe(75025)
     result = await pool.execute({
-      function: WorkerFunctions.factorial
+      function: TaskFunctions.factorial
     })
     expect(result).toBe(9.33262154439441e157)
   })
 
   it('Verify that is possible to invoke the execute() method without input', async () => {
     const result = await pool.execute()
-    expect(result).toBe(false)
+    expect(result).toStrictEqual({ ok: 1 })
+  })
+
+  it("Verify that 'ready' event is emitted", async () => {
+    const pool = new FixedClusterPool(
+      numberOfWorkers,
+      './tests/worker-files/cluster/testWorker.js',
+      {
+        errorHandler: (e) => console.error(e)
+      }
+    )
+    let poolReady = 0
+    pool.emitter.on(PoolEvents.ready, () => ++poolReady)
+    await waitPoolEvents(pool, PoolEvents.ready, 1)
+    expect(poolReady).toBe(1)
+    await pool.destroy()
   })
 
   it("Verify that 'busy' event is emitted", async () => {
+    const promises = new Set()
     let poolBusy = 0
     pool.emitter.on(PoolEvents.busy, () => ++poolBusy)
     for (let i = 0; i < numberOfWorkers * 2; i++) {
-      pool.execute()
+      promises.add(pool.execute())
     }
+    await Promise.all(promises)
     // The `busy` event is triggered when the number of submitted tasks at once reach the number of fixed pool workers.
     // So in total numberOfWorkers + 1 times for a loop submitting up to numberOfWorkers * 2 tasks to the fixed pool.
     expect(poolBusy).toBe(numberOfWorkers + 1)
   })
 
   it('Verify that tasks queuing is working', async () => {
-    const maxMultiplier = 2
     const promises = new Set()
+    const maxMultiplier = 3 // Must be greater than tasksConcurrency
     for (let i = 0; i < numberOfWorkers * maxMultiplier; i++) {
       promises.add(queuePool.execute())
     }
     expect(promises.size).toBe(numberOfWorkers * maxMultiplier)
     for (const workerNode of queuePool.workerNodes) {
-      expect(workerNode.tasksUsage.running).toBeLessThanOrEqual(
+      expect(workerNode.usage.tasks.executing).toBeGreaterThanOrEqual(0)
+      expect(workerNode.usage.tasks.executing).toBeLessThanOrEqual(
         queuePool.opts.tasksQueueOptions.concurrency
       )
-      expect(workerNode.tasksUsage.run).toBe(0)
-      expect(workerNode.tasksQueue.size).toBeGreaterThan(0)
+      expect(workerNode.usage.tasks.executed).toBe(0)
+      expect(workerNode.usage.tasks.queued).toBe(
+        maxMultiplier - queuePool.opts.tasksQueueOptions.concurrency
+      )
+      expect(workerNode.usage.tasks.maxQueued).toBe(
+        maxMultiplier - queuePool.opts.tasksQueueOptions.concurrency
+      )
+      expect(workerNode.usage.tasks.stolen).toBe(0)
     }
-    expect(queuePool.numberOfRunningTasks).toBe(numberOfWorkers)
-    expect(queuePool.numberOfQueuedTasks).toBe(
-      numberOfWorkers * maxMultiplier - numberOfWorkers
+    expect(queuePool.info.executedTasks).toBe(0)
+    expect(queuePool.info.executingTasks).toBe(
+      numberOfWorkers * queuePool.opts.tasksQueueOptions.concurrency
+    )
+    expect(queuePool.info.queuedTasks).toBe(
+      numberOfWorkers *
+        (maxMultiplier - queuePool.opts.tasksQueueOptions.concurrency)
+    )
+    expect(queuePool.info.maxQueuedTasks).toBe(
+      numberOfWorkers *
+        (maxMultiplier - queuePool.opts.tasksQueueOptions.concurrency)
     )
+    expect(queuePool.info.backPressure).toBe(false)
+    expect(queuePool.info.stolenTasks).toBe(0)
     await Promise.all(promises)
     for (const workerNode of queuePool.workerNodes) {
-      expect(workerNode.tasksUsage.running).toBe(0)
-      expect(workerNode.tasksUsage.run).toBeGreaterThan(0)
-      expect(workerNode.tasksQueue.size).toBe(0)
+      expect(workerNode.usage.tasks.executing).toBeGreaterThanOrEqual(0)
+      expect(workerNode.usage.tasks.executing).toBeLessThanOrEqual(
+        numberOfWorkers * maxMultiplier
+      )
+      expect(workerNode.usage.tasks.executed).toBe(maxMultiplier)
+      expect(workerNode.usage.tasks.queued).toBe(0)
+      expect(workerNode.usage.tasks.maxQueued).toBe(
+        maxMultiplier - queuePool.opts.tasksQueueOptions.concurrency
+      )
+      expect(workerNode.usage.tasks.stolen).toBeGreaterThanOrEqual(0)
+      expect(workerNode.usage.tasks.stolen).toBeLessThanOrEqual(
+        numberOfWorkers * maxMultiplier
+      )
     }
-    promises.clear()
+    expect(queuePool.info.executedTasks).toBe(numberOfWorkers * maxMultiplier)
+    expect(queuePool.info.backPressure).toBe(false)
+    expect(queuePool.info.stolenTasks).toBeGreaterThanOrEqual(0)
+    expect(queuePool.info.stolenTasks).toBeLessThanOrEqual(
+      numberOfWorkers * maxMultiplier
+    )
   })
 
   it('Verify that is possible to have a worker that return undefined', async () => {
@@ -128,6 +179,10 @@ describe('Fixed cluster pool test suite', () => {
 
   it('Verify that error handling is working properly:sync', async () => {
     const data = { f: 10 }
+    let taskError
+    errorPool.emitter.on(PoolEvents.taskError, (e) => {
+      taskError = e
+    })
     let inError
     try {
       await errorPool.execute(data)
@@ -137,15 +192,24 @@ describe('Fixed cluster pool test suite', () => {
     expect(inError).toBeDefined()
     expect(typeof inError === 'string').toBe(true)
     expect(inError).toBe('Error Message from ClusterWorker')
+    expect(taskError).toStrictEqual({
+      name: DEFAULT_TASK_NAME,
+      message: 'Error Message from ClusterWorker',
+      data
+    })
     expect(
       errorPool.workerNodes.some(
-        workerNode => workerNode.tasksUsage.error === 1
+        (workerNode) => workerNode.usage.tasks.failed === 1
       )
     ).toBe(true)
   })
 
   it('Verify that error handling is working properly:async', async () => {
     const data = { f: 10 }
+    let taskError
+    asyncErrorPool.emitter.on(PoolEvents.taskError, (e) => {
+      taskError = e
+    })
     let inError
     try {
       await asyncErrorPool.execute(data)
@@ -155,9 +219,14 @@ describe('Fixed cluster pool test suite', () => {
     expect(inError).toBeDefined()
     expect(typeof inError === 'string').toBe(true)
     expect(inError).toBe('Error Message from ClusterWorker:async')
+    expect(taskError).toStrictEqual({
+      name: DEFAULT_TASK_NAME,
+      message: 'Error Message from ClusterWorker:async',
+      data
+    })
     expect(
       asyncErrorPool.workerNodes.some(
-        workerNode => workerNode.tasksUsage.error === 1
+        (workerNode) => workerNode.usage.tasks.failed === 1
       )
     ).toBe(true)
   })
@@ -172,50 +241,55 @@ describe('Fixed cluster pool test suite', () => {
   })
 
   it('Shutdown test', async () => {
-    const exitPromise = TestUtils.waitExits(pool, numberOfWorkers)
+    const exitPromise = waitWorkerEvents(pool, 'exit', numberOfWorkers)
+    let poolDestroy = 0
+    pool.emitter.on(PoolEvents.destroy, () => ++poolDestroy)
     await pool.destroy()
     const numberOfExitEvents = await exitPromise
+    expect(pool.started).toBe(false)
+    expect(pool.workerNodes.length).toBe(0)
     expect(numberOfExitEvents).toBe(numberOfWorkers)
+    expect(poolDestroy).toBe(1)
   })
 
   it('Verify that cluster pool options are checked', async () => {
     const workerFilePath = './tests/worker-files/cluster/testWorker.js'
-    let pool1 = new FixedClusterPool(numberOfWorkers, workerFilePath)
-    expect(pool1.opts.env).toBeUndefined()
-    expect(pool1.opts.settings).toBeUndefined()
-    await pool1.destroy()
-    pool1 = new FixedClusterPool(numberOfWorkers, workerFilePath, {
+    let pool = new FixedClusterPool(numberOfWorkers, workerFilePath)
+    expect(pool.opts.env).toBeUndefined()
+    expect(pool.opts.settings).toBeUndefined()
+    await pool.destroy()
+    pool = new FixedClusterPool(numberOfWorkers, workerFilePath, {
       env: { TEST: 'test' },
       settings: { args: ['--use', 'http'], silent: true }
     })
-    expect(pool1.opts.env).toStrictEqual({ TEST: 'test' })
-    expect(pool1.opts.settings).toStrictEqual({
+    expect(pool.opts.env).toStrictEqual({ TEST: 'test' })
+    expect(pool.opts.settings).toStrictEqual({
       args: ['--use', 'http'],
       silent: true
     })
-    expect({ ...pool1.opts.settings, exec: workerFilePath }).toStrictEqual({
+    expect({ ...pool.opts.settings, exec: workerFilePath }).toStrictEqual({
       args: ['--use', 'http'],
       silent: true,
       exec: workerFilePath
     })
-    await pool1.destroy()
+    await pool.destroy()
   })
 
   it('Should work even without opts in input', async () => {
-    const pool1 = new FixedClusterPool(
+    const pool = new FixedClusterPool(
       numberOfWorkers,
       './tests/worker-files/cluster/testWorker.js'
     )
-    const res = await pool1.execute()
-    expect(res).toBe(false)
+    const res = await pool.execute()
+    expect(res).toStrictEqual({ ok: 1 })
     // We need to clean up the resources after our test
-    await pool1.destroy()
+    await pool.destroy()
   })
 
   it('Verify that a pool with zero worker fails', async () => {
     expect(
       () =>
         new FixedClusterPool(0, './tests/worker-files/cluster/testWorker.js')
-    ).toThrowError('Cannot instantiate a fixed pool with no worker')
+    ).toThrowError('Cannot instantiate a fixed pool with zero worker')
   })
 })