X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FUtils.ts;h=abfac5e4873c98af8a4afa225ed1568fa4c9cec8;hb=0b1828224edf798044ef54672ddfc69598cd99a5;hp=5da54a2e150fb64940c563ca6494297f7f0f7306;hpb=95926c9b54dbbe8b564724b0de42b963f9067653;p=e-mobility-charging-stations-simulator.git

diff --git a/src/utils/Utils.ts b/src/utils/Utils.ts
index 5da54a2e..abfac5e4 100644
--- a/src/utils/Utils.ts
+++ b/src/utils/Utils.ts
@@ -1,235 +1,386 @@
-import Configuration from './Configuration';
-import { WebSocketCloseEventStatusString } from '../types/WebSocket';
-import { WorkerProcessType } from '../types/Worker';
-import { v4 as uuid } from 'uuid';
+import { getRandomValues, randomBytes, randomInt, randomUUID } from 'node:crypto'
+import { env, nextTick } from 'node:process'
 
-export default class Utils {
-  static logPrefix(prefixString = ''): string {
-    return new Date().toLocaleString() + prefixString;
-  }
+import {
+  formatDuration,
+  hoursToMinutes,
+  hoursToSeconds,
+  isDate,
+  millisecondsToHours,
+  millisecondsToMinutes,
+  millisecondsToSeconds,
+  minutesToSeconds,
+  secondsToMilliseconds
+} from 'date-fns'
 
-  static generateUUID(): string {
-    return uuid();
-  }
+import { Constants } from './Constants.js'
+import {
+  type EmptyObject,
+  type ProtocolResponse,
+  type TimestampedData,
+  WebSocketCloseEventStatusString
+} from '../types/index.js'
 
-  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}`
+}
 
-  static secondsToHHMMSS(seconds: number): string {
-    return Utils.milliSecondsToHHMMSS(seconds * 1000);
-  }
+export const generateUUID = (): string => {
+  return randomUUID()
+}
 
-  static milliSecondsToHHMMSS(milliSeconds: number): string {
-    return new Date(milliSeconds).toISOString().substr(11, 8);
-  }
+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)
+}
 
-  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);
-      }
-    }
-  }
+export const sleep = async (milliSeconds: number): Promise<NodeJS.Timeout> => {
+  return await new Promise<NodeJS.Timeout>(resolve =>
+    setTimeout(resolve as () => void, milliSeconds)
+  )
+}
 
-  static convertToDate(value: any): Date {
-    // Check
-    if (!value) {
-      return value;
-    }
-    // Check Type
-    if (!(value instanceof Date)) {
-      return new Date(value);
-    }
-    return value;
+export const formatDurationMilliSeconds = (duration: number): string => {
+  duration = convertToInt(duration)
+  if (duration < 0) {
+    throw new RangeError('Duration cannot be negative')
   }
-
-  static convertToInt(value: any): number {
-    let changedValue: number = value;
-    if (!value) {
-      return 0;
-    }
-    if (Number.isSafeInteger(value)) {
-      return value as number;
-    }
-    // Check
-    if (Utils.isString(value)) {
-      // Create Object
-      changedValue = parseInt(value);
-    }
-    return changedValue;
+  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
+  })
+}
 
-  static convertToFloat(value: any): number {
-    let changedValue: number = value;
-    if (!value) {
-      return 0;
-    }
-    // Check
-    if (Utils.isString(value)) {
-      // Create Object
-      changedValue = parseFloat(value);
-    }
-    return changedValue;
-  }
-
-  static convertToBoolean(value: any): 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 formatDurationSeconds = (duration: number): string => {
+  return formatDurationMilliSeconds(secondsToMilliseconds(duration))
+}
 
-  static getRandomFloat(max: number, min = 0): number {
-    return Math.random() < 0.5 ? (1 - Math.random()) * (max - min) + min : Math.random() * (max - min) + min;
+// 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
+}
 
-  static getRandomInt(max: number, min = 0): number {
-    if (min) {
-      return Math.floor(Math.random() * (max - min + 1) + min);
+export const convertToDate = (
+  value: Date | string | number | undefined | null
+): Date | undefined => {
+  if (value == null) {
+    return undefined
+  }
+  if (isDate(value)) {
+    return value
+  }
+  if (isString(value) || typeof value === 'number') {
+    const valueToDate = new Date(value)
+    if (isNaN(valueToDate.getTime())) {
+      throw new Error(`Cannot convert to date: '${value}'`)
     }
-    return Math.floor(Math.random() * max + 1);
+    return valueToDate
   }
+}
 
-  static roundTo(numberValue: number, scale: number): number {
-    const roundPower = Math.pow(10, scale);
-    return Math.round(numberValue * roundPower) / roundPower;
+export const convertToInt = (value: unknown): number => {
+  if (value == null) {
+    return 0
   }
-
-  static truncTo(numberValue: number, scale: number): number {
-    const truncPower = Math.pow(10, scale);
-    return Math.trunc(numberValue * truncPower) / truncPower;
+  if (Number.isSafeInteger(value)) {
+    return value as number
+  }
+  if (typeof value === 'number') {
+    return Math.trunc(value)
+  }
+  let changedValue: number = value as number
+  if (isString(value)) {
+    changedValue = parseInt(value)
   }
+  if (isNaN(changedValue)) {
+    throw new Error(`Cannot convert to integer: '${String(value)}'`)
+  }
+  return changedValue
+}
 
-  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 == null) {
+    return 0
   }
+  let changedValue: number = value as number
+  if (isString(value)) {
+    changedValue = parseFloat(value)
+  }
+  if (isNaN(changedValue)) {
+    throw new Error(`Cannot convert to float: '${String(value)}'`)
+  }
+  return changedValue
+}
 
-  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 (isString(value) && (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);
   }
+  return result
+}
 
-  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')
   }
-
-  static isIterable<T>(obj: T): boolean {
-    if (obj) {
-      return typeof obj[Symbol.iterator] === 'function';
-    }
-    return false;
+  if (max - min === Infinity) {
+    throw new RangeError('Invalid interval')
   }
+  return (randomBytes(4).readUInt32LE() / 0xffffffff) * (max - min) + min
+}
 
-  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;
+export const getRandomInteger = (max = Constants.MAX_RANDOM_INTEGER, min = 0): number => {
+  max = Math.floor(max)
+  if (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
+}
 
-  static isString(value: any): boolean {
-    return typeof value === 'string';
+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)
+}
 
-  static isUndefined(value: any): 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
+  )
+}
 
-  static isNullOrUndefined(value: any): boolean {
-    // eslint-disable-next-line no-eq-null, eqeqeq
-    if (value == null) {
-      return true;
-    }
-    return false;
+export const extractTimeSeriesValues = (timeSeries: TimestampedData[]): number[] => {
+  return timeSeries.map(timeSeriesItem => timeSeriesItem.value)
+}
+
+export const clone = <T>(object: T): T => {
+  return structuredClone<T>(object)
+}
+
+/**
+ * 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 typeof fn === 'function' && fn.constructor.name === 'AsyncFunction'
+}
+
+export const isObject = (value: unknown): value is object => {
+  return value != null && typeof value === 'object' && !Array.isArray(value)
+}
+
+export const isEmptyObject = (object: object): object is EmptyObject => {
+  if (object.constructor !== Object) {
+    return false
   }
+  // Iterates over the keys of an object, if
+  // any exist, return false.
+  // eslint-disable-next-line no-unreachable-loop
+  for (const _ in object) {
+    return false
+  }
+  return true
+}
 
-  static isEmptyArray(object: any): boolean {
-    if (!object) {
-      return true;
-    }
-    if (Array.isArray(object) && object.length > 0) {
-      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)}`;
-
-  /**
-   * @param {number} [retryNumber=0]
-   * @returns {number} delay in milliseconds
-   */
-  static exponentialDelay(retryNumber = 0): number {
-    const delay = Math.pow(2, retryNumber) * 100;
-    const randomSum = delay * 0.2 * Math.random(); // 0-20% of the delay
-    return delay + randomSum;
-  }
-
-  /**
-   * Convert websocket error code to human readable string message
-   *
-   * @param {number} code websocket error code
-   * @returns {string} human readable string message
-   */
-  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 hasOwnProp = (value: unknown, property: PropertyKey): boolean => {
+  return isObject(value) && Object.hasOwn(value, property)
+}
+
+export const isCFEnvironment = (): boolean => {
+  return env.VCAP_APPLICATION != null
+}
+
+const isString = (value: unknown): value is string => {
+  return typeof value === 'string'
+}
+
+export const isEmptyString = (value: unknown): value is '' | undefined | null => {
+  return value == null || (isString(value) && value.trim().length === 0)
+}
+
+export const isNotEmptyString = (value: unknown): value is string => {
+  return isString(value) && value.trim().length > 0
+}
+
+export const isEmptyArray = (value: unknown): value is never[] => {
+  return Array.isArray(value) && value.length === 0
+}
+
+export const isNotEmptyArray = (value: unknown): value is unknown[] => {
+  return Array.isArray(value) && value.length > 0
+}
+
+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
+}
+
+/**
+ * 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
+}
+
+export const JSONStringifyWithMapSupport = (
+  object:
+  | Record<string, unknown>
+  | Array<Record<string, unknown>>
+  | Map<unknown, unknown>
+  | ProtocolResponse,
+  space?: string | number
+): string => {
+  return JSON.stringify(
+    object,
+    (_, 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 (!Utils.isUndefined(WebSocketCloseEventStatusString[code])) {
-      return WebSocketCloseEventStatusString[code] as string;
-    }
-    return '(Unknown)';
   }
+  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)'
+}
 
-  static workerPoolInUse(): boolean {
-    return [WorkerProcessType.DYNAMIC_POOL, WorkerProcessType.STATIC_POOL].includes(Configuration.getWorkerProcess());
+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 true
+}
 
-  static workerDynamicPoolInUse(): boolean {
-    return Configuration.getWorkerProcess() === WorkerProcessType.DYNAMIC_POOL;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const once = <T, A extends any[], R>(
+  fn: (...args: A) => R,
+  context: T
+): ((...args: A) => R) => {
+  let result: R
+  return (...args: A) => {
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    if (fn != null) {
+      result = fn.apply<T, A, R>(context, args)
+      ;(fn as unknown as undefined) = (context as unknown as undefined) = undefined
+    }
+    return result
   }
 }
+
+export const min = (...args: number[]): number =>
+  args.reduce((minimum, num) => (minimum < num ? minimum : num), Infinity)
+
+export const max = (...args: number[]): number =>
+  args.reduce((maximum, num) => (maximum > num ? maximum : num), -Infinity)
+
+export const throwErrorInNextTick = (error: Error): void => {
+  nextTick(() => {
+    throw error
+  })
+}