build(deps-dev): apply updates
[poolifier.git] / benchmarks / benchmarks-utils.js
index 50dcc40c6edaff1a45d885c7c0dd5d531efe3ae6..a0a42b95d06642cbb8e7aeb282c06e7f20720b16 100644 (file)
@@ -1,18 +1,66 @@
-const fs = require('fs')
+const { randomInt } = require('node:crypto')
+const { strictEqual } = require('node:assert')
 const {
-  PoolTypes,
-  WorkerFunctions,
-  WorkerTypes
-} = require('./benchmarks-types')
+  existsSync,
+  mkdirSync,
+  readFileSync,
+  rmSync,
+  writeFileSync
+} = require('node:fs')
+const Benchmark = require('benchmark')
 const {
   DynamicClusterPool,
   DynamicThreadPool,
   FixedClusterPool,
-  FixedThreadPool
-} = require('../lib')
+  FixedThreadPool,
+  Measurements,
+  PoolTypes,
+  WorkerChoiceStrategies,
+  WorkerTypes
+} = require('../lib/index.js')
+const { TaskFunctions } = require('./benchmarks-types.js')
+
+const buildPoolifierPool = (workerType, poolType, poolSize, poolOptions) => {
+  switch (poolType) {
+    case PoolTypes.fixed:
+      switch (workerType) {
+        case WorkerTypes.thread:
+          return new FixedThreadPool(
+            poolSize,
+            './benchmarks/internal/thread-worker.mjs',
+            poolOptions
+          )
+        case WorkerTypes.cluster:
+          return new FixedClusterPool(
+            poolSize,
+            './benchmarks/internal/cluster-worker.js',
+            poolOptions
+          )
+      }
+      break
+    case PoolTypes.dynamic:
+      switch (workerType) {
+        case WorkerTypes.thread:
+          return new DynamicThreadPool(
+            Math.floor(poolSize / 2),
+            poolSize,
+            './benchmarks/internal/thread-worker.mjs',
+            poolOptions
+          )
+        case WorkerTypes.cluster:
+          return new DynamicClusterPool(
+            Math.floor(poolSize / 2),
+            poolSize,
+            './benchmarks/internal/cluster-worker.js',
+            poolOptions
+          )
+      }
+      break
+  }
+}
 
-async function runTest (pool, { taskExecutions, workerData }) {
-  return new Promise((resolve, reject) => {
+const runPoolifierPool = async (pool, { taskExecutions, workerData }) => {
+  return await new Promise((resolve, reject) => {
     let executions = 0
     for (let i = 1; i <= taskExecutions; i++) {
       pool
@@ -20,19 +68,125 @@ async function runTest (pool, { taskExecutions, workerData }) {
         .then(() => {
           ++executions
           if (executions === taskExecutions) {
-            return resolve({ ok: 1 })
+            resolve({ ok: 1 })
           }
-          return null
+          return undefined
         })
         .catch(err => {
           console.error(err)
-          return reject(err)
+          reject(err)
         })
     }
   })
 }
 
-function generateRandomInteger (max = Number.MAX_SAFE_INTEGER, min = 0) {
+const runPoolifierPoolBenchmark = async (
+  name,
+  workerType,
+  poolType,
+  poolSize,
+  { taskExecutions, workerData }
+) => {
+  return await new Promise((resolve, reject) => {
+    const pool = buildPoolifierPool(workerType, poolType, poolSize)
+    const suite = new Benchmark.Suite(name)
+    try {
+      for (const workerChoiceStrategy of Object.values(
+        WorkerChoiceStrategies
+      )) {
+        for (const enableTasksQueue of [false, true]) {
+          if (workerChoiceStrategy === WorkerChoiceStrategies.FAIR_SHARE) {
+            for (const measurement of [
+              Measurements.runTime,
+              Measurements.elu
+            ]) {
+              suite.add(
+                `${name} with ${workerChoiceStrategy}, with ${measurement} and ${
+                  enableTasksQueue ? 'with' : 'without'
+                } tasks queue`,
+                async () => {
+                  pool.setWorkerChoiceStrategy(workerChoiceStrategy, {
+                    measurement
+                  })
+                  pool.enableTasksQueue(enableTasksQueue)
+                  strictEqual(
+                    pool.opts.workerChoiceStrategy,
+                    workerChoiceStrategy
+                  )
+                  strictEqual(pool.opts.enableTasksQueue, enableTasksQueue)
+                  strictEqual(
+                    pool.opts.workerChoiceStrategyOptions.measurement,
+                    measurement
+                  )
+                  await runPoolifierPool(pool, {
+                    taskExecutions,
+                    workerData
+                  })
+                }
+              )
+            }
+          } else {
+            suite.add(
+              `${name} with ${workerChoiceStrategy} and ${
+                enableTasksQueue ? 'with' : 'without'
+              } tasks queue`,
+              async () => {
+                pool.setWorkerChoiceStrategy(workerChoiceStrategy)
+                pool.enableTasksQueue(enableTasksQueue)
+                strictEqual(
+                  pool.opts.workerChoiceStrategy,
+                  workerChoiceStrategy
+                )
+                strictEqual(pool.opts.enableTasksQueue, enableTasksQueue)
+                await runPoolifierPool(pool, {
+                  taskExecutions,
+                  workerData
+                })
+              }
+            )
+          }
+        }
+      }
+      suite
+        .on('cycle', event => {
+          console.info(event.target.toString())
+        })
+        .on('complete', function () {
+          console.info(
+            'Fastest is ' +
+              LIST_FORMATTER.format(this.filter('fastest').map('name'))
+          )
+          const destroyTimeout = setTimeout(() => {
+            console.error('Pool destroy timeout reached (30s)')
+            resolve()
+          }, 30000)
+          pool
+            .destroy()
+            .then(resolve)
+            .catch(reject)
+            .finally(() => {
+              clearTimeout(destroyTimeout)
+            })
+            .catch(() => {})
+        })
+        .run({ async: true })
+    } catch (error) {
+      pool
+        .destroy()
+        .then(() => {
+          return reject(error)
+        })
+        .catch(() => {})
+    }
+  })
+}
+
+const LIST_FORMATTER = new Intl.ListFormat('en-US', {
+  style: 'long',
+  type: 'conjunction'
+})
+
+const generateRandomInteger = (max = Number.MAX_SAFE_INTEGER, min = 0) => {
   if (max < min || max < 0 || min < 0) {
     throw new RangeError('Invalid interval')
   }
@@ -44,113 +198,76 @@ function generateRandomInteger (max = Number.MAX_SAFE_INTEGER, min = 0) {
   return Math.floor(Math.random() * (max + 1))
 }
 
-function jsonIntegerSerialization (n) {
+const jsonIntegerSerialization = n => {
   for (let i = 0; i < n; i++) {
     const o = {
       a: i
     }
     JSON.stringify(o)
   }
+  return { ok: 1 }
 }
 
 /**
  * Intentionally inefficient implementation.
- *
  * @param {number} n - The number of fibonacci numbers to generate.
  * @returns {number} - The nth fibonacci number.
  */
-function fibonacci (n) {
-  if (n <= 1) return 1
+const fibonacci = n => {
+  if (n <= 1) return n
   return fibonacci(n - 1) + fibonacci(n - 2)
 }
 
 /**
  * Intentionally inefficient implementation.
- *
  * @param {number} n - The number to calculate the factorial of.
  * @returns {number} - The factorial of n.
  */
-function factorial (n) {
+const factorial = n => {
   if (n === 0) {
     return 1
   }
   return factorial(n - 1) * n
 }
 
-function readWriteFiles (n) {
-  const baseDirectory = '/tmp/poolifier-benchmarks'
-  if (fs.existsSync(baseDirectory) === false) {
-    fs.mkdirSync(baseDirectory, { recursive: true })
+const readWriteFiles = (
+  n,
+  baseDirectory = `/tmp/poolifier-benchmarks/${randomInt(281474976710655)}`
+) => {
+  if (existsSync(baseDirectory) === true) {
+    rmSync(baseDirectory, { recursive: true })
   }
+  mkdirSync(baseDirectory, { recursive: true })
   for (let i = 0; i < n; i++) {
     const filePath = `${baseDirectory}/${i}`
-    fs.writeFileSync(filePath, i.toString(), {
+    writeFileSync(filePath, i.toString(), {
       encoding: 'utf8',
       flag: 'a'
     })
-    fs.readFileSync(filePath, 'utf8')
+    readFileSync(filePath, 'utf8')
   }
+  rmSync(baseDirectory, { recursive: true })
+  return { ok: 1 }
 }
 
-function executeWorkerFunction (data) {
+const executeTaskFunction = data => {
   switch (data.function) {
-    case WorkerFunctions.jsonIntegerSerialization:
+    case TaskFunctions.jsonIntegerSerialization:
       return jsonIntegerSerialization(data.taskSize || 1000)
-    case WorkerFunctions.fibonacci:
+    case TaskFunctions.fibonacci:
       return fibonacci(data.taskSize || 1000)
-    case WorkerFunctions.factorial:
+    case TaskFunctions.factorial:
       return factorial(data.taskSize || 1000)
-    case WorkerFunctions.readWriteFiles:
+    case TaskFunctions.readWriteFiles:
       return readWriteFiles(data.taskSize || 1000)
     default:
-      throw new Error('Unknown worker function')
-  }
-}
-
-function buildPool (poolType, poolSize, workerType, poolOptions) {
-  switch (poolType) {
-    case PoolTypes.FIXED:
-      switch (workerType) {
-        case WorkerTypes.THREAD:
-          return new FixedThreadPool(
-            poolSize,
-            './benchmarks/internal/thread-worker.js',
-            poolOptions
-          )
-        case WorkerTypes.CLUSTER:
-          return new FixedClusterPool(
-            poolSize,
-            './benchmarks/internal/cluster-worker.js',
-            poolOptions
-          )
-      }
-      break
-    case PoolTypes.DYNAMIC:
-      switch (workerType) {
-        case WorkerTypes.THREAD:
-          return new DynamicThreadPool(
-            poolSize / 2,
-            poolSize * 3,
-            './benchmarks/internal/thread-worker.js',
-            poolOptions
-          )
-        case WorkerTypes.CLUSTER:
-          return new DynamicClusterPool(
-            poolSize / 2,
-            poolSize * 3,
-            './benchmarks/internal/cluster-worker.js',
-            poolOptions
-          )
-      }
-      break
+      throw new Error('Unknown task function')
   }
 }
 
 module.exports = {
-  WorkerFunctions,
-  buildPool,
-  executeWorkerFunction,
+  LIST_FORMATTER,
+  executeTaskFunction,
   generateRandomInteger,
-  readWriteFiles,
-  runTest
+  runPoolifierPoolBenchmark
 }