import * as os from 'node:os'
-import { webcrypto } from 'node:crypto'
+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 {
- MeasurementStatisticsRequirements,
- WorkerChoiceStrategyOptions
-} from './pools/selection-strategies/selection-strategies-types'
-import type { KillBehavior } from './worker/worker-options'
-import {
- type IWorker,
- type MeasurementStatistics,
- type WorkerType,
- WorkerTypes
-} from './pools/worker'
+ 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.
})
/**
- * Default worker choice strategy options.
+ * Gets default worker choice strategy options.
+ *
+ * @param retries - The number of worker choice retries.
+ * @returns The default worker choice strategy options.
*/
-export const DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS: WorkerChoiceStrategyOptions =
- {
- retries: 6,
+const getDefaultInternalWorkerChoiceStrategyOptions = (
+ retries: number
+): InternalWorkerChoiceStrategyOptions => {
+ return {
+ retries,
runTime: { median: false },
waitTime: { median: false },
elu: { median: false }
}
+}
/**
* Default measurement statistics requirements.
* 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
* @returns The worker type of the given worker.
* @internal
*/
-export const getWorkerType = <Worker extends IWorker>(
- worker: Worker
-): WorkerType | undefined => {
+export const getWorkerType = (worker: IWorker): WorkerType | undefined => {
if (worker instanceof ThreadWorker) {
return WorkerTypes.thread
} else if (worker instanceof ClusterWorker) {
* @returns The worker id of the given worker.
* @internal
*/
-export const getWorkerId = <Worker extends IWorker>(
- worker: Worker
-): number | undefined => {
+export const getWorkerId = (worker: IWorker): number | undefined => {
if (worker instanceof ThreadWorker) {
return worker.threadId
} else if (worker instanceof ClusterWorker) {
*
* @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) => {
+ await new Promise(resolve => {
setTimeout(resolve, ms)
})
}
* @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)
*
* @param obj - The object to check.
* @returns `true` if the given object is a plain object, `false` otherwise.
+ * @internal
*/
export const isPlainObject = (obj: unknown): boolean =>
typeof obj === 'object' &&
*
* @param fn - Any 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
-): 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 || measurementRequirements.median) &&
- measurementValue != null
- ) {
- measurementStatistics.history.push(measurementValue)
- if (measurementRequirements.average) {
- measurementStatistics.average = average(measurementStatistics.history)
- }
- if (measurementRequirements.median) {
- measurementStatistics.median = median(measurementStatistics.history)
- }
- }
- }
+export const secureRandom = (): number => {
+ return getRandomValues(new Uint32Array(1))[0] / 0x100000000
}
/**
- * Generate a cryptographically secure random number in the [0,1[ range
+ * Returns the minimum of the given numbers.
+ * If no numbers are given, `Infinity` is returned.
*
- * @returns A number in the [0,1[ range
+ * @param args - The numbers to get the minimum of.
+ * @returns The minimum of the given numbers.
+ * @internal
*/
-export const secureRandom = (): number => {
- return webcrypto.getRandomValues(new Uint32Array(1))[0] / 0x100000000
+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 wrapped function.
+ * @internal
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const once = <T, A extends any[], R>(
+ fn: (...args: A) => R,
+ context: T
+): ((...args: A) => R) => {
+ let result: R
+ return (...args: A) => {
+ if (fn != null) {
+ result = fn.apply<T, A, R>(context, args)
+ ;(fn as unknown as undefined) = (context as unknown as undefined) =
+ undefined
+ }
+ return result
+ }
+}
+
+const clone = <T extends object>(object: T): T => {
+ return JSON.parse(JSON.stringify(object)) as T
+}
+
+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)
}
repositories / poolifier.git / blobdiff