docs: refine code comment
[poolifier.git] / src / utils.ts
index c8aed4421bb8f7f9a8262683b02cefa4b6a6ff5b..c568a29a049eda2de26cf9bd99d63e613294bc3f 100644 (file)
@@ -1,14 +1,7 @@
+import { getRandomValues } from 'node:crypto'
 import * as os from 'node:os'
-import { getRandomValues, randomInt } from 'node:crypto'
-import { Worker as ClusterWorker } from 'node:cluster'
-import { Worker as ThreadWorker } from 'node:worker_threads'
-import { cpus } from 'node:os'
-import type {
-  InternalWorkerChoiceStrategyOptions,
-  MeasurementStatisticsRequirements
-} from './pools/selection-strategies/selection-strategies-types.js'
+
 import type { KillBehavior } from './worker/worker-options.js'
-import { type IWorker, type WorkerType, WorkerTypes } from './pools/worker.js'
 
 /**
  * Default task name.
@@ -22,33 +15,6 @@ export const EMPTY_FUNCTION: () => void = Object.freeze(() => {
   /* Intentionally empty */
 })
 
-/**
- * Gets default worker choice strategy options.
- *
- * @param retries - The number of worker choice retries.
- * @returns The default worker choice strategy options.
- */
-const getDefaultInternalWorkerChoiceStrategyOptions = (
-  retries: number
-): InternalWorkerChoiceStrategyOptions => {
-  return {
-    retries,
-    runTime: { median: false },
-    waitTime: { median: false },
-    elu: { median: false }
-  }
-}
-
-/**
- * Default measurement statistics requirements.
- */
-export const DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS: MeasurementStatisticsRequirements =
-  {
-    aggregate: false,
-    average: false,
-    median: false
-  }
-
 /**
  * Returns safe host OS optimized estimate of the default amount of parallelism a pool should use.
  * Always returns a value greater than zero.
@@ -68,36 +34,6 @@ export const availableParallelism = (): number => {
   return availableParallelism
 }
 
-/**
- * Returns the worker type of the given worker.
- *
- * @param worker - The worker to get the type of.
- * @returns The worker type of the given worker.
- * @internal
- */
-export const getWorkerType = (worker: IWorker): WorkerType | undefined => {
-  if (worker instanceof ThreadWorker) {
-    return WorkerTypes.thread
-  } else if (worker instanceof ClusterWorker) {
-    return WorkerTypes.cluster
-  }
-}
-
-/**
- * Returns the worker id of the given worker.
- *
- * @param worker - The worker to get the id of.
- * @returns The worker id of the given worker.
- * @internal
- */
-export const getWorkerId = (worker: IWorker): number | undefined => {
-  if (worker instanceof ThreadWorker) {
-    return worker.threadId
-  } else if (worker instanceof ClusterWorker) {
-    return worker.id
-  }
-}
-
 /**
  * Sleeps for the given amount of milliseconds.
  *
@@ -138,8 +74,7 @@ export const exponentialDelay = (
 export const average = (dataSet: number[]): number => {
   if (Array.isArray(dataSet) && dataSet.length === 0) {
     return 0
-  }
-  if (Array.isArray(dataSet) && dataSet.length === 1) {
+  } else if (Array.isArray(dataSet) && dataSet.length === 1) {
     return dataSet[0]
   }
   return (
@@ -158,8 +93,7 @@ export const average = (dataSet: number[]): number => {
 export const median = (dataSet: number[]): number => {
   if (Array.isArray(dataSet) && dataSet.length === 0) {
     return 0
-  }
-  if (Array.isArray(dataSet) && dataSet.length === 1) {
+  } else if (Array.isArray(dataSet) && dataSet.length === 1) {
     return dataSet[0]
   }
   const sortedDataSet = dataSet.slice().sort((a, b) => a - b)
@@ -185,24 +119,24 @@ export const round = (num: number, scale = 2): number => {
 }
 
 /**
- * Is the given object a plain object?
+ * Is the given value a plain object?
  *
- * @param obj - The object to check.
- * @returns `true` if the given object is a plain object, `false` otherwise.
+ * @param value - The value to check.
+ * @returns `true` if the given value is a plain object, `false` otherwise.
  * @internal
  */
-export const isPlainObject = (obj: unknown): boolean =>
-  typeof obj === 'object' &&
-  obj !== null &&
-  obj?.constructor === Object &&
-  Object.prototype.toString.call(obj) === '[object Object]'
+export const isPlainObject = (value: unknown): value is object =>
+  typeof value === 'object' &&
+  value !== null &&
+  value.constructor === Object &&
+  Object.prototype.toString.call(value) === '[object Object]'
 
 /**
  * Detects whether the given value is a kill behavior or not.
  *
  * @typeParam KB - Which specific KillBehavior type to test against.
  * @param killBehavior - Which kind of kill behavior to detect.
- * @param value - Any value.
+ * @param value - Unknown value.
  * @returns `true` if `value` was strictly equals to `killBehavior`, otherwise `false`.
  * @internal
  */
@@ -216,7 +150,7 @@ export const isKillBehavior = <KB extends KillBehavior>(
 /**
  * Detects whether the given value is an asynchronous function or not.
  *
- * @param fn - Any value.
+ * @param fn - Unknown value.
  * @returns `true` if `fn` was an asynchronous function, otherwise `false`.
  * @internal
  */
@@ -264,69 +198,25 @@ export const max = (...args: number[]): number =>
  * @param fn - The function to wrap.
  * @param context - The context to bind the function to.
  * @returns The wrapped function.
+ *
+ * @typeParam A - The function's arguments.
+ * @typeParam R - The function's return value.
+ * @typeParam C - The function's context.
  * @internal
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-export const once = <T, A extends any[], R>(
+export const once = <A extends any[], R, C>(
   fn: (...args: A) => R,
-  context: T
+  context: C
 ): ((...args: A) => R) => {
   let result: R
   return (...args: A) => {
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     if (fn != null) {
-      result = fn.apply<T, A, R>(context, args)
+      result = fn.apply<C, A, R>(context, args)
       ;(fn as unknown as undefined) = (context as unknown as undefined) =
         undefined
     }
     return result
   }
 }
-
-const clone = <T>(object: T): T => {
-  return structuredClone<T>(object)
-}
-
-export const buildInternalWorkerChoiceStrategyOptions = (
-  poolMaxSize: number,
-  opts?: InternalWorkerChoiceStrategyOptions
-): InternalWorkerChoiceStrategyOptions => {
-  opts = clone(opts ?? {})
-  if (opts?.weights == null) {
-    opts.weights = getDefaultWeights(poolMaxSize)
-  }
-  return {
-    ...getDefaultInternalWorkerChoiceStrategyOptions(
-      poolMaxSize + Object.keys(opts.weights).length
-    ),
-    ...opts
-  }
-}
-
-const getDefaultWeights = (
-  poolMaxSize: number,
-  defaultWorkerWeight?: number
-): Record<number, number> => {
-  defaultWorkerWeight = defaultWorkerWeight ?? getDefaultWorkerWeight()
-  const weights: Record<number, number> = {}
-  for (let workerNodeKey = 0; workerNodeKey < poolMaxSize; workerNodeKey++) {
-    weights[workerNodeKey] = defaultWorkerWeight
-  }
-  return weights
-}
-
-const getDefaultWorkerWeight = (): number => {
-  const cpuSpeed = randomInt(500, 2500)
-  let cpusCycleTimeWeight = 0
-  for (const cpu of cpus()) {
-    if (cpu.speed == null || cpu.speed === 0) {
-      cpu.speed =
-        cpus().find(cpu => cpu.speed != null && cpu.speed !== 0)?.speed ??
-        cpuSpeed
-    }
-    // CPU estimated cycle time
-    const numberOfDigits = cpu.speed.toString().length - 1
-    const cpuCycleTime = 1 / (cpu.speed / Math.pow(10, numberOfDigits))
-    cpusCycleTimeWeight += cpuCycleTime * Math.pow(10, numberOfDigits)
-  }
-  return Math.round(cpusCycleTimeWeight / cpus().length)
-}