X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FUtils.ts;h=aeed9b0fa44b4a073bff682583c95695cbb954ac;hb=8a4f882a2486682b72195ad978ec1d81604b452b;hp=0271754f1c00b5df6d24b90501cc4b7d4c831ee0;hpb=268a74bb051fcbbad532fd833f0d8fd2b33b6c64;p=e-mobility-charging-stations-simulator.git

diff --git a/src/utils/Utils.ts b/src/utils/Utils.ts
index 0271754f..aeed9b0f 100644
--- a/src/utils/Utils.ts
+++ b/src/utils/Utils.ts
@@ -1,335 +1,340 @@
-import crypto from 'node:crypto';
-import util from 'node:util';
-
-import clone from 'just-clone';
+import { getRandomValues, randomBytes, randomUUID } from 'node:crypto'
+import { env, nextTick } from 'node:process'
+
+import {
+  formatDuration,
+  hoursToMinutes,
+  hoursToSeconds,
+  isDate,
+  millisecondsToHours,
+  millisecondsToMinutes,
+  millisecondsToSeconds,
+  minutesToSeconds,
+  secondsToMilliseconds
+} from 'date-fns'
+import { is } from 'rambda'
+
+import {
+  type JsonType,
+  MapStringifyFormat,
+  type TimestampedData,
+  WebSocketCloseEventStatusString
+} from '../types/index.js'
+
+export const logPrefix = (prefixString = ''): string => {
+  return `${new Date().toLocaleString()}${prefixString}`
+}
 
-import { Constants } from './Constants';
-import { WebSocketCloseEventStatusString } from '../types';
+export const generateUUID = (): `${string}-${string}-${string}-${string}-${string}` => {
+  return randomUUID()
+}
 
-export class Utils {
-  private constructor() {
-    // This is intentional
-  }
+export const validateUUID = (
+  uuid: `${string}-${string}-${string}-${string}-${string}`
+): uuid is `${string}-${string}-${string}-${string}-${string}` => {
+  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)
+}
 
-  public static logPrefix = (prefixString = ''): string => {
-    return `${new Date().toLocaleString()}${prefixString}`;
-  };
+export const sleep = async (milliSeconds: number): Promise<NodeJS.Timeout> => {
+  return await new Promise<NodeJS.Timeout>(resolve =>
+    setTimeout(resolve as () => void, milliSeconds)
+  )
+}
 
-  public static generateUUID(): string {
-    return crypto.randomUUID();
-  }
+export const formatDurationMilliSeconds = (duration: number): string => {
+  duration = convertToInt(duration)
+  if (duration < 0) {
+    throw new RangeError('Duration cannot be negative')
+  }
+  const days = Math.floor(duration / (24 * 3600 * 1000))
+  const hours = Math.floor(millisecondsToHours(duration) - days * 24)
+  const minutes = Math.floor(
+    millisecondsToMinutes(duration) - days * 24 * 60 - hoursToMinutes(hours)
+  )
+  const seconds = Math.floor(
+    millisecondsToSeconds(duration) -
+      days * 24 * 3600 -
+      hoursToSeconds(hours) -
+      minutesToSeconds(minutes)
+  )
+  if (days === 0 && hours === 0 && minutes === 0 && seconds === 0) {
+    return formatDuration({ seconds }, { zero: true })
+  }
+  return formatDuration({
+    days,
+    hours,
+    minutes,
+    seconds
+  })
+}
 
-  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
-    );
-  }
+export const formatDurationSeconds = (duration: number): string => {
+  return formatDurationMilliSeconds(secondsToMilliseconds(duration))
+}
 
-  public static async sleep(milliSeconds: number): Promise<NodeJS.Timeout> {
-    return new Promise((resolve) => setTimeout(resolve as () => void, milliSeconds));
+// More efficient time validation function than the one provided by date-fns
+export const isValidDate = (date: Date | number | undefined): date is Date | number => {
+  if (typeof date === 'number') {
+    return !isNaN(date)
+  } else if (isDate(date)) {
+    return !isNaN(date.getTime())
   }
+  return false
+}
 
-  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)}`;
+export const convertToDate = (
+  value: Date | string | number | undefined | null
+): Date | undefined => {
+  if (value == null) {
+    return undefined
   }
-
-  public static formatDurationSeconds(duration: number): string {
-    return Utils.formatDurationMilliSeconds(duration * 1000);
+  if (isDate(value)) {
+    return value
   }
-
-  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;
+  if (typeof value === 'string' || typeof value === 'number') {
+    const valueToDate = new Date(value)
+    if (isNaN(valueToDate.getTime())) {
+      throw new Error(`Cannot convert to date: '${value}'`)
     }
-    if (Utils.isString(value) || typeof value === 'number') {
-      return new Date(value);
-    }
-    return null;
+    return valueToDate
   }
+}
 
-  public static convertToInt(value: unknown): number {
-    if (!value) {
-      return 0;
-    }
-    let changedValue: number = value as number;
-    if (Number.isSafeInteger(value)) {
-      return value as number;
-    }
-    if (typeof value === 'number') {
-      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;
+export const convertToInt = (value: unknown): number => {
+  if (value == null) {
+    return 0
   }
-
-  public static convertToFloat(value: unknown): number {
-    if (!value) {
-      return 0;
-    }
-    let changedValue: number = value as number;
-    if (Utils.isString(value)) {
-      changedValue = parseFloat(value as string);
-    }
-    if (isNaN(changedValue)) {
-      throw new Error(`Cannot convert to float: ${value.toString()}`);
-    }
-    return changedValue;
+  if (Number.isSafeInteger(value)) {
+    return value as number
   }
-
-  public static convertToBoolean(value: unknown): boolean {
-    let result = false;
-    if (value) {
-      // Check the type
-      if (typeof value === 'boolean') {
-        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;
+  if (typeof value === 'number') {
+    return Math.trunc(value)
   }
-
-  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;
+  let changedValue: number = value as number
+  if (typeof value === 'string') {
+    changedValue = parseInt(value)
   }
-
-  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(crypto.randomInt(max + 1));
+  if (isNaN(changedValue)) {
+    throw new Error(`Cannot convert to integer: '${String(value)}'`)
   }
+  return changedValue
+}
 
-  public static roundTo(numberValue: number, scale: number): number {
-    const roundPower = Math.pow(10, scale);
-    return Math.round(numberValue * roundPower) / roundPower;
+export const convertToFloat = (value: unknown): number => {
+  if (value == null) {
+    return 0
   }
-
-  public static truncTo(numberValue: number, scale: number): number {
-    const truncPower = Math.pow(10, scale);
-    return Math.trunc(numberValue * truncPower) / truncPower;
+  let changedValue: number = value as number
+  if (typeof value === 'string') {
+    changedValue = parseFloat(value)
   }
-
-  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);
+  if (isNaN(changedValue)) {
+    throw new Error(`Cannot convert to float: '${String(value)}'`)
   }
+  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 != null) {
+    // Check the type
+    if (typeof value === 'boolean') {
+      return value
+    } else if (typeof value === 'string' && (value.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
-    );
-  }
-
-  public static isObject(item: unknown): boolean {
-    return (
-      Utils.isNullOrUndefined(item) === false &&
-      typeof item === 'object' &&
-      Array.isArray(item) === false
-    );
   }
+  return result
+}
 
-  public static cloneObject<T extends object>(object: T): T {
-    return clone<T>(object);
+export const getRandomFloat = (max = Number.MAX_VALUE, min = 0): number => {
+  if (max < min) {
+    throw new RangeError('Invalid interval')
   }
-
-  public static isIterable<T>(obj: T): boolean {
-    return !Utils.isNullOrUndefined(obj) ? typeof obj[Symbol.iterator] === 'function' : false;
+  if (max - min === Infinity) {
+    throw new RangeError('Invalid interval')
   }
+  return (randomBytes(4).readUInt32LE() / 0xffffffff) * (max - min) + min
+}
 
-  public static isString(value: unknown): boolean {
-    return typeof value === 'string';
-  }
+/**
+ * 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 isEmptyString(value: unknown): boolean {
-    return (
-      Utils.isNullOrUndefined(value) ||
-      (Utils.isString(value) && (value as string).trim().length === 0)
-    );
+export const getRandomFloatRounded = (max = Number.MAX_VALUE, min = 0, scale = 2): number => {
+  if (min !== 0) {
+    return roundTo(getRandomFloat(max, min), scale)
   }
+  return roundTo(getRandomFloat(max), scale)
+}
 
-  public static isNotEmptyString(value: unknown): boolean {
-    return Utils.isString(value) && (value as string).trim().length > 0;
-  }
+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 isUndefined(value: unknown): boolean {
-    return value === undefined;
-  }
+export const extractTimeSeriesValues = (timeSeries: TimestampedData[]): number[] => {
+  return timeSeries.map(timeSeriesItem => timeSeriesItem.value)
+}
 
-  public static isNullOrUndefined(value: unknown): boolean {
-    // eslint-disable-next-line eqeqeq, no-eq-null
-    return value == null;
-  }
+export const clone = <T>(object: T): T => {
+  return structuredClone<T>(object)
+}
 
-  public static isEmptyArray(object: unknown | unknown[]): boolean {
-    if (Array.isArray(object) && object.length === 0) {
-      return true;
-    }
-    return false;
-  }
+/**
+ * Detects whether the given value is an asynchronous function or not.
+ *
+ * @param fn - Unknown value.
+ * @returns `true` if `fn` was an asynchronous function, otherwise `false`.
+ * @internal
+ */
+export const isAsyncFunction = (fn: unknown): fn is (...args: unknown[]) => Promise<unknown> => {
+  return is(Function, fn) && fn.constructor.name === 'AsyncFunction'
+}
 
-  public static isNotEmptyArray(object: unknown | unknown[]): boolean {
-    if (Array.isArray(object) && object.length > 0) {
-      return true;
-    }
-    return false;
-  }
+export const isObject = (value: unknown): value is object => {
+  return value != null && !Array.isArray(value) && is(Object, value)
+}
 
-  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;
-  }
+export const hasOwnProp = (value: unknown, property: PropertyKey): boolean => {
+  return isObject(value) && Object.hasOwn(value, property)
+}
 
-  public static insertAt = (str: string, subStr: string, pos: number): string =>
-    `${str.slice(0, pos)}${subStr}${str.slice(pos)}`;
-
-  /**
-   * @param retryNumber - the number of retries that have already been attempted
-   * @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;
-  }
+export const isCFEnvironment = (): boolean => {
+  return env.VCAP_APPLICATION != null
+}
 
-  public static isPromisePending(promise: Promise<unknown>): boolean {
-    return util.inspect(promise).includes('pending');
-  }
+export const isNotEmptyString = (value: unknown): value is string => {
+  return typeof value === 'string' && value.trim().length > 0
+}
 
-  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);
-    });
+export const isNotEmptyArray = (value: unknown): value is unknown[] => {
+  return Array.isArray(value) && value.length > 0
+}
 
-    // Returns a race between timeout promise and the passed promise
-    return Promise.race<T>([promise, timeoutPromise]);
-  }
+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
+ * @param delayFactor - the base delay factor in milliseconds
+ * @returns delay in milliseconds
+ */
+export const exponentialDelay = (retryNumber = 0, delayFactor = 100): number => {
+  const delay = Math.pow(2, retryNumber) * delayFactor
+  const randomSum = delay * 0.2 * secureRandom() // 0-20% of the delay
+  return delay + randomSum
+}
 
-  /**
-   * Generate a cryptographically secure random number in the [0,1[ range
-   *
-   * @returns
-   */
-  public static secureRandom(): number {
-    return crypto.randomBytes(4).readUInt32LE() / 0x100000000;
-  }
+/**
+ * Generates a cryptographically secure random number in the [0,1[ range
+ *
+ * @returns A number in the [0,1[ range
+ */
+export const secureRandom = (): number => {
+  return getRandomValues(new Uint32Array(1))[0] / 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],
-          };
+export const JSONStringify = <
+  T extends
+  | JsonType
+  | Array<Record<string, unknown>>
+  | Set<Record<string, unknown>>
+  | Map<string, Record<string, unknown>>
+>(
+    object: T,
+    space?: string | number,
+    mapFormat?: MapStringifyFormat
+  ): string => {
+  return JSON.stringify(
+    object,
+    (_, value: Record<string, unknown>) => {
+      if (is(Map, value)) {
+        switch (mapFormat) {
+          case MapStringifyFormat.object:
+            return { ...Object.fromEntries<Map<string, Record<string, unknown>>>(value.entries()) }
+          case MapStringifyFormat.array:
+          default:
+            return [...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)';
+      } else if (is(Set, value)) {
+        return [...value] as JsonType[]
       }
+      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 (!Utils.isUndefined(WebSocketCloseEventStatusString[code])) {
-      return WebSocketCloseEventStatusString[code] as string;
+  }
+  if (
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    WebSocketCloseEventStatusString[code as keyof typeof WebSocketCloseEventStatusString] != null
+  ) {
+    return WebSocketCloseEventStatusString[code as keyof typeof WebSocketCloseEventStatusString]
+  }
+  return '(Unknown)'
+}
+
+export const isArraySorted = <T>(array: T[], compareFn: (a: T, b: T) => number): boolean => {
+  for (let index = 0; index < array.length - 1; ++index) {
+    if (compareFn(array[index], array[index + 1]) > 0) {
+      return false
     }
-    return '(Unknown)';
   }
+  return true
+}
+
+export const throwErrorInNextTick = (error: Error): void => {
+  nextTick(() => {
+    throw error
+  })
 }