X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FUtils.ts;h=366ccf98a96d182f55c67b9c2448d076be94e674;hb=6a4032b5d8f3cbaa18d3beddcdfe9d335c1cba90;hp=c5a276bc92609e21bb55f79f2df4549a5f0fe447;hpb=32f5e42d9017783787e24fff7bcf67d3b4118311;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/Utils.ts b/src/utils/Utils.ts index c5a276bc..366ccf98 100644 --- a/src/utils/Utils.ts +++ b/src/utils/Utils.ts @@ -1,5 +1,5 @@ -import { randomBytes, randomInt, randomUUID } from 'node:crypto'; -import { inspect } from 'node:util'; +import { getRandomValues, randomBytes, randomInt, randomUUID } from 'node:crypto'; +import { env, nextTick } from 'node:process'; import { formatDuration, @@ -12,7 +12,6 @@ import { minutesToSeconds, secondsToMilliseconds, } from 'date-fns'; -import deepClone from 'deep-clone'; import { Constants } from './Constants'; import { type TimestampedData, WebSocketCloseEventStatusString } from '../types'; @@ -37,6 +36,9 @@ export const sleep = async (milliSeconds: number): Promise => { export const formatDurationMilliSeconds = (duration: number): string => { duration = convertToInt(duration); + if (duration < 0) { + throw new RangeError('Duration cannot be negative'); + } const days = Math.floor(duration / (24 * 3600 * 1000)); const hours = Math.floor(millisecondsToHours(duration) - days * 24); const minutes = Math.floor( @@ -48,6 +50,9 @@ export const formatDurationMilliSeconds = (duration: number): string => { hoursToSeconds(hours) - minutesToSeconds(minutes), ); + if (days === 0 && hours === 0 && minutes === 0 && seconds === 0) { + return formatDuration({ seconds }, { zero: true }); + } return formatDuration({ days, hours, @@ -65,7 +70,7 @@ export const isValidTime = (date: unknown): boolean => { if (typeof date === 'number') { return !isNaN(date); } else if (isDate(date)) { - return !isNaN((date as Date).getTime()); + return !isNaN(date.getTime()); } return false; }; @@ -77,12 +82,15 @@ export const convertToDate = ( return value as null | undefined; } if (isDate(value)) { - return value as Date; + return value; } if (isString(value) || typeof value === 'number') { - return new Date(value!); + const valueToDate = new Date(value!); + if (isNaN(valueToDate.getTime())) { + throw new Error(`Cannot convert to date: '${value!}'`); + } + return valueToDate; } - return null; }; export const convertToInt = (value: unknown): number => { @@ -100,8 +108,7 @@ export const convertToInt = (value: unknown): number => { changedValue = parseInt(value as string); } if (isNaN(changedValue)) { - // eslint-disable-next-line @typescript-eslint/no-base-to-string - throw new Error(`Cannot convert to integer: ${value.toString()}`); + throw new Error(`Cannot convert to integer: '${String(value)}'`); } return changedValue; }; @@ -115,15 +122,14 @@ export const convertToFloat = (value: unknown): number => { changedValue = parseFloat(value as string); } if (isNaN(changedValue)) { - // eslint-disable-next-line @typescript-eslint/no-base-to-string - throw new Error(`Cannot convert to float: ${value.toString()}`); + throw new Error(`Cannot convert to float: '${String(value)}'`); } return changedValue; }; export const convertToBoolean = (value: unknown): boolean => { let result = false; - if (value) { + if (value != null) { // Check the type if (typeof value === 'boolean') { return value; @@ -216,8 +222,44 @@ type CloneableData = | CloneableData[] | { [key: string]: CloneableData }; +type FormatKey = (key: string) => string; + +const deepClone = ( + value: I, + formatKey?: FormatKey, + refs: Map = new Map(), +): O => { + const ref = refs.get(value); + if (ref !== undefined) { + return ref; + } + if (Array.isArray(value)) { + const clone: CloneableData[] = []; + refs.set(value, clone as O); + for (let i = 0; i < value.length; i++) { + clone[i] = deepClone(value[i], formatKey, refs); + } + return clone as O; + } + if (value instanceof Date) { + return new Date(value.valueOf()) as O; + } + if (typeof value !== 'object' || value === null) { + return value as unknown as O; + } + const clone: Record = {}; + refs.set(value, clone as O); + for (const key of Object.keys(value)) { + clone[typeof formatKey === 'function' ? formatKey(key) : key] = deepClone( + value[key], + formatKey, + refs, + ); + } + return clone as O; +}; + export const cloneObject = (object: T): T => { - // eslint-disable-next-line @typescript-eslint/no-unsafe-call return deepClone(object as CloneableData) as T; }; @@ -226,7 +268,7 @@ export const hasOwnProp = (object: unknown, property: PropertyKey): boolean => { }; export const isCFEnvironment = (): boolean => { - return !isNullOrUndefined(process.env.VCAP_APPLICATION); + return !isNullOrUndefined(env.VCAP_APPLICATION); }; export const isIterable = (obj: T): boolean => { @@ -250,7 +292,6 @@ export const isUndefined = (value: unknown): boolean => { }; export const isNullOrUndefined = (value: unknown): boolean => { - // eslint-disable-next-line eqeqeq, no-eq-null return value == null; }; @@ -281,49 +322,22 @@ export const insertAt = (str: string, subStr: string, pos: number): string => * Computes the retry delay in milliseconds using an exponential backoff 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 */ -export const exponentialDelay = (retryNumber = 0, maxDelayRatio = 0.2): number => { - const delay = Math.pow(2, retryNumber) * 100; - const randomSum = delay * maxDelayRatio * secureRandom(); // 0-(maxDelayRatio*100)% of the delay +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; }; -const isPromisePending = (promise: Promise): boolean => { - return inspect(promise).includes('pending'); -}; - -export const promiseWithTimeout = async ( - promise: Promise, - timeoutMs: number, - timeoutError: Error, - timeoutCallback: () => void = () => { - /* This is intentional */ - }, -): Promise => { - // Create a timeout promise that rejects in timeout milliseconds - const timeoutPromise = new Promise((_, reject) => { - setTimeout(() => { - if (isPromisePending(promise)) { - timeoutCallback(); - // FIXME: The original promise shall be canceled - } - reject(timeoutError); - }, timeoutMs); - }); - - // Returns a race between timeout promise and the passed promise - return Promise.race([promise, timeoutPromise]); -}; - /** * Generates a cryptographically secure random number in the [0,1[ range * - * @returns + * @returns A number in the [0,1[ range */ export const secureRandom = (): number => { - return randomBytes(4).readUInt32LE() / 0x100000000; + return getRandomValues(new Uint32Array(1))[0] / 0x100000000; }; export const JSONStringifyWithMapSupport = ( @@ -383,3 +397,30 @@ export const isArraySorted = (array: T[], compareFn: (a: T, b: T) => number): } return true; }; + +// eslint-disable-next-line @typescript-eslint/no-explicit-any +export const once = ( + fn: (...args: A) => R, + context: T, +): ((...args: A) => R) => { + let result: R; + return (...args: A) => { + if (fn) { + result = fn.apply(context, args); + (fn as unknown as undefined) = (context as unknown as undefined) = undefined; + } + return result; + }; +}; + +export const min = (...args: number[]): number => + args.reduce((minimum, num) => (minimum < num ? minimum : num), Infinity); + +export const max = (...args: number[]): number => + args.reduce((maximum, num) => (maximum > num ? maximum : num), -Infinity); + +export const throwErrorInNextTick = (error: Error): void => { + nextTick(() => { + throw error; + }); +};