Merge branch 'master' into feature/task-functions
[poolifier.git] / tests / utils.test.js
index f62d49c68af0a9a3a187cbf06d7899b7685cc829..5041f1028a49fcf598922aa307e481b94a8745a8 100644 (file)
+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 { isPlainObject, median, availableParallelism } = require('../lib/utils')
 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,
-  KillBehaviors
-} = require('../lib/worker/worker-options')
+  isPlainObject,
+  max,
+  median,
+  min,
+  round,
+  secureRandom,
+  sleep,
+  updateMeasurementStatistics
+} = require('../lib/utils')
+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', () => {
+    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('Verify sleep() behavior', async () => {
+    const start = performance.now()
+    await sleep(1000)
+    const elapsed = performance.now() - start
+    expect(elapsed).toBeGreaterThanOrEqual(999)
+  })
+
+  it('Verify exponentialDelay() behavior', () => {
+    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', () => {
+    expect(average([])).toBe(0)
+    expect(average([0.08])).toBe(0.08)
+    expect(average([0.25, 4.75, 3.05, 6.04, 1.01, 2.02, 5.03])).toBe(
+      3.1642857142857146
+    )
+    expect(average([0.25, 4.75, 3.05, 6.04, 1.01, 2.02])).toBe(
+      2.8533333333333335
+    )
+  })
+
   it('Verify median() computation', () => {
     expect(median([])).toBe(0)
     expect(median([0.08])).toBe(0.08)
@@ -13,6 +115,20 @@ describe('Utils test suite', () => {
     expect(median([0.25, 4.75, 3.05, 6.04, 1.01, 2.02])).toBe(2.535)
   })
 
+  it('Verify round() behavior', () => {
+    expect(round(0)).toBe(0)
+    expect(round(0.5, 0)).toBe(1)
+    expect(round(0.5)).toBe(0.5)
+    expect(round(-0.5, 0)).toBe(-1)
+    expect(round(-0.5)).toBe(-0.5)
+    expect(round(1.005)).toBe(1.01)
+    expect(round(2.175)).toBe(2.18)
+    expect(round(5.015)).toBe(5.02)
+    expect(round(-1.005)).toBe(-1.01)
+    expect(round(-2.175)).toBe(-2.18)
+    expect(round(-5.015)).toBe(-5.02)
+  })
+
   it('Verify isPlainObject() behavior', () => {
     expect(isPlainObject(null)).toBe(false)
     expect(isPlainObject(undefined)).toBe(false)
@@ -58,10 +174,157 @@ describe('Utils test suite', () => {
     expect(isKillBehavior(KillBehaviors.SOFT)).toBe(false)
     expect(isKillBehavior(KillBehaviors.HARD)).toBe(false)
     expect(isKillBehavior(KillBehaviors.HARD, null)).toBe(false)
+    expect(isKillBehavior(KillBehaviors.HARD, undefined)).toBe(false)
     expect(isKillBehavior(KillBehaviors.SOFT, 'unknown')).toBe(false)
   })
 
-  it('Verify availableParallelism() behavior', () => {
-    expect(typeof availableParallelism() === 'number').toBe(true)
+  it('Verify isAsyncFunction() behavior', () => {
+    expect(isAsyncFunction(null)).toBe(false)
+    expect(isAsyncFunction(undefined)).toBe(false)
+    expect(isAsyncFunction(true)).toBe(false)
+    expect(isAsyncFunction(false)).toBe(false)
+    expect(isAsyncFunction(0)).toBe(false)
+    expect(isAsyncFunction('')).toBe(false)
+    expect(isAsyncFunction([])).toBe(false)
+    expect(isAsyncFunction(new Date())).toBe(false)
+    expect(isAsyncFunction(new RegExp())).toBe(false)
+    expect(isAsyncFunction(new Error())).toBe(false)
+    expect(isAsyncFunction(new Map())).toBe(false)
+    expect(isAsyncFunction(new Set())).toBe(false)
+    expect(isAsyncFunction(new WeakMap())).toBe(false)
+    expect(isAsyncFunction(new WeakSet())).toBe(false)
+    expect(isAsyncFunction(new Int8Array())).toBe(false)
+    expect(isAsyncFunction(new Uint8Array())).toBe(false)
+    expect(isAsyncFunction(new Uint8ClampedArray())).toBe(false)
+    expect(isAsyncFunction(new Int16Array())).toBe(false)
+    expect(isAsyncFunction(new Uint16Array())).toBe(false)
+    expect(isAsyncFunction(new Int32Array())).toBe(false)
+    expect(isAsyncFunction(new Uint32Array())).toBe(false)
+    expect(isAsyncFunction(new Float32Array())).toBe(false)
+    expect(isAsyncFunction(new Float64Array())).toBe(false)
+    expect(isAsyncFunction(new BigInt64Array())).toBe(false)
+    expect(isAsyncFunction(new BigUint64Array())).toBe(false)
+    expect(isAsyncFunction(new Promise(() => {}))).toBe(false)
+    expect(isAsyncFunction(new WeakRef({}))).toBe(false)
+    expect(isAsyncFunction(new FinalizationRegistry(() => {}))).toBe(false)
+    expect(isAsyncFunction(new ArrayBuffer())).toBe(false)
+    expect(isAsyncFunction(new SharedArrayBuffer())).toBe(false)
+    expect(isAsyncFunction(new DataView(new ArrayBuffer()))).toBe(false)
+    expect(isAsyncFunction({})).toBe(false)
+    expect(isAsyncFunction({ a: 1 })).toBe(false)
+    expect(isAsyncFunction(() => {})).toBe(false)
+    expect(isAsyncFunction(function () {})).toBe(false)
+    expect(isAsyncFunction(function named () {})).toBe(false)
+    expect(isAsyncFunction(async () => {})).toBe(true)
+    expect(isAsyncFunction(async function () {})).toBe(true)
+    expect(isAsyncFunction(async function named () {})).toBe(true)
+  })
+
+  it('Verify updateMeasurementStatistics() behavior', () => {
+    const measurementStatistics = {
+      history: new CircularArray()
+    }
+    updateMeasurementStatistics(
+      measurementStatistics,
+      { aggregate: true, average: false, median: false },
+      0.01
+    )
+    expect(measurementStatistics).toStrictEqual({
+      aggregate: 0.01,
+      maximum: 0.01,
+      minimum: 0.01,
+      history: new CircularArray()
+    })
+    updateMeasurementStatistics(
+      measurementStatistics,
+      { aggregate: true, average: false, median: false },
+      0.02
+    )
+    expect(measurementStatistics).toStrictEqual({
+      aggregate: 0.03,
+      maximum: 0.02,
+      minimum: 0.01,
+      history: new CircularArray()
+    })
+    updateMeasurementStatistics(
+      measurementStatistics,
+      { aggregate: true, average: true, median: false },
+      0.001
+    )
+    expect(measurementStatistics).toStrictEqual({
+      aggregate: 0.031,
+      maximum: 0.02,
+      minimum: 0.001,
+      average: 0.001,
+      history: new CircularArray(DEFAULT_CIRCULAR_ARRAY_SIZE, 0.001)
+    })
+    updateMeasurementStatistics(
+      measurementStatistics,
+      { aggregate: true, average: true, median: false },
+      0.003
+    )
+    expect(measurementStatistics).toStrictEqual({
+      aggregate: 0.034,
+      maximum: 0.02,
+      minimum: 0.001,
+      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', () => {
+    const randomNumber = secureRandom()
+    expect(typeof randomNumber === 'number').toBe(true)
+    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)
   })
 })