test: add test for worker task function object

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

diff --git a/tests/worker/abstract-worker.test.mjs b/tests/worker/abstract-worker.test.mjs
index df844eef9a9cc72c5bac6c8749f95f8b42bb3d5c..ee89911ce5b15bbe83075b94db38a3d1769fc370 100644 (file)
--- a/tests/worker/abstract-worker.test.mjs
+++ b/tests/worker/abstract-worker.test.mjs
@@ -1,7 +1,13 @@
 import { expect } from 'expect'
 import { restore, stub } from 'sinon'
-import { ClusterWorker, KillBehaviors, ThreadWorker } from '../../lib/index.js'
-import { DEFAULT_TASK_NAME, EMPTY_FUNCTION } from '../../lib/utils.js'
+
+import {
+  ClusterWorker,
+  KillBehaviors,
+  ThreadWorker,
+  WorkerChoiceStrategies
+} from '../../lib/index.cjs'
+import { DEFAULT_TASK_NAME, EMPTY_FUNCTION } from '../../lib/utils.cjs'
 
 describe('Abstract worker test suite', () => {
   class StubWorkerWithMainWorker extends ThreadWorker {
@@ -25,44 +31,37 @@ describe('Abstract worker test suite', () => {
   })
 
   it('Verify that worker options are checked at worker creation', () => {
-    expect(() => new ClusterWorker(() => {}, '')).toThrowError(
+    expect(() => new ClusterWorker(() => {}, '')).toThrow(
       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(
+    expect(() => new ClusterWorker(() => {}, { killBehavior: '' })).toThrow(
+      new TypeError("killBehavior option '' is not valid")
+    )
+    expect(() => new ClusterWorker(() => {}, { killBehavior: 0 })).toThrow(
       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(
+    expect(() => new ThreadWorker(() => {}, { maxInactiveTime: '' })).toThrow(
+      new TypeError('maxInactiveTime option is not an integer')
+    )
+    expect(() => new ThreadWorker(() => {}, { maxInactiveTime: 0.5 })).toThrow(
+      new TypeError('maxInactiveTime option is not an integer')
+    )
+    expect(() => new ThreadWorker(() => {}, { maxInactiveTime: 0 })).toThrow(
       new TypeError(
         'maxInactiveTime option is not a positive integer greater or equal than 5'
       )
     )
-    expect(
-      () => new ThreadWorker(() => {}, { maxInactiveTime: 4 })
-    ).toThrowError(
+    expect(() => new ThreadWorker(() => {}, { maxInactiveTime: 4 })).toThrow(
       new TypeError(
         'maxInactiveTime option is not a positive integer greater or equal than 5'
       )
     )
-    expect(() => new ThreadWorker(() => {}, { killHandler: '' })).toThrowError(
+    expect(() => new ThreadWorker(() => {}, { killHandler: '' })).toThrow(
       new TypeError('killHandler option is not a function')
     )
-    expect(() => new ThreadWorker(() => {}, { killHandler: 0 })).toThrowError(
+    expect(() => new ThreadWorker(() => {}, { killHandler: 0 })).toThrow(
       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', () => {
@@ -82,48 +81,48 @@ describe('Abstract worker test suite', () => {
   })
 
   it('Verify that taskFunctions parameter is mandatory', () => {
-    expect(() => new ClusterWorker()).toThrowError(
+    expect(() => new ClusterWorker()).toThrow(
       new Error('taskFunctions parameter is mandatory')
     )
   })
 
   it('Verify that taskFunctions parameter is a function or a plain object', () => {
-    expect(() => new ClusterWorker(0)).toThrowError(
+    expect(() => new ClusterWorker(0)).toThrow(
       new TypeError(
         'taskFunctions parameter is not a function or a plain object'
       )
     )
-    expect(() => new ClusterWorker('')).toThrowError(
+    expect(() => new ClusterWorker('')).toThrow(
       new TypeError(
         'taskFunctions parameter is not a function or a plain object'
       )
     )
-    expect(() => new ClusterWorker(true)).toThrowError(
+    expect(() => new ClusterWorker(true)).toThrow(
       new TypeError(
         'taskFunctions parameter is not a function or a plain object'
       )
     )
-    expect(() => new ClusterWorker([])).toThrowError(
+    expect(() => new ClusterWorker([])).toThrow(
       new TypeError(
         'taskFunctions parameter is not a function or a plain object'
       )
     )
-    expect(() => new ClusterWorker(new Map())).toThrowError(
+    expect(() => new ClusterWorker(new Map())).toThrow(
       new TypeError(
         'taskFunctions parameter is not a function or a plain object'
       )
     )
-    expect(() => new ClusterWorker(new Set())).toThrowError(
+    expect(() => new ClusterWorker(new Set())).toThrow(
       new TypeError(
         'taskFunctions parameter is not a function or a plain object'
       )
     )
-    expect(() => new ClusterWorker(new WeakMap())).toThrowError(
+    expect(() => new ClusterWorker(new WeakMap())).toThrow(
       new TypeError(
         'taskFunctions parameter is not a function or a plain object'
       )
     )
-    expect(() => new ClusterWorker(new WeakSet())).toThrowError(
+    expect(() => new ClusterWorker(new WeakSet())).toThrow(
       new TypeError(
         'taskFunctions parameter is not a function or a plain object'
       )
@@ -131,15 +130,15 @@ describe('Abstract worker test suite', () => {
   })
 
   it('Verify that taskFunctions parameter is not an empty object', () => {
-    expect(() => new ClusterWorker({})).toThrowError(
+    expect(() => new ClusterWorker({})).toThrow(
       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_TASK_NAME)).toBeInstanceOf(Function)
-    expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function)
+    expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Object)
+    expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Object)
     expect(worker.taskFunctions.size).toBe(2)
     expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual(
       worker.taskFunctions.get('fn1')
@@ -151,11 +150,40 @@ describe('Abstract worker test suite', () => {
       return 1
     }
     const fn2 = ''
-    expect(() => new ThreadWorker({ '': fn1 })).toThrowError(
+    expect(() => new ThreadWorker({ '': fn1 })).toThrow(
       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')
+    expect(() => new ThreadWorker({ fn1, fn2 })).toThrow(
+      new TypeError(
+        "taskFunction object 'taskFunction' property 'undefined' is not a function"
+      )
+    )
+    expect(() => new ThreadWorker({ fn1: { fn1 } })).toThrow(
+      new TypeError(
+        "taskFunction object 'taskFunction' property 'undefined' is not a function"
+      )
+    )
+    expect(() => new ThreadWorker({ fn2: { taskFunction: fn2 } })).toThrow(
+      new TypeError(
+        "taskFunction object 'taskFunction' property '' is not a function"
+      )
+    )
+    expect(
+      () => new ThreadWorker({ fn1: { taskFunction: fn1, priority: '' } })
+    ).toThrow(new TypeError("Invalid priority ''"))
+    expect(
+      () => new ThreadWorker({ fn1: { taskFunction: fn1, priority: -21 } })
+    ).toThrow(new TypeError('Property priority must be between -20 and 19'))
+    expect(
+      () => new ThreadWorker({ fn1: { taskFunction: fn1, priority: 20 } })
+    ).toThrow(new RangeError('Property priority must be between -20 and 19'))
+    expect(
+      () =>
+        new ThreadWorker({
+          fn1: { taskFunction: fn1, strategy: 'invalidStrategy' }
+        })
+    ).toThrow(
+      new RangeError("Invalid worker choice strategy 'invalidStrategy'")
     )
   })
 
@@ -167,9 +195,36 @@ describe('Abstract worker test suite', () => {
       return 2
     }
     const worker = new ClusterWorker({ fn1, fn2 })
-    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.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Object)
+    expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Object)
+    expect(worker.taskFunctions.get('fn2')).toBeInstanceOf(Object)
+    expect(worker.taskFunctions.size).toBe(3)
+    expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual(
+      worker.taskFunctions.get('fn1')
+    )
+  })
+
+  it('Verify that taskFunctions parameter with multiple task functions object is taken', () => {
+    const fn1Obj = {
+      taskFunction: () => {
+        return 1
+      },
+      priority: 5
+    }
+    const fn2Obj = {
+      taskFunction: () => {
+        return 2
+      },
+      priority: 6,
+      strategy: WorkerChoiceStrategies.LESS_BUSY
+    }
+    const worker = new ThreadWorker({
+      fn1: fn1Obj,
+      fn2: fn2Obj
+    })
+    expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual(fn1Obj)
+    expect(worker.taskFunctions.get('fn1')).toStrictEqual(fn1Obj)
+    expect(worker.taskFunctions.get('fn2')).toStrictEqual(fn2Obj)
     expect(worker.taskFunctions.size).toBe(3)
     expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual(
       worker.taskFunctions.get('fn1')
@@ -189,7 +244,7 @@ describe('Abstract worker test suite', () => {
   it('Verify that getMainWorker() throw error if main worker is not set', () => {
     expect(() =>
       new StubWorkerWithMainWorker(() => {}).getMainWorker()
-    ).toThrowError('Main worker not set')
+    ).toThrow('Main worker not set')
   })
 
   it('Verify that hasTaskFunction() is working', () => {
@@ -237,10 +292,12 @@ describe('Abstract worker test suite', () => {
     })
     expect(worker.addTaskFunction('fn3', '')).toStrictEqual({
       status: false,
-      error: new TypeError('fn parameter is not a function')
+      error: new TypeError(
+        "taskFunction object 'taskFunction' property 'undefined' is not a function"
+      )
     })
-    expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Function)
-    expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Function)
+    expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Object)
+    expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Object)
     expect(worker.taskFunctions.size).toBe(2)
     expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual(
       worker.taskFunctions.get('fn1')
@@ -252,17 +309,17 @@ describe('Abstract worker test suite', () => {
       )
     })
     worker.addTaskFunction('fn2', fn2)
-    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.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Object)
+    expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Object)
+    expect(worker.taskFunctions.get('fn2')).toBeInstanceOf(Object)
     expect(worker.taskFunctions.size).toBe(3)
     expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual(
       worker.taskFunctions.get('fn1')
     )
     worker.addTaskFunction('fn1', fn1Replacement)
-    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.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Object)
+    expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Object)
+    expect(worker.taskFunctions.get('fn2')).toBeInstanceOf(Object)
     expect(worker.taskFunctions.size).toBe(3)
     expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual(
       worker.taskFunctions.get('fn1')
@@ -277,10 +334,10 @@ describe('Abstract worker test suite', () => {
       return 2
     }
     const worker = new ClusterWorker({ fn1, fn2 })
-    expect(worker.listTaskFunctionNames()).toStrictEqual([
-      DEFAULT_TASK_NAME,
-      'fn1',
-      'fn2'
+    expect(worker.listTaskFunctionsProperties()).toStrictEqual([
+      { name: DEFAULT_TASK_NAME },
+      { name: 'fn1' },
+      { name: 'fn2' }
     ])
   })
 
@@ -300,9 +357,9 @@ describe('Abstract worker test suite', () => {
       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.get(DEFAULT_TASK_NAME)).toBeInstanceOf(Object)
+    expect(worker.taskFunctions.get('fn1')).toBeInstanceOf(Object)
+    expect(worker.taskFunctions.get('fn2')).toBeInstanceOf(Object)
     expect(worker.taskFunctions.size).toBe(3)
     expect(worker.taskFunctions.get(DEFAULT_TASK_NAME)).toStrictEqual(
       worker.taskFunctions.get('fn1')