X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=tests%2Fworker%2Fabstract-worker.test.js;h=200b05acdff0f26a29c0eb4e2e760a64448935f5;hb=103057eedf4f7b18f009333806d0293bfb23e204;hp=944acbece738f49c21977049098aa3008fe694c9;hpb=135f2a9f5a7ca0e4cc22e064af7d837e551f2ea3;p=poolifier.git diff --git a/tests/worker/abstract-worker.test.js b/tests/worker/abstract-worker.test.js index 944acbec..200b05ac 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,27 +11,79 @@ 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 checked at worker creation', () => { + expect(() => new ClusterWorker(() => {}, '')).toThrowError( + new TypeError('opts worker options parameter is not a plain object') + ) + expect( + () => new ClusterWorker(() => {}, { killBehavior: '' }) + ).toThrowError(new TypeError("killBehavior option '' is not valid")) + expect(() => new ClusterWorker(() => {}, { killBehavior: 0 })).toThrowError( + new TypeError("killBehavior option '0' is not valid") + ) + expect( + () => new ThreadWorker(() => {}, { maxInactiveTime: '' }) + ).toThrowError(new TypeError('maxInactiveTime option is not an integer')) + expect( + () => new ThreadWorker(() => {}, { maxInactiveTime: 0.5 }) + ).toThrowError(new TypeError('maxInactiveTime option is not an integer')) + expect( + () => new ThreadWorker(() => {}, { maxInactiveTime: 0 }) + ).toThrowError( + new TypeError( + 'maxInactiveTime option is not a positive integer greater or equal than 5' + ) + ) + expect( + () => new ThreadWorker(() => {}, { maxInactiveTime: 4 }) + ).toThrowError( + new TypeError( + 'maxInactiveTime option is not a positive integer greater or equal than 5' + ) + ) + expect(() => new ThreadWorker(() => {}, { killHandler: '' })).toThrowError( + new TypeError('killHandler option is not a function') + ) + expect(() => new ThreadWorker(() => {}, { killHandler: 0 })).toThrowError( + new TypeError('killHandler option is not a function') + ) + expect(() => new ThreadWorker(() => {}, { async: true })).toThrowError( + new TypeError('async option is deprecated') + ) }) 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 + }) + 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', () => { expect(() => new ClusterWorker()).toThrowError( - 'taskFunctions parameter is mandatory' + new Error('taskFunctions parameter is mandatory') ) }) @@ -84,19 +138,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,16 +167,40 @@ 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 handleError() method works properly', () => { + 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 is working properly', () => { const error = new Error('Error as an error') const worker = new ClusterWorker(() => {}) expect(worker.handleError(error)).not.toBeInstanceOf(Error) @@ -134,7 +215,7 @@ describe('Abstract worker test suite', () => { ).toThrowError('Main worker not set') }) - it('Verify that hasTaskFunction() works', () => { + it('Verify that hasTaskFunction() is working', () => { const fn1 = () => { return 1 } @@ -142,13 +223,23 @@ describe('Abstract worker test suite', () => { return 2 } const worker = new ClusterWorker({ fn1, fn2 }) - expect(worker.hasTaskFunction('default')).toBe(true) - expect(worker.hasTaskFunction('fn1')).toBe(true) - expect(worker.hasTaskFunction('fn2')).toBe(true) - expect(worker.hasTaskFunction('fn3')).toBe(false) + expect(worker.hasTaskFunction(0)).toStrictEqual({ + status: false, + error: new TypeError('name parameter is not a string') + }) + expect(worker.hasTaskFunction('')).toStrictEqual({ + status: false, + error: new TypeError('name parameter is an empty string') + }) + expect(worker.hasTaskFunction(DEFAULT_TASK_NAME)).toStrictEqual({ + status: true + }) + expect(worker.hasTaskFunction('fn1')).toStrictEqual({ status: true }) + expect(worker.hasTaskFunction('fn2')).toStrictEqual({ status: true }) + expect(worker.hasTaskFunction('fn3')).toStrictEqual({ status: false }) }) - it('Verify that addTaskFunction() works', () => { + it('Verify that addTaskFunction() is working', () => { const fn1 = () => { return 1 } @@ -159,34 +250,49 @@ describe('Abstract worker test suite', () => { return 3 } const worker = new ThreadWorker(fn1) - expect(worker.taskFunctions.get('default')).toBeInstanceOf(Function) + expect(worker.addTaskFunction(0, fn1)).toStrictEqual({ + status: false, + error: new TypeError('name parameter is not a string') + }) + expect(worker.addTaskFunction('', fn1)).toStrictEqual({ + status: false, + error: new TypeError('name parameter is an empty string') + }) + expect(worker.addTaskFunction('fn3', '')).toStrictEqual({ + status: false, + error: 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( - new Error('Cannot add a task function with the default reserved name') - ) + expect(worker.addTaskFunction(DEFAULT_TASK_NAME, fn2)).toStrictEqual({ + status: false, + error: 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') ) }) - it('Verify that removeTaskFunction() works', () => { + it('Verify that removeTaskFunction() is working', () => { const fn1 = () => { return 1 } @@ -194,31 +300,61 @@ describe('Abstract worker test suite', () => { return 2 } const worker = new ClusterWorker({ fn1, fn2 }) - expect(worker.taskFunctions.get('default')).toBeInstanceOf(Function) + expect(worker.removeTaskFunction(0, fn1)).toStrictEqual({ + status: false, + error: new TypeError('name parameter is not a string') + }) + expect(worker.removeTaskFunction('', fn1)).toStrictEqual({ + status: false, + error: 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( - new Error( + expect(worker.removeTaskFunction(DEFAULT_TASK_NAME)).toStrictEqual({ + status: false, + error: new Error( 'Cannot remove the task function with the default reserved name' ) - ) - expect(() => worker.removeTaskFunction('fn1')).toThrowError( - new Error( + }) + expect(worker.removeTaskFunction('fn1')).toStrictEqual({ + status: false, + error: new Error( 'Cannot remove the task function used as the default task function' ) - ) + }) 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 setDefaultTaskFunction() works', () => { + it('Verify that listTaskFunctionNames() is working', () => { + const fn1 = () => { + return 1 + } + const fn2 = () => { + return 2 + } + const worker = new ClusterWorker({ fn1, fn2 }) + expect(worker.listTaskFunctionNames()).toStrictEqual([ + DEFAULT_TASK_NAME, + 'fn1', + 'fn2' + ]) + }) + + it('Verify that setDefaultTaskFunction() is working', () => { const fn1 = () => { return 1 } @@ -226,24 +362,39 @@ 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)).toStrictEqual({ + status: false, + error: new TypeError('name parameter is not a string') + }) + expect(worker.setDefaultTaskFunction('', fn1)).toStrictEqual({ + status: false, + error: 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( - new Error( + expect(worker.setDefaultTaskFunction(DEFAULT_TASK_NAME)).toStrictEqual({ + status: false, + error: new Error( 'Cannot set the default task function reserved name as the default task function' ) - ) + }) + expect(worker.setDefaultTaskFunction('fn3')).toStrictEqual({ + status: false, + error: 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') ) })