src/utils/Utils.ts

   1 import crypto from 'node:crypto';
   2 import util from 'node:util';
   3
   4 import clone from 'just-clone';
   5
   6 import { Constants } from './Constants';
   7 import { WebSocketCloseEventStatusString } from '../types';
   8
   9 export class Utils {
  10   private constructor() {
  11     // This is intentional
  12   }
  13
  14   public static logPrefix = (prefixString = ''): string => {
  15     return `${new Date().toLocaleString()}${prefixString}`;
  16   };
  17
  18   public static generateUUID(): string {
  19     return crypto.randomUUID();
  20   }
  21
  22   public static validateUUID(uuid: string): boolean {
  23     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(
  24       uuid
  25     );
  26   }
  27
  28   public static async sleep(milliSeconds: number): Promise<NodeJS.Timeout> {
  29     return new Promise((resolve) => setTimeout(resolve as () => void, milliSeconds));
  30   }
  31
  32   public static formatDurationMilliSeconds(duration: number): string {
  33     duration = Utils.convertToInt(duration);
  34     const hours = Math.floor(duration / (3600 * 1000));
  35     const minutes = Math.floor((duration / 1000 - hours * 3600) / 60);
  36     const seconds = duration / 1000 - hours * 3600 - minutes * 60;
  37     let hoursStr = hours.toString();
  38     let minutesStr = minutes.toString();
  39     let secondsStr = seconds.toString();
  40
  41     if (hours < 10) {
  42       hoursStr = `0${hours.toString()}`;
  43     }
  44     if (minutes < 10) {
  45       minutesStr = `0${minutes.toString()}`;
  46     }
  47     if (seconds < 10) {
  48       secondsStr = `0${seconds.toString()}`;
  49     }
  50     return `${hoursStr}:${minutesStr}:${secondsStr.substring(0, 6)}`;
  51   }
  52
  53   public static formatDurationSeconds(duration: number): string {
  54     return Utils.formatDurationMilliSeconds(duration * 1000);
  55   }
  56
  57   public static convertToDate(
  58     value: Date | string | number | null | undefined
  59   ): Date | null | undefined {
  60     if (Utils.isNullOrUndefined(value)) {
  61       return value as null | undefined;
  62     }
  63     if (value instanceof Date) {
  64       return value;
  65     }
  66     if (Utils.isString(value) || typeof value === 'number') {
  67       return new Date(value);
  68     }
  69     return null;
  70   }
  71
  72   public static convertToInt(value: unknown): number {
  73     if (!value) {
  74       return 0;
  75     }
  76     let changedValue: number = value as number;
  77     if (Number.isSafeInteger(value)) {
  78       return value as number;
  79     }
  80     if (typeof value === 'number') {
  81       return Math.trunc(value);
  82     }
  83     if (Utils.isString(value)) {
  84       changedValue = parseInt(value as string);
  85     }
  86     if (isNaN(changedValue)) {
  87       throw new Error(`Cannot convert to integer: ${value.toString()}`);
  88     }
  89     return changedValue;
  90   }
  91
  92   public static convertToFloat(value: unknown): number {
  93     if (!value) {
  94       return 0;
  95     }
  96     let changedValue: number = value as number;
  97     if (Utils.isString(value)) {
  98       changedValue = parseFloat(value as string);
  99     }
 100     if (isNaN(changedValue)) {
 101       throw new Error(`Cannot convert to float: ${value.toString()}`);
 102     }
 103     return changedValue;
 104   }
 105
 106   public static convertToBoolean(value: unknown): boolean {
 107     let result = false;
 108     if (value) {
 109       // Check the type
 110       if (typeof value === 'boolean') {
 111         return value;
 112       } else if (
 113         Utils.isString(value) &&
 114         ((value as string).toLowerCase() === 'true' || value === '1')
 115       ) {
 116         result = true;
 117       } else if (typeof value === 'number' && value === 1) {
 118         result = true;
 119       }
 120     }
 121     return result;
 122   }
 123
 124   public static getRandomFloat(max = Number.MAX_VALUE, min = 0): number {
 125     if (max < min) {
 126       throw new RangeError('Invalid interval');
 127     }
 128     if (max - min === Infinity) {
 129       throw new RangeError('Invalid interval');
 130     }
 131     return (crypto.randomBytes(4).readUInt32LE() / 0xffffffff) * (max - min) + min;
 132   }
 133
 134   public static getRandomInteger(max = Constants.MAX_RANDOM_INTEGER, min = 0): number {
 135     max = Math.floor(max);
 136     if (!Utils.isNullOrUndefined(min) && min !== 0) {
 137       min = Math.ceil(min);
 138       return Math.floor(crypto.randomInt(min, max + 1));
 139     }
 140     return Math.floor(crypto.randomInt(max + 1));
 141   }
 142
 143   public static roundTo(numberValue: number, scale: number): number {
 144     const roundPower = Math.pow(10, scale);
 145     return Math.round(numberValue * roundPower * (1 + Number.EPSILON)) / roundPower;
 146   }
 147
 148   public static getRandomFloatRounded(max = Number.MAX_VALUE, min = 0, scale = 2): number {
 149     if (min) {
 150       return Utils.roundTo(Utils.getRandomFloat(max, min), scale);
 151     }
 152     return Utils.roundTo(Utils.getRandomFloat(max), scale);
 153   }
 154
 155   public static getRandomFloatFluctuatedRounded(
 156     staticValue: number,
 157     fluctuationPercent: number,
 158     scale = 2
 159   ): number {
 160     if (fluctuationPercent === 0) {
 161       return Utils.roundTo(staticValue, scale);
 162     }
 163     const fluctuationRatio = fluctuationPercent / 100;
 164     return Utils.getRandomFloatRounded(
 165       staticValue * (1 + fluctuationRatio),
 166       staticValue * (1 - fluctuationRatio),
 167       scale
 168     );
 169   }
 170
 171   public static isObject(item: unknown): boolean {
 172     return (
 173       Utils.isNullOrUndefined(item) === false &&
 174       typeof item === 'object' &&
 175       Array.isArray(item) === false
 176     );
 177   }
 178
 179   public static cloneObject<T extends object>(object: T): T {
 180     return clone<T>(object);
 181   }
 182
 183   public static hasOwnProp(object: unknown, property: PropertyKey): boolean {
 184     return Utils.isObject(object) && Object.hasOwn(object as object, property);
 185   }
 186
 187   public static isCFEnvironment(): boolean {
 188     return !Utils.isNullOrUndefined(process.env.VCAP_APPLICATION);
 189   }
 190
 191   public static isIterable<T>(obj: T): boolean {
 192     return !Utils.isNullOrUndefined(obj) ? typeof obj[Symbol.iterator] === 'function' : false;
 193   }
 194
 195   public static isString(value: unknown): boolean {
 196     return typeof value === 'string';
 197   }
 198
 199   public static isEmptyString(value: unknown): boolean {
 200     return (
 201       Utils.isNullOrUndefined(value) ||
 202       (Utils.isString(value) && (value as string).trim().length === 0)
 203     );
 204   }
 205
 206   public static isNotEmptyString(value: unknown): boolean {
 207     return Utils.isString(value) && (value as string).trim().length > 0;
 208   }
 209
 210   public static isUndefined(value: unknown): boolean {
 211     return value === undefined;
 212   }
 213
 214   public static isNullOrUndefined(value: unknown): boolean {
 215     // eslint-disable-next-line eqeqeq, no-eq-null
 216     return value == null;
 217   }
 218
 219   public static isEmptyArray(object: unknown): boolean {
 220     return Array.isArray(object) && object.length === 0;
 221   }
 222
 223   public static isNotEmptyArray(object: unknown): boolean {
 224     return Array.isArray(object) && object.length > 0;
 225   }
 226
 227   public static isEmptyObject(obj: object): boolean {
 228     if (obj?.constructor !== Object) {
 229       return false;
 230     }
 231     // Iterates over the keys of an object, if
 232     // any exist, return false.
 233     for (const _ in obj) {
 234       return false;
 235     }
 236     return true;
 237   }
 238
 239   public static insertAt = (str: string, subStr: string, pos: number): string =>
 240     `${str.slice(0, pos)}${subStr}${str.slice(pos)}`;
 241
 242   /**
 243    * @param retryNumber - the number of retries that have already been attempted
 244    * @returns delay in milliseconds
 245    */
 246   public static exponentialDelay(retryNumber = 0, maxDelayRatio = 0.2): number {
 247     const delay = Math.pow(2, retryNumber) * 100;
 248     const randomSum = delay * maxDelayRatio * Utils.secureRandom(); // 0-20% of the delay
 249     return delay + randomSum;
 250   }
 251
 252   public static isPromisePending(promise: Promise<unknown>): boolean {
 253     return util.inspect(promise).includes('pending');
 254   }
 255
 256   public static async promiseWithTimeout<T>(
 257     promise: Promise<T>,
 258     timeoutMs: number,
 259     timeoutError: Error,
 260     timeoutCallback: () => void = () => {
 261       /* This is intentional */
 262     }
 263   ): Promise<T> {
 264     // Create a timeout promise that rejects in timeout milliseconds
 265     const timeoutPromise = new Promise<never>((_, reject) => {
 266       setTimeout(() => {
 267         if (Utils.isPromisePending(promise)) {
 268           timeoutCallback();
 269           // FIXME: The original promise shall be canceled
 270         }
 271         reject(timeoutError);
 272       }, timeoutMs);
 273     });
 274
 275     // Returns a race between timeout promise and the passed promise
 276     return Promise.race<T>([promise, timeoutPromise]);
 277   }
 278
 279   /**
 280    * Generate a cryptographically secure random number in the [0,1[ range
 281    *
 282    * @returns
 283    */
 284   public static secureRandom(): number {
 285     return crypto.randomBytes(4).readUInt32LE() / 0x100000000;
 286   }
 287
 288   public static JSONStringifyWithMapSupport(
 289     obj: Record<string, unknown> | Record<string, unknown>[] | Map<unknown, unknown>,
 290     space?: number
 291   ): string {
 292     return JSON.stringify(
 293       obj,
 294       (key, value: Record<string, unknown>) => {
 295         if (value instanceof Map) {
 296           return {
 297             dataType: 'Map',
 298             value: [...value],
 299           };
 300         }
 301         return value;
 302       },
 303       space
 304     );
 305   }
 306
 307   /**
 308    * Convert websocket error code to human readable string message
 309    *
 310    * @param code - websocket error code
 311    * @returns human readable string message
 312    */
 313   public static getWebSocketCloseEventStatusString(code: number): string {
 314     if (code >= 0 && code <= 999) {
 315       return '(Unused)';
 316     } else if (code >= 1016) {
 317       if (code <= 1999) {
 318         return '(For WebSocket standard)';
 319       } else if (code <= 2999) {
 320         return '(For WebSocket extensions)';
 321       } else if (code <= 3999) {
 322         return '(For libraries and frameworks)';
 323       } else if (code <= 4999) {
 324         return '(For applications)';
 325       }
 326     }
 327     if (!Utils.isUndefined(WebSocketCloseEventStatusString[code])) {
 328       return WebSocketCloseEventStatusString[code] as string;
 329     }
 330     return '(Unknown)';
 331   }
 332 }