X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FUtils.ts;h=c2c9d0ad22ac7152a5dd2565d166f278b5cd7ef3;hb=474d4ffcd45d49bb242f51510a28569b00328676;hp=b04814a7a6437dd6a369b81b5998458f652e3465;hpb=72740232578802cecbae5fcf13dc491b92417cce;p=e-mobility-charging-stations-simulator.git

diff --git a/src/utils/Utils.ts b/src/utils/Utils.ts
index b04814a7..c2c9d0ad 100644
--- a/src/utils/Utils.ts
+++ b/src/utils/Utils.ts
@@ -1,246 +1,343 @@
-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 { randomBytes, randomInt, randomUUID } from 'node:crypto';
+import { inspect } from 'node:util';
 
-export default class Utils {
-  public static logPrefix(prefixString = ''): string {
-    return new Date().toLocaleString() + prefixString;
-  }
+import clone from 'just-clone';
 
-  public static generateUUID(): string {
-    return uuid();
-  }
+import { Constants } from './Constants';
+import { type TimestampedData, WebSocketCloseEventStatusString } from '../types';
 
-  public static async sleep(milliSeconds: number): Promise<NodeJS.Timeout> {
-    return new Promise((resolve) => setTimeout(resolve, milliSeconds));
-  }
+export const logPrefix = (prefixString = ''): string => {
+  return `${new Date().toLocaleString()}${prefixString}`;
+};
 
-  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();
+export const generateUUID = (): string => {
+  return randomUUID();
+};
 
-    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);
-  }
+export const 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,
+  );
+};
+
+export const sleep = async (milliSeconds: number): Promise<NodeJS.Timeout> => {
+  return new Promise<NodeJS.Timeout>((resolve) => setTimeout(resolve as () => void, milliSeconds));
+};
+
+export const formatDurationMilliSeconds = (duration: number): string => {
+  duration = 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();
 
-  public static formatDurationSeconds(duration: number): string {
-    return Utils.formatDurationMilliSeconds(duration * 1000);
+  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 convertToDate(value: unknown): Date {
-    // Check
-    if (!value) {
-      return value as Date;
-    }
-    // Check Type
-    if (!(value instanceof Date)) {
-      return new Date(value as string);
-    }
+export const formatDurationSeconds = (duration: number): string => {
+  return formatDurationMilliSeconds(duration * 1000);
+};
+
+export const convertToDate = (
+  value: Date | string | number | null | undefined,
+): Date | null | undefined => {
+  if (isNullOrUndefined(value)) {
+    return value as null | undefined;
+  }
+  if (value instanceof Date) {
     return value;
   }
-
-  public static convertToInt(value: unknown): number {
-    let changedValue: number = value as number;
-    if (!value) {
-      return 0;
-    }
-    if (Number.isSafeInteger(value)) {
-      return value as number;
-    }
-    // Check
-    if (Utils.isString(value)) {
-      // Create Object
-      changedValue = parseInt(value as string);
-    }
-    return changedValue;
+  if (isString(value) || typeof value === 'number') {
+    return new Date(value!);
   }
+  return null;
+};
 
-  public static convertToFloat(value: unknown): number {
-    let changedValue: number = value as number;
-    if (!value) {
-      return 0;
-    }
-    // Check
-    if (Utils.isString(value)) {
-      // Create Object
-      changedValue = parseFloat(value as string);
-    }
-    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 result;
+export const convertToInt = (value: unknown): number => {
+  if (!value) {
+    return 0;
   }
-
-  public static getRandomFloat(max: number, min = 0, negative = false): number {
-    if (max < min || min < 0 || max < 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);
+  let changedValue: number = value as number;
+  if (Number.isSafeInteger(value)) {
+    return value as number;
   }
-
-  public static getRandomInteger(max: number, min = 0): number {
-    if (max < 0) {
-      throw new RangeError('Invalid interval');
-    }
-    max = Math.floor(max);
-    if (min) {
-      if (max < min || min < 0) {
-        throw new RangeError('Invalid interval');
-      }
-      min = Math.ceil(min);
-      return Math.floor(Utils.secureRandom() * (max - min + 1)) + min;
-    }
-    return Math.floor(Utils.secureRandom() * (max + 1));
+  if (typeof value === 'number') {
+    return Math.trunc(value);
   }
-
-  public static roundTo(numberValue: number, scale: number): number {
-    const roundPower = Math.pow(10, scale);
-    return Math.round(numberValue * roundPower) / roundPower;
+  if (isString(value)) {
+    changedValue = parseInt(value as string);
   }
-
-  public static truncTo(numberValue: number, scale: number): number {
-    const truncPower = Math.pow(10, scale);
-    return Math.trunc(numberValue * truncPower) / truncPower;
+  if (isNaN(changedValue)) {
+    // eslint-disable-next-line @typescript-eslint/no-base-to-string
+    throw new Error(`Cannot convert to integer: ${value.toString()}`);
   }
+  return changedValue;
+};
 
-  public static getRandomFloatRounded(max: number, min = 0, scale = 2): number {
-    if (min) {
-      return Utils.roundTo(Utils.getRandomFloat(max, min), scale);
-    }
-    return Utils.roundTo(Utils.getRandomFloat(max), scale);
+export const convertToFloat = (value: unknown): number => {
+  if (!value) {
+    return 0;
+  }
+  let changedValue: number = value as number;
+  if (isString(value)) {
+    changedValue = parseFloat(value as string);
   }
+  if (isNaN(changedValue)) {
+    // eslint-disable-next-line @typescript-eslint/no-base-to-string
+    throw new Error(`Cannot convert to float: ${value.toString()}`);
+  }
+  return changedValue;
+};
 
-  public static getRandomFloatFluctuatedRounded(staticValue: number, fluctuationPercent: number, scale = 2): number {
-    if (fluctuationPercent === 0) {
-      return Utils.roundTo(staticValue, scale);
+export const convertToBoolean = (value: unknown): boolean => {
+  let result = false;
+  if (value) {
+    // Check the type
+    if (typeof value === 'boolean') {
+      return value;
+    } else if (isString(value) && ((value as string).toLowerCase() === 'true' || value === '1')) {
+      result = true;
+    } else if (typeof value === 'number' && value === 1) {
+      result = true;
     }
-    const fluctuationRatio = fluctuationPercent / 100;
-    return Utils.getRandomFloatRounded(staticValue * (1 + fluctuationRatio), staticValue * (1 - fluctuationRatio), scale);
   }
+  return result;
+};
 
-  public static cloneObject<T>(object: T): T {
-    return JSON.parse(JSON.stringify(object)) as T;
+export const 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 (randomBytes(4).readUInt32LE() / 0xffffffff) * (max - min) + min;
+};
 
-  public static isIterable<T>(obj: T): boolean {
-    if (obj) {
-      return typeof obj[Symbol.iterator] === 'function';
-    }
-    return false;
+export const getRandomInteger = (max = Constants.MAX_RANDOM_INTEGER, min = 0): number => {
+  max = Math.floor(max);
+  if (!isNullOrUndefined(min) && min !== 0) {
+    min = Math.ceil(min);
+    return Math.floor(randomInt(min, max + 1));
   }
+  return Math.floor(randomInt(max + 1));
+};
+
+/**
+ * Rounds the given number to the given scale.
+ * The rounding is done using the "round half away from zero" method.
+ *
+ * @param numberValue - The number to round.
+ * @param scale - The scale to round to.
+ * @returns The rounded number.
+ */
+export const roundTo = (numberValue: number, scale: number): number => {
+  const roundPower = Math.pow(10, scale);
+  return Math.round(numberValue * roundPower * (1 + Number.EPSILON)) / roundPower;
+};
 
-  public static isString(value: unknown): boolean {
-    return typeof value === 'string';
+export const getRandomFloatRounded = (max = Number.MAX_VALUE, min = 0, scale = 2): number => {
+  if (min) {
+    return roundTo(getRandomFloat(max, min), scale);
   }
+  return roundTo(getRandomFloat(max), scale);
+};
 
-  public static isUndefined(value: unknown): boolean {
-    return typeof value === 'undefined';
+export const getRandomFloatFluctuatedRounded = (
+  staticValue: number,
+  fluctuationPercent: number,
+  scale = 2,
+): number => {
+  if (fluctuationPercent < 0 || fluctuationPercent > 100) {
+    throw new RangeError(
+      `Fluctuation percent must be between 0 and 100. Actual value: ${fluctuationPercent}`,
+    );
   }
+  if (fluctuationPercent === 0) {
+    return roundTo(staticValue, scale);
+  }
+  const fluctuationRatio = fluctuationPercent / 100;
+  return getRandomFloatRounded(
+    staticValue * (1 + fluctuationRatio),
+    staticValue * (1 - fluctuationRatio),
+    scale,
+  );
+};
 
-  public static isNullOrUndefined(value: unknown): boolean {
-    // eslint-disable-next-line no-eq-null, eqeqeq
-    if (value == null) {
-      return true;
-    }
+export const extractTimeSeriesValues = (timeSeries: Array<TimestampedData>): number[] => {
+  return timeSeries.map((timeSeriesItem) => timeSeriesItem.value);
+};
+
+export const isObject = (item: unknown): boolean => {
+  return (
+    isNullOrUndefined(item) === false && typeof item === 'object' && Array.isArray(item) === false
+  );
+};
+
+export const cloneObject = <T extends object>(object: T): T => {
+  return clone<T>(object);
+};
+
+export const hasOwnProp = (object: unknown, property: PropertyKey): boolean => {
+  return isObject(object) && Object.hasOwn(object as object, property);
+};
+
+export const isCFEnvironment = (): boolean => {
+  return !isNullOrUndefined(process.env.VCAP_APPLICATION);
+};
+
+export const isIterable = <T>(obj: T): boolean => {
+  return !isNullOrUndefined(obj) ? typeof obj[Symbol.iterator as keyof T] === 'function' : false;
+};
+
+const isString = (value: unknown): boolean => {
+  return typeof value === 'string';
+};
+
+export const isEmptyString = (value: unknown): boolean => {
+  return isNullOrUndefined(value) || (isString(value) && (value as string).trim().length === 0);
+};
+
+export const isNotEmptyString = (value: unknown): boolean => {
+  return isString(value) && (value as string).trim().length > 0;
+};
+
+export const isUndefined = (value: unknown): boolean => {
+  return value === undefined;
+};
+
+export const isNullOrUndefined = (value: unknown): boolean => {
+  // eslint-disable-next-line eqeqeq, no-eq-null
+  return value == null;
+};
+
+export const isEmptyArray = (object: unknown): boolean => {
+  return Array.isArray(object) && object.length === 0;
+};
+
+export const isNotEmptyArray = (object: unknown): boolean => {
+  return Array.isArray(object) && object.length > 0;
+};
+
+export const 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 isEmptyArray(object: unknown): boolean {
-    if (!object) {
-      return true;
-    }
-    if (Array.isArray(object) && object.length > 0) {
-      return false;
-    }
-    return true;
-  }
-
-  public static isEmptyObject(obj: Record<string, unknown>): boolean {
-    return !Object.keys(obj).length;
-  }
-
-  public static insertAt = (str: string, subStr: string, pos: number): string => `${str.slice(0, pos)}${subStr}${str.slice(pos)}`;
-
-  /**
-   * @param [retryNumber=0]
-   * @returns delay in milliseconds
-   */
-  public static exponentialDelay(retryNumber = 0): number {
-    const delay = Math.pow(2, retryNumber) * 100;
-    const randomSum = delay * 0.2 * Utils.secureRandom(); // 0-20% of the delay
-    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)';
+export const insertAt = (str: string, subStr: string, pos: number): string =>
+  `${str.slice(0, pos)}${subStr}${str.slice(pos)}`;
+
+/**
+ * Computes the retry delay in milliseconds using an exponential backoff algorithm.
+ *
+ * @param retryNumber - the number of retries that have already been attempted
+ * @returns delay in milliseconds
+ */
+export const exponentialDelay = (retryNumber = 0, maxDelayRatio = 0.2): number => {
+  const delay = Math.pow(2, retryNumber) * 100;
+  const randomSum = delay * maxDelayRatio * secureRandom(); // 0-20% of the delay
+  return delay + randomSum;
+};
+
+const isPromisePending = (promise: Promise<unknown>): boolean => {
+  return inspect(promise).includes('pending');
+};
+
+export const promiseWithTimeout = async <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 (isPromisePending(promise)) {
+        timeoutCallback();
+        // FIXME: The original promise shall be canceled
       }
-    }
-    if (!Utils.isUndefined(WebSocketCloseEventStatusString[code])) {
-      return WebSocketCloseEventStatusString[code] as string;
-    }
-    return '(Unknown)';
-  }
+      reject(timeoutError);
+    }, timeoutMs);
+  });
 
-  public static workerPoolInUse(): boolean {
-    return [WorkerProcessType.DYNAMIC_POOL, WorkerProcessType.STATIC_POOL].includes(Configuration.getWorkerProcess());
-  }
+  // Returns a race between timeout promise and the passed promise
+  return Promise.race<T>([promise, timeoutPromise]);
+};
 
-  public static workerDynamicPoolInUse(): boolean {
-    return Configuration.getWorkerProcess() === WorkerProcessType.DYNAMIC_POOL;
-  }
+/**
+ * Generates a cryptographically secure random number in the [0,1[ range
+ *
+ * @returns
+ */
+export const secureRandom = (): number => {
+  return randomBytes(4).readUInt32LE() / 0x100000000;
+};
 
-  /**
-   * Generate a cryptographically secure random number in the [0,1[ range
-   *
-   * @returns
-   */
-  public static secureRandom(): number {
-    return crypto.randomBytes(4).readUInt32LE() / 0x100000000;
+export const JSONStringifyWithMapSupport = (
+  obj: Record<string, unknown> | Record<string, unknown>[] | Map<unknown, unknown>,
+  space?: number,
+): string => {
+  return JSON.stringify(
+    obj,
+    (_, value: Record<string, unknown>) => {
+      if (value instanceof Map) {
+        return {
+          dataType: 'Map',
+          value: [...value],
+        };
+      }
+      return value;
+    },
+    space,
+  );
+};
+
+/**
+ * Converts websocket error code to human readable string message
+ *
+ * @param code - websocket error code
+ * @returns human readable string message
+ */
+export const 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 (
+    !isUndefined(
+      WebSocketCloseEventStatusString[code as keyof typeof WebSocketCloseEventStatusString],
+    )
+  ) {
+    return WebSocketCloseEventStatusString[code as keyof typeof WebSocketCloseEventStatusString];
   }
-}
+  return '(Unknown)';
+};