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     return changedValue;
  79   }
  80
  81   public static convertToFloat(value: unknown): number {
  82     let changedValue: number = value as number;
  83     if (!value) {
  84       return 0;
  85     }
  86     // Check
  87     if (Utils.isString(value)) {
  88       // Create Object
  89       changedValue = parseFloat(value as string);
  90     }
  91     return changedValue;
  92   }
  93
  94   public static convertToBoolean(value: unknown): boolean {
  95     let result = false;
  96     // Check boolean
  97     if (value) {
  98       // Check the type
  99       if (typeof value === 'boolean') {
 100         // Already a boolean
 101         result = value;
 102       } else {
 103         // Convert
 104         result = value === 'true';
 105       }
 106     }
 107     return result;
 108   }
 109
 110   public static getRandomFloat(max = Number.MAX_VALUE, min = 0, negative = false): number {
 111     if (max < min || max < 0 || min < 0) {
 112       throw new RangeError('Invalid interval');
 113     }
 114     const randomPositiveFloat = crypto.randomBytes(4).readUInt32LE() / 0xffffffff;
 115     const sign = negative && randomPositiveFloat < 0.5 ? -1 : 1;
 116     return sign * (randomPositiveFloat * (max - min) + min);
 117   }
 118
 119   public static getRandomInteger(max = Number.MAX_SAFE_INTEGER, min = 0): number {
 120     if (max < min || max < 0 || min < 0) {
 121       throw new RangeError('Invalid interval');
 122     }
 123     max = Math.floor(max);
 124     if (!Utils.isNullOrUndefined(min) && min !== 0) {
 125       min = Math.ceil(min);
 126       return Math.floor(Utils.secureRandom() * (max - min + 1)) + min;
 127     }
 128     return Math.floor(Utils.secureRandom() * (max + 1));
 129   }
 130
 131   public static roundTo(numberValue: number, scale: number): number {
 132     const roundPower = Math.pow(10, scale);
 133     return Math.round(numberValue * roundPower) / roundPower;
 134   }
 135
 136   public static truncTo(numberValue: number, scale: number): number {
 137     const truncPower = Math.pow(10, scale);
 138     return Math.trunc(numberValue * truncPower) / truncPower;
 139   }
 140
 141   public static getRandomFloatRounded(max = Number.MAX_VALUE, min = 0, scale = 2): number {
 142     if (min) {
 143       return Utils.roundTo(Utils.getRandomFloat(max, min), scale);
 144     }
 145     return Utils.roundTo(Utils.getRandomFloat(max), scale);
 146   }
 147
 148   public static getRandomFloatFluctuatedRounded(
 149     staticValue: number,
 150     fluctuationPercent: number,
 151     scale = 2
 152   ): number {
 153     if (fluctuationPercent === 0) {
 154       return Utils.roundTo(staticValue, scale);
 155     }
 156     const fluctuationRatio = fluctuationPercent / 100;
 157     return Utils.getRandomFloatRounded(
 158       staticValue * (1 + fluctuationRatio),
 159       staticValue * (1 - fluctuationRatio),
 160       scale
 161     );
 162   }
 163
 164   public static cloneObject<T>(object: T): T {
 165     return JSON.parse(JSON.stringify(object)) as T;
 166   }
 167
 168   public static isIterable<T>(obj: T): boolean {
 169     return obj ? typeof obj[Symbol.iterator] === 'function' : false;
 170   }
 171
 172   public static isString(value: unknown): boolean {
 173     return typeof value === 'string';
 174   }
 175
 176   public static isEmptyString(value: unknown): boolean {
 177     return Utils.isString(value) && (value as string).trim().length === 0;
 178   }
 179
 180   public static isUndefined(value: unknown): boolean {
 181     return typeof value === 'undefined';
 182   }
 183
 184   public static isNullOrUndefined(value: unknown): boolean {
 185     // eslint-disable-next-line eqeqeq, no-eq-null
 186     return value == null ? true : false;
 187   }
 188
 189   public static isEmptyArray(object: unknown | unknown[]): boolean {
 190     if (!Array.isArray(object)) {
 191       return false;
 192     }
 193     if (object.length > 0) {
 194       return false;
 195     }
 196     return true;
 197   }
 198
 199   public static isEmptyObject(obj: object): boolean {
 200     if (obj?.constructor !== Object) {
 201       return false;
 202     }
 203     // Iterates over the keys of an object, if
 204     // any exist, return false.
 205     for (const _ in obj) {
 206       return false;
 207     }
 208     return true;
 209   }
 210
 211   public static insertAt = (str: string, subStr: string, pos: number): string =>
 212     `${str.slice(0, pos)}${subStr}${str.slice(pos)}`;
 213
 214   /**
 215    * @param [retryNumber=0]
 216    * @returns delay in milliseconds
 217    */
 218   public static exponentialDelay(retryNumber = 0): number {
 219     const delay = Math.pow(2, retryNumber) * 100;
 220     const randomSum = delay * 0.2 * Utils.secureRandom(); // 0-20% of the delay
 221     return delay + randomSum;
 222   }
 223
 224   public static async promiseWithTimeout<T>(
 225     promise: Promise<T>,
 226     timeoutMs: number,
 227     timeoutError: Error,
 228     timeoutCallback: () => void = () => {
 229       /* This is intentional */
 230     }
 231   ): Promise<T> {
 232     // Create a timeout promise that rejects in timeout milliseconds
 233     const timeoutPromise = new Promise<never>((_, reject) => {
 234       setTimeout(() => {
 235         timeoutCallback();
 236         reject(timeoutError);
 237       }, timeoutMs);
 238     });
 239
 240     // Returns a race between timeout promise and the passed promise
 241     return Promise.race<T>([promise, timeoutPromise]);
 242   }
 243
 244   /**
 245    * Generate a cryptographically secure random number in the [0,1[ range
 246    *
 247    * @returns
 248    */
 249   public static secureRandom(): number {
 250     return crypto.randomBytes(4).readUInt32LE() / 0x100000000;
 251   }
 252
 253   public static JSONStringifyWithMapSupport(
 254     obj: Record<string, unknown> | Record<string, unknown>[],
 255     space?: number
 256   ): string {
 257     return JSON.stringify(
 258       obj,
 259       (key, value: Record<string, unknown>) => {
 260         if (value instanceof Map) {
 261           return {
 262             dataType: 'Map',
 263             value: [...value],
 264           };
 265         }
 266         return value;
 267       },
 268       space
 269     );
 270   }
 271
 272   /**
 273    * Convert websocket error code to human readable string message
 274    *
 275    * @param code websocket error code
 276    * @returns human readable string message
 277    */
 278   public static getWebSocketCloseEventStatusString(code: number): string {
 279     if (code >= 0 && code <= 999) {
 280       return '(Unused)';
 281     } else if (code >= 1016) {
 282       if (code <= 1999) {
 283         return '(For WebSocket standard)';
 284       } else if (code <= 2999) {
 285         return '(For WebSocket extensions)';
 286       } else if (code <= 3999) {
 287         return '(For libraries and frameworks)';
 288       } else if (code <= 4999) {
 289         return '(For applications)';
 290       }
 291     }
 292     if (!Utils.isUndefined(WebSocketCloseEventStatusString[code])) {
 293       return WebSocketCloseEventStatusString[code] as string;
 294     }
 295     return '(Unknown)';
 296   }
 297 }