feat: add support for async kill handler

[poolifier.git] / tests / worker / abstract-worker.test.js

diff --git a/tests/worker/abstract-worker.test.js b/tests/worker/abstract-worker.test.js
index 25e097234f439dc6ec68f18903440c21e95f1c10..46370777f4e1fcb5e1df8cef70ecdff08472578f 100644 (file)
--- a/tests/worker/abstract-worker.test.js
+++ b/tests/worker/abstract-worker.test.js
@@ -1,8 +1,10 @@
 const { expect } = require('expect')
+const sinon = require('sinon')
 const { ClusterWorker, KillBehaviors, ThreadWorker } = require('../../lib')
+const { EMPTY_FUNCTION } = require('../../lib/utils')
 
 describe('Abstract worker test suite', () => {
-  class StubPoolWithIsMainWorker extends ThreadWorker {
+  class StubWorkerWithMainWorker extends ThreadWorker {
     constructor (fn, opts) {
       super(fn, opts)
       this.mainWorker = undefined
@@ -13,18 +15,24 @@ describe('Abstract worker test suite', () => {
     const worker = new ThreadWorker(() => {})
     expect(worker.opts.maxInactiveTime).toStrictEqual(60000)
     expect(worker.opts.killBehavior).toBe(KillBehaviors.SOFT)
-    expect(worker.opts.async).toBe(false)
+    expect(worker.opts.killHandler).toStrictEqual(EMPTY_FUNCTION)
+    expect(worker.opts.async).toBe(undefined)
   })
 
   it('Verify that worker options are set at worker creation', () => {
+    const killHandler = () => {
+      console.info('Worker received kill message')
+    }
     const worker = new ClusterWorker(() => {}, {
       maxInactiveTime: 6000,
-      async: true,
-      killBehavior: KillBehaviors.HARD
+      killBehavior: KillBehaviors.HARD,
+      killHandler,
+      async: true
     })
     expect(worker.opts.maxInactiveTime).toStrictEqual(6000)
     expect(worker.opts.killBehavior).toBe(KillBehaviors.HARD)
-    expect(worker.opts.async).toBe(true)
+    expect(worker.opts.killHandler).toStrictEqual(killHandler)
+    expect(worker.opts.async).toBe(undefined)
   })
 
   it('Verify that taskFunctions parameter is mandatory', () => {
@@ -33,33 +41,72 @@ describe('Abstract worker test suite', () => {
     )
   })
 
-  it('Verify that taskFunctions parameter is a function or an object', () => {
+  it('Verify that taskFunctions parameter is a function or a plain object', () => {
     expect(() => new ClusterWorker(0)).toThrowError(
-      new TypeError('taskFunctions parameter is not a function or an object')
+      new TypeError(
+        'taskFunctions parameter is not a function or a plain object'
+      )
     )
     expect(() => new ClusterWorker('')).toThrowError(
-      new TypeError('taskFunctions parameter is not a function or an object')
+      new TypeError(
+        'taskFunctions parameter is not a function or a plain object'
+      )
     )
     expect(() => new ClusterWorker(true)).toThrowError(
-      new TypeError('taskFunctions parameter is not a function or an object')
+      new TypeError(
+        'taskFunctions parameter is not a function or a plain object'
+      )
     )
-  })
-
-  it('Verify that taskFunctions parameter is an object literal', () => {
     expect(() => new ClusterWorker([])).toThrowError(
-      new TypeError('taskFunctions parameter is not an object literal')
+      new TypeError(
+        'taskFunctions parameter is not a function or a plain object'
+      )
     )
     expect(() => new ClusterWorker(new Map())).toThrowError(
-      new TypeError('taskFunctions parameter is not an object literal')
+      new TypeError(
+        'taskFunctions parameter is not a function or a plain object'
+      )
     )
     expect(() => new ClusterWorker(new Set())).toThrowError(
-      new TypeError('taskFunctions parameter is not an object literal')
+      new TypeError(
+        'taskFunctions parameter is not a function or a plain object'
+      )
     )
     expect(() => new ClusterWorker(new WeakMap())).toThrowError(
-      new TypeError('taskFunctions parameter is not an object literal')
+      new TypeError(
+        'taskFunctions parameter is not a function or a plain object'
+      )
     )
     expect(() => new ClusterWorker(new WeakSet())).toThrowError(
-      new TypeError('taskFunctions parameter is not an object literal')
+      new TypeError(
+        'taskFunctions parameter is not a function or a plain object'
+      )
+    )
+  })
+
+  it('Verify that taskFunctions parameter is not an empty object', () => {
+    expect(() => new ClusterWorker({})).toThrowError(
+      new Error('taskFunctions parameter object is empty')
+    )
+  })
+
+  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('fn1')).toBeInstanceOf(Function)
+    expect(worker.taskFunctions.size).toBe(2)
+    expect(worker.taskFunctions.get('default')).toStrictEqual(
+      worker.taskFunctions.get('fn1')
+    )
+  })
+
+  it('Verify that taskFunctions parameter with multiple task functions contains function', () => {
+    const fn1 = () => {
+      return 1
+    }
+    const fn2 = ''
+    expect(() => new ThreadWorker({ fn1, fn2 })).toThrowError(
+      new TypeError('A taskFunctions parameter object value is not a function')
     )
   })
 
@@ -71,19 +118,171 @@ describe('Abstract worker test suite', () => {
       return 2
     }
     const worker = new ClusterWorker({ fn1, fn2 })
-    expect(typeof worker.taskFunctions.get('fn1') === 'function').toBe(true)
-    expect(typeof worker.taskFunctions.get('fn2') === 'function').toBe(true)
+    expect(worker.taskFunctions.get('default')).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(
+      worker.taskFunctions.get('fn1')
+    )
   })
 
-  it('Verify that handleError() method is working properly', () => {
-    const error = new Error('My error')
-    const worker = new ThreadWorker(() => {})
-    expect(worker.handleError(error)).toStrictEqual(error)
+  it('Verify that sync kill handler is called when worker is killed', () => {
+    const worker = new ClusterWorker(() => {}, {
+      killHandler: sinon.stub().returns()
+    })
+    worker.isMain = false
+    worker.handleKillMessage()
+    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(() => {})
+    expect(worker.handleError(error)).not.toBeInstanceOf(Error)
+    expect(worker.handleError(error)).toStrictEqual(error.message)
+    const errorMessage = 'Error as a string'
+    expect(worker.handleError(errorMessage)).toStrictEqual(errorMessage)
   })
 
   it('Verify that getMainWorker() throw error if main worker is not set', () => {
     expect(() =>
-      new StubPoolWithIsMainWorker(() => {}).getMainWorker()
-    ).toThrowError('Main worker was not set')
+      new StubWorkerWithMainWorker(() => {}).getMainWorker()
+    ).toThrowError('Main worker not set')
+  })
+
+  it('Verify that hasTaskFunction() works', () => {
+    const fn1 = () => {
+      return 1
+    }
+    const fn2 = () => {
+      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)
+  })
+
+  it('Verify that addTaskFunction() works', () => {
+    const fn1 = () => {
+      return 1
+    }
+    const fn2 = () => {
+      return 2
+    }
+    const fn1Replacement = () => {
+      return 3
+    }
+    const worker = new ThreadWorker(fn1)
+    expect(worker.taskFunctions.get('default')).toBeInstanceOf(Function)
+    expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function)
+    expect(worker.taskFunctions.size).toBe(2)
+    expect(worker.taskFunctions.get('default')).toStrictEqual(
+      worker.taskFunctions.get('fn1')
+    )
+    expect(() => worker.addTaskFunction('default', 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('fn1')).toBeInstanceOf(Function)
+    expect(worker.taskFunctions.get('fn2')).toBeInstanceOf(Function)
+    expect(worker.taskFunctions.size).toBe(3)
+    expect(worker.taskFunctions.get('default')).toStrictEqual(
+      worker.taskFunctions.get('fn1')
+    )
+    worker.addTaskFunction('fn1', fn1Replacement)
+    expect(worker.taskFunctions.get('default')).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(
+      worker.taskFunctions.get('fn1')
+    )
+  })
+
+  it('Verify that removeTaskFunction() works', () => {
+    const fn1 = () => {
+      return 1
+    }
+    const fn2 = () => {
+      return 2
+    }
+    const worker = new ClusterWorker({ fn1, fn2 })
+    expect(worker.taskFunctions.get('default')).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(
+      worker.taskFunctions.get('fn1')
+    )
+    expect(() => worker.removeTaskFunction('default')).toThrowError(
+      new Error(
+        'Cannot remove the task function with the default reserved name'
+      )
+    )
+    expect(() => worker.removeTaskFunction('fn1')).toThrowError(
+      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('fn1')).toBeInstanceOf(Function)
+    expect(worker.taskFunctions.get('fn2')).toBeUndefined()
+    expect(worker.taskFunctions.size).toBe(2)
+  })
+
+  it('Verify that listTaskFunctions() works', () => {
+    const fn1 = () => {
+      return 1
+    }
+    const fn2 = () => {
+      return 2
+    }
+    const worker = new ClusterWorker({ fn1, fn2 })
+    expect(worker.listTaskFunctions()).toStrictEqual(['default', 'fn1', 'fn2'])
+  })
+
+  it('Verify that setDefaultTaskFunction() works', () => {
+    const fn1 = () => {
+      return 1
+    }
+    const fn2 = () => {
+      return 2
+    }
+    const worker = new ThreadWorker({ fn1, fn2 })
+    expect(worker.taskFunctions.get('default')).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(
+      worker.taskFunctions.get('fn1')
+    )
+    expect(() => worker.setDefaultTaskFunction('default')).toThrowError(
+      new Error(
+        'Cannot set the default task function reserved name as the default task function'
+      )
+    )
+    worker.setDefaultTaskFunction('fn1')
+    expect(worker.taskFunctions.get('default')).toStrictEqual(
+      worker.taskFunctions.get('fn1')
+    )
+    worker.setDefaultTaskFunction('fn2')
+    expect(worker.taskFunctions.get('default')).toStrictEqual(
+      worker.taskFunctions.get('fn2')
+    )
   })
 })