Merge pull request #878 from poolifier/dependabot/npm_and_yarn/examples/typescript...

[poolifier.git] / src / utils.ts

diff --git a/src/utils.ts b/src/utils.ts
index f3952ab1746f559e780774b61520e099d7cdc310..efd1f124084776667bd60495f202cec32c7e04a9 100644 (file)
--- a/src/utils.ts
+++ b/src/utils.ts
@@ -1,9 +1,15 @@
-import os from 'node:os'
+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.
@@ -17,6 +23,7 @@ export const EMPTY_FUNCTION: () => void = Object.freeze(() => {
  */
 export const DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS: WorkerChoiceStrategyOptions =
   {
+    choiceRetries: 6,
     runTime: { median: false },
     waitTime: { median: false },
     elu: { median: false }
@@ -43,14 +50,30 @@ export const availableParallelism = (): number => {
   try {
     availableParallelism = os.availableParallelism()
   } catch {
-    const cpus = os.cpus()
-    if (Array.isArray(cpus) && cpus.length > 0) {
-      availableParallelism = cpus.length
+    const numberOfCpus = os.cpus()
+    if (Array.isArray(numberOfCpus) && numberOfCpus.length > 0) {
+      availableParallelism = numberOfCpus.length
     }
   }
   return availableParallelism
 }
 
+// /**
+//  * Computes the retry delay in milliseconds using an exponential back off algorithm.
+//  *
+//  * @param retryNumber - The number of retries that have already been attempted
+//  * @param maxDelayRatio - The maximum ratio of the delay that can be randomized
+//  * @returns Delay in milliseconds
+//  */
+// export const exponentialDelay = (
+//   retryNumber = 0,
+//   maxDelayRatio = 0.2
+// ): number => {
+//   const delay = Math.pow(2, retryNumber) * 100
+//   const randomSum = delay * maxDelayRatio * Math.random() // 0-(maxDelayRatio*100)% of the delay
+//   return delay + randomSum
+// }
+
 /**
  * Computes the median of the given data set.
  *
@@ -123,3 +146,39 @@ export const isAsyncFunction = (
 ): 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)
+    }
+  }
+}