feat: add pool and worker readyness tracking infrastructure
[poolifier.git] / tests / pools / abstract / abstract-pool.test.js
index 0e31ad5c21927c135ce77d1d69508c7b7061d611..caec34fd47a0ae267f9c6b5dcfe7648a352e1a2a 100644 (file)
@@ -12,6 +12,7 @@ const {
 const { CircularArray } = require('../../../lib/circular-array')
 const { Queue } = require('../../../lib/queue')
 const { version } = require('../../../package.json')
+const { waitPoolEvents } = require('../../test-utils')
 
 describe('Abstract pool test suite', () => {
   const numberOfWorkers = 2
@@ -19,6 +20,7 @@ describe('Abstract pool test suite', () => {
     removeAllWorker () {
       this.workerNodes = []
       this.promiseResponseMap.clear()
+      this.handleWorkerReadyMessage = () => {}
     }
   }
   class StubPoolWithIsMain extends FixedThreadPool {
@@ -80,6 +82,25 @@ describe('Abstract pool test suite', () => {
     )
   })
 
+  it('Verify dynamic pool sizing', () => {
+    expect(
+      () =>
+        new DynamicThreadPool(2, 1, './tests/worker-files/thread/testWorker.js')
+    ).toThrowError(
+      new RangeError(
+        'Cannot instantiate a dynamic pool with a maximum pool size inferior to the minimum pool size'
+      )
+    )
+    expect(
+      () =>
+        new DynamicThreadPool(1, 1, './tests/worker-files/thread/testWorker.js')
+    ).toThrowError(
+      new RangeError(
+        'Cannot instantiate a dynamic pool with a minimum pool size equal to the maximum pool size. Use a fixed pool instead'
+      )
+    )
+  })
+
   it('Verify that pool options are checked', async () => {
     let pool = new FixedThreadPool(
       numberOfWorkers,
@@ -224,7 +245,7 @@ describe('Abstract pool test suite', () => {
     ).toThrowError('Invalid worker tasks concurrency: must be an integer')
   })
 
-  it('Verify that worker choice strategy options can be set', async () => {
+  it('Verify that pool worker choice strategy options can be set', async () => {
     const pool = new FixedThreadPool(
       numberOfWorkers,
       './tests/worker-files/thread/testWorker.js',
@@ -348,7 +369,7 @@ describe('Abstract pool test suite', () => {
     await pool.destroy()
   })
 
-  it('Verify that tasks queue can be enabled/disabled', async () => {
+  it('Verify that pool tasks queue can be enabled/disabled', async () => {
     const pool = new FixedThreadPool(
       numberOfWorkers,
       './tests/worker-files/thread/testWorker.js'
@@ -367,7 +388,7 @@ describe('Abstract pool test suite', () => {
     await pool.destroy()
   })
 
-  it('Verify that tasks queue options can be set', async () => {
+  it('Verify that pool tasks queue options can be set', async () => {
     const pool = new FixedThreadPool(
       numberOfWorkers,
       './tests/worker-files/thread/testWorker.js',
@@ -397,6 +418,8 @@ describe('Abstract pool test suite', () => {
       version,
       type: PoolTypes.fixed,
       worker: WorkerTypes.thread,
+      ready: false,
+      strategy: WorkerChoiceStrategies.ROUND_ROBIN,
       minSize: numberOfWorkers,
       maxSize: numberOfWorkers,
       workerNodes: numberOfWorkers,
@@ -410,18 +433,20 @@ describe('Abstract pool test suite', () => {
     })
     await pool.destroy()
     pool = new DynamicClusterPool(
+      Math.floor(numberOfWorkers / 2),
       numberOfWorkers,
-      numberOfWorkers * 2,
       './tests/worker-files/cluster/testWorker.js'
     )
     expect(pool.info).toStrictEqual({
       version,
       type: PoolTypes.dynamic,
       worker: WorkerTypes.cluster,
-      minSize: numberOfWorkers,
-      maxSize: numberOfWorkers * 2,
-      workerNodes: numberOfWorkers,
-      idleWorkerNodes: numberOfWorkers,
+      ready: false,
+      strategy: WorkerChoiceStrategies.ROUND_ROBIN,
+      minSize: Math.floor(numberOfWorkers / 2),
+      maxSize: numberOfWorkers,
+      workerNodes: Math.floor(numberOfWorkers / 2),
+      idleWorkerNodes: Math.floor(numberOfWorkers / 2),
       busyWorkerNodes: 0,
       executedTasks: 0,
       executingTasks: 0,
@@ -447,7 +472,7 @@ describe('Abstract pool test suite', () => {
     await pool.destroy()
   })
 
-  it('Verify that worker pool tasks usage are initialized', async () => {
+  it('Verify that pool worker tasks usage are initialized', async () => {
     const pool = new FixedClusterPool(
       numberOfWorkers,
       './tests/worker-files/cluster/testWorker.js'
@@ -480,8 +505,8 @@ describe('Abstract pool test suite', () => {
     await pool.destroy()
   })
 
-  it('Verify that worker pool tasks queue are initialized', async () => {
-    const pool = new FixedClusterPool(
+  it('Verify that pool worker tasks queue are initialized', async () => {
+    let pool = new FixedClusterPool(
       numberOfWorkers,
       './tests/worker-files/cluster/testWorker.js'
     )
@@ -492,9 +517,49 @@ describe('Abstract pool test suite', () => {
       expect(workerNode.tasksQueue.maxSize).toBe(0)
     }
     await pool.destroy()
+    pool = new DynamicThreadPool(
+      Math.floor(numberOfWorkers / 2),
+      numberOfWorkers,
+      './tests/worker-files/thread/testWorker.js'
+    )
+    for (const workerNode of pool.workerNodes) {
+      expect(workerNode.tasksQueue).toBeDefined()
+      expect(workerNode.tasksQueue).toBeInstanceOf(Queue)
+      expect(workerNode.tasksQueue.size).toBe(0)
+      expect(workerNode.tasksQueue.maxSize).toBe(0)
+    }
+  })
+
+  it('Verify that pool worker info are initialized', async () => {
+    let pool = new FixedClusterPool(
+      numberOfWorkers,
+      './tests/worker-files/cluster/testWorker.js'
+    )
+    for (const workerNode of pool.workerNodes) {
+      expect(workerNode.info).toStrictEqual({
+        id: expect.any(Number),
+        type: WorkerTypes.cluster,
+        dynamic: false,
+        ready: false
+      })
+    }
+    await pool.destroy()
+    pool = new DynamicThreadPool(
+      Math.floor(numberOfWorkers / 2),
+      numberOfWorkers,
+      './tests/worker-files/thread/testWorker.js'
+    )
+    for (const workerNode of pool.workerNodes) {
+      expect(workerNode.info).toStrictEqual({
+        id: expect.any(Number),
+        type: WorkerTypes.thread,
+        dynamic: false,
+        ready: false
+      })
+    }
   })
 
-  it('Verify that worker pool tasks usage are computed', async () => {
+  it('Verify that pool worker tasks usage are computed', async () => {
     const pool = new FixedClusterPool(
       numberOfWorkers,
       './tests/worker-files/cluster/testWorker.js'
@@ -558,9 +623,9 @@ describe('Abstract pool test suite', () => {
     await pool.destroy()
   })
 
-  it('Verify that worker pool tasks usage are reset at worker choice strategy change', async () => {
+  it('Verify that pool worker tasks usage are reset at worker choice strategy change', async () => {
     const pool = new DynamicThreadPool(
-      numberOfWorkers,
+      Math.floor(numberOfWorkers / 2),
       numberOfWorkers,
       './tests/worker-files/thread/testWorker.js'
     )
@@ -630,7 +695,7 @@ describe('Abstract pool test suite', () => {
 
   it("Verify that pool event emitter 'full' event can register a callback", async () => {
     const pool = new DynamicThreadPool(
-      numberOfWorkers,
+      Math.floor(numberOfWorkers / 2),
       numberOfWorkers,
       './tests/worker-files/thread/testWorker.js'
     )
@@ -645,13 +710,48 @@ describe('Abstract pool test suite', () => {
       promises.add(pool.execute())
     }
     await Promise.all(promises)
-    // The `full` 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 * 2 times for a loop submitting up to numberOfWorkers * 2 tasks to the dynamic pool with min = max = numberOfWorkers.
-    expect(poolFull).toBe(numberOfWorkers * 2)
+    // The `full` event is triggered when the number of submitted tasks at once reach the maximum number of workers in the dynamic pool.
+    // So in total numberOfWorkers * 2 - 1 times for a loop submitting up to numberOfWorkers * 2 tasks to the dynamic pool with min = (max = numberOfWorkers) / 2.
+    expect(poolFull).toBe(numberOfWorkers * 2 - 1)
     expect(poolInfo).toStrictEqual({
       version,
       type: PoolTypes.dynamic,
       worker: WorkerTypes.thread,
+      ready: expect.any(Boolean),
+      strategy: WorkerChoiceStrategies.ROUND_ROBIN,
+      minSize: expect.any(Number),
+      maxSize: expect.any(Number),
+      workerNodes: expect.any(Number),
+      idleWorkerNodes: expect.any(Number),
+      busyWorkerNodes: expect.any(Number),
+      executedTasks: expect.any(Number),
+      executingTasks: expect.any(Number),
+      queuedTasks: expect.any(Number),
+      maxQueuedTasks: expect.any(Number),
+      failedTasks: expect.any(Number)
+    })
+    await pool.destroy()
+  })
+
+  it("Verify that pool event emitter 'ready' event can register a callback", async () => {
+    const pool = new FixedClusterPool(
+      numberOfWorkers,
+      './tests/worker-files/cluster/testWorker.js'
+    )
+    let poolReady = 0
+    let poolInfo
+    pool.emitter.on(PoolEvents.ready, info => {
+      ++poolReady
+      poolInfo = info
+    })
+    await waitPoolEvents(pool, PoolEvents.ready, 1)
+    expect(poolReady).toBe(1)
+    expect(poolInfo).toStrictEqual({
+      version,
+      type: PoolTypes.fixed,
+      worker: WorkerTypes.cluster,
+      ready: true,
+      strategy: WorkerChoiceStrategies.ROUND_ROBIN,
       minSize: expect.any(Number),
       maxSize: expect.any(Number),
       workerNodes: expect.any(Number),
@@ -689,6 +789,8 @@ describe('Abstract pool test suite', () => {
       version,
       type: PoolTypes.fixed,
       worker: WorkerTypes.thread,
+      ready: expect.any(Boolean),
+      strategy: WorkerChoiceStrategies.ROUND_ROBIN,
       minSize: expect.any(Number),
       maxSize: expect.any(Number),
       workerNodes: expect.any(Number),
@@ -705,8 +807,8 @@ describe('Abstract pool test suite', () => {
 
   it('Verify that multiple tasks worker is working', async () => {
     const pool = new DynamicClusterPool(
+      Math.floor(numberOfWorkers / 2),
       numberOfWorkers,
-      numberOfWorkers * 2,
       './tests/worker-files/cluster/testMultiTasksWorker.js'
     )
     const data = { n: 10 }