X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FUtils.ts;h=83c1e3f7490a4dd9fff5976c2367a5eb548e7dfa;hb=361c98f57255e5b91d123d5f2ba43ab533134b1a;hp=0da6289c242ea69e3b3b72aa32657a190a631b6f;hpb=edd134392e237a3242dc2093341df70244c51472;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/Utils.ts b/src/utils/Utils.ts index 0da6289c..83c1e3f7 100644 --- a/src/utils/Utils.ts +++ b/src/utils/Utils.ts @@ -1,17 +1,19 @@ -import crypto from 'crypto'; +import crypto from 'node:crypto'; +import util from 'node:util'; import clone from 'just-clone'; -import { WebSocketCloseEventStatusString } from '../types/WebSocket'; +import { Constants } from './Constants'; +import { WebSocketCloseEventStatusString } from '../types'; -export default class Utils { +export class Utils { private constructor() { // This is intentional } - public static logPrefix(prefixString = ''): string { - return new Date().toLocaleString() + prefixString; - } + public static logPrefix = (prefixString = ''): string => { + return `${new Date().toLocaleString()}${prefixString}`; + }; public static generateUUID(): string { return crypto.randomUUID(); @@ -37,15 +39,15 @@ export default class Utils { let secondsStr = seconds.toString(); if (hours < 10) { - hoursStr = '0' + hours.toString(); + hoursStr = `0${hours.toString()}`; } if (minutes < 10) { - minutesStr = '0' + minutes.toString(); + minutesStr = `0${minutes.toString()}`; } if (seconds < 10) { - secondsStr = '0' + seconds.toString(); + secondsStr = `0${seconds.toString()}`; } - return hoursStr + ':' + minutesStr + ':' + secondsStr.substring(0, 6); + return `${hoursStr}:${minutesStr}:${secondsStr.substring(0, 6)}`; } public static formatDurationSeconds(duration: number): string { @@ -119,35 +121,36 @@ export default class Utils { return result; } - public static getRandomFloat(max = Number.MAX_VALUE, min = 0, negative = false): number { - if (max < min || max < 0 || min < 0) { + public static getRandomFloat(max = Number.MAX_VALUE, min = 0): number { + if (max < min) { throw new RangeError('Invalid interval'); } - const randomPositiveFloat = crypto.randomBytes(4).readUInt32LE() / 0xffffffff; - const sign = negative && randomPositiveFloat < 0.5 ? -1 : 1; - return sign * (randomPositiveFloat * (max - min) + min); - } - - public static getRandomInteger(max = Number.MAX_SAFE_INTEGER, min = 0): number { - if (max < min || max < 0 || min < 0) { + if (max - min === Infinity) { throw new RangeError('Invalid interval'); } + return (crypto.randomBytes(4).readUInt32LE() / 0xffffffff) * (max - min) + min; + } + + public static getRandomInteger(max = Constants.MAX_RANDOM_INTEGER, min = 0): number { max = Math.floor(max); if (!Utils.isNullOrUndefined(min) && min !== 0) { min = Math.ceil(min); - return Math.floor(Utils.secureRandom() * (max - min + 1)) + min; + return Math.floor(crypto.randomInt(min, max + 1)); } - return Math.floor(Utils.secureRandom() * (max + 1)); + 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 { @@ -174,15 +177,27 @@ export default class Utils { } public static isObject(item: unknown): boolean { - return item && typeof item === 'object' && Array.isArray(item) === false; + return ( + Utils.isNullOrUndefined(item) === false && + typeof item === 'object' && + Array.isArray(item) === false + ); } public static cloneObject(object: T): T { return clone(object); } + public static hasOwnProp(object: unknown, property: PropertyKey): boolean { + return Utils.isObject(object) && Object.hasOwn(object as object, property); + } + + public static isCFEnvironment(): boolean { + return !Utils.isNullOrUndefined(process.env.VCAP_APPLICATION); + } + public static isIterable(obj: T): boolean { - return obj ? typeof obj[Symbol.iterator] === 'function' : false; + return !Utils.isNullOrUndefined(obj) ? typeof obj[Symbol.iterator] === 'function' : false; } public static isString(value: unknown): boolean { @@ -190,26 +205,31 @@ export default class Utils { } public static isEmptyString(value: unknown): boolean { - return Utils.isString(value) && (value as string).trim().length === 0; + return ( + Utils.isNullOrUndefined(value) || + (Utils.isString(value) && (value as string).trim().length === 0) + ); + } + + public static isNotEmptyString(value: unknown): boolean { + return Utils.isString(value) && (value as string).trim().length > 0; } public static isUndefined(value: unknown): boolean { - return typeof value === 'undefined'; + return value === undefined; } public static isNullOrUndefined(value: unknown): boolean { // eslint-disable-next-line eqeqeq, no-eq-null - return value == null ? true : false; + return value == null; } - public static isEmptyArray(object: unknown | unknown[]): boolean { - if (!Array.isArray(object)) { - return true; - } - if (object.length > 0) { - return false; - } - return true; + public static isEmptyArray(object: unknown): boolean { + return Array.isArray(object) && object.length === 0; + } + + public static isNotEmptyArray(object: unknown): boolean { + return Array.isArray(object) && object.length > 0; } public static isEmptyObject(obj: object): boolean { @@ -228,15 +248,21 @@ export default 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; } + public static isPromisePending(promise: Promise): boolean { + return util.inspect(promise).includes('pending'); + } + public static async promiseWithTimeout( promise: Promise, timeoutMs: number, @@ -248,7 +274,10 @@ export default class Utils { // Create a timeout promise that rejects in timeout milliseconds const timeoutPromise = new Promise((_, reject) => { setTimeout(() => { - timeoutCallback(); + if (Utils.isPromisePending(promise)) { + timeoutCallback(); + // FIXME: The original promise shall be canceled + } reject(timeoutError); }, timeoutMs); }); @@ -258,7 +287,7 @@ export default 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 */ @@ -286,7 +315,7 @@ export default 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