Disable web ui sonar CI action
[e-mobility-charging-stations-simulator.git] / src / utils / Utils.ts
index 8eebc2abe64a2526984ee2f0eb2bf56ddcaa505f..bc957c24a497ce38e5d02da80b1e7d3931bdf027 100644 (file)
@@ -1,16 +1,24 @@
-import Configuration from './Configuration';
-import { WebSocketCloseEventStatusString } from '../types/WebSocket';
-import { WorkerProcessType } from '../types/Worker';
 import crypto from 'crypto';
-import { v4 as uuid } from 'uuid';
+
+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 generateUUID(): string {
-    return uuid();
+    return crypto.randomUUID();
+  }
+
+  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> {
@@ -99,8 +107,8 @@ export default class Utils {
     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;
@@ -108,15 +116,12 @@ export default class Utils {
     return sign * (randomPositiveFloat * (max - min) + min);
   }
 
-  public static getRandomInteger(max: number, min = 0): number {
-    if (max < 0) {
+  public static getRandomInteger(max = Number.MAX_SAFE_INTEGER, min = 0): number {
+    if (max < min || max < 0 || min < 0) {
       throw new RangeError('Invalid interval');
     }
     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;
     }
@@ -133,7 +138,7 @@ export default class Utils {
     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);
     }
@@ -161,10 +166,7 @@ export default class Utils {
   }
 
   public static isIterable<T>(obj: T): boolean {
-    if (obj) {
-      return typeof obj[Symbol.iterator] === 'function';
-    }
-    return false;
+    return obj ? typeof obj[Symbol.iterator] === 'function' : false;
   }
 
   public static isString(value: unknown): boolean {
@@ -172,7 +174,7 @@ export default class Utils {
   }
 
   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 {
@@ -180,25 +182,30 @@ export default class Utils {
   }
 
   public static isNullOrUndefined(value: unknown): boolean {
-    // eslint-disable-next-line no-eq-null, eqeqeq
-    if (value == null) {
-      return true;
-    }
-    return false;
+    // eslint-disable-next-line eqeqeq, no-eq-null
+    return value == null ? true : false;
   }
 
   public static isEmptyArray(object: unknown): boolean {
-    if (!object) {
-      return true;
+    if (!Array.isArray(object)) {
+      return false;
     }
-    if (Array.isArray(object) && object.length > 0) {
+    if ((object as unknown[]).length > 0) {
       return false;
     }
     return true;
   }
 
-  public static isEmptyObject(obj: Record<string, unknown>): boolean {
-    return !Object.keys(obj).length;
+  public static isEmptyObject(obj: object): boolean {
+    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 =>
@@ -214,42 +221,6 @@ export default class Utils {
     return delay + randomSum;
   }
 
-  /**
-   * 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)';
-  }
-
-  public static workerPoolInUse(): boolean {
-    return [WorkerProcessType.DYNAMIC_POOL, WorkerProcessType.STATIC_POOL].includes(
-      Configuration.getWorkerProcess()
-    );
-  }
-
-  public static workerDynamicPoolInUse(): boolean {
-    return Configuration.getWorkerProcess() === WorkerProcessType.DYNAMIC_POOL;
-  }
-
   public static async promiseWithTimeout<T>(
     promise: Promise<T>,
     timeoutMs: number,
@@ -278,4 +249,49 @@ export default class Utils {
   public static secureRandom(): number {
     return crypto.randomBytes(4).readUInt32LE() / 0x100000000;
   }
+
+  public static JSONStringifyWithMapSupport(
+    obj: Record<string, unknown> | Record<string, 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)';
+  }
 }