fix: untangle tasks queuing condition from pool busyness
[poolifier.git] / tests / pools / cluster / fixed.test.js
index c28b8021db11f0342ba3130146cc0e54d2b66eb5..0415d9c1eaa7a94cdc1f1260a9bac060c5703c04 100644 (file)
@@ -1,10 +1,11 @@
 const { expect } = require('expect')
-const { FixedClusterPool, PoolEvents } = require('../../../lib/index')
+const { FixedClusterPool, PoolEvents } = require('../../../lib')
 const { WorkerFunctions } = require('../../test-types')
-const TestUtils = require('../../test-utils')
+const { waitPoolEvents, waitWorkerEvents } = require('../../test-utils')
 
 describe('Fixed cluster pool test suite', () => {
   const numberOfWorkers = 6
+  const tasksConcurrency = 2
   const pool = new FixedClusterPool(
     numberOfWorkers,
     './tests/worker-files/cluster/testWorker.js',
@@ -18,7 +19,7 @@ describe('Fixed cluster pool test suite', () => {
     {
       enableTasksQueue: true,
       tasksQueueOptions: {
-        concurrency: 2
+        concurrency: tasksConcurrency
       },
       errorHandler: e => console.error(e)
     }
@@ -65,19 +66,33 @@ describe('Fixed cluster pool test suite', () => {
     let result = await pool.execute({
       function: WorkerFunctions.fibonacci
     })
-    expect(result).toBe(false)
+    expect(result).toBe(75025)
     result = await pool.execute({
       function: WorkerFunctions.factorial
     })
-    expect(result).toBe(false)
+    expect(result).toBe(9.33262154439441e157)
   })
 
-  it('Verify that is possible to invoke the execute method without input', async () => {
+  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 'busy' event is emitted", async () => {
+  it("Verify that 'ready' event is emitted", async () => {
+    const pool1 = new FixedClusterPool(
+      numberOfWorkers,
+      './tests/worker-files/cluster/testWorker.js',
+      {
+        errorHandler: e => console.error(e)
+      }
+    )
+    let poolReady = 0
+    pool1.emitter.on(PoolEvents.ready, () => ++poolReady)
+    await waitPoolEvents(pool1, PoolEvents.ready, 1)
+    expect(poolReady).toBe(1)
+  })
+
+  it("Verify that 'busy' event is emitted", () => {
     let poolBusy = 0
     pool.emitter.on(PoolEvents.busy, () => ++poolBusy)
     for (let i = 0; i < numberOfWorkers * 2; i++) {
@@ -89,30 +104,44 @@ describe('Fixed cluster pool test suite', () => {
   })
 
   it('Verify that tasks queuing is working', async () => {
-    const maxMultiplier = 10
     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).toBeLessThanOrEqual(
         queuePool.opts.tasksQueueOptions.concurrency
       )
-      expect(workerNode.tasksUsage.run).toBe(0)
-      expect(workerNode.tasksQueue.length).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(queuePool.numberOfRunningTasks).toBe(numberOfWorkers)
-    expect(queuePool.numberOfQueuedTasks).toBe(
-      numberOfWorkers * maxMultiplier - numberOfWorkers
+    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)
     )
     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.length).toBe(0)
+      expect(workerNode.usage.tasks.executing).toBe(0)
+      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
+      )
     }
-    promises.clear()
   })
 
   it('Verify that is possible to have a worker that return undefined', async () => {
@@ -128,6 +157,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,10 +170,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',
+      message: 'Error Message from ClusterWorker',
+      data
+    })
+    expect(
+      errorPool.workerNodes.some(
+        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)
@@ -150,6 +197,16 @@ 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',
+      message: 'Error Message from ClusterWorker:async',
+      data
+    })
+    expect(
+      asyncErrorPool.workerNodes.some(
+        workerNode => workerNode.usage.tasks.failed === 1
+      )
+    ).toBe(true)
   })
 
   it('Verify that async function is working properly', async () => {
@@ -162,7 +219,7 @@ describe('Fixed cluster pool test suite', () => {
   })
 
   it('Shutdown test', async () => {
-    const exitPromise = TestUtils.waitExits(pool, numberOfWorkers)
+    const exitPromise = waitWorkerEvents(pool, 'exit', numberOfWorkers)
     await pool.destroy()
     const numberOfExitEvents = await exitPromise
     expect(numberOfExitEvents).toBe(numberOfWorkers)
@@ -197,7 +254,7 @@ describe('Fixed cluster pool test suite', () => {
       './tests/worker-files/cluster/testWorker.js'
     )
     const res = await pool1.execute()
-    expect(res).toBe(false)
+    expect(res).toStrictEqual({ ok: 1 })
     // We need to clean up the resources after our test
     await pool1.destroy()
   })
@@ -206,6 +263,6 @@ describe('Fixed cluster pool test suite', () => {
     expect(
       () =>
         new FixedClusterPool(0, './tests/worker-files/cluster/testWorker.js')
-    ).toThrowError(new Error('Cannot instantiate a fixed pool with no worker'))
+    ).toThrowError('Cannot instantiate a fixed pool with zero worker')
   })
 })