X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=tests%2Fpools%2Fcluster%2Ffixed.test.js;h=8234fab9a5f4f4e62b72f8ecdabd51b94f046c4d;hb=c726f66c5c7ce127bfd2010a60fa07761f21cbd1;hp=b9c7d676d0404c7787e2fd8a00560e4167b88290;hpb=15e5141f463661f3dd0f17e8a9402703fddd4050;p=poolifier.git diff --git a/tests/pools/cluster/fixed.test.js b/tests/pools/cluster/fixed.test.js index b9c7d676..0994e9e9 100644 --- a/tests/pools/cluster/fixed.test.js +++ b/tests/pools/cluster/fixed.test.js @@ -1,10 +1,12 @@ const { expect } = require('expect') -const { FixedClusterPool, PoolEvents } = require('../../../lib/index') -const { WorkerFunctions } = require('../../test-types') -const TestUtils = require('../../test-utils') +const { FixedClusterPool, PoolEvents } = require('../../../lib') +const { TaskFunctions } = require('../../test-types') +const { waitPoolEvents, waitWorkerEvents } = require('../../test-utils') +const { DEFAULT_TASK_NAME } = require('../../../lib/utils') describe('Fixed cluster pool test suite', () => { - const numberOfWorkers = 6 + const numberOfWorkers = 8 + const tasksConcurrency = 2 const pool = new FixedClusterPool( numberOfWorkers, './tests/worker-files/cluster/testWorker.js', @@ -12,10 +14,21 @@ describe('Fixed cluster pool test suite', () => { errorHandler: e => console.error(e) } ) + const queuePool = new FixedClusterPool( + numberOfWorkers, + './tests/worker-files/cluster/testWorker.js', + { + enableTasksQueue: true, + tasksQueueOptions: { + concurrency: tasksConcurrency + }, + errorHandler: e => console.error(e) + } + ) const emptyPool = new FixedClusterPool( numberOfWorkers, './tests/worker-files/cluster/emptyWorker.js', - { exitHandler: () => console.log('empty pool worker exited') } + { exitHandler: () => console.info('empty pool worker exited') } ) const echoPool = new FixedClusterPool( numberOfWorkers, @@ -47,35 +60,116 @@ describe('Fixed cluster pool test suite', () => { await errorPool.destroy() await asyncErrorPool.destroy() await emptyPool.destroy() + await queuePool.destroy() }) it('Verify that the function is executed in a worker cluster', async () => { let result = await pool.execute({ - function: WorkerFunctions.fibonacci + function: TaskFunctions.fibonacci }) - expect(result).toBe(false) + expect(result).toBe(75025) result = await pool.execute({ - function: WorkerFunctions.factorial + function: TaskFunctions.factorial }) - expect(result).toBe(false) + expect(result).toBe(9.33262154439441e157) }) - it('Verify that is possible to invoke the execute method without input', async () => { + it('Verify that is possible to invoke the execute() method without input', async () => { const result = await pool.execute() - expect(result).toBe(false) + expect(result).toStrictEqual({ ok: 1 }) + }) + + it("Verify that 'ready' event is emitted", async () => { + const pool = new FixedClusterPool( + numberOfWorkers, + './tests/worker-files/cluster/testWorker.js', + { + errorHandler: e => console.error(e) + } + ) + expect(pool.emitter.eventNames()).toStrictEqual([]) + let poolReady = 0 + pool.emitter.on(PoolEvents.ready, () => ++poolReady) + await waitPoolEvents(pool, PoolEvents.ready, 1) + expect(pool.emitter.eventNames()).toStrictEqual([PoolEvents.ready]) + expect(poolReady).toBe(1) + await pool.destroy() }) it("Verify that 'busy' event is emitted", async () => { + expect(pool.emitter.eventNames()).toStrictEqual([]) + const promises = new Set() let poolBusy = 0 pool.emitter.on(PoolEvents.busy, () => ++poolBusy) + expect(pool.emitter.eventNames()).toStrictEqual([PoolEvents.busy]) for (let i = 0; i < numberOfWorkers * 2; i++) { - 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) }) + it('Verify that tasks queuing is working', async () => { + const promises = new Set() + const maxMultiplier = 3 // Must be greater than tasksConcurrency + for (let i = 0; i < numberOfWorkers * maxMultiplier; i++) { + promises.add(queuePool.execute()) + } + expect(promises.size).toBe(numberOfWorkers * maxMultiplier) + for (const workerNode of queuePool.workerNodes) { + expect(workerNode.usage.tasks.executing).toBeGreaterThanOrEqual(0) + expect(workerNode.usage.tasks.executing).toBeLessThanOrEqual( + queuePool.opts.tasksQueueOptions.concurrency + ) + expect(workerNode.usage.tasks.executed).toBe(0) + expect(workerNode.usage.tasks.queued).toBe( + maxMultiplier - queuePool.opts.tasksQueueOptions.concurrency + ) + expect(workerNode.usage.tasks.maxQueued).toBe( + maxMultiplier - queuePool.opts.tasksQueueOptions.concurrency + ) + expect(workerNode.usage.tasks.stolen).toBe(0) + } + expect(queuePool.info.executedTasks).toBe(0) + expect(queuePool.info.executingTasks).toBe( + numberOfWorkers * queuePool.opts.tasksQueueOptions.concurrency + ) + expect(queuePool.info.queuedTasks).toBe( + numberOfWorkers * + (maxMultiplier - queuePool.opts.tasksQueueOptions.concurrency) + ) + expect(queuePool.info.maxQueuedTasks).toBe( + numberOfWorkers * + (maxMultiplier - queuePool.opts.tasksQueueOptions.concurrency) + ) + expect(queuePool.info.backPressure).toBe(false) + expect(queuePool.info.stolenTasks).toBe(0) + await Promise.all(promises) + for (const workerNode of queuePool.workerNodes) { + expect(workerNode.usage.tasks.executing).toBeGreaterThanOrEqual(0) + expect(workerNode.usage.tasks.executing).toBeLessThanOrEqual( + numberOfWorkers * maxMultiplier + ) + expect(workerNode.usage.tasks.executed).toBe(maxMultiplier) + expect(workerNode.usage.tasks.queued).toBe(0) + expect(workerNode.usage.tasks.maxQueued).toBe( + maxMultiplier - queuePool.opts.tasksQueueOptions.concurrency + ) + expect(workerNode.usage.tasks.stolen).toBeGreaterThanOrEqual(0) + expect(workerNode.usage.tasks.stolen).toBeLessThanOrEqual( + numberOfWorkers * maxMultiplier + ) + } + expect(queuePool.info.executedTasks).toBe(numberOfWorkers * maxMultiplier) + expect(queuePool.info.backPressure).toBe(false) + expect(queuePool.info.stolenTasks).toBeGreaterThanOrEqual(0) + expect(queuePool.info.stolenTasks).toBeLessThanOrEqual( + numberOfWorkers * maxMultiplier + ) + }) + it('Verify that is possible to have a worker that return undefined', async () => { const result = await emptyPool.execute() expect(result).toBeUndefined() @@ -89,6 +183,12 @@ describe('Fixed cluster pool test suite', () => { it('Verify that error handling is working properly:sync', async () => { const data = { f: 10 } + expect(errorPool.emitter.eventNames()).toStrictEqual([]) + let taskError + errorPool.emitter.on(PoolEvents.taskError, e => { + taskError = e + }) + expect(errorPool.emitter.eventNames()).toStrictEqual([PoolEvents.taskError]) let inError try { await errorPool.execute(data) @@ -98,10 +198,28 @@ describe('Fixed cluster pool test suite', () => { expect(inError).toBeDefined() expect(typeof inError === 'string').toBe(true) expect(inError).toBe('Error Message from ClusterWorker') + expect(taskError).toStrictEqual({ + name: DEFAULT_TASK_NAME, + message: 'Error Message from ClusterWorker', + data + }) + expect( + errorPool.workerNodes.some( + workerNode => workerNode.usage.tasks.failed === 1 + ) + ).toBe(true) }) it('Verify that error handling is working properly:async', async () => { const data = { f: 10 } + expect(asyncErrorPool.emitter.eventNames()).toStrictEqual([]) + let taskError + asyncErrorPool.emitter.on(PoolEvents.taskError, e => { + taskError = e + }) + expect(asyncErrorPool.emitter.eventNames()).toStrictEqual([ + PoolEvents.taskError + ]) let inError try { await asyncErrorPool.execute(data) @@ -111,6 +229,16 @@ describe('Fixed cluster pool test suite', () => { expect(inError).toBeDefined() expect(typeof inError === 'string').toBe(true) expect(inError).toBe('Error Message from ClusterWorker:async') + expect(taskError).toStrictEqual({ + name: DEFAULT_TASK_NAME, + message: 'Error Message from ClusterWorker:async', + data + }) + expect( + asyncErrorPool.workerNodes.some( + workerNode => workerNode.usage.tasks.failed === 1 + ) + ).toBe(true) }) it('Verify that async function is working properly', async () => { @@ -123,50 +251,77 @@ describe('Fixed cluster pool test suite', () => { }) it('Shutdown test', async () => { - const exitPromise = TestUtils.waitExits(pool, numberOfWorkers) + const exitPromise = waitWorkerEvents(pool, 'exit', numberOfWorkers) + expect(pool.emitter.eventNames()).toStrictEqual([PoolEvents.busy]) + let poolDestroy = 0 + pool.emitter.on(PoolEvents.destroy, () => ++poolDestroy) + expect(pool.emitter.eventNames()).toStrictEqual([ + PoolEvents.busy, + PoolEvents.destroy + ]) await pool.destroy() const numberOfExitEvents = await exitPromise + expect(pool.started).toBe(false) + expect(pool.workerNodes.length).toBe(0) expect(numberOfExitEvents).toBe(numberOfWorkers) + expect(poolDestroy).toBe(1) }) it('Verify that cluster pool options are checked', async () => { const workerFilePath = './tests/worker-files/cluster/testWorker.js' - let pool1 = new FixedClusterPool(numberOfWorkers, workerFilePath) - expect(pool1.opts.env).toBeUndefined() - expect(pool1.opts.settings).toBeUndefined() - await pool1.destroy() - pool1 = new FixedClusterPool(numberOfWorkers, workerFilePath, { + let pool = new FixedClusterPool(numberOfWorkers, workerFilePath) + expect(pool.opts.env).toBeUndefined() + expect(pool.opts.settings).toBeUndefined() + await pool.destroy() + pool = new FixedClusterPool(numberOfWorkers, workerFilePath, { env: { TEST: 'test' }, settings: { args: ['--use', 'http'], silent: true } }) - expect(pool1.opts.env).toStrictEqual({ TEST: 'test' }) - expect(pool1.opts.settings).toStrictEqual({ + expect(pool.opts.env).toStrictEqual({ TEST: 'test' }) + expect(pool.opts.settings).toStrictEqual({ args: ['--use', 'http'], silent: true }) - expect({ ...pool1.opts.settings, exec: workerFilePath }).toStrictEqual({ + expect({ ...pool.opts.settings, exec: workerFilePath }).toStrictEqual({ args: ['--use', 'http'], silent: true, exec: workerFilePath }) - await pool1.destroy() + await pool.destroy() }) it('Should work even without opts in input', async () => { - const pool1 = new FixedClusterPool( - numberOfWorkers, - './tests/worker-files/cluster/testWorker.js' - ) - const res = await pool1.execute() - expect(res).toBe(false) + const workerFilePath = './tests/worker-files/cluster/testWorker.js' + const pool = new FixedClusterPool(numberOfWorkers, workerFilePath) + const res = await pool.execute() + expect(res).toStrictEqual({ ok: 1 }) // We need to clean up the resources after our test - await pool1.destroy() + await pool.destroy() + }) + + it('Verify destroyWorkerNode()', async () => { + const workerFilePath = './tests/worker-files/cluster/testWorker.js' + const pool = new FixedClusterPool(numberOfWorkers, workerFilePath) + const workerNodeKey = 0 + let disconnectEvent = 0 + pool.workerNodes[workerNodeKey].worker.on('disconnect', () => { + ++disconnectEvent + }) + let exitEvent = 0 + pool.workerNodes[workerNodeKey].worker.on('exit', () => { + ++exitEvent + }) + await expect(pool.destroyWorkerNode(workerNodeKey)).resolves.toBeUndefined() + expect(disconnectEvent).toBe(1) + expect(exitEvent).toBe(1) + expect(pool.workerNodes.length).toBe(numberOfWorkers - 1) + await pool.destroy() }) it('Verify that a pool with zero worker fails', async () => { expect( () => new FixedClusterPool(0, './tests/worker-files/cluster/testWorker.js') - ).toThrowError(new Error('Cannot instantiate a fixed pool with no worker')) + ).toThrowError('Cannot instantiate a fixed pool with zero worker') }) })