X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FUtils.ts;h=bc957c24a497ce38e5d02da80b1e7d3931bdf027;hb=c2d3028f2593d516d2a4e0c8d2bb646f6052a392;hp=4876f46db8c0483b72e0d81e6affd76941673e46;hpb=963ee397d378bffb9d41154a38bd6a83e4ac0fb8;p=e-mobility-charging-stations-simulator.git

diff --git a/src/utils/Utils.ts b/src/utils/Utils.ts
index 4876f46d..bc957c24 100644
--- a/src/utils/Utils.ts
+++ b/src/utils/Utils.ts
@@ -1,80 +1,97 @@
-import { v4 as uuid } from 'uuid';
+import crypto from 'crypto';
+
+import { WebSocketCloseEventStatusString } from '../types/WebSocket';
 
 export default class Utils {
-  static generateUUID(): string {
-    return uuid();
+  private constructor() {
+    // This is intentional
   }
 
-  static async sleep(milliSeconds: number): Promise<NodeJS.Timeout> {
-    return new Promise((resolve) => setTimeout(resolve, milliSeconds));
+  public static logPrefix(prefixString = ''): string {
+    return new Date().toLocaleString() + prefixString;
   }
 
-  static secondsToHHMMSS(seconds: number): string {
-    return new Date(seconds * 1000).toISOString().substr(11, 8);
+  public static generateUUID(): string {
+    return crypto.randomUUID();
   }
 
-  static milliSecondsToHHMMSS(milliSeconds: number): string {
-    return new Date(milliSeconds).toISOString().substr(11, 8);
+  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
+    );
   }
 
-  static removeExtraEmptyLines(tab): void {
-    // Start from the end
-    for (let i = tab.length - 1; i > 0; i--) {
-      // Two consecutive empty lines?
-      if (tab[i].length === 0 && tab[i - 1].length === 0) {
-        // Remove the last one
-        tab.splice(i, 1);
-      }
-      // Check last line
-      if (i === 1 && tab[i - 1].length === 0) {
-        // Remove the first one
-        tab.splice(i - 1, 1);
-      }
+  public static async sleep(milliSeconds: number): Promise<NodeJS.Timeout> {
+    return new Promise((resolve) => setTimeout(resolve as () => void, milliSeconds));
+  }
+
+  public static formatDurationMilliSeconds(duration: number): string {
+    duration = Utils.convertToInt(duration);
+    const hours = Math.floor(duration / (3600 * 1000));
+    const minutes = Math.floor((duration / 1000 - hours * 3600) / 60);
+    const seconds = duration / 1000 - hours * 3600 - minutes * 60;
+    let hoursStr = hours.toString();
+    let minutesStr = minutes.toString();
+    let secondsStr = seconds.toString();
+
+    if (hours < 10) {
+      hoursStr = '0' + hours.toString();
     }
+    if (minutes < 10) {
+      minutesStr = '0' + minutes.toString();
+    }
+    if (seconds < 10) {
+      secondsStr = '0' + seconds.toString();
+    }
+    return hoursStr + ':' + minutesStr + ':' + secondsStr.substring(0, 6);
+  }
+
+  public static formatDurationSeconds(duration: number): string {
+    return Utils.formatDurationMilliSeconds(duration * 1000);
   }
 
-  static convertToDate(value): Date {
+  public static convertToDate(value: unknown): Date {
     // Check
     if (!value) {
-      return value;
+      return value as Date;
     }
     // Check Type
     if (!(value instanceof Date)) {
-      return new Date(value);
+      return new Date(value as string);
     }
     return value;
   }
 
-  static convertToInt(value): number {
-    let changedValue = value;
+  public static convertToInt(value: unknown): number {
+    let changedValue: number = value as number;
     if (!value) {
       return 0;
     }
     if (Number.isSafeInteger(value)) {
-      return value;
+      return value as number;
     }
     // Check
-    if (typeof value === 'string') {
+    if (Utils.isString(value)) {
       // Create Object
-      changedValue = parseInt(value);
+      changedValue = parseInt(value as string);
     }
     return changedValue;
   }
 
-  static convertToFloat(value): number {
-    let changedValue = value;
+  public static convertToFloat(value: unknown): number {
+    let changedValue: number = value as number;
     if (!value) {
       return 0;
     }
     // Check
-    if (typeof value === 'string') {
+    if (Utils.isString(value)) {
       // Create Object
-      changedValue = parseFloat(value);
+      changedValue = parseFloat(value as string);
     }
     return changedValue;
   }
 
-  static convertToBoolean(value): boolean {
+  public static convertToBoolean(value: unknown): boolean {
     let result = false;
     // Check boolean
     if (value) {
@@ -84,102 +101,197 @@ export default class Utils {
         result = value;
       } else {
         // Convert
-        result = (value === 'true');
+        result = value === 'true';
       }
     }
     return result;
   }
 
-  static getRandomFloat(max: number, min = 0): number {
-    return Math.random() < 0.5 ? (1 - Math.random()) * (max - min) + min : Math.random() * (max - min) + min;
+  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;
+    const sign = negative && randomPositiveFloat < 0.5 ? -1 : 1;
+    return sign * (randomPositiveFloat * (max - min) + min);
   }
 
-  static getRandomInt(max: number, min = 0): number {
-    if (min) {
-      return Math.floor(Math.random() * (max - min + 1) + min);
+  public static getRandomInteger(max = Number.MAX_SAFE_INTEGER, min = 0): number {
+    if (max < min || max < 0 || min < 0) {
+      throw new RangeError('Invalid interval');
     }
-    return Math.floor(Math.random() * max + 1);
+    max = Math.floor(max);
+    if (!Utils.isNullOrUndefined(min) && min !== 0) {
+      min = Math.ceil(min);
+      return Math.floor(Utils.secureRandom() * (max - min + 1)) + min;
+    }
+    return Math.floor(Utils.secureRandom() * (max + 1));
+  }
+
+  public static roundTo(numberValue: number, scale: number): number {
+    const roundPower = Math.pow(10, scale);
+    return Math.round(numberValue * roundPower) / roundPower;
   }
 
-  static roundTo(number: number, scale: number): number {
-    return Utils.convertToFloat(number.toFixed(scale));
+  public static truncTo(numberValue: number, scale: number): number {
+    const truncPower = Math.pow(10, scale);
+    return Math.trunc(numberValue * truncPower) / truncPower;
   }
 
-  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);
     }
     return Utils.roundTo(Utils.getRandomFloat(max), scale);
   }
 
-  static logPrefix(prefixString = ''): string {
-    const date = new Date();
-    return date.toLocaleString() + prefixString;
+  public static getRandomFloatFluctuatedRounded(
+    staticValue: number,
+    fluctuationPercent: number,
+    scale = 2
+  ): number {
+    if (fluctuationPercent === 0) {
+      return Utils.roundTo(staticValue, scale);
+    }
+    const fluctuationRatio = fluctuationPercent / 100;
+    return Utils.getRandomFloatRounded(
+      staticValue * (1 + fluctuationRatio),
+      staticValue * (1 - fluctuationRatio),
+      scale
+    );
   }
 
-  static cloneObject(object) {
-    return JSON.parse(JSON.stringify(object));
+  public static cloneObject<T>(object: T): T {
+    return JSON.parse(JSON.stringify(object)) as T;
   }
 
-  static isIterable(obj): boolean {
-    if (obj) {
-      return typeof obj[Symbol.iterator] === 'function';
-    }
-    return false;
+  public static isIterable<T>(obj: T): boolean {
+    return obj ? typeof obj[Symbol.iterator] === 'function' : false;
   }
 
-  static isEmptyJSon(document): boolean {
-    // Empty?
-    if (!document) {
-      return true;
-    }
-    // Check type
-    if (typeof document !== 'object') {
-      return true;
-    }
-    // Check
-    return Object.keys(document).length === 0;
+  public static isString(value: unknown): boolean {
+    return typeof value === 'string';
   }
 
-  static isString(value): boolean {
-    return typeof value === 'string';
+  public static isEmptyString(value: unknown): boolean {
+    return Utils.isString(value) && (value as string).trim().length === 0;
   }
 
-  static isUndefined(value): boolean {
+  public static isUndefined(value: unknown): boolean {
     return typeof value === 'undefined';
   }
 
-  static isNullOrUndefined(value): boolean {
-    // eslint-disable-next-line no-eq-null
-    if (value == null) {
-      return true;
-    }
-    return false;
+  public static isNullOrUndefined(value: unknown): boolean {
+    // eslint-disable-next-line eqeqeq, no-eq-null
+    return value == null ? true : false;
   }
 
-  static isEmptyArray(object): boolean {
-    if (!object) {
-      return true;
+  public static isEmptyArray(object: unknown): boolean {
+    if (!Array.isArray(object)) {
+      return false;
     }
-    if (Array.isArray(object) && object.length > 0) {
+    if ((object as unknown[]).length > 0) {
       return false;
     }
     return true;
   }
 
-  static isEmptyObject(obj): 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;
   }
 
-  static insertAt = (str: string, subStr: string, pos: number): string => `${str.slice(0, pos)}${subStr}${str.slice(pos)}`;
+  public static insertAt = (str: string, subStr: string, pos: number): string =>
+    `${str.slice(0, pos)}${subStr}${str.slice(pos)}`;
 
   /**
-   * @param  {number} [retryNumber=0]
-   * @return {number} - delay in milliseconds
+   * @param [retryNumber=0]
+   * @returns delay in milliseconds
    */
-  static exponentialDelay(retryNumber = 0): number {
+  public static exponentialDelay(retryNumber = 0): number {
     const delay = Math.pow(2, retryNumber) * 100;
-    const randomSum = delay * 0.2 * Math.random(); // 0-20% of the delay
+    const randomSum = delay * 0.2 * Utils.secureRandom(); // 0-20% of the delay
     return delay + randomSum;
   }
+
+  public static async promiseWithTimeout<T>(
+    promise: Promise<T>,
+    timeoutMs: number,
+    timeoutError: Error,
+    timeoutCallback: () => void = () => {
+      /* This is intentional */
+    }
+  ): Promise<T> {
+    // Create a timeout promise that rejects in timeout milliseconds
+    const timeoutPromise = new Promise<never>((_, reject) => {
+      setTimeout(() => {
+        timeoutCallback();
+        reject(timeoutError);
+      }, timeoutMs);
+    });
+
+    // Returns a race between timeout promise and the passed promise
+    return Promise.race<T>([promise, timeoutPromise]);
+  }
+
+  /**
+   * Generate a cryptographically secure random number in the [0,1[ range
+   *
+   * @returns
+   */
+  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)';
+  }
 }