const { expect } = require('expect')
const {
+ DynamicClusterPool,
DynamicThreadPool,
FixedClusterPool,
FixedThreadPool,
PoolEvents,
- WorkerChoiceStrategies
-} = require('../../../lib/index')
+ WorkerChoiceStrategies,
+ PoolTypes,
+ WorkerTypes
+} = require('../../../lib')
+const { CircularArray } = require('../../../lib/circular-array')
+const { Queue } = require('../../../lib/queue')
describe('Abstract pool test suite', () => {
- const numberOfWorkers = 1
- const workerNotFoundInPoolError = new Error(
- 'Worker could not be found in the pool'
- )
+ const numberOfWorkers = 2
class StubPoolWithRemoveAllWorker extends FixedThreadPool {
removeAllWorker () {
- this.workers = []
+ this.workerNodes = []
this.promiseResponseMap.clear()
}
}
errorHandler: e => console.error(e)
}
)
- ).toThrowError(new Error('Cannot start a pool from a worker!'))
+ ).toThrowError('Cannot start a pool from a worker!')
})
it('Verify that filePath is checked', () => {
it('Verify that numberOfWorkers is checked', () => {
expect(() => new FixedThreadPool()).toThrowError(
- new Error(
- 'Cannot instantiate a pool without specifying the number of workers'
- )
+ 'Cannot instantiate a pool without specifying the number of workers'
)
})
new FixedThreadPool(0.25, './tests/worker-files/thread/testWorker.js')
).toThrowError(
new TypeError(
- 'Cannot instantiate a pool with a non integer number of workers'
+ 'Cannot instantiate a pool with a non safe integer number of workers'
)
)
})
numberOfWorkers,
'./tests/worker-files/thread/testWorker.js'
)
- expect(pool.opts.enableEvents).toBe(true)
expect(pool.emitter).toBeDefined()
+ expect(pool.opts.enableEvents).toBe(true)
+ expect(pool.opts.restartWorkerOnError).toBe(true)
+ expect(pool.opts.enableTasksQueue).toBe(false)
+ expect(pool.opts.tasksQueueOptions).toBeUndefined()
expect(pool.opts.workerChoiceStrategy).toBe(
WorkerChoiceStrategies.ROUND_ROBIN
)
+ expect(pool.opts.workerChoiceStrategyOptions).toStrictEqual({
+ medRunTime: false,
+ medWaitTime: false
+ })
expect(pool.opts.messageHandler).toBeUndefined()
expect(pool.opts.errorHandler).toBeUndefined()
expect(pool.opts.onlineHandler).toBeUndefined()
numberOfWorkers,
'./tests/worker-files/thread/testWorker.js',
{
- workerChoiceStrategy: WorkerChoiceStrategies.LESS_USED,
+ workerChoiceStrategy: WorkerChoiceStrategies.LEAST_USED,
+ workerChoiceStrategyOptions: {
+ medRunTime: true,
+ weights: { 0: 300, 1: 200 }
+ },
enableEvents: false,
+ restartWorkerOnError: false,
+ enableTasksQueue: true,
+ tasksQueueOptions: { concurrency: 2 },
messageHandler: testHandler,
errorHandler: testHandler,
onlineHandler: testHandler,
exitHandler: testHandler
}
)
- expect(pool.opts.enableEvents).toBe(false)
expect(pool.emitter).toBeUndefined()
+ expect(pool.opts.enableEvents).toBe(false)
+ expect(pool.opts.restartWorkerOnError).toBe(false)
+ expect(pool.opts.enableTasksQueue).toBe(true)
+ expect(pool.opts.tasksQueueOptions).toStrictEqual({ concurrency: 2 })
expect(pool.opts.workerChoiceStrategy).toBe(
- WorkerChoiceStrategies.LESS_USED
+ WorkerChoiceStrategies.LEAST_USED
)
+ expect(pool.opts.workerChoiceStrategyOptions).toStrictEqual({
+ medRunTime: true,
+ weights: { 0: 300, 1: 200 }
+ })
expect(pool.opts.messageHandler).toStrictEqual(testHandler)
expect(pool.opts.errorHandler).toStrictEqual(testHandler)
expect(pool.opts.onlineHandler).toStrictEqual(testHandler)
await pool.destroy()
})
- it('Simulate worker not found during getWorkerTasksUsage', async () => {
+ it('Verify that pool options are validated', async () => {
+ expect(
+ () =>
+ new FixedThreadPool(
+ numberOfWorkers,
+ './tests/worker-files/thread/testWorker.js',
+ {
+ enableTasksQueue: true,
+ tasksQueueOptions: { concurrency: 0 }
+ }
+ )
+ ).toThrowError("Invalid worker tasks concurrency '0'")
+ expect(
+ () =>
+ new FixedThreadPool(
+ numberOfWorkers,
+ './tests/worker-files/thread/testWorker.js',
+ {
+ workerChoiceStrategy: 'invalidStrategy'
+ }
+ )
+ ).toThrowError("Invalid worker choice strategy 'invalidStrategy'")
+ expect(
+ () =>
+ new FixedThreadPool(
+ numberOfWorkers,
+ './tests/worker-files/thread/testWorker.js',
+ {
+ workerChoiceStrategyOptions: { weights: {} }
+ }
+ )
+ ).toThrowError(
+ 'Invalid worker choice strategy options: must have a weight for each worker node'
+ )
+ })
+
+ it('Verify that worker choice strategy options can be set', async () => {
+ const pool = new FixedThreadPool(
+ numberOfWorkers,
+ './tests/worker-files/thread/testWorker.js',
+ { workerChoiceStrategy: WorkerChoiceStrategies.FAIR_SHARE }
+ )
+ expect(pool.opts.workerChoiceStrategyOptions).toStrictEqual({
+ medRunTime: false,
+ medWaitTime: false
+ })
+ for (const [, workerChoiceStrategy] of pool.workerChoiceStrategyContext
+ .workerChoiceStrategies) {
+ expect(workerChoiceStrategy.opts).toStrictEqual({
+ medRunTime: false,
+ medWaitTime: false
+ })
+ }
+ expect(pool.workerChoiceStrategyContext.getTaskStatistics()).toStrictEqual({
+ runTime: true,
+ avgRunTime: true,
+ medRunTime: false,
+ waitTime: false,
+ avgWaitTime: false,
+ medWaitTime: false,
+ elu: false
+ })
+ pool.setWorkerChoiceStrategyOptions({ medRunTime: true })
+ expect(pool.opts.workerChoiceStrategyOptions).toStrictEqual({
+ medRunTime: true
+ })
+ for (const [, workerChoiceStrategy] of pool.workerChoiceStrategyContext
+ .workerChoiceStrategies) {
+ expect(workerChoiceStrategy.opts).toStrictEqual({ medRunTime: true })
+ }
+ expect(pool.workerChoiceStrategyContext.getTaskStatistics()).toStrictEqual({
+ runTime: true,
+ avgRunTime: false,
+ medRunTime: true,
+ waitTime: false,
+ avgWaitTime: false,
+ medWaitTime: false,
+ elu: false
+ })
+ pool.setWorkerChoiceStrategyOptions({ medRunTime: false })
+ expect(pool.opts.workerChoiceStrategyOptions).toStrictEqual({
+ medRunTime: false
+ })
+ for (const [, workerChoiceStrategy] of pool.workerChoiceStrategyContext
+ .workerChoiceStrategies) {
+ expect(workerChoiceStrategy.opts).toStrictEqual({ medRunTime: false })
+ }
+ expect(pool.workerChoiceStrategyContext.getTaskStatistics()).toStrictEqual({
+ runTime: true,
+ avgRunTime: true,
+ medRunTime: false,
+ waitTime: false,
+ avgWaitTime: false,
+ medWaitTime: false,
+ elu: false
+ })
+ await pool.destroy()
+ })
+
+ it('Verify that tasks queue can be enabled/disabled', async () => {
+ const pool = new FixedThreadPool(
+ numberOfWorkers,
+ './tests/worker-files/thread/testWorker.js'
+ )
+ expect(pool.opts.enableTasksQueue).toBe(false)
+ expect(pool.opts.tasksQueueOptions).toBeUndefined()
+ pool.enableTasksQueue(true)
+ expect(pool.opts.enableTasksQueue).toBe(true)
+ expect(pool.opts.tasksQueueOptions).toStrictEqual({ concurrency: 1 })
+ pool.enableTasksQueue(true, { concurrency: 2 })
+ expect(pool.opts.enableTasksQueue).toBe(true)
+ expect(pool.opts.tasksQueueOptions).toStrictEqual({ concurrency: 2 })
+ pool.enableTasksQueue(false)
+ expect(pool.opts.enableTasksQueue).toBe(false)
+ expect(pool.opts.tasksQueueOptions).toBeUndefined()
+ await pool.destroy()
+ })
+
+ it('Verify that tasks queue options can be set', async () => {
+ const pool = new FixedThreadPool(
+ numberOfWorkers,
+ './tests/worker-files/thread/testWorker.js',
+ { enableTasksQueue: true }
+ )
+ expect(pool.opts.tasksQueueOptions).toStrictEqual({ concurrency: 1 })
+ pool.setTasksQueueOptions({ concurrency: 2 })
+ expect(pool.opts.tasksQueueOptions).toStrictEqual({ concurrency: 2 })
+ expect(() => pool.setTasksQueueOptions({ concurrency: 0 })).toThrowError(
+ "Invalid worker tasks concurrency '0'"
+ )
+ await pool.destroy()
+ })
+
+ it('Verify that pool info is set', async () => {
+ let pool = new FixedThreadPool(
+ numberOfWorkers,
+ './tests/worker-files/thread/testWorker.js'
+ )
+ expect(pool.info).toStrictEqual({
+ type: PoolTypes.fixed,
+ worker: WorkerTypes.thread,
+ minSize: numberOfWorkers,
+ maxSize: numberOfWorkers,
+ workerNodes: numberOfWorkers,
+ idleWorkerNodes: numberOfWorkers,
+ busyWorkerNodes: 0,
+ runningTasks: 0,
+ queuedTasks: 0,
+ maxQueuedTasks: 0
+ })
+ await pool.destroy()
+ pool = new DynamicClusterPool(
+ numberOfWorkers,
+ numberOfWorkers * 2,
+ './tests/worker-files/thread/testWorker.js'
+ )
+ expect(pool.info).toStrictEqual({
+ type: PoolTypes.dynamic,
+ worker: WorkerTypes.cluster,
+ minSize: numberOfWorkers,
+ maxSize: numberOfWorkers * 2,
+ workerNodes: numberOfWorkers,
+ idleWorkerNodes: numberOfWorkers,
+ busyWorkerNodes: 0,
+ runningTasks: 0,
+ queuedTasks: 0,
+ maxQueuedTasks: 0
+ })
+ await pool.destroy()
+ })
+
+ it('Simulate worker not found', async () => {
const pool = new StubPoolWithRemoveAllWorker(
numberOfWorkers,
'./tests/worker-files/cluster/testWorker.js',
errorHandler: e => console.error(e)
}
)
+ expect(pool.workerNodes.length).toBe(numberOfWorkers)
// Simulate worker not found.
pool.removeAllWorker()
- expect(() => pool.getWorkerTasksUsage()).toThrowError(
- workerNotFoundInPoolError
- )
+ expect(pool.workerNodes.length).toBe(0)
await pool.destroy()
})
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)
+ for (const workerNode of pool.workerNodes) {
+ expect(workerNode.tasksUsage).toStrictEqual({
+ ran: 0,
+ running: 0,
+ runTime: 0,
+ runTimeHistory: expect.any(CircularArray),
+ avgRunTime: 0,
+ medRunTime: 0,
+ waitTime: 0,
+ waitTimeHistory: expect.any(CircularArray),
+ avgWaitTime: 0,
+ medWaitTime: 0,
+ error: 0,
+ elu: undefined
+ })
+ }
+ 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(Queue)
+ expect(workerNode.tasksQueue.size).toBe(0)
}
await pool.destroy()
})
numberOfWorkers,
'./tests/worker-files/cluster/testWorker.js'
)
- const promises = []
- for (let i = 0; i < numberOfWorkers * 2; i++) {
- promises.push(pool.execute())
+ const promises = new Set()
+ const maxMultiplier = 2
+ for (let i = 0; i < numberOfWorkers * maxMultiplier; i++) {
+ promises.add(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)
+ for (const workerNode of pool.workerNodes) {
+ expect(workerNode.tasksUsage).toStrictEqual({
+ ran: 0,
+ running: maxMultiplier,
+ runTime: 0,
+ runTimeHistory: expect.any(CircularArray),
+ avgRunTime: 0,
+ medRunTime: 0,
+ waitTime: 0,
+ waitTimeHistory: expect.any(CircularArray),
+ avgWaitTime: 0,
+ medWaitTime: 0,
+ error: 0,
+ elu: undefined
+ })
}
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)
+ for (const workerNode of pool.workerNodes) {
+ expect(workerNode.tasksUsage).toStrictEqual({
+ ran: maxMultiplier,
+ running: 0,
+ runTime: 0,
+ runTimeHistory: expect.any(CircularArray),
+ avgRunTime: 0,
+ medRunTime: 0,
+ waitTime: 0,
+ waitTimeHistory: expect.any(CircularArray),
+ avgWaitTime: 0,
+ medWaitTime: 0,
+ error: 0,
+ elu: undefined
+ })
}
await pool.destroy()
})
numberOfWorkers,
'./tests/worker-files/thread/testWorker.js'
)
- const promises = []
- for (let i = 0; i < numberOfWorkers * 2; i++) {
- promises.push(pool.execute())
+ const promises = new Set()
+ const maxMultiplier = 2
+ for (let i = 0; i < numberOfWorkers * maxMultiplier; i++) {
+ promises.add(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)
+ for (const workerNode of pool.workerNodes) {
+ expect(workerNode.tasksUsage).toStrictEqual({
+ ran: expect.any(Number),
+ running: 0,
+ runTime: 0,
+ runTimeHistory: expect.any(CircularArray),
+ avgRunTime: 0,
+ medRunTime: 0,
+ waitTime: 0,
+ waitTimeHistory: expect.any(CircularArray),
+ avgWaitTime: 0,
+ medWaitTime: 0,
+ error: 0,
+ elu: undefined
+ })
+ expect(workerNode.tasksUsage.ran).toBeGreaterThan(0)
+ expect(workerNode.tasksUsage.ran).toBeLessThanOrEqual(maxMultiplier)
}
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)
+ for (const workerNode of pool.workerNodes) {
+ expect(workerNode.tasksUsage).toStrictEqual({
+ ran: 0,
+ running: 0,
+ runTime: 0,
+ runTimeHistory: expect.any(CircularArray),
+ avgRunTime: 0,
+ medRunTime: 0,
+ waitTime: 0,
+ waitTimeHistory: expect.any(CircularArray),
+ avgWaitTime: 0,
+ medWaitTime: 0,
+ error: 0,
+ elu: undefined
+ })
+ expect(workerNode.tasksUsage.runTimeHistory.length).toBe(0)
+ expect(workerNode.tasksUsage.waitTimeHistory.length).toBe(0)
}
await pool.destroy()
})
numberOfWorkers,
'./tests/worker-files/thread/testWorker.js'
)
- const promises = []
+ const promises = new Set()
let poolFull = 0
- pool.emitter.on(PoolEvents.full, () => ++poolFull)
+ let poolInfo
+ pool.emitter.on(PoolEvents.full, info => {
+ ++poolFull
+ poolInfo = info
+ })
for (let i = 0; i < numberOfWorkers * 2; i++) {
- promises.push(pool.execute())
+ promises.add(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)
+ // 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)
+ expect(poolInfo).toStrictEqual({
+ type: PoolTypes.dynamic,
+ worker: WorkerTypes.thread,
+ minSize: expect.any(Number),
+ maxSize: expect.any(Number),
+ workerNodes: expect.any(Number),
+ idleWorkerNodes: expect.any(Number),
+ busyWorkerNodes: expect.any(Number),
+ runningTasks: expect.any(Number),
+ queuedTasks: expect.any(Number),
+ maxQueuedTasks: expect.any(Number)
+ })
await pool.destroy()
})
numberOfWorkers,
'./tests/worker-files/thread/testWorker.js'
)
- const promises = []
+ const promises = new Set()
let poolBusy = 0
- pool.emitter.on(PoolEvents.busy, () => ++poolBusy)
+ let poolInfo
+ pool.emitter.on(PoolEvents.busy, info => {
+ ++poolBusy
+ poolInfo = info
+ })
for (let i = 0; i < numberOfWorkers * 2; i++) {
- promises.push(pool.execute())
+ promises.add(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)
+ expect(poolInfo).toStrictEqual({
+ type: PoolTypes.fixed,
+ worker: WorkerTypes.thread,
+ minSize: expect.any(Number),
+ maxSize: expect.any(Number),
+ workerNodes: expect.any(Number),
+ idleWorkerNodes: expect.any(Number),
+ busyWorkerNodes: expect.any(Number),
+ runningTasks: expect.any(Number),
+ queuedTasks: expect.any(Number),
+ maxQueuedTasks: expect.any(Number)
+ })
await pool.destroy()
})
+
+ it('Verify that multiple tasks worker is working', async () => {
+ const pool = new DynamicClusterPool(
+ numberOfWorkers,
+ numberOfWorkers * 2,
+ './tests/worker-files/cluster/testMultiTasksWorker.js'
+ )
+ const data = { n: 10 }
+ const result0 = await pool.execute(data)
+ expect(result0).toBe(false)
+ const result1 = await pool.execute(data, 'jsonIntegerSerialization')
+ expect(result1).toBe(false)
+ const result2 = await pool.execute(data, 'factorial')
+ expect(result2).toBe(3628800)
+ const result3 = await pool.execute(data, 'fibonacci')
+ expect(result3).toBe(89)
+ })
})