refactor: add PoolEvents/PoolEvent types
[poolifier.git] / tests / pools / thread / fixed.test.js
index e160f17c72b6d4db2e8111d7fed488f84a666610..a42b5d37ede902bd5c6a490ce7ff832e6025d1fc 100644 (file)
@@ -1,64 +1,93 @@
-const expect = require('expect')
-const { FixedThreadPool } = require('../../../lib/index')
-const numberOfThreads = 10
-const maxTasks = 400
-const pool = new FixedThreadPool(
-  numberOfThreads,
-  './tests/worker/thread/testWorker.js',
-  {
-    errorHandler: e => console.error(e)
-  }
-)
-const emptyPool = new FixedThreadPool(1, './tests/worker/thread/emptyWorker.js')
-const echoPool = new FixedThreadPool(1, './tests/worker/thread/echoWorker.js')
-const errorPool = new FixedThreadPool(
-  1,
-  './tests/worker/thread/errorWorker.js',
-  {
-    errorHandler: e => console.error(e),
-    onlineHandler: () => console.log('worker is online')
-  }
-)
-const asyncPool = new FixedThreadPool(
-  1,
-  './tests/worker/thread/asyncWorker.js',
-  { maxTasks: maxTasks }
-)
+const { expect } = require('expect')
+const { FixedThreadPool, PoolEvents } = require('../../../lib/index')
+const { WorkerFunctions } = require('../../test-types')
+const TestUtils = require('../../test-utils')
 
-describe('Fixed thread pool test suite ', () => {
-  it('Choose worker round robin test', async () => {
-    const results = new Set()
-    for (let i = 0; i < numberOfThreads; i++) {
-      results.add(pool.chooseWorker().threadId)
+describe('Fixed thread pool test suite', () => {
+  const numberOfThreads = 6
+  const pool = new FixedThreadPool(
+    numberOfThreads,
+    './tests/worker-files/thread/testWorker.js',
+    {
+      errorHandler: e => console.error(e)
     }
-    expect(results.size).toBe(numberOfThreads)
+  )
+  const emptyPool = new FixedThreadPool(
+    numberOfThreads,
+    './tests/worker-files/thread/emptyWorker.js',
+    { exitHandler: () => console.log('empty pool worker exited') }
+  )
+  const echoPool = new FixedThreadPool(
+    numberOfThreads,
+    './tests/worker-files/thread/echoWorker.js'
+  )
+  const errorPool = new FixedThreadPool(
+    numberOfThreads,
+    './tests/worker-files/thread/errorWorker.js',
+    {
+      errorHandler: e => console.error(e)
+    }
+  )
+  const asyncErrorPool = new FixedThreadPool(
+    numberOfThreads,
+    './tests/worker-files/thread/asyncErrorWorker.js',
+    {
+      errorHandler: e => console.error(e)
+    }
+  )
+  const asyncPool = new FixedThreadPool(
+    numberOfThreads,
+    './tests/worker-files/thread/asyncWorker.js'
+  )
+
+  after('Destroy all pools', async () => {
+    // We need to clean up the resources after our test
+    await echoPool.destroy()
+    await asyncPool.destroy()
+    await errorPool.destroy()
+    await asyncErrorPool.destroy()
+    await emptyPool.destroy()
   })
 
   it('Verify that the function is executed in a worker thread', async () => {
-    const result = await pool.execute({ test: 'test' })
-    expect(result).toBeDefined()
-    expect(result).toBeFalsy()
+    let result = await pool.execute({
+      function: WorkerFunctions.fibonacci
+    })
+    expect(result).toBe(false)
+    result = await pool.execute({
+      function: WorkerFunctions.factorial
+    })
+    expect(result).toBe(false)
   })
 
   it('Verify that is possible to invoke the execute method without input', async () => {
     const result = await pool.execute()
-    expect(result).toBeDefined()
-    expect(result).toBeFalsy()
+    expect(result).toBe(false)
+  })
+
+  it("Verify that 'busy' event is emitted", async () => {
+    let poolBusy = 0
+    pool.emitter.on(PoolEvents.busy, () => ++poolBusy)
+    for (let i = 0; i < numberOfThreads * 2; i++) {
+      pool.execute()
+    }
+    // The `busy` event is triggered when the number of submitted tasks at once reach the number of fixed pool workers.
+    // So in total numberOfThreads + 1 times for a loop submitting up to numberOfThreads * 2 tasks to the fixed pool.
+    expect(poolBusy).toBe(numberOfThreads + 1)
   })
 
   it('Verify that is possible to have a worker that return undefined', async () => {
     const result = await emptyPool.execute()
-    expect(result).toBeFalsy()
+    expect(result).toBeUndefined()
   })
 
   it('Verify that data are sent to the worker correctly', async () => {
     const data = { f: 10 }
     const result = await echoPool.execute(data)
-    expect(result).toBeTruthy()
-    expect(result.f).toBe(data.f)
+    expect(result).toStrictEqual(data)
   })
 
-  it('Verify that error handling is working properly', async () => {
+  it('Verify that error handling is working properly:sync', async () => {
     const data = { f: 10 }
     let inError
     try {
@@ -66,52 +95,58 @@ describe('Fixed thread pool test suite ', () => {
     } catch (e) {
       inError = e
     }
-    expect(inError).toBeTruthy()
-    expect(inError instanceof Error).toBeTruthy()
-    expect(inError.message).toBeTruthy()
+    expect(inError).toBeDefined()
+    expect(inError).toBeInstanceOf(Error)
+    expect(inError.message).toBeDefined()
+    expect(typeof inError.message === 'string').toBe(true)
+    expect(inError.message).toBe('Error Message from ThreadWorker')
+  })
+
+  it('Verify that error handling is working properly:async', async () => {
+    const data = { f: 10 }
+    let inError
+    try {
+      await asyncErrorPool.execute(data)
+    } catch (e) {
+      inError = e
+    }
+    expect(inError).toBeDefined()
+    expect(inError).toBeInstanceOf(Error)
+    expect(inError.message).toBeDefined()
+    expect(typeof inError.message === 'string').toBe(true)
+    expect(inError.message).toBe('Error Message from ThreadWorker:async')
   })
 
   it('Verify that async function is working properly', async () => {
     const data = { f: 10 }
-    const startTime = new Date().getTime()
+    const startTime = Date.now()
     const result = await asyncPool.execute(data)
-    const usedTime = new Date().getTime() - startTime
-    expect(result).toBeTruthy()
-    expect(result.f).toBe(data.f)
+    const usedTime = Date.now() - startTime
+    expect(result).toStrictEqual(data)
     expect(usedTime).toBeGreaterThanOrEqual(2000)
   })
 
-  it('Verify that maxTasks is set properly', async () => {
-    const worker = asyncPool.chooseWorker()
-    expect(worker.port2.getMaxListeners()).toBe(maxTasks)
-  })
-
   it('Shutdown test', async () => {
-    let closedThreads = 0
-    pool.workers.forEach(w => {
-      w.on('exit', () => {
-        closedThreads++
-      })
-    })
+    const exitPromise = TestUtils.waitExits(pool, numberOfThreads)
     await pool.destroy()
-    expect(closedThreads).toBe(numberOfThreads)
+    const numberOfExitEvents = await exitPromise
+    expect(numberOfExitEvents).toBe(numberOfThreads)
   })
 
-  it('Validations test', () => {
-    let error
-    try {
-      const pool1 = new FixedThreadPool()
-      console.log(pool1)
-    } catch (e) {
-      error = e
-    }
-    expect(error).toBeTruthy()
-    expect(error.message).toBeTruthy()
+  it('Should work even without opts in input', async () => {
+    const pool1 = new FixedThreadPool(
+      numberOfThreads,
+      './tests/worker-files/thread/testWorker.js'
+    )
+    const res = await pool1.execute()
+    expect(res).toBe(false)
+    // We need to clean up the resources after our test
+    await pool1.destroy()
   })
 
-  it('Should work even without opts in input', async () => {
-    const pool1 = new FixedThreadPool(1, './tests/worker/thread/testWorker.js')
-    const res = await pool1.execute({ test: 'test' })
-    expect(res).toBeFalsy()
+  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'))
   })
 })