Merge branch 'master' into feature/task-functions
[poolifier.git] / tests / utils.test.js
index 0f72aa429fc5caae1494231f2bafaf7a3676b51b..5041f1028a49fcf598922aa307e481b94a8745a8 100644 (file)
-const { randomInt } = require('crypto')
+const { randomInt } = require('node:crypto')
+const { Worker } = require('node:worker_threads')
+const cluster = require('node:cluster')
+const os = require('node:os')
 const { expect } = require('expect')
 const {
   CircularArray,
   DEFAULT_CIRCULAR_ARRAY_SIZE
 } = require('../lib/circular-array')
 const {
+  DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+  DEFAULT_TASK_NAME,
+  DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS,
+  EMPTY_FUNCTION,
   availableParallelism,
   average,
   exponentialDelay,
+  getWorkerType,
+  getWorkerId,
   isAsyncFunction,
   isKillBehavior,
   isPlainObject,
+  max,
   median,
+  min,
   round,
   secureRandom,
   sleep,
   updateMeasurementStatistics
 } = require('../lib/utils')
-const { KillBehaviors } = require('../lib/worker/worker-options')
+const { KillBehaviors, WorkerTypes } = require('../lib')
 
 describe('Utils test suite', () => {
+  it('Verify DEFAULT_TASK_NAME value', () => {
+    expect(DEFAULT_TASK_NAME).toBe('default')
+  })
+
+  it('Verify EMPTY_FUNCTION value', () => {
+    expect(EMPTY_FUNCTION).toStrictEqual(expect.any(Function))
+  })
+
+  it('Verify DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS values', () => {
+    expect(DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS).toStrictEqual({
+      retries: 6,
+      runTime: { median: false },
+      waitTime: { median: false },
+      elu: { median: false }
+    })
+  })
+
+  it('Verify DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS values', () => {
+    expect(DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS).toStrictEqual({
+      aggregate: false,
+      average: false,
+      median: false
+    })
+  })
+
   it('Verify availableParallelism() behavior', () => {
-    expect(typeof availableParallelism() === 'number').toBe(true)
-    expect(availableParallelism()).toBeGreaterThan(0)
-    expect(Number.isSafeInteger(availableParallelism())).toBe(true)
+    const parallelism = availableParallelism()
+    expect(typeof parallelism === 'number').toBe(true)
+    expect(Number.isSafeInteger(parallelism)).toBe(true)
+    let expectedParallelism = 1
+    try {
+      expectedParallelism = os.availableParallelism()
+    } catch {
+      expectedParallelism = os.cpus().length
+    }
+    expect(parallelism).toBe(expectedParallelism)
+  })
+
+  it('Verify getWorkerType() behavior', () => {
+    expect(
+      getWorkerType(new Worker('./tests/worker-files/thread/testWorker.js'))
+    ).toBe(WorkerTypes.thread)
+    expect(getWorkerType(cluster.fork())).toBe(WorkerTypes.cluster)
+  })
+
+  it('Verify getWorkerId() behavior', () => {
+    const threadWorker = new Worker('./tests/worker-files/thread/testWorker.js')
+    const clusterWorker = cluster.fork()
+    expect(getWorkerId(threadWorker)).toBe(threadWorker.threadId)
+    expect(getWorkerId(clusterWorker)).toBe(clusterWorker.id)
   })
 
-  it.skip('Verify sleep() behavior', async () => {
+  it('Verify sleep() behavior', async () => {
     const start = performance.now()
     await sleep(1000)
     const elapsed = performance.now() - start
-    expect(elapsed).toBeGreaterThanOrEqual(1000)
+    expect(elapsed).toBeGreaterThanOrEqual(999)
   })
 
   it('Verify exponentialDelay() behavior', () => {
-    expect(typeof exponentialDelay(randomInt(1000)) === 'number').toBe(true)
-    expect(exponentialDelay(randomInt(1000))).toBeGreaterThanOrEqual(
-      Number.MIN_VALUE
-    )
-    expect(exponentialDelay(randomInt(1000))).toBeLessThanOrEqual(
-      Number.MAX_VALUE
-    )
+    const delay = exponentialDelay(randomInt(1000))
+    expect(typeof delay === 'number').toBe(true)
+    expect(delay).toBeGreaterThanOrEqual(Number.MIN_VALUE)
+    expect(delay).toBeLessThanOrEqual(Number.MAX_VALUE)
   })
 
   it('Verify average() computation', () => {
@@ -216,6 +270,41 @@ describe('Utils test suite', () => {
       average: 0.002,
       history: new CircularArray(DEFAULT_CIRCULAR_ARRAY_SIZE, 0.001, 0.003)
     })
+    updateMeasurementStatistics(
+      measurementStatistics,
+      { aggregate: true, average: false, median: true },
+      0.006
+    )
+    expect(measurementStatistics).toStrictEqual({
+      aggregate: 0.04,
+      maximum: 0.02,
+      minimum: 0.001,
+      median: 0.003,
+      history: new CircularArray(
+        DEFAULT_CIRCULAR_ARRAY_SIZE,
+        0.001,
+        0.003,
+        0.006
+      )
+    })
+    updateMeasurementStatistics(
+      measurementStatistics,
+      { aggregate: true, average: true, median: false },
+      0.01
+    )
+    expect(measurementStatistics).toStrictEqual({
+      aggregate: 0.05,
+      maximum: 0.02,
+      minimum: 0.001,
+      average: 0.005,
+      history: new CircularArray(
+        DEFAULT_CIRCULAR_ARRAY_SIZE,
+        0.001,
+        0.003,
+        0.006,
+        0.01
+      )
+    })
   })
 
   it('Verify secureRandom() behavior', () => {
@@ -224,4 +313,18 @@ describe('Utils test suite', () => {
     expect(randomNumber).toBeGreaterThanOrEqual(0)
     expect(randomNumber).toBeLessThan(1)
   })
+
+  it('Verify min() behavior', () => {
+    expect(min()).toBe(Infinity)
+    expect(min(1, 2)).toBe(1)
+    expect(min(2, 1)).toBe(1)
+    expect(min(1, 1)).toBe(1)
+  })
+
+  it('Verify max() behavior', () => {
+    expect(max()).toBe(-Infinity)
+    expect(max(1, 2)).toBe(2)
+    expect(max(2, 1)).toBe(2)
+    expect(max(1, 1)).toBe(1)
+  })
 })