X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FUtils.ts;h=ca8f44af23d44ed91b15047428787edccdb0a9db;hb=a1e5fe4e22aaee2d4c7535fc9b6998f0e5f9a8f3;hp=006e9ddd40278c8f3e84d75f4e4306267c3fcfed;hpb=d439da5cfbb01ef12fcf9a46150715d91bf06c81;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/Utils.ts b/src/utils/Utils.ts index 006e9ddd..ca8f44af 100644 --- a/src/utils/Utils.ts +++ b/src/utils/Utils.ts @@ -1,5 +1,9 @@ -import crypto from 'crypto'; +import crypto from 'node:crypto'; +import util from 'node:util'; +import clone from 'just-clone'; + +import Constants from './Constants'; import { WebSocketCloseEventStatusString } from '../types/WebSocket'; export default class Utils { @@ -8,7 +12,7 @@ export default class Utils { } public static logPrefix(prefixString = ''): string { - return new Date().toLocaleString() + prefixString; + return `${new Date().toLocaleString()}${prefixString}`; } public static generateUUID(): string { @@ -35,22 +39,24 @@ 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 { return Utils.formatDurationMilliSeconds(duration * 1000); } - public static convertToDate(value: unknown): Date | null | undefined { + public static convertToDate( + value: Date | string | number | null | undefined + ): Date | null | undefined { if (Utils.isNullOrUndefined(value)) { return value as null | undefined; } @@ -58,36 +64,42 @@ export default class Utils { return value; } if (Utils.isString(value) || typeof value === 'number') { - return new Date(value as string | number); + return new Date(value); } return null; } public static convertToInt(value: unknown): number { - let changedValue: number = value as number; if (!value) { return 0; } + let changedValue: number = value as number; if (Number.isSafeInteger(value)) { return value as number; } if (typeof value === 'number') { - changedValue = Math.trunc(value); + return Math.trunc(value); } if (Utils.isString(value)) { changedValue = parseInt(value as string); } + if (isNaN(changedValue)) { + throw new Error(`Cannot convert to integer: ${value.toString()}`); + } return changedValue; } public static convertToFloat(value: unknown): number { - let changedValue: number = value as number; if (!value) { return 0; } + let changedValue: number = value as number; if (Utils.isString(value)) { changedValue = parseFloat(value as string); } + if (isNaN(changedValue)) { + throw new Error(`Cannot convert to float: ${value.toString()}`); + } return changedValue; } @@ -96,7 +108,7 @@ export default class Utils { if (value) { // Check the type if (typeof value === 'boolean') { - result = value; + return value; } else if ( Utils.isString(value) && ((value as string).toLowerCase() === 'true' || value === '1') @@ -118,16 +130,13 @@ export default class Utils { return sign * (randomPositiveFloat * (max - min) + min); } - public static getRandomInteger(max = Number.MAX_SAFE_INTEGER, min = 0): number { - if (max < min || max < 0 || min < 0) { - throw new RangeError('Invalid interval'); - } + 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)); } public static roundTo(numberValue: number, scale: number): number { @@ -163,8 +172,16 @@ export default class Utils { ); } - public static cloneObject(object: T): T { - return JSON.parse(JSON.stringify(object)) as T; + public static isObject(item: unknown): boolean { + return ( + Utils.isNullOrUndefined(item) === false && + typeof item === 'object' && + Array.isArray(item) === false + ); + } + + public static cloneObject(object: T): T { + return clone(object); } public static isIterable(obj: T): boolean { @@ -214,7 +231,7 @@ export default class Utils { `${str.slice(0, pos)}${subStr}${str.slice(pos)}`; /** - * @param [retryNumber=0] + * @param retryNumber - the number of retries that have already been attempted * @returns delay in milliseconds */ public static exponentialDelay(retryNumber = 0): number { @@ -223,6 +240,10 @@ export default class Utils { return delay + randomSum; } + public static isPromisePending(promise: Promise): boolean { + return util.inspect(promise).includes('pending'); + } + public static async promiseWithTimeout( promise: Promise, timeoutMs: number, @@ -234,7 +255,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); }); @@ -253,7 +277,7 @@ export default class Utils { } public static JSONStringifyWithMapSupport( - obj: Record | Record[], + obj: Record | Record[] | Map, space?: number ): string { return JSON.stringify( @@ -274,7 +298,7 @@ export default class Utils { /** * Convert websocket error code to human readable string message * - * @param code websocket error code + * @param code - websocket error code * @returns human readable string message */ public static getWebSocketCloseEventStatusString(code: number): string {