Use arrow function for log messages prefixing

[e-mobility-charging-stations-simulator.git] / src / utils / Utils.ts

diff --git a/src/utils/Utils.ts b/src/utils/Utils.ts
index f27f06660227643ebe516f8972ee08206334af22..810267200fb1e3b1a4949918f264d8f57e085455 100644 (file)
--- a/src/utils/Utils.ts
+++ b/src/utils/Utils.ts
@@ -1,5 +1,9 @@
-import crypto from 'crypto';
+import crypto from 'node:crypto';
+import util from 'node:util';
 
+import clone from 'just-clone';
+
+import Constants from './Constants';
 import { WebSocketCloseEventStatusString } from '../types/WebSocket';
 
 export default class Utils {
@@ -7,9 +11,9 @@ export default class Utils {
     // 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,22 +39,24 @@ 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 | null | undefined {
+  public static convertToDate(
+    value: Date | string | number | null | undefined
+  ): Date | null | undefined {
     if (Utils.isNullOrUndefined(value)) {
       return value as null | undefined;
     }
@@ -58,7 +64,7 @@ export default class Utils {
       return value;
     }
     if (Utils.isString(value) || typeof value === 'number') {
-      return new Date(value as string | number);
+      return new Date(value);
     }
     return null;
   }
@@ -72,11 +78,14 @@ export default class Utils {
       return value as number;
     }
     if (typeof value === 'number') {
-      changedValue = Math.trunc(value);
+      return Math.trunc(value);
     }
     if (Utils.isString(value)) {
       changedValue = parseInt(value as string);
     }
+    if (isNaN(changedValue)) {
+      throw new Error(`Cannot convert to integer: ${value.toString()}`);
+    }
     return changedValue;
   }
 
@@ -88,6 +97,9 @@ export default class Utils {
     if (Utils.isString(value)) {
       changedValue = parseFloat(value as string);
     }
+    if (isNaN(changedValue)) {
+      throw new Error(`Cannot convert to float: ${value.toString()}`);
+    }
     return changedValue;
   }
 
@@ -96,7 +108,7 @@ export default class Utils {
     if (value) {
       // Check the type
       if (typeof value === 'boolean') {
-        result = value;
+        return value;
       } else if (
         Utils.isString(value) &&
         ((value as string).toLowerCase() === 'true' || value === '1')
@@ -118,16 +130,13 @@ export default class Utils {
     return sign * (randomPositiveFloat * (max - min) + min);
   }
 
-  public static getRandomInteger(max = Number.MAX_SAFE_INTEGER, min = 0): number {
-    if (max < min || max < 0 || min < 0) {
-      throw new RangeError('Invalid interval');
-    }
+  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 {
@@ -163,12 +172,20 @@ 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 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 {
@@ -180,7 +197,7 @@ export default class Utils {
   }
 
   public static isUndefined(value: unknown): boolean {
-    return typeof value === 'undefined';
+    return value === undefined;
   }
 
   public static isNullOrUndefined(value: unknown): boolean {
@@ -214,7 +231,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 {
@@ -223,6 +240,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,
@@ -234,7 +255,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);
     });
@@ -253,7 +277,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(
@@ -274,7 +298,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 {