X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FUtils.ts;h=d396cfa959f930167978cd35dd240eae08ff29cd;hb=b3aa9f53cdbf6dac72396c4392e11dcc4c37df65;hp=92373cf043ba2161426ae6066c3376ef53097af4;hpb=87f1fc2acc3bfc56decd07366b6dc9466b4e267e;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/Utils.ts b/src/utils/Utils.ts index 92373cf0..d396cfa9 100644 --- a/src/utils/Utils.ts +++ b/src/utils/Utils.ts @@ -1,27 +1,33 @@ -import Configuration from './Configuration'; -import { WebSocketCloseEventStatusString } from '../types/WebSocket'; -import { WorkerProcessType } from '../types/Worker'; import crypto from 'crypto'; -import { v4 as uuid } from 'uuid'; + +import { WebSocketCloseEventStatusString } from '../types/WebSocket'; export default class Utils { + private constructor() { + // This is intentional + } + public static logPrefix(prefixString = ''): string { return new Date().toLocaleString() + prefixString; } public static generateUUID(): string { - return uuid(); + return crypto.randomUUID(); + } + + public static validateUUID(uuid: string): boolean { + return /\/^[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$\/i/.test(uuid); } public static async sleep(milliSeconds: number): Promise { - return new Promise((resolve) => setTimeout(resolve, milliSeconds)); + return new Promise((resolve) => setTimeout(resolve as () => void, milliSeconds)); } public static formatDurationMilliSeconds(duration: number): string { duration = Utils.convertToInt(duration); const hours = Math.floor(duration / (3600 * 1000)); - const minutes = Math.floor((duration / 1000 - (hours * 3600)) / 60); - const seconds = duration / 1000 - (hours * 3600) - (minutes * 60); + const minutes = Math.floor((duration / 1000 - hours * 3600) / 60); + const seconds = duration / 1000 - hours * 3600 - minutes * 60; let hoursStr = hours.toString(); let minutesStr = minutes.toString(); let secondsStr = seconds.toString(); @@ -93,30 +99,27 @@ export default class Utils { result = value; } else { // Convert - result = (value === 'true'); + result = value === 'true'; } } return result; } - public static getRandomFloat(max: number, min = 0, negative = false): number { - if (max < min || min < 0 || max < 0) { + public static getRandomFloat(max = Number.MAX_VALUE, min = 0, negative = false): number { + if (max < min || max < 0 || min < 0) { throw new RangeError('Invalid interval'); } const randomPositiveFloat = crypto.randomBytes(4).readUInt32LE() / 0xffffffff; - const sign = (negative && randomPositiveFloat < 0.5) ? -1 : 1; + const sign = negative && randomPositiveFloat < 0.5 ? -1 : 1; return sign * (randomPositiveFloat * (max - min) + min); } - public static getRandomInt(max: number, min = 0): number { - if (max < 0) { + public static getRandomInteger(max = Number.MAX_SAFE_INTEGER, min = 0): number { + if (max < min || max < 0 || min < 0) { throw new RangeError('Invalid interval'); } max = Math.floor(max); - if (min) { - if (max < min || min < 0) { - throw new RangeError('Invalid interval'); - } + if (!Utils.isNullOrUndefined(min) && min !== 0) { min = Math.ceil(min); return Math.floor(Utils.secureRandom() * (max - min + 1)) + min; } @@ -133,19 +136,27 @@ export default class Utils { return Math.trunc(numberValue * truncPower) / truncPower; } - public static getRandomFloatRounded(max: number, min = 0, scale = 2): number { + public static getRandomFloatRounded(max = Number.MAX_VALUE, min = 0, scale = 2): number { if (min) { return Utils.roundTo(Utils.getRandomFloat(max, min), scale); } return Utils.roundTo(Utils.getRandomFloat(max), scale); } - public static getRandomFloatFluctuatedRounded(staticValue: number, fluctuationPercent: number, scale = 2): number { + public static getRandomFloatFluctuatedRounded( + staticValue: number, + fluctuationPercent: number, + scale = 2 + ): number { if (fluctuationPercent === 0) { return Utils.roundTo(staticValue, scale); } const fluctuationRatio = fluctuationPercent / 100; - return Utils.getRandomFloatRounded(staticValue * (1 + fluctuationRatio), staticValue * (1 - fluctuationRatio), scale); + return Utils.getRandomFloatRounded( + staticValue * (1 + fluctuationRatio), + staticValue * (1 - fluctuationRatio), + scale + ); } public static cloneObject(object: T): T { @@ -153,43 +164,42 @@ export default class Utils { } public static isIterable(obj: T): boolean { - if (obj) { - return typeof obj[Symbol.iterator] === 'function'; - } - return false; + return obj ? typeof obj[Symbol.iterator] === 'function' : false; } public static isString(value: unknown): boolean { return typeof value === 'string'; } + public static isEmptyString(value: unknown): boolean { + return Utils.isString(value) && (value as string).length === 0; + } + public static isUndefined(value: unknown): boolean { return typeof value === 'undefined'; } public static isNullOrUndefined(value: unknown): boolean { - // eslint-disable-next-line no-eq-null, eqeqeq - if (value == null) { - return true; - } - return false; + // eslint-disable-next-line eqeqeq, no-eq-null + return value == null ? true : false; } public static isEmptyArray(object: unknown): boolean { if (!object) { return true; } - if (Array.isArray(object) && object.length > 0) { + if (Array.isArray(object) === true && (object as unknown[]).length > 0) { return false; } return true; } - public static isEmptyObject(obj: Record): boolean { + public static isEmptyObject(obj: object): boolean { return !Object.keys(obj).length; } - public static insertAt = (str: string, subStr: string, pos: number): string => `${str.slice(0, pos)}${subStr}${str.slice(pos)}`; + public static insertAt = (str: string, subStr: string, pos: number): string => + `${str.slice(0, pos)}${subStr}${str.slice(pos)}`; /** * @param [retryNumber=0] @@ -201,6 +211,54 @@ export default class Utils { return delay + randomSum; } + public static async promiseWithTimeout( + 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(() => { + timeoutCallback(); + reject(timeoutError); + }, timeoutMs); + }); + + // Returns a race between timeout promise and the passed promise + return Promise.race([promise, timeoutPromise]); + } + + /** + * Generate a cryptographically secure random number in the [0,1[ range + * + * @returns + */ + public static secureRandom(): number { + return crypto.randomBytes(4).readUInt32LE() / 0x100000000; + } + + public static JSONStringifyWithMapSupport( + obj: Record | Record[], + space?: number + ): string { + return JSON.stringify( + obj, + (key, value: Record) => { + if (value instanceof Map) { + return { + dataType: 'Map', + value: [...value], + }; + } + return value; + }, + space + ); + } + /** * Convert websocket error code to human readable string message * @@ -226,21 +284,4 @@ export default class Utils { } return '(Unknown)'; } - - public static workerPoolInUse(): boolean { - return [WorkerProcessType.DYNAMIC_POOL, WorkerProcessType.STATIC_POOL].includes(Configuration.getWorkerProcess()); - } - - public static workerDynamicPoolInUse(): boolean { - return Configuration.getWorkerProcess() === WorkerProcessType.DYNAMIC_POOL; - } - - /** - * Generate a cryptographically secure random number in the [0,1[ range - * - * @returns - */ - public static secureRandom(): number { - return crypto.randomBytes(4).readUInt32LE() / 0x100000000; - } }