Fix pool execute promises fullfilment in tests
[poolifier.git] / tests / pools / thread / dynamic.test.js
index 4efb0f4b83bdad12b0d96e83d6276ab773198eda..f345a0ee665a78543e085bad4dd32248c70bd7d7 100644 (file)
@@ -1,5 +1,6 @@
-const expect = require('expect')
+const { expect } = require('expect')
 const { DynamicThreadPool } = require('../../../lib/index')
+const TestUtils = require('../../test-utils')
 const min = 1
 const max = 3
 const pool = new DynamicThreadPool(
@@ -11,7 +12,7 @@ const pool = new DynamicThreadPool(
   }
 )
 
-describe('Dynamic thread pool test suite ', () => {
+describe('Dynamic thread pool test suite', () => {
   it('Verify that the function is executed in a worker thread', async () => {
     const result = await pool.execute({ test: 'test' })
     expect(result).toBeDefined()
@@ -20,21 +21,19 @@ describe('Dynamic thread pool test suite ', () => {
 
   it('Verify that new workers are created when required, max size is not exceeded and that after a while new workers will die', async () => {
     const promises = []
-    let closedThreads = 0
-    let fullPool = 0
-    pool.emitter.on('FullPool', () => fullPool++)
+    let poolBusy = 0
+    pool.emitter.on('busy', () => poolBusy++)
     for (let i = 0; i < max * 2; i++) {
       promises.push(pool.execute({ test: 'test' }))
     }
-    expect(pool.workers.length).toBe(max)
-    pool.workers.forEach(w => {
-      w.on('exit', () => {
-        closedThreads++
-      })
-    })
-    expect(fullPool > 1).toBeTruthy()
-    await new Promise(resolve => setTimeout(resolve, 2000))
-    expect(closedThreads).toBe(max - min)
+    await Promise.all(promises)
+    expect(pool.workers.length).toBeLessThanOrEqual(max)
+    expect(pool.workers.length).toBeGreaterThan(min)
+    // The `busy` event is triggered when the number of submitted tasks at once reach the max number of workers in the dynamic pool.
+    // So in total numberOfWorkers + 1 times for a loop submitting up to numberOfWorkers * 2 tasks to the dynamic pool.
+    expect(poolBusy).toBe(max + 1)
+    const numberOfExitEvents = await TestUtils.waitExits(pool, max - min)
+    expect(numberOfExitEvents).toBe(max - min)
   })
 
   it('Verify scale thread up and down is working', async () => {
@@ -43,37 +42,27 @@ describe('Dynamic thread pool test suite ', () => {
       pool.execute({ test: 'test' })
     }
     expect(pool.workers.length).toBe(max)
-    await new Promise(resolve => setTimeout(resolve, 1000))
+    await TestUtils.waitExits(pool, max - min)
     expect(pool.workers.length).toBe(min)
     for (let i = 0; i < max * 10; i++) {
       pool.execute({ test: 'test' })
     }
     expect(pool.workers.length).toBe(max)
-    await new Promise(resolve => setTimeout(resolve, 1500))
+    await TestUtils.waitExits(pool, max - min)
     expect(pool.workers.length).toBe(min)
   })
 
   it('Shutdown test', async () => {
-    let closedThreads = 0
-    pool.workers.forEach(w => {
-      w.on('exit', () => {
-        closedThreads++
-      })
-    })
+    const exitPromise = TestUtils.waitExits(pool, min)
     await pool.destroy()
-    expect(closedThreads).toBe(min)
+    const numberOfExitEvents = await exitPromise
+    expect(numberOfExitEvents).toBe(min)
   })
 
-  it('Validations test', () => {
-    let error
-    try {
-      const pool1 = new DynamicThreadPool()
-      console.log(pool1)
-    } catch (e) {
-      error = e
-    }
-    expect(error).toBeTruthy()
-    expect(error.message).toBeTruthy()
+  it('Validation of inputs test', () => {
+    expect(() => new DynamicThreadPool(min)).toThrowError(
+      new Error('Please specify a file with a worker implementation')
+    )
   })
 
   it('Should work even without opts in input', async () => {
@@ -83,17 +72,21 @@ describe('Dynamic thread pool test suite ', () => {
       './tests/worker-files/thread/testWorker.js'
     )
     const res = await pool1.execute({ test: 'test' })
+    expect(res).toBeDefined()
     expect(res).toBeFalsy()
+    // We need to clean up the resources after our test
+    await pool1.destroy()
   })
 
   it('Verify scale thread up and down is working when long running task is used:hard', async () => {
     const longRunningPool = new DynamicThreadPool(
       min,
       max,
-      './tests/worker/thread/longRunningWorkerHardBehavior.js',
+      './tests/worker-files/thread/longRunningWorkerHardBehavior.js',
       {
         errorHandler: e => console.error(e),
-        onlineHandler: () => console.log('worker is online')
+        onlineHandler: () => console.log('long running worker is online'),
+        exitHandler: () => console.log('long running worker exited')
       }
     )
     expect(longRunningPool.workers.length).toBe(min)
@@ -101,18 +94,21 @@ describe('Dynamic thread pool test suite ', () => {
       longRunningPool.execute({ test: 'test' })
     }
     expect(longRunningPool.workers.length).toBe(max)
-    await new Promise(resolve => setTimeout(resolve, 1500))
+    await TestUtils.waitExits(longRunningPool, max - min)
     expect(longRunningPool.workers.length).toBe(min)
+    // We need to clean up the resources after our test
+    await longRunningPool.destroy()
   })
 
   it('Verify scale thread up and down is working when long running task is used:soft', async () => {
     const longRunningPool = new DynamicThreadPool(
       min,
       max,
-      './tests/worker/thread/longRunningWorkerSoftBehavior.js',
+      './tests/worker-files/thread/longRunningWorkerSoftBehavior.js',
       {
         errorHandler: e => console.error(e),
-        onlineHandler: () => console.log('worker is online')
+        onlineHandler: () => console.log('long running worker is online'),
+        exitHandler: () => console.log('long running worker exited')
       }
     )
     expect(longRunningPool.workers.length).toBe(min)
@@ -120,8 +116,21 @@ describe('Dynamic thread pool test suite ', () => {
       longRunningPool.execute({ test: 'test' })
     }
     expect(longRunningPool.workers.length).toBe(max)
-    await new Promise(resolve => setTimeout(resolve, 1500))
+    await TestUtils.sleep(1500)
     // Here we expect the workers to be at the max size since that the task is still running
     expect(longRunningPool.workers.length).toBe(max)
+    // We need to clean up the resources after our test
+    await longRunningPool.destroy()
+  })
+
+  it('Verify that a pool with zero worker can be instantiated', async () => {
+    const pool = new DynamicThreadPool(
+      0,
+      max,
+      './tests/worker-files/thread/testWorker.js'
+    )
+    expect(pool).toBeInstanceOf(DynamicThreadPool)
+    // We need to clean up the resources after our test
+    await pool.destroy()
   })
 })