-import crypto from 'crypto';
-import { v4 as uuid } from 'uuid';
+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 {
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 uuid();
+ return crypto.randomUUID();
}
- public static equals(obj1: unknown, obj2: unknown): boolean {
- return JSON.stringify(obj1) === JSON.stringify(obj2);
+ public static validateUUID(uuid: string): boolean {
+ return /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.test(
+ uuid
+ );
}
public static async sleep(milliSeconds: number): Promise<NodeJS.Timeout> {
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 {
- // Check
- if (!value) {
- return value as Date;
+ public static convertToDate(
+ value: Date | string | number | null | undefined
+ ): Date | null | undefined {
+ if (Utils.isNullOrUndefined(value)) {
+ return value as null | undefined;
}
- // Check Type
- if (!(value instanceof Date)) {
- return new Date(value as string);
+ if (value instanceof Date) {
+ return value;
}
- return value;
+ if (Utils.isString(value) || typeof value === '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;
}
- // Check
+ if (typeof value === 'number') {
+ return Math.trunc(value);
+ }
if (Utils.isString(value)) {
- // Create Object
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;
}
- // Check
+ let changedValue: number = value as number;
if (Utils.isString(value)) {
- // Create Object
changedValue = parseFloat(value as string);
}
+ if (isNaN(changedValue)) {
+ throw new Error(`Cannot convert to float: ${value.toString()}`);
+ }
return changedValue;
}
public static convertToBoolean(value: unknown): boolean {
let result = false;
- // Check boolean
if (value) {
// Check the type
if (typeof value === 'boolean') {
- // Already a boolean
- result = value;
- } else {
- // Convert
- result = value === 'true';
+ return value;
+ } else if (
+ Utils.isString(value) &&
+ ((value as string).toLowerCase() === 'true' || value === '1')
+ ) {
+ result = true;
+ } else if (typeof value === 'number' && value === 1) {
+ result = 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;
return sign * (randomPositiveFloat * (max - min) + min);
}
- public static getRandomInteger(max: number, min = 0): number {
- if (max < 0) {
- throw new RangeError('Invalid interval');
- }
+ public static getRandomInteger(max = Constants.MAX_RANDOM_INTEGER, min = 0): number {
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;
+ 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 {
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);
}
);
}
- public static cloneObject<T>(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<T extends object>(object: T): T {
+ return clone<T>(object);
}
public static isIterable<T>(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 {
}
public static isEmptyString(value: unknown): boolean {
- return Utils.isString(value) && (value as string).length === 0;
+ 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 {
return value == null ? true : false;
}
- public static isEmptyArray(object: unknown): boolean {
- if (!object) {
+ public static isEmptyArray(object: unknown | unknown[]): boolean {
+ if (!Array.isArray(object)) {
return true;
}
- if (Array.isArray(object) && object.length > 0) {
+ if (object.length > 0) {
return false;
}
return true;
}
public static isEmptyObject(obj: object): boolean {
- return !Object.keys(obj).length;
+ if (obj?.constructor !== Object) {
+ return false;
+ }
+ // Iterates over the keys of an object, if
+ // any exist, return false.
+ for (const _ in obj) {
+ return false;
+ }
+ return true;
}
public static insertAt = (str: string, subStr: string, pos: number): string =>
`${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 {
return delay + randomSum;
}
+ public static isPromisePending(promise: Promise<unknown>): boolean {
+ return util.inspect(promise).includes('pending');
+ }
+
public static async promiseWithTimeout<T>(
promise: Promise<T>,
timeoutMs: number,
// Create a timeout promise that rejects in timeout milliseconds
const timeoutPromise = new Promise<never>((_, reject) => {
setTimeout(() => {
- timeoutCallback();
+ if (Utils.isPromisePending(promise)) {
+ timeoutCallback();
+ // FIXME: The original promise shall be canceled
+ }
reject(timeoutError);
}, timeoutMs);
});
public static secureRandom(): number {
return crypto.randomBytes(4).readUInt32LE() / 0x100000000;
}
+
+ public static JSONStringifyWithMapSupport(
+ obj: Record<string, unknown> | Record<string, unknown>[] | Map<unknown, unknown>,
+ space?: number
+ ): string {
+ return JSON.stringify(
+ obj,
+ (key, value: Record<string, unknown>) => {
+ if (value instanceof Map) {
+ return {
+ dataType: 'Map',
+ value: [...value],
+ };
+ }
+ return value;
+ },
+ space
+ );
+ }
+
+ /**
+ * Convert websocket error code to human readable string message
+ *
+ * @param code - websocket error code
+ * @returns human readable string message
+ */
+ public static getWebSocketCloseEventStatusString(code: number): string {
+ if (code >= 0 && code <= 999) {
+ return '(Unused)';
+ } else if (code >= 1016) {
+ if (code <= 1999) {
+ return '(For WebSocket standard)';
+ } else if (code <= 2999) {
+ return '(For WebSocket extensions)';
+ } else if (code <= 3999) {
+ return '(For libraries and frameworks)';
+ } else if (code <= 4999) {
+ return '(For applications)';
+ }
+ }
+ if (!Utils.isUndefined(WebSocketCloseEventStatusString[code])) {
+ return WebSocketCloseEventStatusString[code] as string;
+ }
+ return '(Unknown)';
+ }
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff