X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils.ts;h=b36eba273510160016c6308e71aa11cc4b818af3;hb=3b594fe1b0f89d6665da2eb2ebdc14eb7628fe70;hp=d7ce5a210f2dea09290fd90a5f4eb64fcb2162d5;hpb=8bb271861d8632c109fb0293f2a6f43bd5e3bea6;p=poolifier.git diff --git a/src/utils.ts b/src/utils.ts index d7ce5a21..b36eba27 100644 --- a/src/utils.ts +++ b/src/utils.ts @@ -1,13 +1,9 @@ +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 WorkerType, WorkerTypes } from './pools/worker' + +import type { TaskFunctionProperties } from './utility-types.js' +import type { TaskFunctionObject } from './worker/task-functions.js' +import type { KillBehavior } from './worker/worker-options.js' /** * Default task name. @@ -21,31 +17,9 @@ 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. - * * @returns The host OS optimized maximum pool size. */ export const availableParallelism = (): number => { @@ -61,39 +35,8 @@ 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. - * * @param ms - The amount of milliseconds to sleep. * @returns A promise that resolves after the given amount of milliseconds. * @internal @@ -106,7 +49,6 @@ 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 delayFactor - The base delay factor in milliseconds * @returns Delay in milliseconds @@ -123,7 +65,6 @@ export const exponentialDelay = ( /** * Computes the average of the given data set. - * * @param dataSet - Data set. * @returns The average of the given data set. * @internal @@ -131,8 +72,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 ( @@ -143,7 +83,6 @@ export const average = (dataSet: number[]): number => { /** * Computes the median of the given data set. - * * @param dataSet - Data set. * @returns The median of the given data set. * @internal @@ -151,8 +90,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) @@ -166,7 +104,6 @@ export const median = (dataSet: number[]): number => { /** * Rounds the given number to the given scale. * The rounding is done using the "round half away from zero" method. - * * @param num - The number to round. * @param scale - The scale to round to. * @returns The rounded number. @@ -178,24 +115,22 @@ export const round = (num: number, scale = 2): number => { } /** - * Is the given object a plain object? - * - * @param obj - The object to check. - * @returns `true` if the given object is a plain object, `false` otherwise. + * Is the given value a plain object? + * @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 */ @@ -208,8 +143,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 */ @@ -221,32 +155,77 @@ export const isAsyncFunction = ( /** * Generates a cryptographically secure random number in the [0,1[ range - * * @returns A number in the [0,1[ range * @internal */ export const secureRandom = (): number => { - return webcrypto.getRandomValues(new Uint32Array(1))[0] / 0x100000000 + return getRandomValues(new Uint32Array(1))[0] / 0x100000000 } /** * Returns the minimum of the given numbers. - * If no numbers are given, `Infinity` is returned. - * + * If no numbers are given, `Number.POSITIVE_INFINITY` is returned. * @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) + args.reduce( + (minimum, num) => (minimum < num ? minimum : num), + Number.POSITIVE_INFINITY + ) /** * Returns the maximum of the given numbers. - * If no numbers are given, `-Infinity` is returned. - * + * If no numbers are given, `Number.NEGATIVE_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) + args.reduce( + (maximum, num) => (maximum > num ? maximum : num), + Number.NEGATIVE_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 + } +} + +export const buildTaskFunctionProperties = ( + name: string, + taskFunctionObject: TaskFunctionObject | undefined +): TaskFunctionProperties => { + return { + name, + ...(taskFunctionObject?.priority != null && { + priority: taskFunctionObject.priority, + }), + ...(taskFunctionObject?.strategy != null && { + strategy: taskFunctionObject.strategy, + }), + } +}