X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils.ts;h=c568a29a049eda2de26cf9bd99d63e613294bc3f;hb=5bbdaeff9b95f2ecb177394f869e9d0715e38e9e;hp=400a92b14a7f42e8518878af1744623c8f6c2290;hpb=563b18cd8fe9c211f15e9da91a299f2819abea01;p=poolifier.git diff --git a/src/utils.ts b/src/utils.ts index 400a92b1..c568a29a 100644 --- a/src/utils.ts +++ b/src/utils.ts @@ -1,18 +1,7 @@ +import { getRandomValues } from 'node:crypto' 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 IWorker, - type MeasurementStatistics, - type WorkerType, - WorkerTypes -} from './pools/worker' + +import type { KillBehavior } from './worker/worker-options.js' /** * Default task name. @@ -26,27 +15,6 @@ export const EMPTY_FUNCTION: () => void = Object.freeze(() => { /* Intentionally empty */ }) -/** - * Default worker choice strategy options. - */ -export const DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS: WorkerChoiceStrategyOptions = - { - retries: 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. @@ -66,36 +34,6 @@ export const availableParallelism = (): number => { 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. * @@ -136,8 +74,7 @@ export const exponentialDelay = ( export const average = (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] } return ( @@ -156,8 +93,7 @@ export const average = (dataSet: number[]): number => { 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) @@ -183,24 +119,24 @@ export const round = (num: number, scale = 2): number => { } /** - * 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 */ @@ -214,7 +150,7 @@ export const isKillBehavior = ( /** * 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 */ @@ -224,50 +160,6 @@ export const isAsyncFunction = ( 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. - * @internal - */ -export const updateMeasurementStatistics = ( - measurementStatistics: MeasurementStatistics, - measurementRequirements: MeasurementStatisticsRequirements, - measurementValue: number -): void => { - if (measurementRequirements.aggregate) { - measurementStatistics.aggregate = - (measurementStatistics.aggregate ?? 0) + measurementValue - measurementStatistics.minimum = min( - measurementValue, - measurementStatistics.minimum ?? Infinity - ) - measurementStatistics.maximum = max( - measurementValue, - measurementStatistics.maximum ?? -Infinity - ) - if ( - (measurementRequirements.average || measurementRequirements.median) && - measurementValue != null - ) { - 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 - } - } - } -} - /** * Generates a cryptographically secure random number in the [0,1[ range * @@ -275,7 +167,7 @@ export const updateMeasurementStatistics = ( * @internal */ export const secureRandom = (): number => { - return webcrypto.getRandomValues(new Uint32Array(1))[0] / 0x100000000 + return getRandomValues(new Uint32Array(1))[0] / 0x100000000 } /** @@ -299,3 +191,32 @@ export const min = (...args: number[]): number => */ 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. + * + * @typeParam A - The function's arguments. + * @typeParam R - The function's return value. + * @typeParam C - The function's context. + * @internal + */ +// eslint-disable-next-line @typescript-eslint/no-explicit-any +export const once = ( + 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(context, args) + ;(fn as unknown as undefined) = (context as unknown as undefined) = + undefined + } + return result + } +}