X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FUtils.ts;h=d99dcc3a0da29e98f11882cb0b4d3726bbff4133;hb=a78c196b969380d9d968c94fab567b0be6828f69;hp=8d51349a2357fbb9ea0b450dd3367f00f8c7406e;hpb=a37fc6dc8267e22b2b2d35773525980b81f014e8;p=e-mobility-charging-stations-simulator.git

diff --git a/src/utils/Utils.ts b/src/utils/Utils.ts
index 8d51349a..d99dcc3a 100644
--- a/src/utils/Utils.ts
+++ b/src/utils/Utils.ts
@@ -1,7 +1,17 @@
-import { randomBytes, randomInt, randomUUID } from 'node:crypto';
-import { inspect } from 'node:util';
-
-import clone from 'just-clone';
+import { getRandomValues, randomBytes, randomInt, randomUUID } from 'node:crypto';
+import { env, nextTick } from 'node:process';
+
+import {
+  formatDuration,
+  hoursToMinutes,
+  hoursToSeconds,
+  isDate,
+  millisecondsToHours,
+  millisecondsToMinutes,
+  millisecondsToSeconds,
+  minutesToSeconds,
+  secondsToMilliseconds,
+} from 'date-fns';
 
 import { Constants } from './Constants';
 import { type TimestampedData, WebSocketCloseEventStatusString } from '../types';
@@ -21,47 +31,66 @@ export const validateUUID = (uuid: string): boolean => {
 };
 
 export const sleep = async (milliSeconds: number): Promise<NodeJS.Timeout> => {
-  return new Promise((resolve) => setTimeout(resolve as () => void, milliSeconds));
+  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();
-
-  if (hours < 10) {
-    hoursStr = `0${hours.toString()}`;
-  }
-  if (minutes < 10) {
-    minutesStr = `0${minutes.toString()}`;
+  if (duration < 0) {
+    throw new RangeError('Duration cannot be negative');
   }
-  if (seconds < 10) {
-    secondsStr = `0${seconds.toString()}`;
+  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 `${hoursStr}:${minutesStr}:${secondsStr.substring(0, 6)}`;
+  return formatDuration({
+    days,
+    hours,
+    minutes,
+    seconds,
+  });
 };
 
 export const formatDurationSeconds = (duration: number): string => {
-  return formatDurationMilliSeconds(duration * 1000);
+  return formatDurationMilliSeconds(secondsToMilliseconds(duration));
+};
+
+// 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)) {
+    return !isNaN(date.getTime());
+  }
+  return false;
 };
 
 export const convertToDate = (
   value: Date | string | number | null | undefined,
 ): Date | null | undefined => {
   if (isNullOrUndefined(value)) {
-    return value as null | undefined;
+    return value as undefined;
   }
-  if (value instanceof Date) {
+  if (isDate(value)) {
     return value;
   }
   if (isString(value) || typeof value === 'number') {
-    return new Date(value!);
+    const valueToDate = new Date(value!);
+    if (isNaN(valueToDate.getTime())) {
+      throw new Error(`Cannot convert to date: '${value!}'`);
+    }
+    return valueToDate;
   }
-  return null;
 };
 
 export const convertToInt = (value: unknown): number => {
@@ -79,8 +108,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;
 };
@@ -94,15 +122,14 @@ 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;
 };
 
 export const convertToBoolean = (value: unknown): boolean => {
   let result = false;
-  if (value) {
+  if (value != null) {
     // Check the type
     if (typeof value === 'boolean') {
       return value;
@@ -185,8 +212,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 => {
@@ -194,7 +268,7 @@ export const hasOwnProp = (object: unknown, property: PropertyKey): boolean => {
 };
 
 export const isCFEnvironment = (): boolean => {
-  return !isNullOrUndefined(process.env.VCAP_APPLICATION);
+  return !isNullOrUndefined(env.VCAP_APPLICATION);
 };
 
 export const isIterable = <T>(obj: T): boolean => {
@@ -218,7 +292,6 @@ export const isUndefined = (value: unknown): boolean => {
 };
 
 export const isNullOrUndefined = (value: unknown): boolean => {
-  // eslint-disable-next-line eqeqeq, no-eq-null
   return value == null;
 };
 
@@ -249,48 +322,22 @@ 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 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-20% 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;
 };
 
-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
-      }
-      reject(timeoutError);
-    }, timeoutMs);
-  });
-
-  // Returns a race between timeout promise and the passed promise
-  return Promise.race<T>([promise, timeoutPromise]);
-};
-
 /**
  * Generates a cryptographically secure random number in the [0,1[ range
  *
- * @returns
+ * @returns A number in the [0,1[ range
  */
 export const secureRandom = (): number => {
-  return randomBytes(4).readUInt32LE() / 0x100000000;
+  return getRandomValues(new Uint32Array(1))[0] / 0x100000000;
 };
 
 export const JSONStringifyWithMapSupport = (
@@ -341,3 +388,39 @@ export const getWebSocketCloseEventStatusString = (code: number): string => {
   }
   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 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);
+
+export const throwErrorInNextTick = (error: Error): void => {
+  nextTick(() => {
+    throw error;
+  });
+};