-const expect = require('expect')
-const { FixedThreadPool } = require('../../../lib/index')
-const expectedError = new Error('Worker could not be found in tasks map')
+const { expect } = require('expect')
+const {
+ DynamicThreadPool,
+ FixedClusterPool,
+ FixedThreadPool,
+ PoolEvents,
+ WorkerChoiceStrategies
+} = require('../../../lib/index')
-class StubPoolWithTasksMapClear extends FixedThreadPool {
- removeAllWorker () {
- this.tasks.clear()
+describe('Abstract pool test suite', () => {
+ const numberOfWorkers = 1
+ const workerNotFoundInPoolError = new Error(
+ 'Worker could not be found in the pool'
+ )
+ class StubPoolWithRemoveAllWorker extends FixedThreadPool {
+ removeAllWorker () {
+ this.workers = []
+ this.promiseResponseMap.clear()
+ }
}
-}
-
-class StubPoolWithIsMainMethod extends FixedThreadPool {
- isMain () {
- return false
+ class StubPoolWithIsMain extends FixedThreadPool {
+ isMain () {
+ return false
+ }
}
-}
-describe('Abstract pool test suite ', () => {
- it('Simulate worker not found during increaseWorkersTask', () => {
- const pool = new StubPoolWithTasksMapClear(
- 1,
- './tests/worker-files/cluster/testWorker.js',
+ it('Simulate pool creation from a non main thread/process', () => {
+ expect(
+ () =>
+ new StubPoolWithIsMain(
+ numberOfWorkers,
+ './tests/worker-files/thread/testWorker.js',
+ {
+ errorHandler: e => console.error(e)
+ }
+ )
+ ).toThrowError(new Error('Cannot start a pool from a worker!'))
+ })
+
+ it('Verify that filePath is checked', () => {
+ const expectedError = new Error(
+ 'Please specify a file with a worker implementation'
+ )
+ expect(() => new FixedThreadPool(numberOfWorkers)).toThrowError(
+ expectedError
+ )
+ expect(() => new FixedThreadPool(numberOfWorkers, '')).toThrowError(
+ expectedError
+ )
+ })
+
+ it('Verify that numberOfWorkers is checked', () => {
+ expect(() => new FixedThreadPool()).toThrowError(
+ new Error(
+ 'Cannot instantiate a pool without specifying the number of workers'
+ )
+ )
+ })
+
+ it('Verify that a negative number of workers is checked', () => {
+ expect(
+ () =>
+ new FixedClusterPool(-1, './tests/worker-files/cluster/testWorker.js')
+ ).toThrowError(
+ new RangeError(
+ 'Cannot instantiate a pool with a negative number of workers'
+ )
+ )
+ })
+
+ it('Verify that a non integer number of workers is checked', () => {
+ expect(
+ () =>
+ new FixedThreadPool(0.25, './tests/worker-files/thread/testWorker.js')
+ ).toThrowError(
+ new TypeError(
+ 'Cannot instantiate a pool with a non integer number of workers'
+ )
+ )
+ })
+
+ it('Verify that pool options are checked', async () => {
+ let pool = new FixedThreadPool(
+ numberOfWorkers,
+ './tests/worker-files/thread/testWorker.js'
+ )
+ expect(pool.opts.enableEvents).toBe(true)
+ expect(pool.emitter).toBeDefined()
+ expect(pool.opts.workerChoiceStrategy).toBe(
+ WorkerChoiceStrategies.ROUND_ROBIN
+ )
+ expect(pool.opts.messageHandler).toBeUndefined()
+ expect(pool.opts.errorHandler).toBeUndefined()
+ expect(pool.opts.onlineHandler).toBeUndefined()
+ expect(pool.opts.exitHandler).toBeUndefined()
+ await pool.destroy()
+ const testHandler = () => console.log('test handler executed')
+ pool = new FixedThreadPool(
+ numberOfWorkers,
+ './tests/worker-files/thread/testWorker.js',
{
- errorHandler: e => console.error(e)
+ workerChoiceStrategy: WorkerChoiceStrategies.LESS_USED,
+ enableEvents: false,
+ messageHandler: testHandler,
+ errorHandler: testHandler,
+ onlineHandler: testHandler,
+ exitHandler: testHandler
}
)
- // simulate worker not found.
- pool.removeAllWorker()
- expect(() => pool.increaseWorkersTask()).toThrowError(expectedError)
+ expect(pool.opts.enableEvents).toBe(false)
+ expect(pool.emitter).toBeUndefined()
+ expect(pool.opts.workerChoiceStrategy).toBe(
+ WorkerChoiceStrategies.LESS_USED
+ )
+ expect(pool.opts.messageHandler).toStrictEqual(testHandler)
+ expect(pool.opts.errorHandler).toStrictEqual(testHandler)
+ expect(pool.opts.onlineHandler).toStrictEqual(testHandler)
+ expect(pool.opts.exitHandler).toStrictEqual(testHandler)
+ await pool.destroy()
})
- it('Simulate worker not found during decreaseWorkersTasks', () => {
- const pool = new StubPoolWithTasksMapClear(
- 1,
+ it('Simulate worker not found during getWorkerTasksUsage', async () => {
+ const pool = new StubPoolWithRemoveAllWorker(
+ numberOfWorkers,
'./tests/worker-files/cluster/testWorker.js',
{
errorHandler: e => console.error(e)
}
)
- // simulate worker not found.
+ // Simulate worker not found.
pool.removeAllWorker()
- expect(() => pool.decreaseWorkersTasks()).toThrowError(expectedError)
+ expect(() => pool.getWorkerTasksUsage()).toThrowError(
+ workerNotFoundInPoolError
+ )
+ await pool.destroy()
})
- it('Simulate pool creation from a non main thread/process', () => {
- expect(() => {
- const pool = new StubPoolWithIsMainMethod(
- 1,
- './tests/worker-files/cluster/testWorker.js',
- {
- errorHandler: e => console.error(e)
- }
- )
- }).toThrowError()
+ it('Verify that worker pool tasks usage are initialized', async () => {
+ const pool = new FixedClusterPool(
+ 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)
+ expect(workerItem.tasksUsage.error).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 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)
+ expect(workerItem.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)
+ expect(workerItem.tasksUsage.error).toBe(0)
+ }
+ await pool.destroy()
+ })
+
+ it('Verify that worker pool tasks usage are reset at worker choice strategy change', async () => {
+ const pool = new DynamicThreadPool(
+ numberOfWorkers,
+ 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 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)
+ expect(workerItem.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)
+ expect(workerItem.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,
+ './tests/worker-files/thread/testWorker.js'
+ )
+ const promises = []
+ let poolBusy = 0
+ pool.emitter.on(PoolEvents.busy, () => ++poolBusy)
+ for (let i = 0; i < numberOfWorkers * 2; i++) {
+ 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)
+ await pool.destroy()
})
})
repositories / poolifier.git / blobdiff