src/utils/Utils.ts

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