refactor: cleanup and type task error messages
[poolifier.git] / tests / pools / thread / fixed.test.js
index fd9ce5dfe799a7f8e707bcdb843f875dfe0fbd5a..90dd110cd44ce0da7c2d43dd7b5cd0fd442be26b 100644 (file)
@@ -1,5 +1,5 @@
 const { expect } = require('expect')
-const { FixedThreadPool } = require('../../../lib/index')
+const { FixedThreadPool, PoolEvents } = require('../../../lib')
 const { WorkerFunctions } = require('../../test-types')
 const TestUtils = require('../../test-utils')
 
@@ -12,6 +12,17 @@ describe('Fixed thread pool test suite', () => {
       errorHandler: e => console.error(e)
     }
   )
+  const queuePool = new FixedThreadPool(
+    numberOfThreads,
+    './tests/worker-files/thread/testWorker.js',
+    {
+      enableTasksQueue: true,
+      tasksQueueOptions: {
+        concurrency: 2
+      },
+      errorHandler: e => console.error(e)
+    }
+  )
   const emptyPool = new FixedThreadPool(
     numberOfThreads,
     './tests/worker-files/thread/emptyWorker.js',
@@ -47,27 +58,28 @@ describe('Fixed thread pool test suite', () => {
     await errorPool.destroy()
     await asyncErrorPool.destroy()
     await emptyPool.destroy()
+    await queuePool.destroy()
   })
 
   it('Verify that the function is executed in a worker thread', async () => {
     let result = await pool.execute({
       function: WorkerFunctions.fibonacci
     })
-    expect(result).toBe(false)
+    expect(result).toBe(121393)
     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)
   })
 
-  it('Verify that busy event is emitted', async () => {
+  it("Verify that 'busy' event is emitted", async () => {
     let poolBusy = 0
-    pool.emitter.on('busy', () => ++poolBusy)
+    pool.emitter.on(PoolEvents.busy, () => ++poolBusy)
     for (let i = 0; i < numberOfThreads * 2; i++) {
       pool.execute()
     }
@@ -76,6 +88,36 @@ describe('Fixed thread pool test suite', () => {
     expect(poolBusy).toBe(numberOfThreads + 1)
   })
 
+  it('Verify that tasks queuing is working', async () => {
+    const promises = new Set()
+    const maxMultiplier = 2
+    for (let i = 0; i < numberOfThreads * maxMultiplier; i++) {
+      promises.add(queuePool.execute())
+    }
+    expect(promises.size).toBe(numberOfThreads * maxMultiplier)
+    for (const workerNode of queuePool.workerNodes) {
+      expect(workerNode.tasksUsage.running).toBeLessThanOrEqual(
+        queuePool.opts.tasksQueueOptions.concurrency
+      )
+      expect(workerNode.tasksUsage.ran).toBe(0)
+      expect(workerNode.tasksQueue.size).toBeGreaterThan(0)
+    }
+    expect(queuePool.info.runningTasks).toBe(numberOfThreads)
+    expect(queuePool.info.queuedTasks).toBe(
+      numberOfThreads * maxMultiplier - numberOfThreads
+    )
+    expect(queuePool.info.maxQueuedTasks).toBe(
+      numberOfThreads * maxMultiplier - numberOfThreads
+    )
+    await Promise.all(promises)
+    for (const workerNode of queuePool.workerNodes) {
+      expect(workerNode.tasksUsage.running).toBe(0)
+      expect(workerNode.tasksUsage.ran).toBeGreaterThan(0)
+      expect(workerNode.tasksUsage.ran).toBeLessThanOrEqual(maxMultiplier)
+      expect(workerNode.tasksQueue.size).toBe(0)
+    }
+  })
+
   it('Verify that is possible to have a worker that return undefined', async () => {
     const result = await emptyPool.execute()
     expect(result).toBeUndefined()
@@ -89,6 +131,10 @@ describe('Fixed thread 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)
@@ -100,10 +146,23 @@ describe('Fixed thread pool test suite', () => {
     expect(inError.message).toBeDefined()
     expect(typeof inError.message === 'string').toBe(true)
     expect(inError.message).toBe('Error Message from ThreadWorker')
+    expect(taskError).toStrictEqual({
+      message: new Error('Error Message from ThreadWorker'),
+      data
+    })
+    expect(
+      errorPool.workerNodes.some(
+        workerNode => workerNode.tasksUsage.error === 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)
@@ -115,24 +174,51 @@ describe('Fixed thread pool test suite', () => {
     expect(inError.message).toBeDefined()
     expect(typeof inError.message === 'string').toBe(true)
     expect(inError.message).toBe('Error Message from ThreadWorker:async')
+    expect(taskError).toStrictEqual({
+      message: new Error('Error Message from ThreadWorker:async'),
+      data
+    })
+    expect(
+      asyncErrorPool.workerNodes.some(
+        workerNode => workerNode.tasksUsage.error === 1
+      )
+    ).toBe(true)
   })
 
   it('Verify that async function is working properly', async () => {
     const data = { f: 10 }
-    const startTime = Date.now()
+    const startTime = performance.now()
     const result = await asyncPool.execute(data)
-    const usedTime = Date.now() - startTime
+    const usedTime = performance.now() - startTime
     expect(result).toStrictEqual(data)
     expect(usedTime).toBeGreaterThanOrEqual(2000)
   })
 
   it('Shutdown test', async () => {
-    const exitPromise = TestUtils.waitExits(pool, numberOfThreads)
+    const exitPromise = TestUtils.waitWorkerExits(pool, numberOfThreads)
     await pool.destroy()
     const numberOfExitEvents = await exitPromise
     expect(numberOfExitEvents).toBe(numberOfThreads)
   })
 
+  it('Verify that thread pool options are checked', async () => {
+    const workerFilePath = './tests/worker-files/cluster/testWorker.js'
+    let pool1 = new FixedThreadPool(numberOfThreads, workerFilePath)
+    expect(pool1.opts.workerOptions).toBeUndefined()
+    await pool1.destroy()
+    pool1 = new FixedThreadPool(numberOfThreads, workerFilePath, {
+      workerOptions: {
+        env: { TEST: 'test' },
+        name: 'test'
+      }
+    })
+    expect(pool1.opts.workerOptions).toStrictEqual({
+      env: { TEST: 'test' },
+      name: 'test'
+    })
+    await pool1.destroy()
+  })
+
   it('Should work even without opts in input', async () => {
     const pool1 = new FixedThreadPool(
       numberOfThreads,
@@ -147,6 +233,6 @@ describe('Fixed thread pool test suite', () => {
   it('Verify that a pool with zero worker fails', async () => {
     expect(
       () => new FixedThreadPool(0, './tests/worker-files/thread/testWorker.js')
-    ).toThrowError(new Error('Cannot instantiate a fixed pool with no worker'))
+    ).toThrowError('Cannot instantiate a fixed pool with no worker')
   })
 })