refactor: prepare the code to handle task abstraction at execute

[poolifier.git] / tests / pools / abstract / abstract-pool.test.js

diff --git a/tests/pools/abstract/abstract-pool.test.js b/tests/pools/abstract/abstract-pool.test.js
index a87c8934701bd442af287fcdc91e27af33eeda41..54646e3aecbc3b5e87dc5bb791045b678862c6bd 100644 (file)
--- a/tests/pools/abstract/abstract-pool.test.js
+++ b/tests/pools/abstract/abstract-pool.test.js
@@ -1,20 +1,22 @@
 const { expect } = require('expect')
 const {
-  FixedClusterPool,
   DynamicThreadPool,
+  FixedClusterPool,
   FixedThreadPool,
+  PoolEvents,
   WorkerChoiceStrategies
 } = require('../../../lib/index')
+const { CircularArray } = require('../../../lib/circular-array')
 
 describe('Abstract pool test suite', () => {
   const numberOfWorkers = 1
   const workerNotFoundInPoolError = new Error(
-    'Worker could not be found in the pool'
+    'Worker could not be found in the pool worker nodes'
   )
   class StubPoolWithRemoveAllWorker extends FixedThreadPool {
     removeAllWorker () {
       this.workers = []
-      this.promiseMap.clear()
+      this.promiseResponseMap.clear()
     }
   }
   class StubPoolWithIsMain extends FixedThreadPool {
@@ -139,12 +141,29 @@ describe('Abstract pool test suite', () => {
       numberOfWorkers,
       './tests/worker-files/cluster/testWorker.js'
     )
-    for (const workerItem of pool.workers) {
-      expect(workerItem.tasksUsage).toBeDefined()
-      expect(workerItem.tasksUsage.run).toBe(0)
-      expect(workerItem.tasksUsage.running).toBe(0)
-      expect(workerItem.tasksUsage.runTime).toBe(0)
-      expect(workerItem.tasksUsage.avgRunTime).toBe(0)
+    for (const workerNode of pool.workerNodes) {
+      expect(workerNode.tasksUsage).toBeDefined()
+      expect(workerNode.tasksUsage.run).toBe(0)
+      expect(workerNode.tasksUsage.running).toBe(0)
+      expect(workerNode.tasksUsage.runTime).toBe(0)
+      expect(workerNode.tasksUsage.runTimeHistory).toBeInstanceOf(CircularArray)
+      expect(workerNode.tasksUsage.runTimeHistory.length).toBe(0)
+      expect(workerNode.tasksUsage.avgRunTime).toBe(0)
+      expect(workerNode.tasksUsage.medRunTime).toBe(0)
+      expect(workerNode.tasksUsage.error).toBe(0)
+    }
+    await pool.destroy()
+  })
+
+  it('Verify that worker pool tasks queue are initialized', async () => {
+    const pool = new FixedClusterPool(
+      numberOfWorkers,
+      './tests/worker-files/cluster/testWorker.js'
+    )
+    for (const workerNode of pool.workerNodes) {
+      expect(workerNode.tasksQueue).toBeDefined()
+      expect(workerNode.tasksQueue).toBeInstanceOf(Array)
+      expect(workerNode.tasksQueue.length).toBe(0)
     }
     await pool.destroy()
   })
@@ -158,20 +177,28 @@ describe('Abstract pool test suite', () => {
     for (let i = 0; i < numberOfWorkers * 2; i++) {
       promises.push(pool.execute())
     }
-    for (const workerItem of pool.workers) {
-      expect(workerItem.tasksUsage).toBeDefined()
-      expect(workerItem.tasksUsage.run).toBe(0)
-      expect(workerItem.tasksUsage.running).toBe(numberOfWorkers * 2)
-      expect(workerItem.tasksUsage.runTime).toBe(0)
-      expect(workerItem.tasksUsage.avgRunTime).toBe(0)
+    for (const workerNode of pool.workerNodes) {
+      expect(workerNode.tasksUsage).toBeDefined()
+      expect(workerNode.tasksUsage.run).toBe(0)
+      expect(workerNode.tasksUsage.running).toBe(numberOfWorkers * 2)
+      expect(workerNode.tasksUsage.runTime).toBe(0)
+      expect(workerNode.tasksUsage.runTimeHistory).toBeInstanceOf(CircularArray)
+      expect(workerNode.tasksUsage.runTimeHistory.length).toBe(0)
+      expect(workerNode.tasksUsage.avgRunTime).toBe(0)
+      expect(workerNode.tasksUsage.medRunTime).toBe(0)
+      expect(workerNode.tasksUsage.error).toBe(0)
     }
     await Promise.all(promises)
-    for (const workerItem of pool.workers) {
-      expect(workerItem.tasksUsage).toBeDefined()
-      expect(workerItem.tasksUsage.run).toBe(numberOfWorkers * 2)
-      expect(workerItem.tasksUsage.running).toBe(0)
-      expect(workerItem.tasksUsage.runTime).toBeGreaterThanOrEqual(0)
-      expect(workerItem.tasksUsage.avgRunTime).toBeGreaterThanOrEqual(0)
+    for (const workerNode of pool.workerNodes) {
+      expect(workerNode.tasksUsage).toBeDefined()
+      expect(workerNode.tasksUsage.run).toBe(numberOfWorkers * 2)
+      expect(workerNode.tasksUsage.running).toBe(0)
+      expect(workerNode.tasksUsage.runTime).toBeGreaterThanOrEqual(0)
+      expect(workerNode.tasksUsage.runTimeHistory).toBeInstanceOf(CircularArray)
+      expect(workerNode.tasksUsage.runTimeHistory.length).toBe(0)
+      expect(workerNode.tasksUsage.avgRunTime).toBeGreaterThanOrEqual(0)
+      expect(workerNode.tasksUsage.medRunTime).toBe(0)
+      expect(workerNode.tasksUsage.error).toBe(0)
     }
     await pool.destroy()
   })
@@ -187,24 +214,51 @@ describe('Abstract pool test suite', () => {
       promises.push(pool.execute())
     }
     await Promise.all(promises)
-    for (const workerItem of pool.workers) {
-      expect(workerItem.tasksUsage).toBeDefined()
-      expect(workerItem.tasksUsage.run).toBe(numberOfWorkers * 2)
-      expect(workerItem.tasksUsage.running).toBe(0)
-      expect(workerItem.tasksUsage.runTime).toBeGreaterThanOrEqual(0)
-      expect(workerItem.tasksUsage.avgRunTime).toBeGreaterThanOrEqual(0)
+    for (const workerNode of pool.workerNodes) {
+      expect(workerNode.tasksUsage).toBeDefined()
+      expect(workerNode.tasksUsage.run).toBe(numberOfWorkers * 2)
+      expect(workerNode.tasksUsage.running).toBe(0)
+      expect(workerNode.tasksUsage.runTime).toBeGreaterThanOrEqual(0)
+      expect(workerNode.tasksUsage.runTimeHistory).toBeInstanceOf(CircularArray)
+      expect(workerNode.tasksUsage.runTimeHistory.length).toBe(0)
+      expect(workerNode.tasksUsage.avgRunTime).toBeGreaterThanOrEqual(0)
+      expect(workerNode.tasksUsage.medRunTime).toBe(0)
+      expect(workerNode.tasksUsage.error).toBe(0)
     }
     pool.setWorkerChoiceStrategy(WorkerChoiceStrategies.FAIR_SHARE)
-    for (const workerItem of pool.workers) {
-      expect(workerItem.tasksUsage).toBeDefined()
-      expect(workerItem.tasksUsage.run).toBe(0)
-      expect(workerItem.tasksUsage.running).toBe(0)
-      expect(workerItem.tasksUsage.runTime).toBe(0)
-      expect(workerItem.tasksUsage.avgRunTime).toBe(0)
+    for (const workerNode of pool.workerNodes) {
+      expect(workerNode.tasksUsage).toBeDefined()
+      expect(workerNode.tasksUsage.run).toBe(0)
+      expect(workerNode.tasksUsage.running).toBe(0)
+      expect(workerNode.tasksUsage.runTime).toBe(0)
+      expect(workerNode.tasksUsage.runTimeHistory).toBeInstanceOf(CircularArray)
+      expect(workerNode.tasksUsage.runTimeHistory.length).toBe(0)
+      expect(workerNode.tasksUsage.avgRunTime).toBe(0)
+      expect(workerNode.tasksUsage.medRunTime).toBe(0)
+      expect(workerNode.tasksUsage.error).toBe(0)
     }
     await pool.destroy()
   })
 
+  it("Verify that pool event emitter 'full' event can register a callback", async () => {
+    const pool = new DynamicThreadPool(
+      numberOfWorkers,
+      numberOfWorkers,
+      './tests/worker-files/thread/testWorker.js'
+    )
+    const promises = []
+    let poolFull = 0
+    pool.emitter.on(PoolEvents.full, () => ++poolFull)
+    for (let i = 0; i < numberOfWorkers * 2; i++) {
+      promises.push(pool.execute())
+    }
+    await Promise.all(promises)
+    // The `full` event is triggered when the number of submitted tasks at once reach the number of dynamic pool workers.
+    // So in total numberOfWorkers + 1 times for a loop submitting up to numberOfWorkers * 2 tasks to the dynamic pool.
+    expect(poolFull).toBe(numberOfWorkers + 1)
+    await pool.destroy()
+  })
+
   it("Verify that pool event emitter 'busy' event can register a callback", async () => {
     const pool = new FixedThreadPool(
       numberOfWorkers,
@@ -212,7 +266,7 @@ describe('Abstract pool test suite', () => {
     )
     const promises = []
     let poolBusy = 0
-    pool.emitter.on('busy', () => poolBusy++)
+    pool.emitter.on(PoolEvents.busy, () => ++poolBusy)
     for (let i = 0; i < numberOfWorkers * 2; i++) {
       promises.push(pool.execute())
     }