X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FUtils.ts;h=f701cea041ab831d1b1ff323123e02c60b69b11b;hb=878e026c886468c5d488b75a6d3636abea6fc07c;hp=bc957c24a497ce38e5d02da80b1e7d3931bdf027;hpb=8bd02502e5cb44f91964241a5bc93b762ca7557e;p=e-mobility-charging-stations-simulator.git

diff --git a/src/utils/Utils.ts b/src/utils/Utils.ts
index bc957c24..f701cea0 100644
--- a/src/utils/Utils.ts
+++ b/src/utils/Utils.ts
@@ -1,15 +1,20 @@
-import crypto from 'crypto';
+import crypto from 'node:crypto';
+import util from 'node:util';
 
-import { WebSocketCloseEventStatusString } from '../types/WebSocket';
+import clone from 'just-clone';
 
-export default class Utils {
+// import { Constants } from './internal';
+import { Constants } from './Constants';
+import { WebSocketCloseEventStatusString } from '../types';
+
+export class Utils {
   private constructor() {
     // This is intentional
   }
 
-  public static logPrefix(prefixString = ''): string {
-    return new Date().toLocaleString() + prefixString;
-  }
+  public static logPrefix = (prefixString = ''): string => {
+    return `${new Date().toLocaleString()}${prefixString}`;
+  };
 
   public static generateUUID(): string {
     return crypto.randomUUID();
@@ -35,97 +40,105 @@ export default class Utils {
     let secondsStr = seconds.toString();
 
     if (hours < 10) {
-      hoursStr = '0' + hours.toString();
+      hoursStr = `0${hours.toString()}`;
     }
     if (minutes < 10) {
-      minutesStr = '0' + minutes.toString();
+      minutesStr = `0${minutes.toString()}`;
     }
     if (seconds < 10) {
-      secondsStr = '0' + seconds.toString();
+      secondsStr = `0${seconds.toString()}`;
     }
-    return hoursStr + ':' + minutesStr + ':' + secondsStr.substring(0, 6);
+    return `${hoursStr}:${minutesStr}:${secondsStr.substring(0, 6)}`;
   }
 
   public static formatDurationSeconds(duration: number): string {
     return Utils.formatDurationMilliSeconds(duration * 1000);
   }
 
-  public static convertToDate(value: unknown): Date {
-    // Check
-    if (!value) {
-      return value as Date;
+  public static convertToDate(
+    value: Date | string | number | null | undefined
+  ): Date | null | undefined {
+    if (Utils.isNullOrUndefined(value)) {
+      return value as null | undefined;
     }
-    // Check Type
-    if (!(value instanceof Date)) {
-      return new Date(value as string);
+    if (value instanceof Date) {
+      return value;
     }
-    return value;
+    if (Utils.isString(value) || typeof value === 'number') {
+      return new Date(value);
+    }
+    return null;
   }
 
   public static convertToInt(value: unknown): number {
-    let changedValue: number = value as number;
     if (!value) {
       return 0;
     }
+    let changedValue: number = value as number;
     if (Number.isSafeInteger(value)) {
       return value as number;
     }
-    // Check
+    if (typeof value === 'number') {
+      return Math.trunc(value);
+    }
     if (Utils.isString(value)) {
-      // Create Object
       changedValue = parseInt(value as string);
     }
+    if (isNaN(changedValue)) {
+      throw new Error(`Cannot convert to integer: ${value.toString()}`);
+    }
     return changedValue;
   }
 
   public static convertToFloat(value: unknown): number {
-    let changedValue: number = value as number;
     if (!value) {
       return 0;
     }
-    // Check
+    let changedValue: number = value as number;
     if (Utils.isString(value)) {
-      // Create Object
       changedValue = parseFloat(value as string);
     }
+    if (isNaN(changedValue)) {
+      throw new Error(`Cannot convert to float: ${value.toString()}`);
+    }
     return changedValue;
   }
 
   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;
   }
 
-  public static getRandomFloat(max = Number.MAX_VALUE, min = 0, negative = false): number {
-    if (max < min || max < 0 || min < 0) {
+  public static getRandomFloat(max = Number.MAX_VALUE, min = 0): number {
+    if (max < min) {
       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);
-  }
-
-  public static getRandomInteger(max = Number.MAX_SAFE_INTEGER, min = 0): number {
-    if (max < min || max < 0 || min < 0) {
+    if (max - min === Infinity) {
       throw new RangeError('Invalid interval');
     }
+    return (crypto.randomBytes(4).readUInt32LE() / 0xffffffff) * (max - min) + 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(Utils.secureRandom() * (max - min + 1)) + min;
+      return Math.floor(crypto.randomInt(min, max + 1));
     }
-    return Math.floor(Utils.secureRandom() * (max + 1));
+    return Math.floor(crypto.randomInt(max + 1));
   }
 
   public static roundTo(numberValue: number, scale: number): number {
@@ -161,12 +174,28 @@ export default class Utils {
     );
   }
 
-  public 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
+    );
+  }
+
+  public static cloneObject<T extends object>(object: T): T {
+    return clone<T>(object);
+  }
+
+  public static hasOwnProp(object: unknown, property: PropertyKey): boolean {
+    return Utils.isObject(object) && Object.hasOwn(object as object, property);
+  }
+
+  public static isCFEnvironment(): boolean {
+    return process.env.VCAP_APPLICATION !== undefined;
   }
 
   public static isIterable<T>(obj: T): boolean {
-    return obj ? typeof obj[Symbol.iterator] === 'function' : false;
+    return !Utils.isNullOrUndefined(obj) ? typeof obj[Symbol.iterator] === 'function' : false;
   }
 
   public static isString(value: unknown): boolean {
@@ -174,26 +203,37 @@ export default class Utils {
   }
 
   public static isEmptyString(value: unknown): boolean {
-    return Utils.isString(value) && (value as string).trim().length === 0;
+    return (
+      Utils.isNullOrUndefined(value) ||
+      (Utils.isString(value) && (value as string).trim().length === 0)
+    );
+  }
+
+  public static isNotEmptyString(value: unknown): boolean {
+    return Utils.isString(value) && (value as string).trim().length > 0;
   }
 
   public static isUndefined(value: unknown): boolean {
-    return typeof value === 'undefined';
+    return value === undefined;
   }
 
   public static isNullOrUndefined(value: unknown): boolean {
     // eslint-disable-next-line eqeqeq, no-eq-null
-    return value == null ? true : false;
+    return value == null;
   }
 
-  public static isEmptyArray(object: unknown): boolean {
-    if (!Array.isArray(object)) {
-      return false;
+  public static isEmptyArray(object: unknown | unknown[]): boolean {
+    if (Array.isArray(object) && object.length === 0) {
+      return true;
     }
-    if ((object as unknown[]).length > 0) {
-      return false;
+    return false;
+  }
+
+  public static isNotEmptyArray(object: unknown | unknown[]): boolean {
+    if (Array.isArray(object) && object.length > 0) {
+      return true;
     }
-    return true;
+    return false;
   }
 
   public static isEmptyObject(obj: object): boolean {
@@ -212,7 +252,7 @@ export default class Utils {
     `${str.slice(0, pos)}${subStr}${str.slice(pos)}`;
 
   /**
-   * @param [retryNumber=0]
+   * @param retryNumber - the number of retries that have already been attempted
    * @returns delay in milliseconds
    */
   public static exponentialDelay(retryNumber = 0): number {
@@ -221,6 +261,10 @@ export default class Utils {
     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,
@@ -232,7 +276,10 @@ export default class Utils {
     // Create a timeout promise that rejects in timeout milliseconds
     const timeoutPromise = new Promise<never>((_, reject) => {
       setTimeout(() => {
-        timeoutCallback();
+        if (Utils.isPromisePending(promise)) {
+          timeoutCallback();
+          // FIXME: The original promise shall be canceled
+        }
         reject(timeoutError);
       }, timeoutMs);
     });
@@ -251,7 +298,7 @@ export default class Utils {
   }
 
   public static JSONStringifyWithMapSupport(
-    obj: Record<string, unknown> | Record<string, unknown>[],
+    obj: Record<string, unknown> | Record<string, unknown>[] | Map<unknown, unknown>,
     space?: number
   ): string {
     return JSON.stringify(
@@ -272,7 +319,7 @@ export default class Utils {
   /**
    * Convert websocket error code to human readable string message
    *
-   * @param code websocket error code
+   * @param code - websocket error code
    * @returns human readable string message
    */
   public static getWebSocketCloseEventStatusString(code: number): string {