X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FUtils.ts;h=3d8c73bdf0cdbeec9516dd079832587a0696ebba;hb=60655b2618d2d049b20efb78c1a75a75c2874db6;hp=6b3349d0af83d5fb7c9c7b4c8f140762ff6adc5f;hpb=087a502dd0b03aa2107ebd6355062397e86d5e7f;p=e-mobility-charging-stations-simulator.git

diff --git a/src/utils/Utils.ts b/src/utils/Utils.ts
index 6b3349d0..3d8c73bd 100644
--- a/src/utils/Utils.ts
+++ b/src/utils/Utils.ts
@@ -1,211 +1,321 @@
-import Configuration from './Configuration';
-import { WebSocketCloseEventStatusString } from '../types/WebSocket';
-import { WorkerProcessType } from '../types/Worker';
-import { v4 as uuid } from 'uuid';
+import crypto from 'node:crypto';
+import util from 'node:util';
 
-export default class Utils {
-  static logPrefix(prefixString = ''): string {
-    return new Date().toLocaleString() + prefixString;
-  }
+import clone from 'just-clone';
+
+import { Constants } from './Constants';
+import { WebSocketCloseEventStatusString } from '../types';
 
-  static generateUUID(): string {
-    return uuid();
+export class Utils {
+  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}`;
+  };
+
+  public static generateUUID(): string {
+    return crypto.randomUUID();
   }
 
-  static secondsToHHMMSS(seconds: number): string {
-    return Utils.milliSecondsToHHMMSS(seconds * 1000);
+  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 milliSecondsToHHMMSS(milliSeconds: number): string {
-    return new Date(milliSeconds).toISOString().substr(11, 8);
+  public static async sleep(milliSeconds: number): Promise<NodeJS.Timeout> {
+    return new Promise((resolve) => setTimeout(resolve as () => void, milliSeconds));
   }
 
-  static removeExtraEmptyLines(tab: string[]): 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 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)}`;
   }
 
-  static convertToDate(value: any): Date {
-    // Check
-    if (!value) {
+  public static formatDurationSeconds(duration: number): string {
+    return Utils.formatDurationMilliSeconds(duration * 1000);
+  }
+
+  public static convertToDate(
+    value: Date | string | number | null | undefined
+  ): Date | null | undefined {
+    if (Utils.isNullOrUndefined(value)) {
+      return value as null | undefined;
+    }
+    if (value instanceof Date) {
       return value;
     }
-    // Check Type
-    if (!(value instanceof Date)) {
+    if (Utils.isString(value) || typeof value === 'number') {
       return new Date(value);
     }
-    return value;
+    return null;
   }
 
-  static convertToInt(value: any): number {
-    let changedValue = value;
+  public static convertToInt(value: unknown): number {
     if (!value) {
       return 0;
     }
+    let changedValue: number = value as number;
     if (Number.isSafeInteger(value)) {
-      return value;
+      return value as number;
+    }
+    if (typeof value === 'number') {
+      return Math.trunc(value);
     }
-    // Check
     if (Utils.isString(value)) {
-      // Create Object
-      changedValue = parseInt(value);
+      changedValue = parseInt(value as string);
+    }
+    if (isNaN(changedValue)) {
+      throw new Error(`Cannot convert to integer: ${value.toString()}`);
     }
     return changedValue;
   }
 
-  static convertToFloat(value: any): number {
-    let changedValue = value;
+  public static convertToFloat(value: unknown): number {
     if (!value) {
       return 0;
     }
-    // Check
+    let changedValue: number = value as number;
     if (Utils.isString(value)) {
-      // Create Object
-      changedValue = parseFloat(value);
+      changedValue = parseFloat(value as string);
+    }
+    if (isNaN(changedValue)) {
+      throw new Error(`Cannot convert to float: ${value.toString()}`);
     }
     return changedValue;
   }
 
-  static convertToBoolean(value: any): boolean {
+  public static convertToBoolean(value: unknown): boolean {
     let result = false;
-    // Check boolean
     if (value) {
       // Check the type
       if (typeof value === 'boolean') {
-        // Already a boolean
-        result = value;
-      } else {
-        // Convert
-        result = (value === 'true');
+        return value;
+      } else if (
+        Utils.isString(value) &&
+        ((value as string).toLowerCase() === 'true' || value === '1')
+      ) {
+        result = true;
+      } else if (typeof value === 'number' && value === 1) {
+        result = 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): number {
+    if (max < min) {
+      throw new RangeError('Invalid interval');
+    }
+    if (max - min === Infinity) {
+      throw new RangeError('Invalid interval');
+    }
+    return (crypto.randomBytes(4).readUInt32LE() / 0xffffffff) * (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 = Constants.MAX_RANDOM_INTEGER, min = 0): number {
+    max = Math.floor(max);
+    if (!Utils.isNullOrUndefined(min) && min !== 0) {
+      min = Math.ceil(min);
+      return Math.floor(crypto.randomInt(min, max + 1));
     }
-    return Math.floor(Math.random() * max + 1);
+    return Math.floor(crypto.randomInt(max + 1));
   }
 
-  static roundTo(numberValue: number, scale: number): number {
+  public static roundTo(numberValue: number, scale: number): number {
     const roundPower = Math.pow(10, scale);
     return Math.round(numberValue * roundPower) / roundPower;
   }
 
-  static truncTo(numberValue: number, scale: number): number {
+  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 getRandomFloatFluctuatedRounded(staticValue: number, fluctuationPercent: number, scale = 2): number {
+  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);
+    return Utils.getRandomFloatRounded(
+      staticValue * (1 + fluctuationRatio),
+      staticValue * (1 - fluctuationRatio),
+      scale
+    );
   }
 
-  static cloneObject<T>(object: T): T {
-    return JSON.parse(JSON.stringify(object)) as T;
+  public static isObject(item: unknown): boolean {
+    return (
+      Utils.isNullOrUndefined(item) === false &&
+      typeof item === 'object' &&
+      Array.isArray(item) === false
+    );
   }
 
-  static isIterable<T>(obj: T): boolean {
-    if (obj) {
-      return typeof obj[Symbol.iterator] === 'function';
-    }
-    return false;
+  public static cloneObject<T extends object>(object: T): T {
+    return clone<T>(object);
   }
 
-  static isEmptyJSon(document: any): boolean {
-    // Empty?
-    if (!document) {
-      return true;
-    }
-    // Check type
-    if (typeof document !== 'object') {
-      return true;
-    }
-    // Check
-    return Object.keys(document).length === 0;
+  public static hasOwnProp(object: unknown, property: PropertyKey): boolean {
+    return Utils.isObject(object) && Object.hasOwn(object as object, property);
+  }
+
+  public static isCFEnvironment(): boolean {
+    return !Utils.isNullOrUndefined(process.env.VCAP_APPLICATION);
   }
 
-  static isString(value: any): boolean {
+  public static isIterable<T>(obj: T): boolean {
+    return !Utils.isNullOrUndefined(obj) ? typeof obj[Symbol.iterator] === 'function' : false;
+  }
+
+  public static isString(value: unknown): boolean {
     return typeof value === 'string';
   }
 
-  static isUndefined(value: any): boolean {
-    return typeof value === 'undefined';
+  public static isEmptyString(value: unknown): boolean {
+    return (
+      Utils.isNullOrUndefined(value) ||
+      (Utils.isString(value) && (value as string).trim().length === 0)
+    );
   }
 
-  static isNullOrUndefined(value: any): boolean {
-    // eslint-disable-next-line no-eq-null, eqeqeq
-    if (value == null) {
-      return true;
-    }
-    return false;
+  public static isNotEmptyString(value: unknown): boolean {
+    return Utils.isString(value) && (value as string).trim().length > 0;
+  }
+
+  public static isUndefined(value: unknown): boolean {
+    return value === undefined;
+  }
+
+  public static isNullOrUndefined(value: unknown): boolean {
+    // eslint-disable-next-line eqeqeq, no-eq-null
+    return value == null;
+  }
+
+  public static isEmptyArray(object: unknown): boolean {
+    return Array.isArray(object) && object.length === 0;
+  }
+
+  public static isNotEmptyArray(object: unknown): boolean {
+    return Array.isArray(object) && object.length > 0;
   }
 
-  static isEmptyArray(object: any): boolean {
-    if (!object) {
-      return true;
+  public static isEmptyObject(obj: object): boolean {
+    if (obj?.constructor !== Object) {
+      return false;
     }
-    if (Array.isArray(object) && object.length > 0) {
+    // Iterates over the keys of an object, if
+    // any exist, return false.
+    for (const _ in obj) {
       return false;
     }
     return true;
   }
 
-  static isEmptyObject(obj: any): boolean {
-    return !Object.keys(obj).length;
-  }
-
-  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]
-   * @returns {number} delay in milliseconds
+   * @param retryNumber - the number of retries that have already been attempted
+   * @returns delay in milliseconds
    */
-  static exponentialDelay(retryNumber = 0): number {
+  public static exponentialDelay(retryNumber = 0, maxDelayRatio = 0.2): number {
     const delay = Math.pow(2, retryNumber) * 100;
-    const randomSum = delay * 0.2 * Math.random(); // 0-20% of the delay
+    const randomSum = delay * maxDelayRatio * Utils.secureRandom(); // 0-20% of the delay
     return delay + randomSum;
   }
 
+  public static isPromisePending(promise: Promise<unknown>): boolean {
+    return util.inspect(promise).includes('pending');
+  }
+
+  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(() => {
+        if (Utils.isPromisePending(promise)) {
+          timeoutCallback();
+          // FIXME: The original promise shall be canceled
+        }
+        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>[] | Map<unknown, 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 {number} code websocket error code
-   * @returns {string} human readable string message
+   * @param code - websocket error code
+   * @returns human readable string message
    */
-  static getWebSocketCloseEventStatusString(code: number): string {
+  public static getWebSocketCloseEventStatusString(code: number): string {
     if (code >= 0 && code <= 999) {
       return '(Unused)';
     } else if (code >= 1016) {
@@ -225,11 +335,58 @@ export default class Utils {
     return '(Unknown)';
   }
 
-  static workerPoolInUse(): boolean {
-    return [WorkerProcessType.DYNAMIC_POOL, WorkerProcessType.STATIC_POOL].includes(Configuration.getWorkerProcess());
+  public static median(dataSet: number[]): number {
+    if (Utils.isEmptyArray(dataSet)) {
+      return 0;
+    }
+    if (Array.isArray(dataSet) === true && dataSet.length === 1) {
+      return dataSet[0];
+    }
+    const sortedDataSet = dataSet.slice().sort((a, b) => a - b);
+    return (
+      (sortedDataSet[(sortedDataSet.length - 1) >> 1] + sortedDataSet[sortedDataSet.length >> 1]) /
+      2
+    );
+  }
+
+  // TODO: use order statistics tree https://en.wikipedia.org/wiki/Order_statistic_tree
+  public static percentile(dataSet: number[], percentile: number): number {
+    if (percentile < 0 && percentile > 100) {
+      throw new RangeError('Percentile is not between 0 and 100');
+    }
+    if (Utils.isEmptyArray(dataSet)) {
+      return 0;
+    }
+    const sortedDataSet = dataSet.slice().sort((a, b) => a - b);
+    if (percentile === 0 || sortedDataSet.length === 1) {
+      return sortedDataSet[0];
+    }
+    if (percentile === 100) {
+      return sortedDataSet[sortedDataSet.length - 1];
+    }
+    const percentileIndexBase = (percentile / 100) * (sortedDataSet.length - 1);
+    const percentileIndexInteger = Math.floor(percentileIndexBase);
+    if (!Utils.isNullOrUndefined(sortedDataSet[percentileIndexInteger + 1])) {
+      return (
+        sortedDataSet[percentileIndexInteger] +
+        (percentileIndexBase - percentileIndexInteger) *
+          (sortedDataSet[percentileIndexInteger + 1] - sortedDataSet[percentileIndexInteger])
+      );
+    }
+    return sortedDataSet[percentileIndexInteger];
   }
 
-  static workerDynamicPoolInUse(): boolean {
-    return Configuration.getWorkerProcess() === WorkerProcessType.DYNAMIC_POOL;
+  public static stdDeviation(dataSet: number[]): number {
+    let totalDataSet = 0;
+    for (const data of dataSet) {
+      totalDataSet += data;
+    }
+    const dataSetMean = totalDataSet / dataSet.length;
+    let totalGeometricDeviation = 0;
+    for (const data of dataSet) {
+      const deviation = data - dataSetMean;
+      totalGeometricDeviation += deviation * deviation;
+    }
+    return Math.sqrt(totalGeometricDeviation / dataSet.length);
   }
 }