Commit | Line | Data |
---|---|---|
a074ffee JB |
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' | |
7fc5cce6 | 5 | |
e1ffb94f | 6 | describe('Abstract worker test suite', () => { |
1f68cede | 7 | class StubWorkerWithMainWorker extends ThreadWorker { |
e1ffb94f JB |
8 | constructor (fn, opts) { |
9 | super(fn, opts) | |
41072404 | 10 | delete this.mainWorker |
e1ffb94f | 11 | } |
7fc5cce6 | 12 | } |
c510fea7 | 13 | |
dc021bcc | 14 | afterEach(() => { |
a074ffee | 15 | restore() |
dc021bcc JB |
16 | }) |
17 | ||
e088a00c | 18 | it('Verify worker options default values', () => { |
8620fb25 | 19 | const worker = new ThreadWorker(() => {}) |
cca3bb1a JB |
20 | expect(worker.opts).toStrictEqual({ |
21 | killBehavior: KillBehaviors.SOFT, | |
22 | maxInactiveTime: 60000, | |
23 | killHandler: EMPTY_FUNCTION | |
24 | }) | |
8620fb25 JB |
25 | }) |
26 | ||
c20084b6 JB |
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') | |
30 | ) | |
31 | expect( | |
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") | |
36 | ) | |
37 | expect( | |
38 | () => new ThreadWorker(() => {}, { maxInactiveTime: '' }) | |
39 | ).toThrowError(new TypeError('maxInactiveTime option is not an integer')) | |
40 | expect( | |
41 | () => new ThreadWorker(() => {}, { maxInactiveTime: 0.5 }) | |
42 | ).toThrowError(new TypeError('maxInactiveTime option is not an integer')) | |
43 | expect( | |
44 | () => new ThreadWorker(() => {}, { maxInactiveTime: 0 }) | |
45 | ).toThrowError( | |
46 | new TypeError( | |
47 | 'maxInactiveTime option is not a positive integer greater or equal than 5' | |
48 | ) | |
49 | ) | |
50 | expect( | |
51 | () => new ThreadWorker(() => {}, { maxInactiveTime: 4 }) | |
52 | ).toThrowError( | |
53 | new TypeError( | |
54 | 'maxInactiveTime option is not a positive integer greater or equal than 5' | |
55 | ) | |
56 | ) | |
57 | expect(() => new ThreadWorker(() => {}, { killHandler: '' })).toThrowError( | |
58 | new TypeError('killHandler option is not a function') | |
59 | ) | |
60 | expect(() => new ThreadWorker(() => {}, { killHandler: 0 })).toThrowError( | |
61 | new TypeError('killHandler option is not a function') | |
62 | ) | |
63 | expect(() => new ThreadWorker(() => {}, { async: true })).toThrowError( | |
64 | new TypeError('async option is deprecated') | |
65 | ) | |
66 | }) | |
67 | ||
8620fb25 | 68 | it('Verify that worker options are set at worker creation', () => { |
df9aaf20 JB |
69 | const killHandler = () => { |
70 | console.info('Worker received kill message') | |
71 | } | |
8620fb25 | 72 | const worker = new ClusterWorker(() => {}, { |
df9aaf20 | 73 | killBehavior: KillBehaviors.HARD, |
cca3bb1a | 74 | maxInactiveTime: 6000, |
c20084b6 | 75 | killHandler |
8620fb25 | 76 | }) |
cca3bb1a JB |
77 | expect(worker.opts).toStrictEqual({ |
78 | killBehavior: KillBehaviors.HARD, | |
79 | maxInactiveTime: 6000, | |
80 | killHandler | |
81 | }) | |
8620fb25 JB |
82 | }) |
83 | ||
a86b6df1 JB |
84 | it('Verify that taskFunctions parameter is mandatory', () => { |
85 | expect(() => new ClusterWorker()).toThrowError( | |
c20084b6 | 86 | new Error('taskFunctions parameter is mandatory') |
a86b6df1 | 87 | ) |
d4aeae5a JB |
88 | }) |
89 | ||
f34fdabe | 90 | it('Verify that taskFunctions parameter is a function or a plain object', () => { |
a86b6df1 | 91 | expect(() => new ClusterWorker(0)).toThrowError( |
f34fdabe JB |
92 | new TypeError( |
93 | 'taskFunctions parameter is not a function or a plain object' | |
94 | ) | |
d4aeae5a JB |
95 | ) |
96 | expect(() => new ClusterWorker('')).toThrowError( | |
f34fdabe JB |
97 | new TypeError( |
98 | 'taskFunctions parameter is not a function or a plain object' | |
99 | ) | |
a86b6df1 JB |
100 | ) |
101 | expect(() => new ClusterWorker(true)).toThrowError( | |
f34fdabe JB |
102 | new TypeError( |
103 | 'taskFunctions parameter is not a function or a plain object' | |
104 | ) | |
d4aeae5a | 105 | ) |
a86b6df1 | 106 | expect(() => new ClusterWorker([])).toThrowError( |
f34fdabe JB |
107 | new TypeError( |
108 | 'taskFunctions parameter is not a function or a plain object' | |
109 | ) | |
a86b6df1 JB |
110 | ) |
111 | expect(() => new ClusterWorker(new Map())).toThrowError( | |
f34fdabe JB |
112 | new TypeError( |
113 | 'taskFunctions parameter is not a function or a plain object' | |
114 | ) | |
a86b6df1 JB |
115 | ) |
116 | expect(() => new ClusterWorker(new Set())).toThrowError( | |
f34fdabe JB |
117 | new TypeError( |
118 | 'taskFunctions parameter is not a function or a plain object' | |
119 | ) | |
a86b6df1 JB |
120 | ) |
121 | expect(() => new ClusterWorker(new WeakMap())).toThrowError( | |
f34fdabe JB |
122 | new TypeError( |
123 | 'taskFunctions parameter is not a function or a plain object' | |
124 | ) | |
d4aeae5a | 125 | ) |
a86b6df1 | 126 | expect(() => new ClusterWorker(new WeakSet())).toThrowError( |
f34fdabe JB |
127 | new TypeError( |
128 | 'taskFunctions parameter is not a function or a plain object' | |
129 | ) | |
a86b6df1 | 130 | ) |
f34fdabe JB |
131 | }) |
132 | ||
133 | it('Verify that taskFunctions parameter is not an empty object', () => { | |
630f0acf | 134 | expect(() => new ClusterWorker({})).toThrowError( |
0d80593b | 135 | new Error('taskFunctions parameter object is empty') |
630f0acf | 136 | ) |
a86b6df1 JB |
137 | }) |
138 | ||
2a69b8c5 JB |
139 | it('Verify that taskFunctions parameter with unique function is taken', () => { |
140 | const worker = new ThreadWorker(() => {}) | |
6cd5248f | 141 | expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function) |
2a69b8c5 JB |
142 | expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function) |
143 | expect(worker.taskFunctions.size).toBe(2) | |
6cd5248f | 144 | expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual( |
2a69b8c5 JB |
145 | worker.taskFunctions.get('fn1') |
146 | ) | |
147 | }) | |
148 | ||
6934964f | 149 | it('Verify that taskFunctions parameter with multiple task functions is checked', () => { |
f34fdabe JB |
150 | const fn1 = () => { |
151 | return 1 | |
152 | } | |
153 | const fn2 = '' | |
6934964f JB |
154 | expect(() => new ThreadWorker({ '': fn1 })).toThrowError( |
155 | new TypeError('A taskFunctions parameter object key is an empty string') | |
156 | ) | |
f34fdabe JB |
157 | expect(() => new ThreadWorker({ fn1, fn2 })).toThrowError( |
158 | new TypeError('A taskFunctions parameter object value is not a function') | |
159 | ) | |
160 | }) | |
161 | ||
a86b6df1 JB |
162 | it('Verify that taskFunctions parameter with multiple task functions is taken', () => { |
163 | const fn1 = () => { | |
164 | return 1 | |
165 | } | |
166 | const fn2 = () => { | |
167 | return 2 | |
168 | } | |
169 | const worker = new ClusterWorker({ fn1, fn2 }) | |
6cd5248f | 170 | expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function) |
2a69b8c5 JB |
171 | expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function) |
172 | expect(worker.taskFunctions.get('fn2')).toBeInstanceOf(Function) | |
173 | expect(worker.taskFunctions.size).toBe(3) | |
6cd5248f | 174 | expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual( |
2a69b8c5 JB |
175 | worker.taskFunctions.get('fn1') |
176 | ) | |
d4aeae5a JB |
177 | }) |
178 | ||
df9aaf20 JB |
179 | it('Verify that sync kill handler is called when worker is killed', () => { |
180 | const worker = new ClusterWorker(() => {}, { | |
a074ffee | 181 | killHandler: stub().returns() |
df9aaf20 JB |
182 | }) |
183 | worker.isMain = false | |
a074ffee | 184 | worker.getMainWorker = stub().returns({ |
1e3214b6 | 185 | id: 1, |
a074ffee | 186 | send: stub().returns() |
1e3214b6 | 187 | }) |
df9aaf20 | 188 | worker.handleKillMessage() |
1e3214b6 | 189 | expect(worker.getMainWorker().send.calledOnce).toBe(true) |
df9aaf20 JB |
190 | expect(worker.opts.killHandler.calledOnce).toBe(true) |
191 | }) | |
192 | ||
07588f30 | 193 | it('Verify that async kill handler is called when worker is killed', () => { |
a074ffee | 194 | const killHandlerStub = stub().returns() |
07588f30 JB |
195 | const worker = new ClusterWorker(() => {}, { |
196 | killHandler: async () => Promise.resolve(killHandlerStub()) | |
197 | }) | |
198 | worker.isMain = false | |
199 | worker.handleKillMessage() | |
200 | expect(killHandlerStub.calledOnce).toBe(true) | |
201 | }) | |
df9aaf20 | 202 | |
9eae3c69 | 203 | it('Verify that handleError() method is working properly', () => { |
2431bdb4 JB |
204 | const error = new Error('Error as an error') |
205 | const worker = new ClusterWorker(() => {}) | |
206 | expect(worker.handleError(error)).not.toBeInstanceOf(Error) | |
207 | expect(worker.handleError(error)).toStrictEqual(error.message) | |
208 | const errorMessage = 'Error as a string' | |
209 | expect(worker.handleError(errorMessage)).toStrictEqual(errorMessage) | |
7fc5cce6 APA |
210 | }) |
211 | ||
318d4156 | 212 | it('Verify that getMainWorker() throw error if main worker is not set', () => { |
7fc5cce6 | 213 | expect(() => |
1f68cede | 214 | new StubWorkerWithMainWorker(() => {}).getMainWorker() |
e102732c | 215 | ).toThrowError('Main worker not set') |
7fc5cce6 | 216 | }) |
2a69b8c5 | 217 | |
9eae3c69 | 218 | it('Verify that hasTaskFunction() is working', () => { |
2a69b8c5 JB |
219 | const fn1 = () => { |
220 | return 1 | |
221 | } | |
222 | const fn2 = () => { | |
223 | return 2 | |
224 | } | |
225 | const worker = new ClusterWorker({ fn1, fn2 }) | |
66979634 JB |
226 | expect(worker.hasTaskFunction(0)).toStrictEqual({ |
227 | status: false, | |
228 | error: new TypeError('name parameter is not a string') | |
229 | }) | |
230 | expect(worker.hasTaskFunction('')).toStrictEqual({ | |
231 | status: false, | |
232 | error: new TypeError('name parameter is an empty string') | |
233 | }) | |
234 | expect(worker.hasTaskFunction(DEFAULT_TASK_NAME)).toStrictEqual({ | |
235 | status: true | |
236 | }) | |
237 | expect(worker.hasTaskFunction('fn1')).toStrictEqual({ status: true }) | |
238 | expect(worker.hasTaskFunction('fn2')).toStrictEqual({ status: true }) | |
239 | expect(worker.hasTaskFunction('fn3')).toStrictEqual({ status: false }) | |
2a69b8c5 JB |
240 | }) |
241 | ||
9eae3c69 | 242 | it('Verify that addTaskFunction() is working', () => { |
2a69b8c5 JB |
243 | const fn1 = () => { |
244 | return 1 | |
245 | } | |
246 | const fn2 = () => { | |
247 | return 2 | |
248 | } | |
249 | const fn1Replacement = () => { | |
250 | return 3 | |
251 | } | |
252 | const worker = new ThreadWorker(fn1) | |
66979634 JB |
253 | expect(worker.addTaskFunction(0, fn1)).toStrictEqual({ |
254 | status: false, | |
255 | error: new TypeError('name parameter is not a string') | |
256 | }) | |
257 | expect(worker.addTaskFunction('', fn1)).toStrictEqual({ | |
258 | status: false, | |
259 | error: new TypeError('name parameter is an empty string') | |
260 | }) | |
261 | expect(worker.addTaskFunction('fn3', '')).toStrictEqual({ | |
262 | status: false, | |
263 | error: new TypeError('fn parameter is not a function') | |
264 | }) | |
6cd5248f | 265 | expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function) |
2a69b8c5 JB |
266 | expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function) |
267 | expect(worker.taskFunctions.size).toBe(2) | |
6cd5248f | 268 | expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual( |
2a69b8c5 JB |
269 | worker.taskFunctions.get('fn1') |
270 | ) | |
66979634 JB |
271 | expect(worker.addTaskFunction(DEFAULT_TASK_NAME, fn2)).toStrictEqual({ |
272 | status: false, | |
273 | error: new Error( | |
274 | 'Cannot add a task function with the default reserved name' | |
275 | ) | |
276 | }) | |
2a69b8c5 | 277 | worker.addTaskFunction('fn2', fn2) |
6cd5248f | 278 | expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function) |
2a69b8c5 JB |
279 | expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function) |
280 | expect(worker.taskFunctions.get('fn2')).toBeInstanceOf(Function) | |
281 | expect(worker.taskFunctions.size).toBe(3) | |
6cd5248f | 282 | expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual( |
2a69b8c5 JB |
283 | worker.taskFunctions.get('fn1') |
284 | ) | |
285 | worker.addTaskFunction('fn1', fn1Replacement) | |
6cd5248f | 286 | expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function) |
2a69b8c5 JB |
287 | expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function) |
288 | expect(worker.taskFunctions.get('fn2')).toBeInstanceOf(Function) | |
289 | expect(worker.taskFunctions.size).toBe(3) | |
6cd5248f | 290 | expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual( |
2a69b8c5 JB |
291 | worker.taskFunctions.get('fn1') |
292 | ) | |
293 | }) | |
294 | ||
9eae3c69 | 295 | it('Verify that removeTaskFunction() is working', () => { |
2a69b8c5 JB |
296 | const fn1 = () => { |
297 | return 1 | |
298 | } | |
299 | const fn2 = () => { | |
300 | return 2 | |
301 | } | |
135f2a9f | 302 | const worker = new ClusterWorker({ fn1, fn2 }) |
66979634 JB |
303 | expect(worker.removeTaskFunction(0, fn1)).toStrictEqual({ |
304 | status: false, | |
305 | error: new TypeError('name parameter is not a string') | |
306 | }) | |
307 | expect(worker.removeTaskFunction('', fn1)).toStrictEqual({ | |
308 | status: false, | |
309 | error: new TypeError('name parameter is an empty string') | |
310 | }) | |
a074ffee | 311 | worker.getMainWorker = stub().returns({ |
90d7d101 | 312 | id: 1, |
a074ffee | 313 | send: stub().returns() |
90d7d101 | 314 | }) |
6cd5248f | 315 | expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function) |
2a69b8c5 JB |
316 | expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function) |
317 | expect(worker.taskFunctions.get('fn2')).toBeInstanceOf(Function) | |
318 | expect(worker.taskFunctions.size).toBe(3) | |
6cd5248f | 319 | expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual( |
2a69b8c5 JB |
320 | worker.taskFunctions.get('fn1') |
321 | ) | |
66979634 JB |
322 | expect(worker.removeTaskFunction(DEFAULT_TASK_NAME)).toStrictEqual({ |
323 | status: false, | |
324 | error: new Error( | |
2a69b8c5 JB |
325 | 'Cannot remove the task function with the default reserved name' |
326 | ) | |
66979634 JB |
327 | }) |
328 | expect(worker.removeTaskFunction('fn1')).toStrictEqual({ | |
329 | status: false, | |
330 | error: new Error( | |
2a69b8c5 JB |
331 | 'Cannot remove the task function used as the default task function' |
332 | ) | |
66979634 | 333 | }) |
2a69b8c5 | 334 | worker.removeTaskFunction('fn2') |
6cd5248f | 335 | expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function) |
2a69b8c5 JB |
336 | expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function) |
337 | expect(worker.taskFunctions.get('fn2')).toBeUndefined() | |
338 | expect(worker.taskFunctions.size).toBe(2) | |
90d7d101 | 339 | expect(worker.getMainWorker().send.calledOnce).toBe(true) |
2a69b8c5 JB |
340 | }) |
341 | ||
9eae3c69 | 342 | it('Verify that listTaskFunctionNames() is working', () => { |
c50b93fb JB |
343 | const fn1 = () => { |
344 | return 1 | |
345 | } | |
346 | const fn2 = () => { | |
347 | return 2 | |
348 | } | |
349 | const worker = new ClusterWorker({ fn1, fn2 }) | |
66979634 | 350 | expect(worker.listTaskFunctionNames()).toStrictEqual([ |
6cd5248f JB |
351 | DEFAULT_TASK_NAME, |
352 | 'fn1', | |
353 | 'fn2' | |
354 | ]) | |
c50b93fb JB |
355 | }) |
356 | ||
9eae3c69 | 357 | it('Verify that setDefaultTaskFunction() is working', () => { |
2a69b8c5 JB |
358 | const fn1 = () => { |
359 | return 1 | |
360 | } | |
361 | const fn2 = () => { | |
362 | return 2 | |
363 | } | |
364 | const worker = new ThreadWorker({ fn1, fn2 }) | |
66979634 JB |
365 | expect(worker.setDefaultTaskFunction(0, fn1)).toStrictEqual({ |
366 | status: false, | |
367 | error: new TypeError('name parameter is not a string') | |
368 | }) | |
369 | expect(worker.setDefaultTaskFunction('', fn1)).toStrictEqual({ | |
370 | status: false, | |
371 | error: new TypeError('name parameter is an empty string') | |
372 | }) | |
6cd5248f | 373 | expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function) |
2a69b8c5 JB |
374 | expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function) |
375 | expect(worker.taskFunctions.get('fn2')).toBeInstanceOf(Function) | |
376 | expect(worker.taskFunctions.size).toBe(3) | |
6cd5248f | 377 | expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual( |
2a69b8c5 JB |
378 | worker.taskFunctions.get('fn1') |
379 | ) | |
66979634 JB |
380 | expect(worker.setDefaultTaskFunction(DEFAULT_TASK_NAME)).toStrictEqual({ |
381 | status: false, | |
382 | error: new Error( | |
2a69b8c5 JB |
383 | 'Cannot set the default task function reserved name as the default task function' |
384 | ) | |
66979634 JB |
385 | }) |
386 | expect(worker.setDefaultTaskFunction('fn3')).toStrictEqual({ | |
387 | status: false, | |
388 | error: new Error( | |
6934964f JB |
389 | 'Cannot set the default task function to a non-existing task function' |
390 | ) | |
66979634 | 391 | }) |
2a69b8c5 | 392 | worker.setDefaultTaskFunction('fn1') |
6cd5248f | 393 | expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual( |
2a69b8c5 JB |
394 | worker.taskFunctions.get('fn1') |
395 | ) | |
396 | worker.setDefaultTaskFunction('fn2') | |
6cd5248f | 397 | expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual( |
2a69b8c5 JB |
398 | worker.taskFunctions.get('fn2') |
399 | ) | |
400 | }) | |
c510fea7 | 401 | }) |