X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils.ts;h=400a92b14a7f42e8518878af1744623c8f6c2290;hb=f7d15c1217381b306300beb7926b42fde93bc579;hp=b5fb9afeda348ddd15e9c441a3c23d67c07ffeb0;hpb=68cbdc846878bc058323b757a68b4c83eedc6388;p=poolifier.git diff --git a/src/utils.ts b/src/utils.ts index b5fb9afe..400a92b1 100644 --- a/src/utils.ts +++ b/src/utils.ts @@ -1,10 +1,18 @@ import * as os from 'node:os' +import { webcrypto } from 'node:crypto' +import { Worker as ClusterWorker } from 'node:cluster' +import { Worker as ThreadWorker } from 'node:worker_threads' 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 IWorker, + type MeasurementStatistics, + type WorkerType, + WorkerTypes +} from './pools/worker' /** * Default task name. @@ -23,7 +31,7 @@ export const EMPTY_FUNCTION: () => void = Object.freeze(() => { */ export const DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS: WorkerChoiceStrategyOptions = { - choiceRetries: 6, + retries: 6, runTime: { median: false }, waitTime: { median: false }, elu: { median: false } @@ -44,29 +52,59 @@ export const DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS: MeasurementStatisticsR * 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. + * + * @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. * * @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 => { - await new Promise((resolve) => { + await new Promise(resolve => { setTimeout(resolve, ms) }) } @@ -75,16 +113,16 @@ export const sleep = async (ms: number): Promise => { * 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 + * @param delayFactor - The base delay factor in milliseconds * @returns Delay in milliseconds * @internal */ export const exponentialDelay = ( retryNumber = 0, - maxDelayRatio = 0.2 + delayFactor = 100 ): number => { - const delay = Math.pow(2, retryNumber) * 100 - const randomSum = delay * maxDelayRatio * secureRandom() // 0-(maxDelayRatio*100)% of the delay + const delay = Math.pow(2, retryNumber) * delayFactor + const randomSum = delay * 0.2 * secureRandom() // 0-20% of the delay return delay + randomSum } @@ -137,6 +175,7 @@ export const median = (dataSet: number[]): number => { * @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) @@ -148,6 +187,7 @@ export const round = (num: number, scale = 2): number => { * * @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' && @@ -176,6 +216,7 @@ export const isKillBehavior = ( * * @param fn - Any value. * @returns `true` if `fn` was an asynchronous function, otherwise `false`. + * @internal */ export const isAsyncFunction = ( fn: unknown @@ -200,11 +241,11 @@ export const updateMeasurementStatistics = ( if (measurementRequirements.aggregate) { measurementStatistics.aggregate = (measurementStatistics.aggregate ?? 0) + measurementValue - measurementStatistics.minimum = Math.min( + measurementStatistics.minimum = min( measurementValue, measurementStatistics.minimum ?? Infinity ) - measurementStatistics.maximum = Math.max( + measurementStatistics.maximum = max( measurementValue, measurementStatistics.maximum ?? -Infinity ) @@ -215,43 +256,46 @@ export const updateMeasurementStatistics = ( measurementStatistics.history.push(measurementValue) if (measurementRequirements.average) { measurementStatistics.average = average(measurementStatistics.history) + } else if (measurementStatistics.average != null) { + delete measurementStatistics.average } if (measurementRequirements.median) { measurementStatistics.median = median(measurementStatistics.history) + } else if (measurementStatistics.median != null) { + delete measurementStatistics.median } } } } /** - * Executes a function once at a time. + * Generates a cryptographically secure random number in the [0,1[ range * - * @param fn - The function to execute. - * @param context - The context to bind the function to. - * @returns The function to execute. + * @returns A number in the [0,1[ range + * @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 - } - } +export const secureRandom = (): number => { + return webcrypto.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 */ -const secureRandom = (): number => { - return crypto.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)