X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=tests%2Fworker%2Fabstract-worker.test.js;h=62f6dd2bea37b3e8f4789ea2ed7c027cc0fe7a43;hb=4e6ddcbc38e0374e33505f5e363d2e7ec8a21c79;hp=429fff7da79d2c3d4797e645fd3d90c9d73933c9;hpb=2a69b8c50a10229de607013f867d685ee594dba9;p=poolifier.git diff --git a/tests/worker/abstract-worker.test.js b/tests/worker/abstract-worker.test.js index 429fff7d..62f6dd2b 100644 --- a/tests/worker/abstract-worker.test.js +++ b/tests/worker/abstract-worker.test.js @@ -1,5 +1,7 @@ const { expect } = require('expect') +const sinon = require('sinon') const { ClusterWorker, KillBehaviors, ThreadWorker } = require('../../lib') +const { DEFAULT_TASK_NAME, EMPTY_FUNCTION } = require('../../lib/utils') describe('Abstract worker test suite', () => { class StubWorkerWithMainWorker extends ThreadWorker { @@ -9,22 +11,34 @@ describe('Abstract worker test suite', () => { } } + afterEach(() => { + sinon.restore() + }) + it('Verify worker options default values', () => { const worker = new ThreadWorker(() => {}) - expect(worker.opts.maxInactiveTime).toStrictEqual(60000) - expect(worker.opts.killBehavior).toBe(KillBehaviors.SOFT) - expect(worker.opts.async).toBe(undefined) + expect(worker.opts).toStrictEqual({ + killBehavior: KillBehaviors.SOFT, + maxInactiveTime: 60000, + killHandler: EMPTY_FUNCTION + }) }) it('Verify that worker options are set at worker creation', () => { + const killHandler = () => { + console.info('Worker received kill message') + } const worker = new ClusterWorker(() => {}, { + killBehavior: KillBehaviors.HARD, + maxInactiveTime: 6000, + killHandler, + async: true + }) + expect(worker.opts).toStrictEqual({ + killBehavior: KillBehaviors.HARD, maxInactiveTime: 6000, - async: true, - killBehavior: KillBehaviors.HARD + killHandler }) - expect(worker.opts.maxInactiveTime).toStrictEqual(6000) - expect(worker.opts.killBehavior).toBe(KillBehaviors.HARD) - expect(worker.opts.async).toBe(undefined) }) it('Verify that taskFunctions parameter is mandatory', () => { @@ -84,19 +98,22 @@ describe('Abstract worker test suite', () => { it('Verify that taskFunctions parameter with unique function is taken', () => { const worker = new ThreadWorker(() => {}) - expect(worker.taskFunctions.get('default')).toBeInstanceOf(Function) + expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function) expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function) expect(worker.taskFunctions.size).toBe(2) - expect(worker.taskFunctions.get('default')).toStrictEqual( + expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual( worker.taskFunctions.get('fn1') ) }) - it('Verify that taskFunctions parameter with multiple task functions contains function', () => { + it('Verify that taskFunctions parameter with multiple task functions is checked', () => { const fn1 = () => { return 1 } const fn2 = '' + expect(() => new ThreadWorker({ '': fn1 })).toThrowError( + new TypeError('A taskFunctions parameter object key is an empty string') + ) expect(() => new ThreadWorker({ fn1, fn2 })).toThrowError( new TypeError('A taskFunctions parameter object value is not a function') ) @@ -110,15 +127,39 @@ describe('Abstract worker test suite', () => { return 2 } const worker = new ClusterWorker({ fn1, fn2 }) - expect(worker.taskFunctions.get('default')).toBeInstanceOf(Function) + expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function) expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function) expect(worker.taskFunctions.get('fn2')).toBeInstanceOf(Function) expect(worker.taskFunctions.size).toBe(3) - expect(worker.taskFunctions.get('default')).toStrictEqual( + expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual( worker.taskFunctions.get('fn1') ) }) + it('Verify that sync kill handler is called when worker is killed', () => { + const worker = new ClusterWorker(() => {}, { + killHandler: sinon.stub().returns() + }) + worker.isMain = false + worker.getMainWorker = sinon.stub().returns({ + id: 1, + send: sinon.stub().returns() + }) + worker.handleKillMessage() + expect(worker.getMainWorker().send.calledOnce).toBe(true) + expect(worker.opts.killHandler.calledOnce).toBe(true) + }) + + it('Verify that async kill handler is called when worker is killed', () => { + const killHandlerStub = sinon.stub().returns() + const worker = new ClusterWorker(() => {}, { + killHandler: async () => Promise.resolve(killHandlerStub()) + }) + worker.isMain = false + worker.handleKillMessage() + expect(killHandlerStub.calledOnce).toBe(true) + }) + it('Verify that handleError() method works properly', () => { const error = new Error('Error as an error') const worker = new ClusterWorker(() => {}) @@ -142,7 +183,13 @@ describe('Abstract worker test suite', () => { return 2 } const worker = new ClusterWorker({ fn1, fn2 }) - expect(worker.hasTaskFunction('default')).toBe(true) + expect(() => worker.hasTaskFunction(0)).toThrowError( + new TypeError('name parameter is not a string') + ) + expect(() => worker.hasTaskFunction('')).toThrowError( + new TypeError('name parameter is an empty string') + ) + expect(worker.hasTaskFunction(DEFAULT_TASK_NAME)).toBe(true) expect(worker.hasTaskFunction('fn1')).toBe(true) expect(worker.hasTaskFunction('fn2')).toBe(true) expect(worker.hasTaskFunction('fn3')).toBe(false) @@ -159,29 +206,38 @@ describe('Abstract worker test suite', () => { return 3 } const worker = new ThreadWorker(fn1) - expect(worker.taskFunctions.get('default')).toBeInstanceOf(Function) + expect(() => worker.addTaskFunction(0, fn1)).toThrowError( + new TypeError('name parameter is not a string') + ) + expect(() => worker.addTaskFunction('', fn1)).toThrowError( + new TypeError('name parameter is an empty string') + ) + expect(() => worker.addTaskFunction('fn3', '')).toThrowError( + new TypeError('fn parameter is not a function') + ) + expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function) expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function) expect(worker.taskFunctions.size).toBe(2) - expect(worker.taskFunctions.get('default')).toStrictEqual( + expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual( worker.taskFunctions.get('fn1') ) - expect(() => worker.addTaskFunction('default', fn2)).toThrowError( + expect(() => worker.addTaskFunction(DEFAULT_TASK_NAME, fn2)).toThrowError( new Error('Cannot add a task function with the default reserved name') ) worker.addTaskFunction('fn2', fn2) - expect(worker.taskFunctions.get('default')).toBeInstanceOf(Function) + expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function) expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function) expect(worker.taskFunctions.get('fn2')).toBeInstanceOf(Function) expect(worker.taskFunctions.size).toBe(3) - expect(worker.taskFunctions.get('default')).toStrictEqual( + expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual( worker.taskFunctions.get('fn1') ) worker.addTaskFunction('fn1', fn1Replacement) - expect(worker.taskFunctions.get('default')).toBeInstanceOf(Function) + expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function) expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function) expect(worker.taskFunctions.get('fn2')).toBeInstanceOf(Function) expect(worker.taskFunctions.size).toBe(3) - expect(worker.taskFunctions.get('default')).toStrictEqual( + expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual( worker.taskFunctions.get('fn1') ) }) @@ -193,15 +249,25 @@ describe('Abstract worker test suite', () => { const fn2 = () => { return 2 } - const worker = new ThreadWorker({ fn1, fn2 }) - expect(worker.taskFunctions.get('default')).toBeInstanceOf(Function) + const worker = new ClusterWorker({ fn1, fn2 }) + expect(() => worker.removeTaskFunction(0, fn1)).toThrowError( + new TypeError('name parameter is not a string') + ) + expect(() => worker.removeTaskFunction('', fn1)).toThrowError( + new TypeError('name parameter is an empty string') + ) + worker.getMainWorker = sinon.stub().returns({ + id: 1, + send: sinon.stub().returns() + }) + expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function) expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function) expect(worker.taskFunctions.get('fn2')).toBeInstanceOf(Function) expect(worker.taskFunctions.size).toBe(3) - expect(worker.taskFunctions.get('default')).toStrictEqual( + expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual( worker.taskFunctions.get('fn1') ) - expect(() => worker.removeTaskFunction('default')).toThrowError( + expect(() => worker.removeTaskFunction(DEFAULT_TASK_NAME)).toThrowError( new Error( 'Cannot remove the task function with the default reserved name' ) @@ -212,10 +278,26 @@ describe('Abstract worker test suite', () => { ) ) worker.removeTaskFunction('fn2') - expect(worker.taskFunctions.get('default')).toBeInstanceOf(Function) + expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function) expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function) expect(worker.taskFunctions.get('fn2')).toBeUndefined() expect(worker.taskFunctions.size).toBe(2) + expect(worker.getMainWorker().send.calledOnce).toBe(true) + }) + + it('Verify that listTaskFunctions() works', () => { + const fn1 = () => { + return 1 + } + const fn2 = () => { + return 2 + } + const worker = new ClusterWorker({ fn1, fn2 }) + expect(worker.listTaskFunctions()).toStrictEqual([ + DEFAULT_TASK_NAME, + 'fn1', + 'fn2' + ]) }) it('Verify that setDefaultTaskFunction() works', () => { @@ -226,24 +308,35 @@ describe('Abstract worker test suite', () => { return 2 } const worker = new ThreadWorker({ fn1, fn2 }) - expect(worker.taskFunctions.get('default')).toBeInstanceOf(Function) + expect(() => worker.setDefaultTaskFunction(0, fn1)).toThrowError( + new TypeError('name parameter is not a string') + ) + expect(() => worker.setDefaultTaskFunction('', fn1)).toThrowError( + new TypeError('name parameter is an empty string') + ) + expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function) expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function) expect(worker.taskFunctions.get('fn2')).toBeInstanceOf(Function) expect(worker.taskFunctions.size).toBe(3) - expect(worker.taskFunctions.get('default')).toStrictEqual( + expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual( worker.taskFunctions.get('fn1') ) - expect(() => worker.setDefaultTaskFunction('default')).toThrowError( + expect(() => worker.setDefaultTaskFunction(DEFAULT_TASK_NAME)).toThrowError( new Error( 'Cannot set the default task function reserved name as the default task function' ) ) + expect(() => worker.setDefaultTaskFunction('fn3')).toThrowError( + new Error( + 'Cannot set the default task function to a non-existing task function' + ) + ) worker.setDefaultTaskFunction('fn1') - expect(worker.taskFunctions.get('default')).toStrictEqual( + expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual( worker.taskFunctions.get('fn1') ) worker.setDefaultTaskFunction('fn2') - expect(worker.taskFunctions.get('default')).toStrictEqual( + expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual( worker.taskFunctions.get('fn2') ) })