X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils.ts;h=45e4fd2393d0533a5256754eec9075666a7f7ea1;hb=c4424e52e4924efa5eef704cb5dcb82f2760e0da;hp=403fed951bb21f7af0474b65cc8a02fbec6d5a78;hpb=4a45e8d2e79023615e5c5a3ea4b1c6a5e5cf963f;p=poolifier.git

diff --git a/src/utils.ts b/src/utils.ts
index 403fed95..45e4fd23 100644
--- a/src/utils.ts
+++ b/src/utils.ts
@@ -1,4 +1,15 @@
-import type { WorkerChoiceStrategyOptions } from './pools/selection-strategies/selection-strategies-types'
+import * as os from 'node:os'
+import type {
+  MeasurementStatisticsRequirements,
+  WorkerChoiceStrategyOptions
+} from './pools/selection-strategies/selection-strategies-types'
+import type { KillBehavior } from './worker/worker-options'
+import type { MeasurementStatistics } from './pools/worker'
+
+/**
+ * Default task name.
+ */
+export const DEFAULT_TASK_NAME = 'default'
 
 /**
  * An intentional empty function.
@@ -12,11 +23,42 @@ export const EMPTY_FUNCTION: () => void = Object.freeze(() => {
  */
 export const DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS: WorkerChoiceStrategyOptions =
   {
-    medRunTime: false
+    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
   }
 
 /**
- * Compute the median of the given data set.
+ * Returns safe host OS optimized estimate of the default amount of parallelism a pool should use.
+ * Always returns a value greater than zero.
+ *
+ * @returns The host OS optimized maximum pool size.
+ */
+export const availableParallelism = (): number => {
+  let availableParallelism = 1
+  try {
+    availableParallelism = os.availableParallelism()
+  } catch {
+    const numberOfCpus = os.cpus()
+    if (Array.isArray(numberOfCpus) && numberOfCpus.length > 0) {
+      availableParallelism = numberOfCpus.length
+    }
+  }
+  return availableParallelism
+}
+
+/**
+ * Computes the median of the given data set.
  *
  * @param dataSet - Data set.
  * @returns The median of the given data set.
@@ -28,12 +70,98 @@ export const median = (dataSet: number[]): number => {
   if (Array.isArray(dataSet) && dataSet.length === 1) {
     return dataSet[0]
   }
-  dataSet = dataSet.slice().sort((a, b) => a - b)
-  return (dataSet[(dataSet.length - 1) >> 1] + dataSet[dataSet.length >> 1]) / 2
+  const sortedDataSet = dataSet.slice().sort((a, b) => a - b)
+  return (
+    (sortedDataSet[(sortedDataSet.length - 1) >> 1] +
+      sortedDataSet[sortedDataSet.length >> 1]) /
+    2
+  )
+}
+
+/**
+ * Rounds the given number to the given scale.
+ * The rounding is done using the "round half away from zero" method.
+ *
+ * @param num - The number to round.
+ * @param scale - The scale to round to.
+ * @returns The rounded number.
+ */
+export const round = (num: number, scale = 2): number => {
+  const rounder = Math.pow(10, scale)
+  return Math.round(num * rounder * (1 + Number.EPSILON)) / rounder
 }
 
+/**
+ * Is the given object a plain object?
+ *
+ * @param obj - The object to check.
+ * @returns `true` if the given object is a plain object, `false` otherwise.
+ */
 export const isPlainObject = (obj: unknown): boolean =>
   typeof obj === 'object' &&
   obj !== null &&
   obj?.constructor === Object &&
   Object.prototype.toString.call(obj) === '[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.
+ * @returns `true` if `value` was strictly equals to `killBehavior`, otherwise `false`.
+ */
+export const isKillBehavior = <KB extends KillBehavior>(
+  killBehavior: KB,
+  value: unknown
+): value is KB => {
+  return value === killBehavior
+}
+
+/**
+ * Detects whether the given value is an asynchronous function or not.
+ *
+ * @param fn - Any value.
+ * @returns `true` if `fn` was an asynchronous function, otherwise `false`.
+ */
+export const isAsyncFunction = (
+  fn: unknown
+): fn is (...args: unknown[]) => Promise<unknown> => {
+  return typeof fn === 'function' && fn.constructor.name === 'AsyncFunction'
+}
+
+/**
+ * Updates the given measurement statistics.
+ *
+ * @param measurementStatistics - The measurement statistics to update.
+ * @param measurementRequirements - The measurement statistics requirements.
+ * @param measurementValue - The measurement value.
+ * @param numberOfMeasurements - The number of measurements.
+ */
+export const updateMeasurementStatistics = (
+  measurementStatistics: MeasurementStatistics,
+  measurementRequirements: MeasurementStatisticsRequirements,
+  measurementValue: number,
+  numberOfMeasurements: number
+): void => {
+  if (measurementRequirements.aggregate) {
+    measurementStatistics.aggregate =
+      (measurementStatistics.aggregate ?? 0) + measurementValue
+    measurementStatistics.minimum = Math.min(
+      measurementValue,
+      measurementStatistics.minimum ?? Infinity
+    )
+    measurementStatistics.maximum = Math.max(
+      measurementValue,
+      measurementStatistics.maximum ?? -Infinity
+    )
+    if (measurementRequirements.average && numberOfMeasurements !== 0) {
+      measurementStatistics.average =
+        measurementStatistics.aggregate / numberOfMeasurements
+    }
+    if (measurementRequirements.median && measurementValue != null) {
+      measurementStatistics.history.push(measurementValue)
+      measurementStatistics.median = median(measurementStatistics.history)
+    }
+  }
+}