Merge branch 'main' into dependabot/github_actions/sonarsource/sonarcloud-github...

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

diff --git a/src/utils/Utils.ts b/src/utils/Utils.ts
index dd6591f88bd2b27fe999a2e9c748a5029eb41383..14a6aa69ef3bffef0ea4ee60a9b392f876277122 100644 (file)
--- a/src/utils/Utils.ts
+++ b/src/utils/Utils.ts
@@ -12,7 +12,6 @@ import {
   minutesToSeconds,
   secondsToMilliseconds,
 } from 'date-fns';
-import clone from 'just-clone';
 
 import { Constants } from './Constants';
 import { type TimestampedData, WebSocketCloseEventStatusString } from '../types';
@@ -60,8 +59,8 @@ export const formatDurationSeconds = (duration: number): string => {
   return formatDurationMilliSeconds(secondsToMilliseconds(duration));
 };
 
-// More efficient date validation function than the one provided by date-fns
-export const isValidDate = (date: unknown): boolean => {
+// More efficient time validation function than the one provided by date-fns
+export const isValidTime = (date: unknown): boolean => {
   if (typeof date === 'number') {
     return !isNaN(date);
   } else if (isDate(date)) {
@@ -70,19 +69,20 @@ export const isValidDate = (date: unknown): boolean => {
   return false;
 };
 
-export const convertToDate = (
-  value: Date | string | number | null | undefined,
-): Date | null | undefined => {
+export const convertToDate = (value: Date | string | number | undefined): Date | undefined => {
   if (isNullOrUndefined(value)) {
-    return value as null | undefined;
+    return value as undefined;
   }
-  if (value instanceof Date) {
-    return value;
+  if (isDate(value)) {
+    return value as Date;
   }
   if (isString(value) || typeof value === 'number') {
-    return new Date(value!);
+    const valueToDate = new Date(value as string | number);
+    if (isNaN(valueToDate.getTime())) {
+      throw new Error(`Cannot convert to date: '${value as string | number}'`);
+    }
+    return valueToDate;
   }
-  return null;
 };
 
 export const convertToInt = (value: unknown): number => {
@@ -100,8 +100,7 @@ export const convertToInt = (value: unknown): number => {
     changedValue = parseInt(value as string);
   }
   if (isNaN(changedValue)) {
-    // eslint-disable-next-line @typescript-eslint/no-base-to-string
-    throw new Error(`Cannot convert to integer: ${value.toString()}`);
+    throw new Error(`Cannot convert to integer: '${String(value)}'`);
   }
   return changedValue;
 };
@@ -115,8 +114,7 @@ export const convertToFloat = (value: unknown): number => {
     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()}`);
+    throw new Error(`Cannot convert to float: '${String(value)}'`);
   }
   return changedValue;
 };
@@ -206,8 +204,55 @@ export const isObject = (item: unknown): boolean => {
   );
 };
 
-export const cloneObject = <T extends object>(object: T): T => {
-  return clone<T>(object);
+type CloneableData =
+  | number
+  | string
+  | boolean
+  | null
+  | undefined
+  | Date
+  | CloneableData[]
+  | { [key: string]: CloneableData };
+
+type FormatKey = (key: string) => string;
+
+const deepClone = <I extends CloneableData, O extends CloneableData = I>(
+  value: I,
+  formatKey?: FormatKey,
+  refs: Map<I, O> = new Map<I, O>(),
+): O => {
+  const ref = refs.get(value);
+  if (ref !== undefined) {
+    return ref;
+  }
+  if (Array.isArray(value)) {
+    const clone: CloneableData[] = [];
+    refs.set(value, clone as O);
+    for (let i = 0; i < value.length; i++) {
+      clone[i] = deepClone(value[i], formatKey, refs);
+    }
+    return clone as O;
+  }
+  if (value instanceof Date) {
+    return new Date(value.valueOf()) as O;
+  }
+  if (typeof value !== 'object' || value === null) {
+    return value as unknown as O;
+  }
+  const clone: Record<string, CloneableData> = {};
+  refs.set(value, clone as O);
+  for (const key of Object.keys(value)) {
+    clone[typeof formatKey === 'function' ? formatKey(key) : key] = deepClone(
+      value[key],
+      formatKey,
+      refs,
+    );
+  }
+  return clone as O;
+};
+
+export const cloneObject = <T>(object: T): T => {
+  return deepClone(object as CloneableData) as T;
 };
 
 export const hasOwnProp = (object: unknown, property: PropertyKey): boolean => {
@@ -270,12 +315,12 @@ export const insertAt = (str: string, subStr: string, pos: number): string =>
  * Computes the retry delay in milliseconds using an exponential backoff algorithm.
  *
  * @param retryNumber - the number of retries that have already been attempted
- * @param maxDelayRatio - the maximum ratio of the delay that can be randomized
+ * @param delayFactor - the base delay factor in milliseconds
  * @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-(maxDelayRatio*100)% of the delay
+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;
 };
 
@@ -291,7 +336,7 @@ export const promiseWithTimeout = async <T>(
     /* This is intentional */
   },
 ): Promise<T> => {
-  // Create a timeout promise that rejects in timeout milliseconds
+  // Creates a timeout promise that rejects in timeout milliseconds
   const timeoutPromise = new Promise<never>((_, reject) => {
     setTimeout(() => {
       if (isPromisePending(promise)) {
@@ -372,3 +417,24 @@ export const isArraySorted = <T>(array: T[], compareFn: (a: T, b: T) => number):
   }
   return true;
 };
+
+// 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) => {
+    if (fn) {
+      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);