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   /**
 144    * Rounds the given number to the given scale.
 145    * The rounding is done using the "round half away from zero" method.
 146    *
 147    * @param numberValue - The number to round.
 148    * @param scale - The scale to round to.
 149    * @returns The rounded number.
 150    */
 151   public static roundTo(numberValue: number, scale: number): number {
 152     const roundPower = Math.pow(10, scale);
 153     return Math.round(numberValue * roundPower * (1 + Number.EPSILON)) / roundPower;
 154   }
 155
 156   public static getRandomFloatRounded(max = Number.MAX_VALUE, min = 0, scale = 2): number {
 157     if (min) {
 158       return Utils.roundTo(Utils.getRandomFloat(max, min), scale);
 159     }
 160     return Utils.roundTo(Utils.getRandomFloat(max), scale);
 161   }
 162
 163   public static getRandomFloatFluctuatedRounded(
 164     staticValue: number,
 165     fluctuationPercent: number,
 166     scale = 2
 167   ): number {
 168     if (fluctuationPercent === 0) {
 169       return Utils.roundTo(staticValue, scale);
 170     }
 171     const fluctuationRatio = fluctuationPercent / 100;
 172     return Utils.getRandomFloatRounded(
 173       staticValue * (1 + fluctuationRatio),
 174       staticValue * (1 - fluctuationRatio),
 175       scale
 176     );
 177   }
 178
 179   public static isObject(item: unknown): boolean {
 180     return (
 181       Utils.isNullOrUndefined(item) === false &&
 182       typeof item === 'object' &&
 183       Array.isArray(item) === false
 184     );
 185   }
 186
 187   public static cloneObject<T extends object>(object: T): T {
 188     return clone<T>(object);
 189   }
 190
 191   public static hasOwnProp(object: unknown, property: PropertyKey): boolean {
 192     return Utils.isObject(object) && Object.hasOwn(object as object, property);
 193   }
 194
 195   public static isCFEnvironment(): boolean {
 196     return !Utils.isNullOrUndefined(process.env.VCAP_APPLICATION);
 197   }
 198
 199   public static isIterable<T>(obj: T): boolean {
 200     return !Utils.isNullOrUndefined(obj) ? typeof obj[Symbol.iterator] === 'function' : false;
 201   }
 202
 203   public static isString(value: unknown): boolean {
 204     return typeof value === 'string';
 205   }
 206
 207   public static isEmptyString(value: unknown): boolean {
 208     return (
 209       Utils.isNullOrUndefined(value) ||
 210       (Utils.isString(value) && (value as string).trim().length === 0)
 211     );
 212   }
 213
 214   public static isNotEmptyString(value: unknown): boolean {
 215     return Utils.isString(value) && (value as string).trim().length > 0;
 216   }
 217
 218   public static isUndefined(value: unknown): boolean {
 219     return value === undefined;
 220   }
 221
 222   public static isNullOrUndefined(value: unknown): boolean {
 223     // eslint-disable-next-line eqeqeq, no-eq-null
 224     return value == null;
 225   }
 226
 227   public static isEmptyArray(object: unknown): boolean {
 228     return Array.isArray(object) && object.length === 0;
 229   }
 230
 231   public static isNotEmptyArray(object: unknown): boolean {
 232     return Array.isArray(object) && object.length > 0;
 233   }
 234
 235   public static isEmptyObject(obj: object): boolean {
 236     if (obj?.constructor !== Object) {
 237       return false;
 238     }
 239     // Iterates over the keys of an object, if
 240     // any exist, return false.
 241     for (const _ in obj) {
 242       return false;
 243     }
 244     return true;
 245   }
 246
 247   public static insertAt = (str: string, subStr: string, pos: number): string =>
 248     `${str.slice(0, pos)}${subStr}${str.slice(pos)}`;
 249
 250   /**
 251    * Computes the retry delay in milliseconds using an exponential backoff algorithm.
 252    *
 253    * @param retryNumber - the number of retries that have already been attempted
 254    * @returns delay in milliseconds
 255    */
 256   public static exponentialDelay(retryNumber = 0, maxDelayRatio = 0.2): number {
 257     const delay = Math.pow(2, retryNumber) * 100;
 258     const randomSum = delay * maxDelayRatio * Utils.secureRandom(); // 0-20% of the delay
 259     return delay + randomSum;
 260   }
 261
 262   public static isPromisePending(promise: Promise<unknown>): boolean {
 263     return util.inspect(promise).includes('pending');
 264   }
 265
 266   public static async promiseWithTimeout<T>(
 267     promise: Promise<T>,
 268     timeoutMs: number,
 269     timeoutError: Error,
 270     timeoutCallback: () => void = () => {
 271       /* This is intentional */
 272     }
 273   ): Promise<T> {
 274     // Create a timeout promise that rejects in timeout milliseconds
 275     const timeoutPromise = new Promise<never>((_, reject) => {
 276       setTimeout(() => {
 277         if (Utils.isPromisePending(promise)) {
 278           timeoutCallback();
 279           // FIXME: The original promise shall be canceled
 280         }
 281         reject(timeoutError);
 282       }, timeoutMs);
 283     });
 284
 285     // Returns a race between timeout promise and the passed promise
 286     return Promise.race<T>([promise, timeoutPromise]);
 287   }
 288
 289   /**
 290    * Generates a cryptographically secure random number in the [0,1[ range
 291    *
 292    * @returns
 293    */
 294   public static secureRandom(): number {
 295     return crypto.randomBytes(4).readUInt32LE() / 0x100000000;
 296   }
 297
 298   public static JSONStringifyWithMapSupport(
 299     obj: Record<string, unknown> | Record<string, unknown>[] | Map<unknown, unknown>,
 300     space?: number
 301   ): string {
 302     return JSON.stringify(
 303       obj,
 304       (key, value: Record<string, unknown>) => {
 305         if (value instanceof Map) {
 306           return {
 307             dataType: 'Map',
 308             value: [...value],
 309           };
 310         }
 311         return value;
 312       },
 313       space
 314     );
 315   }
 316
 317   /**
 318    * Converts websocket error code to human readable string message
 319    *
 320    * @param code - websocket error code
 321    * @returns human readable string message
 322    */
 323   public static getWebSocketCloseEventStatusString(code: number): string {
 324     if (code >= 0 && code <= 999) {
 325       return '(Unused)';
 326     } else if (code >= 1016) {
 327       if (code <= 1999) {
 328         return '(For WebSocket standard)';
 329       } else if (code <= 2999) {
 330         return '(For WebSocket extensions)';
 331       } else if (code <= 3999) {
 332         return '(For libraries and frameworks)';
 333       } else if (code <= 4999) {
 334         return '(For applications)';
 335       }
 336     }
 337     if (!Utils.isUndefined(WebSocketCloseEventStatusString[code])) {
 338       return WebSocketCloseEventStatusString[code] as string;
 339     }
 340     return '(Unknown)';
 341   }
 342 }