+import { getRandomValues } from 'node:crypto'
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'
+
+import type { KillBehavior } from './worker/worker-options.js'
/**
* Default task name.
/* Intentionally empty */
})
-/**
- * Default worker choice strategy options.
- */
-export const DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS: WorkerChoiceStrategyOptions =
- {
- choiceRetries: 6,
- 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.
*
* @returns The host OS optimized maximum pool size.
- * @internal
*/
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
+ const cpus = os.cpus()
+ if (Array.isArray(cpus) && cpus.length > 0) {
+ availableParallelism = cpus.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
-// * @internal
-// */
-// 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
-// }
+/**
+ * Sleeps for the given amount of milliseconds.
+ *
+ * @param ms - The amount of milliseconds to sleep.
+ * @returns A promise that resolves after the given amount of milliseconds.
+ * @internal
+ */
+export const sleep = async (ms: number): Promise<void> => {
+ await new Promise(resolve => {
+ setTimeout(resolve, ms)
+ })
+}
+
+/**
+ * Computes the retry delay in milliseconds using an exponential back off algorithm.
+ *
+ * @param retryNumber - The number of retries that have already been attempted
+ * @param delayFactor - The base delay factor in milliseconds
+ * @returns Delay in milliseconds
+ * @internal
+ */
+export const exponentialDelay = (
+ retryNumber = 0,
+ delayFactor = 100
+): number => {
+ const delay = Math.pow(2, retryNumber) * delayFactor
+ const randomSum = delay * 0.2 * secureRandom() // 0-20% of the delay
+ return delay + randomSum
+}
+
+/**
+ * Computes the average of the given data set.
+ *
+ * @param dataSet - Data set.
+ * @returns The average of the given data set.
+ * @internal
+ */
+export const average = (dataSet: number[]): number => {
+ if (Array.isArray(dataSet) && dataSet.length === 0) {
+ return 0
+ } else if (Array.isArray(dataSet) && dataSet.length === 1) {
+ return dataSet[0]
+ }
+ return (
+ dataSet.reduce((accumulator, number) => accumulator + number, 0) /
+ dataSet.length
+ )
+}
/**
* Computes the median of the given data set.
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)
* @param num - The number to round.
* @param scale - The scale to round to.
* @returns The rounded number.
+ * @internal
*/
export const round = (num: number, scale = 2): number => {
const rounder = Math.pow(10, scale)
}
/**
- * 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
*/
/**
* 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
*/
export const isAsyncFunction = (
fn: unknown
}
/**
- * Updates the given measurement statistics.
+ * Generates a cryptographically secure random number in the [0,1[ range
*
- * @param measurementStatistics - The measurement statistics to update.
- * @param measurementRequirements - The measurement statistics requirements.
- * @param measurementValue - The measurement value.
- * @param numberOfMeasurements - The number of measurements.
+ * @returns A number in the [0,1[ range
* @internal
*/
-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)
- }
- }
+export const secureRandom = (): number => {
+ return getRandomValues(new Uint32Array(1))[0] / 0x100000000
}
/**
- * Executes a function once at a time.
+ * Returns the minimum of the given numbers.
+ * If no numbers are given, `Infinity` is returned.
*
- * @param fn - The function to execute.
+ * @param args - The numbers to get the minimum of.
+ * @returns The minimum of the given numbers.
+ * @internal
+ */
+export const min = (...args: number[]): number =>
+ args.reduce((minimum, num) => (minimum < num ? minimum : num), Infinity)
+
+/**
+ * Returns the maximum of the given numbers.
+ * If no numbers are given, `-Infinity` is returned.
+ *
+ * @param args - The numbers to get the maximum of.
+ * @returns The maximum of the given numbers.
+ * @internal
+ */
+export const max = (...args: number[]): number =>
+ args.reduce((maximum, num) => (maximum > num ? maximum : num), -Infinity)
+
+/**
+ * Wraps a function so that it can only be called once.
+ *
+ * @param fn - The function to wrap.
* @param context - The context to bind the function to.
- * @returns The function to execute.
+ * @returns The wrapped function.
+ *
+ * @typeParam A - The function's arguments.
+ * @typeParam R - The function's return value.
+ * @typeParam C - The function's context.
+ * @internal
*/
-export const once = (
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
- fn: (...args: any[]) => void,
- context: unknown
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
-): ((...args: any[]) => void) => {
- let called = false
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
- return function (...args: any[]): void {
- if (!called) {
- called = true
- fn.apply(context, args)
- called = false
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const once = <A extends any[], R, C>(
+ fn: (...args: A) => R,
+ 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<C, A, R>(context, args)
+ ;(fn as unknown as undefined) = (context as unknown as undefined) =
+ undefined
}
+ return result
}
}
repositories / poolifier.git / blobdiff