1 import { expect } from 'expect'
2 import { restore, stub } from 'sinon'
3 import { ClusterWorker, KillBehaviors, ThreadWorker } from '../../lib/index.js'
4 import { DEFAULT_TASK_NAME, EMPTY_FUNCTION } from '../../lib/utils.js'
6 describe('Abstract worker test suite', () => {
7 class StubWorkerWithMainWorker extends ThreadWorker {
8 constructor (fn, opts) {
10 delete this.mainWorker
18 it('Verify worker options default values', () => {
19 const worker = new ThreadWorker(() => {})
20 expect(worker.opts).toStrictEqual({
21 killBehavior: KillBehaviors.SOFT,
22 maxInactiveTime: 60000,
23 killHandler: EMPTY_FUNCTION
27 it('Verify that worker options are checked at worker creation', () => {
28 expect(() => new ClusterWorker(() => {}, '')).toThrowError(
29 new TypeError('opts worker options parameter is not a plain object')
32 () => new ClusterWorker(() => {}, { killBehavior: '' })
33 ).toThrowError(new TypeError("killBehavior option '' is not valid"))
34 expect(() => new ClusterWorker(() => {}, { killBehavior: 0 })).toThrowError(
35 new TypeError("killBehavior option '0' is not valid")
38 () => new ThreadWorker(() => {}, { maxInactiveTime: '' })
39 ).toThrowError(new TypeError('maxInactiveTime option is not an integer'))
41 () => new ThreadWorker(() => {}, { maxInactiveTime: 0.5 })
42 ).toThrowError(new TypeError('maxInactiveTime option is not an integer'))
44 () => new ThreadWorker(() => {}, { maxInactiveTime: 0 })
47 'maxInactiveTime option is not a positive integer greater or equal than 5'
51 () => new ThreadWorker(() => {}, { maxInactiveTime: 4 })
54 'maxInactiveTime option is not a positive integer greater or equal than 5'
57 expect(() => new ThreadWorker(() => {}, { killHandler: '' })).toThrowError(
58 new TypeError('killHandler option is not a function')
60 expect(() => new ThreadWorker(() => {}, { killHandler: 0 })).toThrowError(
61 new TypeError('killHandler option is not a function')
63 expect(() => new ThreadWorker(() => {}, { async: true })).toThrowError(
64 new TypeError('async option is deprecated')
68 it('Verify that worker options are set at worker creation', () => {
69 const killHandler = () => {
70 console.info('Worker received kill message')
72 const worker = new ClusterWorker(() => {}, {
73 killBehavior: KillBehaviors.HARD,
74 maxInactiveTime: 6000,
77 expect(worker.opts).toStrictEqual({
78 killBehavior: KillBehaviors.HARD,
79 maxInactiveTime: 6000,
84 it('Verify that taskFunctions parameter is mandatory', () => {
85 expect(() => new ClusterWorker()).toThrowError(
86 new Error('taskFunctions parameter is mandatory')
90 it('Verify that taskFunctions parameter is a function or a plain object', () => {
91 expect(() => new ClusterWorker(0)).toThrowError(
93 'taskFunctions parameter is not a function or a plain object'
96 expect(() => new ClusterWorker('')).toThrowError(
98 'taskFunctions parameter is not a function or a plain object'
101 expect(() => new ClusterWorker(true)).toThrowError(
103 'taskFunctions parameter is not a function or a plain object'
106 expect(() => new ClusterWorker([])).toThrowError(
108 'taskFunctions parameter is not a function or a plain object'
111 expect(() => new ClusterWorker(new Map())).toThrowError(
113 'taskFunctions parameter is not a function or a plain object'
116 expect(() => new ClusterWorker(new Set())).toThrowError(
118 'taskFunctions parameter is not a function or a plain object'
121 expect(() => new ClusterWorker(new WeakMap())).toThrowError(
123 'taskFunctions parameter is not a function or a plain object'
126 expect(() => new ClusterWorker(new WeakSet())).toThrowError(
128 'taskFunctions parameter is not a function or a plain object'
133 it('Verify that taskFunctions parameter is not an empty object', () => {
134 expect(() => new ClusterWorker({})).toThrowError(
135 new Error('taskFunctions parameter object is empty')
139 it('Verify that taskFunctions parameter with unique function is taken', () => {
140 const worker = new ThreadWorker(() => {})
141 expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function)
142 expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function)
143 expect(worker.taskFunctions.size).toBe(2)
144 expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual(
145 worker.taskFunctions.get('fn1')
149 it('Verify that taskFunctions parameter with multiple task functions is checked', () => {
154 expect(() => new ThreadWorker({ '': fn1 })).toThrowError(
155 new TypeError('A taskFunctions parameter object key is an empty string')
157 expect(() => new ThreadWorker({ fn1, fn2 })).toThrowError(
158 new TypeError('A taskFunctions parameter object value is not a function')
162 it('Verify that taskFunctions parameter with multiple task functions is taken', () => {
169 const worker = new ClusterWorker({ fn1, fn2 })
170 expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function)
171 expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function)
172 expect(worker.taskFunctions.get('fn2')).toBeInstanceOf(Function)
173 expect(worker.taskFunctions.size).toBe(3)
174 expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual(
175 worker.taskFunctions.get('fn1')
179 it('Verify that sync kill handler is called when worker is killed', () => {
180 const worker = new ClusterWorker(() => {}, {
181 killHandler: stub().returns()
183 worker.isMain = false
184 worker.getMainWorker = stub().returns({
186 send: stub().returns()
188 worker.handleKillMessage()
189 expect(worker.getMainWorker().send.calledOnce).toBe(true)
190 expect(worker.opts.killHandler.calledOnce).toBe(true)
193 it('Verify that async kill handler is called when worker is killed', () => {
194 const killHandlerStub = stub().returns()
195 const worker = new ClusterWorker(() => {}, {
196 killHandler: async () => Promise.resolve(killHandlerStub())
198 worker.isMain = false
199 worker.handleKillMessage()
200 expect(killHandlerStub.calledOnce).toBe(true)
203 it('Verify that getMainWorker() throw error if main worker is not set', () => {
205 new StubWorkerWithMainWorker(() => {}).getMainWorker()
206 ).toThrowError('Main worker not set')
209 it('Verify that hasTaskFunction() is working', () => {
216 const worker = new ClusterWorker({ fn1, fn2 })
217 expect(worker.hasTaskFunction(0)).toStrictEqual({
219 error: new TypeError('name parameter is not a string')
221 expect(worker.hasTaskFunction('')).toStrictEqual({
223 error: new TypeError('name parameter is an empty string')
225 expect(worker.hasTaskFunction(DEFAULT_TASK_NAME)).toStrictEqual({
228 expect(worker.hasTaskFunction('fn1')).toStrictEqual({ status: true })
229 expect(worker.hasTaskFunction('fn2')).toStrictEqual({ status: true })
230 expect(worker.hasTaskFunction('fn3')).toStrictEqual({ status: false })
233 it('Verify that addTaskFunction() is working', () => {
240 const fn1Replacement = () => {
243 const worker = new ThreadWorker(fn1)
244 expect(worker.addTaskFunction(0, fn1)).toStrictEqual({
246 error: new TypeError('name parameter is not a string')
248 expect(worker.addTaskFunction('', fn1)).toStrictEqual({
250 error: new TypeError('name parameter is an empty string')
252 expect(worker.addTaskFunction('fn3', '')).toStrictEqual({
254 error: new TypeError('fn parameter is not a function')
256 expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function)
257 expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function)
258 expect(worker.taskFunctions.size).toBe(2)
259 expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual(
260 worker.taskFunctions.get('fn1')
262 expect(worker.addTaskFunction(DEFAULT_TASK_NAME, fn2)).toStrictEqual({
265 'Cannot add a task function with the default reserved name'
268 worker.addTaskFunction('fn2', fn2)
269 expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function)
270 expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function)
271 expect(worker.taskFunctions.get('fn2')).toBeInstanceOf(Function)
272 expect(worker.taskFunctions.size).toBe(3)
273 expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual(
274 worker.taskFunctions.get('fn1')
276 worker.addTaskFunction('fn1', fn1Replacement)
277 expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function)
278 expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function)
279 expect(worker.taskFunctions.get('fn2')).toBeInstanceOf(Function)
280 expect(worker.taskFunctions.size).toBe(3)
281 expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual(
282 worker.taskFunctions.get('fn1')
286 it('Verify that removeTaskFunction() is working', () => {
293 const worker = new ClusterWorker({ fn1, fn2 })
294 expect(worker.removeTaskFunction(0, fn1)).toStrictEqual({
296 error: new TypeError('name parameter is not a string')
298 expect(worker.removeTaskFunction('', fn1)).toStrictEqual({
300 error: new TypeError('name parameter is an empty string')
302 worker.getMainWorker = stub().returns({
304 send: stub().returns()
306 expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function)
307 expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function)
308 expect(worker.taskFunctions.get('fn2')).toBeInstanceOf(Function)
309 expect(worker.taskFunctions.size).toBe(3)
310 expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual(
311 worker.taskFunctions.get('fn1')
313 expect(worker.removeTaskFunction(DEFAULT_TASK_NAME)).toStrictEqual({
316 'Cannot remove the task function with the default reserved name'
319 expect(worker.removeTaskFunction('fn1')).toStrictEqual({
322 'Cannot remove the task function used as the default task function'
325 worker.removeTaskFunction('fn2')
326 expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function)
327 expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function)
328 expect(worker.taskFunctions.get('fn2')).toBeUndefined()
329 expect(worker.taskFunctions.size).toBe(2)
330 expect(worker.getMainWorker().send.calledOnce).toBe(true)
333 it('Verify that listTaskFunctionNames() is working', () => {
340 const worker = new ClusterWorker({ fn1, fn2 })
341 expect(worker.listTaskFunctionNames()).toStrictEqual([
348 it('Verify that setDefaultTaskFunction() is working', () => {
355 const worker = new ThreadWorker({ fn1, fn2 })
356 expect(worker.setDefaultTaskFunction(0, fn1)).toStrictEqual({
358 error: new TypeError('name parameter is not a string')
360 expect(worker.setDefaultTaskFunction('', fn1)).toStrictEqual({
362 error: new TypeError('name parameter is an empty string')
364 expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function)
365 expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function)
366 expect(worker.taskFunctions.get('fn2')).toBeInstanceOf(Function)
367 expect(worker.taskFunctions.size).toBe(3)
368 expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual(
369 worker.taskFunctions.get('fn1')
371 expect(worker.setDefaultTaskFunction(DEFAULT_TASK_NAME)).toStrictEqual({
374 'Cannot set the default task function reserved name as the default task function'
377 expect(worker.setDefaultTaskFunction('fn3')).toStrictEqual({
380 'Cannot set the default task function to a non-existing task function'
383 worker.setDefaultTaskFunction('fn1')
384 expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual(
385 worker.taskFunctions.get('fn1')
387 worker.setDefaultTaskFunction('fn2')
388 expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual(
389 worker.taskFunctions.get('fn2')