X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FUtils.ts;h=83c1e3f7490a4dd9fff5976c2367a5eb548e7dfa;hb=361c98f57255e5b91d123d5f2ba43ab533134b1a;hp=f701cea041ab831d1b1ff323123e02c60b69b11b;hpb=878e026c886468c5d488b75a6d3636abea6fc07c;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/Utils.ts b/src/utils/Utils.ts index f701cea0..83c1e3f7 100644 --- a/src/utils/Utils.ts +++ b/src/utils/Utils.ts @@ -3,7 +3,6 @@ import util from 'node:util'; import clone from 'just-clone'; -// import { Constants } from './internal'; import { Constants } from './Constants'; import { WebSocketCloseEventStatusString } from '../types'; @@ -141,14 +140,17 @@ export class Utils { return Math.floor(crypto.randomInt(max + 1)); } + /** + * Rounds the given number to the given scale. + * The rounding is done using the "round half away from zero" method. + * + * @param numberValue - The number to round. + * @param scale - The scale to round to. + * @returns The rounded number. + */ public static roundTo(numberValue: number, scale: number): number { const roundPower = Math.pow(10, scale); - return Math.round(numberValue * roundPower) / roundPower; - } - - public static truncTo(numberValue: number, scale: number): number { - const truncPower = Math.pow(10, scale); - return Math.trunc(numberValue * truncPower) / truncPower; + return Math.round(numberValue * roundPower * (1 + Number.EPSILON)) / roundPower; } public static getRandomFloatRounded(max = Number.MAX_VALUE, min = 0, scale = 2): number { @@ -191,7 +193,7 @@ export class Utils { } public static isCFEnvironment(): boolean { - return process.env.VCAP_APPLICATION !== undefined; + return !Utils.isNullOrUndefined(process.env.VCAP_APPLICATION); } public static isIterable(obj: T): boolean { @@ -222,18 +224,12 @@ export class Utils { return value == null; } - public static isEmptyArray(object: unknown | unknown[]): boolean { - if (Array.isArray(object) && object.length === 0) { - return true; - } - return false; + public static isEmptyArray(object: unknown): boolean { + return Array.isArray(object) && object.length === 0; } - public static isNotEmptyArray(object: unknown | unknown[]): boolean { - if (Array.isArray(object) && object.length > 0) { - return true; - } - return false; + public static isNotEmptyArray(object: unknown): boolean { + return Array.isArray(object) && object.length > 0; } public static isEmptyObject(obj: object): boolean { @@ -252,12 +248,14 @@ export class Utils { `${str.slice(0, pos)}${subStr}${str.slice(pos)}`; /** + * Computes the retry delay in milliseconds using an exponential backoff algorithm. + * * @param retryNumber - the number of retries that have already been attempted * @returns delay in milliseconds */ - public static exponentialDelay(retryNumber = 0): number { + public static exponentialDelay(retryNumber = 0, maxDelayRatio = 0.2): number { const delay = Math.pow(2, retryNumber) * 100; - const randomSum = delay * 0.2 * Utils.secureRandom(); // 0-20% of the delay + const randomSum = delay * maxDelayRatio * Utils.secureRandom(); // 0-20% of the delay return delay + randomSum; } @@ -289,7 +287,7 @@ export class Utils { } /** - * Generate a cryptographically secure random number in the [0,1[ range + * Generates a cryptographically secure random number in the [0,1[ range * * @returns */ @@ -317,7 +315,7 @@ export class Utils { } /** - * Convert websocket error code to human readable string message + * Converts websocket error code to human readable string message * * @param code - websocket error code * @returns human readable string message