refactor: add PoolEvents/PoolEvent types
[poolifier.git] / tests / pools / cluster / fixed.test.js
index 1cbfadf5b63ad3e029b61d47e24f6d6d9a445467..908acbfe84530f59d3facb59cfec315df7333cd1 100644 (file)
@@ -1,78 +1,90 @@
-const expect = require('expect')
-const { FixedClusterPool } = require('../../../lib/index')
-const numberOfWorkers = 10
-const maxTasks = 500
-const pool = new FixedClusterPool(
-  numberOfWorkers,
-  './tests/worker-files/cluster/testWorker.js',
-  {
-    errorHandler: e => console.error(e),
-    onlineHandler: () => console.log('worker is online')
-  }
-)
-const emptyPool = new FixedClusterPool(
-  1,
-  './tests/worker-files/cluster/emptyWorker.js'
-)
-const echoPool = new FixedClusterPool(
-  1,
-  './tests/worker-files/cluster/echoWorker.js'
-)
-const errorPool = new FixedClusterPool(
-  1,
-  './tests/worker-files/cluster/errorWorker.js',
-  {
-    errorHandler: e => console.error(e),
-    onlineHandler: () => console.log('worker is online')
-  }
-)
+const { expect } = require('expect')
+const { FixedClusterPool, PoolEvents } = require('../../../lib/index')
+const { WorkerFunctions } = require('../../test-types')
+const TestUtils = require('../../test-utils')
 
-const asyncErrorPool = new FixedClusterPool(
-  1,
-  './tests/worker-files/cluster/asyncErrorWorker.js',
-  {
-    onlineHandler: () => console.log('worker is online')
-  }
-)
-const asyncPool = new FixedClusterPool(
-  1,
-  './tests/worker-files/cluster/asyncWorker.js',
-  {
-    maxTasks: maxTasks
-  }
-)
-
-describe('Fixed cluster pool test suite ', () => {
-  it('Choose worker round robin test', async () => {
-    const results = new Set()
-    for (let i = 0; i < numberOfWorkers; i++) {
-      results.add(pool.chooseWorker().id)
+describe('Fixed cluster pool test suite', () => {
+  const numberOfWorkers = 6
+  const pool = new FixedClusterPool(
+    numberOfWorkers,
+    './tests/worker-files/cluster/testWorker.js',
+    {
+      errorHandler: e => console.error(e)
+    }
+  )
+  const emptyPool = new FixedClusterPool(
+    numberOfWorkers,
+    './tests/worker-files/cluster/emptyWorker.js',
+    { exitHandler: () => console.log('empty pool worker exited') }
+  )
+  const echoPool = new FixedClusterPool(
+    numberOfWorkers,
+    './tests/worker-files/cluster/echoWorker.js'
+  )
+  const errorPool = new FixedClusterPool(
+    numberOfWorkers,
+    './tests/worker-files/cluster/errorWorker.js',
+    {
+      errorHandler: e => console.error(e)
+    }
+  )
+  const asyncErrorPool = new FixedClusterPool(
+    numberOfWorkers,
+    './tests/worker-files/cluster/asyncErrorWorker.js',
+    {
+      errorHandler: e => console.error(e)
     }
-    expect(results.size).toBe(numberOfWorkers)
+  )
+  const asyncPool = new FixedClusterPool(
+    numberOfWorkers,
+    './tests/worker-files/cluster/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 cluster', 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 < numberOfWorkers * 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 numberOfWorkers + 1 times for a loop submitting up to numberOfWorkers * 2 tasks to the fixed pool.
+    expect(poolBusy).toBe(numberOfWorkers + 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:sync', async () => {
@@ -84,7 +96,7 @@ describe('Fixed cluster pool test suite ', () => {
       inError = e
     }
     expect(inError).toBeDefined()
-    expect(typeof inError === 'string').toBeTruthy()
+    expect(typeof inError === 'string').toBe(true)
     expect(inError).toBe('Error Message from ClusterWorker')
   })
 
@@ -97,55 +109,64 @@ describe('Fixed cluster pool test suite ', () => {
       inError = e
     }
     expect(inError).toBeDefined()
-    expect(typeof inError === 'string').toBeTruthy()
+    expect(typeof inError === 'string').toBe(true)
     expect(inError).toBe('Error Message from ClusterWorker: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.getMaxListeners()).toBe(maxTasks)
-  })
-
   it('Shutdown test', async () => {
-    let closedWorkers = 0
-    pool.workers.forEach(w => {
-      w.on('exit', () => {
-        closedWorkers++
-      })
-    })
+    const exitPromise = TestUtils.waitExits(pool, numberOfWorkers)
     await pool.destroy()
-    await new Promise(resolve => setTimeout(resolve, 200))
-    expect(closedWorkers).toBe(numberOfWorkers)
+    const numberOfExitEvents = await exitPromise
+    expect(numberOfExitEvents).toBe(numberOfWorkers)
   })
 
-  it('Validations test', () => {
-    let error
-    try {
-      const pool1 = new FixedClusterPool()
-      console.log(pool1)
-    } catch (e) {
-      error = e
-    }
-    expect(error).toBeTruthy()
-    expect(error.message).toBeTruthy()
+  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, {
+      env: { TEST: 'test' },
+      settings: { args: ['--use', 'http'], silent: true }
+    })
+    expect(pool1.opts.env).toStrictEqual({ TEST: 'test' })
+    expect(pool1.opts.settings).toStrictEqual({
+      args: ['--use', 'http'],
+      silent: true
+    })
+    expect({ ...pool1.opts.settings, exec: workerFilePath }).toStrictEqual({
+      args: ['--use', 'http'],
+      silent: true,
+      exec: workerFilePath
+    })
+    await pool1.destroy()
   })
 
   it('Should work even without opts in input', async () => {
     const pool1 = new FixedClusterPool(
-      1,
+      numberOfWorkers,
       './tests/worker-files/cluster/testWorker.js'
     )
-    const res = await pool1.execute({ test: 'test' })
-    expect(res).toBeFalsy()
+    const res = await pool1.execute()
+    expect(res).toBe(false)
+    // We need to clean up the resources after our test
+    await pool1.destroy()
+  })
+
+  it('Verify that a pool with zero worker fails', async () => {
+    expect(
+      () =>
+        new FixedClusterPool(0, './tests/worker-files/cluster/testWorker.js')
+    ).toThrowError(new Error('Cannot instantiate a fixed pool with no worker'))
   })
 })