Test: Verify that worker pool tasks usage are reset at worker choice strategy change...
[poolifier.git] / tests / pools / abstract / abstract-pool.test.js
index d4690b4fac4dcc5e9233b1a773ba4adb178f8b4b..e1c83b6fbfdf91caf6da8ffab5fd8532bd48da7b 100644 (file)
@@ -1,50 +1,26 @@
 const { expect } = require('expect')
 const {
   FixedClusterPool,
+  DynamicThreadPool,
   FixedThreadPool,
   WorkerChoiceStrategies
 } = require('../../../lib/index')
-const expectedError = new Error('Worker could not be found in tasks map')
 
-const numberOfWorkers = 1
-
-class StubPoolWithTasksMapClear extends FixedThreadPool {
-  removeAllWorker () {
-    this.tasks.clear()
+describe('Abstract pool test suite', () => {
+  const numberOfWorkers = 1
+  const workerNotFoundInTasksUsageMapError = new Error(
+    'Worker could not be found in worker tasks usage map'
+  )
+  class StubPoolWithWorkerTasksUsageMapClear extends FixedThreadPool {
+    removeAllWorker () {
+      this.workersTasksUsage.clear()
+    }
   }
-}
-
-class StubPoolWithIsMainMethod extends FixedThreadPool {
-  isMain () {
-    return false
+  class StubPoolWithIsMainMethod extends FixedThreadPool {
+    isMain () {
+      return false
+    }
   }
-}
-
-describe('Abstract pool test suite', () => {
-  it('Simulate worker not found during increaseWorkersTask', () => {
-    const pool = new StubPoolWithTasksMapClear(
-      numberOfWorkers,
-      './tests/worker-files/thread/testWorker.js'
-    )
-    // Simulate worker not found.
-    pool.removeAllWorker()
-    expect(() => pool.increaseWorkersTask()).toThrowError(expectedError)
-    pool.destroy()
-  })
-
-  it('Simulate worker not found during decreaseWorkersTasks', () => {
-    const pool = new StubPoolWithTasksMapClear(
-      numberOfWorkers,
-      './tests/worker-files/thread/testWorker.js',
-      {
-        errorHandler: e => console.error(e)
-      }
-    )
-    // Simulate worker not found.
-    pool.removeAllWorker()
-    expect(() => pool.decreaseWorkersTasks()).toThrowError(expectedError)
-    pool.destroy()
-  })
 
   it('Simulate pool creation from a non main thread/process', () => {
     expect(
@@ -99,7 +75,7 @@ describe('Abstract pool test suite', () => {
     )
   })
 
-  it('Verify that pool options are checked', () => {
+  it('Verify that pool options are checked', async () => {
     let pool = new FixedThreadPool(
       numberOfWorkers,
       './tests/worker-files/thread/testWorker.js'
@@ -113,7 +89,7 @@ describe('Abstract pool test suite', () => {
     expect(pool.opts.errorHandler).toBeUndefined()
     expect(pool.opts.onlineHandler).toBeUndefined()
     expect(pool.opts.exitHandler).toBeUndefined()
-    pool.destroy()
+    await pool.destroy()
     const testHandler = () => console.log('test handler executed')
     pool = new FixedThreadPool(
       numberOfWorkers,
@@ -136,10 +112,182 @@ describe('Abstract pool test suite', () => {
     expect(pool.opts.errorHandler).toStrictEqual(testHandler)
     expect(pool.opts.onlineHandler).toStrictEqual(testHandler)
     expect(pool.opts.exitHandler).toStrictEqual(testHandler)
-    pool.destroy()
+    await pool.destroy()
+  })
+
+  it('Simulate worker not found during increaseWorkerRunningTasks', async () => {
+    const pool = new StubPoolWithWorkerTasksUsageMapClear(
+      numberOfWorkers,
+      './tests/worker-files/cluster/testWorker.js'
+    )
+    // Simulate worker not found.
+    pool.removeAllWorker()
+    expect(() => pool.increaseWorkerRunningTasks()).toThrowError(
+      workerNotFoundInTasksUsageMapError
+    )
+    await pool.destroy()
+  })
+
+  it('Simulate worker not found during decreaseWorkerRunningTasks', async () => {
+    const pool = new StubPoolWithWorkerTasksUsageMapClear(
+      numberOfWorkers,
+      './tests/worker-files/cluster/testWorker.js',
+      {
+        errorHandler: e => console.error(e)
+      }
+    )
+    // Simulate worker not found.
+    pool.removeAllWorker()
+    expect(() => pool.decreaseWorkerRunningTasks()).toThrowError(
+      workerNotFoundInTasksUsageMapError
+    )
+    await pool.destroy()
+  })
+
+  it('Simulate worker not found during stepWorkerRunTasks', async () => {
+    const pool = new StubPoolWithWorkerTasksUsageMapClear(
+      numberOfWorkers,
+      './tests/worker-files/cluster/testWorker.js',
+      {
+        errorHandler: e => console.error(e)
+      }
+    )
+    // Simulate worker not found.
+    pool.removeAllWorker()
+    expect(() => pool.stepWorkerRunTasks()).toThrowError(
+      workerNotFoundInTasksUsageMapError
+    )
+    await pool.destroy()
+  })
+
+  it('Simulate worker not found during updateWorkerTasksRunTime with strategy not requiring it', async () => {
+    const pool = new StubPoolWithWorkerTasksUsageMapClear(
+      numberOfWorkers,
+      './tests/worker-files/cluster/testWorker.js',
+      {
+        errorHandler: e => console.error(e)
+      }
+    )
+    // Simulate worker not found.
+    pool.removeAllWorker()
+    expect(() => pool.updateWorkerTasksRunTime()).not.toThrowError()
+    await pool.destroy()
+  })
+
+  it('Simulate worker not found during updateWorkerTasksRunTime with strategy requiring it', async () => {
+    const pool = new StubPoolWithWorkerTasksUsageMapClear(
+      numberOfWorkers,
+      './tests/worker-files/cluster/testWorker.js',
+      {
+        workerChoiceStrategy: WorkerChoiceStrategies.FAIR_SHARE,
+        errorHandler: e => console.error(e)
+      }
+    )
+    // Simulate worker not found.
+    pool.removeAllWorker()
+    expect(() => pool.updateWorkerTasksRunTime()).toThrowError(
+      workerNotFoundInTasksUsageMapError
+    )
+    await pool.destroy()
+  })
+
+  it('Verify that worker pool tasks usage are initialized', async () => {
+    const pool = new FixedClusterPool(
+      numberOfWorkers,
+      './tests/worker-files/cluster/testWorker.js'
+    )
+    for (const tasksUsage of pool.workersTasksUsage.values()) {
+      expect(tasksUsage).toBeDefined()
+      expect(tasksUsage.run).toBe(0)
+      expect(tasksUsage.running).toBe(0)
+      expect(tasksUsage.runTime).toBe(0)
+      expect(tasksUsage.avgRunTime).toBe(0)
+    }
+    await pool.destroy()
+  })
+
+  it('Verify that worker pool tasks usage are computed', async () => {
+    const pool = new FixedClusterPool(
+      numberOfWorkers,
+      './tests/worker-files/cluster/testWorker.js'
+    )
+    const promises = []
+    for (let i = 0; i < numberOfWorkers * 2; i++) {
+      promises.push(pool.execute())
+    }
+    for (const tasksUsage of pool.workersTasksUsage.values()) {
+      expect(tasksUsage).toBeDefined()
+      expect(tasksUsage.run).toBe(0)
+      expect(tasksUsage.running).toBe(numberOfWorkers * 2)
+      expect(tasksUsage.runTime).toBe(0)
+      expect(tasksUsage.avgRunTime).toBe(0)
+    }
+    await Promise.all(promises)
+    for (const tasksUsage of pool.workersTasksUsage.values()) {
+      expect(tasksUsage).toBeDefined()
+      expect(tasksUsage.run).toBe(numberOfWorkers * 2)
+      expect(tasksUsage.running).toBe(0)
+      expect(tasksUsage.runTime).toBeGreaterThanOrEqual(0)
+      expect(tasksUsage.avgRunTime).toBeGreaterThanOrEqual(0)
+    }
+    await pool.destroy()
+  })
+
+  it('Verify that worker pool tasks usage are reset at worker choice strategy change', async () => {
+    let pool = new FixedThreadPool(
+      numberOfWorkers,
+      './tests/worker-files/thread/testWorker.js'
+    )
+    const promises = []
+    for (let i = 0; i < numberOfWorkers * 2; i++) {
+      promises.push(pool.execute())
+    }
+    await Promise.all(promises)
+    for (const tasksUsage of pool.workersTasksUsage.values()) {
+      expect(tasksUsage).toBeDefined()
+      expect(tasksUsage.run).toBe(numberOfWorkers * 2)
+      expect(tasksUsage.running).toBe(0)
+      expect(tasksUsage.runTime).toBeGreaterThanOrEqual(0)
+      expect(tasksUsage.avgRunTime).toBeGreaterThanOrEqual(0)
+    }
+    pool.setWorkerChoiceStrategy(WorkerChoiceStrategies.FAIR_SHARE)
+    for (const tasksUsage of pool.workersTasksUsage.values()) {
+      expect(tasksUsage).toBeDefined()
+      expect(tasksUsage.run).toBe(0)
+      expect(tasksUsage.running).toBe(0)
+      expect(tasksUsage.runTime).toBe(0)
+      expect(tasksUsage.avgRunTime).toBe(0)
+    }
+    await pool.destroy()
+    pool = new DynamicThreadPool(
+      numberOfWorkers,
+      numberOfWorkers,
+      './tests/worker-files/thread/testWorker.js'
+    )
+    promises.length = 0
+    for (let i = 0; i < numberOfWorkers * 2; i++) {
+      promises.push(pool.execute())
+    }
+    await Promise.all(promises)
+    for (const tasksUsage of pool.workersTasksUsage.values()) {
+      expect(tasksUsage).toBeDefined()
+      expect(tasksUsage.run).toBe(numberOfWorkers * 2)
+      expect(tasksUsage.running).toBe(0)
+      expect(tasksUsage.runTime).toBeGreaterThanOrEqual(0)
+      expect(tasksUsage.avgRunTime).toBeGreaterThanOrEqual(0)
+    }
+    pool.setWorkerChoiceStrategy(WorkerChoiceStrategies.FAIR_SHARE)
+    for (const tasksUsage of pool.workersTasksUsage.values()) {
+      expect(tasksUsage).toBeDefined()
+      expect(tasksUsage.run).toBe(0)
+      expect(tasksUsage.running).toBe(0)
+      expect(tasksUsage.runTime).toBe(0)
+      expect(tasksUsage.avgRunTime).toBe(0)
+    }
+    await pool.destroy()
   })
 
-  it("Verify that pool event emitter 'busy' event can register a callback", () => {
+  it("Verify that pool event emitter 'busy' event can register a callback", async () => {
     const pool = new FixedThreadPool(
       numberOfWorkers,
       './tests/worker-files/thread/testWorker.js'
@@ -148,11 +296,12 @@ describe('Abstract pool test suite', () => {
     let poolBusy = 0
     pool.emitter.on('busy', () => poolBusy++)
     for (let i = 0; i < numberOfWorkers * 2; i++) {
-      promises.push(pool.execute({ test: 'test' }))
+      promises.push(pool.execute())
     }
+    await Promise.all(promises)
     // 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)
-    pool.destroy()
+    await pool.destroy()
   })
 })