X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FUtils.ts;h=2dff293af5f31479f5c8fde2f6cc43b3b84dc346;hb=9d73266c8bb85d7e2bc1fab9954a76910fd689eb;hp=f6565cc53c3f1cbaeef542d36f6ced8d247cce55;hpb=d10397af9d19f1607a187c749eefd160c9ef7392;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/Utils.ts b/src/utils/Utils.ts index f6565cc5..2dff293a 100644 --- a/src/utils/Utils.ts +++ b/src/utils/Utils.ts @@ -1,10 +1,14 @@ -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; } @@ -14,17 +18,17 @@ export default class Utils { } 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); - let hoursStr: string = hours.toString(); - let minutesStr: string = minutes.toString(); - let secondsStr: string = seconds.toString(); + 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(); if (hours < 10) { hoursStr = '0' + hours.toString(); @@ -33,31 +37,15 @@ export default class Utils { minutesStr = '0' + minutes.toString(); } if (seconds < 10) { - secondsStr = ('0' + seconds.toString()).substring(0, 6); + secondsStr = '0' + seconds.toString(); } - return hoursStr + ':' + minutesStr + ':' + secondsStr; + return hoursStr + ':' + minutesStr + ':' + secondsStr.substring(0, 6); } public static formatDurationSeconds(duration: number): string { return Utils.formatDurationMilliSeconds(duration * 1000); } - public static removeExtraEmptyLines(tab: string[]): void { - // Start from the end - for (let i = tab.length - 1; i > 0; i--) { - // Two consecutive empty lines? - if (tab[i].length === 0 && tab[i - 1].length === 0) { - // Remove the last one - tab.splice(i, 1); - } - // Check last line - if (i === 1 && tab[i - 1].length === 0) { - // Remove the first one - tab.splice(i - 1, 1); - } - } - } - public static convertToDate(value: unknown): Date { // Check if (!value) { @@ -109,21 +97,30 @@ 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) { + 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 { + public static getRandomInteger(max: number, min = 0): number { + if (max < 0) { + throw new RangeError('Invalid interval'); + } max = Math.floor(max); if (min) { + if (max < min || min < 0) { + throw new RangeError('Invalid interval'); + } min = Math.ceil(min); return Math.floor(Utils.secureRandom() * (max - min + 1)) + min; } @@ -147,12 +144,20 @@ export default class Utils { 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 { @@ -160,39 +165,24 @@ export default class Utils { } public static isIterable(obj: T): boolean { - if (obj) { - return typeof obj[Symbol.iterator] === 'function'; - } - return false; - } - - public static isEmptyJSon(document: unknown): boolean { - // Empty? - if (!document) { - return true; - } - // Check type - if (typeof document !== 'object') { - return true; - } - // Check - return Object.keys(document).length === 0; + 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 { @@ -205,11 +195,12 @@ export default class Utils { 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] @@ -221,6 +212,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 * @@ -246,21 +285,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; - } }