refactor: flag tunable as deprecated

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

diff --git a/src/utils/Utils.ts b/src/utils/Utils.ts
index 5841ca1910f810670296b5824e051ef267cdce16..1a93669dbc334f4b7c2b1d18bd7f049d0625cc4f 100644 (file)
--- a/src/utils/Utils.ts
+++ b/src/utils/Utils.ts
@@ -1,8 +1,18 @@
 import { randomBytes, randomInt, randomUUID } from 'node:crypto';
 import { inspect } from 'node:util';
 
-import { formatDuration, secondsToMilliseconds } from 'date-fns';
-import clone from 'just-clone';
+import {
+  formatDuration,
+  hoursToMinutes,
+  hoursToSeconds,
+  isDate,
+  millisecondsToHours,
+  millisecondsToMinutes,
+  millisecondsToSeconds,
+  minutesToSeconds,
+  secondsToMilliseconds,
+} from 'date-fns';
+import deepClone from 'deep-clone';
 
 import { Constants } from './Constants';
 import { type TimestampedData, WebSocketCloseEventStatusString } from '../types';
@@ -28,9 +38,16 @@ export const sleep = async (milliSeconds: number): Promise<NodeJS.Timeout> => {
 export const formatDurationMilliSeconds = (duration: number): string => {
   duration = convertToInt(duration);
   const days = Math.floor(duration / (24 * 3600 * 1000));
-  const hours = Math.floor(duration / (3600 * 1000) - days * 24);
-  const minutes = Math.floor(duration / (60 * 1000) - days * 24 * 60 - hours * 60);
-  const seconds = Math.floor(duration / 1000 - days * 24 * 3600 - hours * 3600 - minutes * 60);
+  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),
+  );
   return formatDuration({
     days,
     hours,
@@ -43,19 +60,30 @@ export const formatDurationSeconds = (duration: number): string => {
   return formatDurationMilliSeconds(secondsToMilliseconds(duration));
 };
 
-export const convertToDate = (
-  value: Date | string | number | null | undefined,
-): Date | null | undefined => {
+// 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 as Date).getTime());
+  }
+  return false;
+};
+
+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 => {
@@ -73,8 +101,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;
 };
@@ -88,8 +115,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;
 };
@@ -179,8 +205,19 @@ 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 };
+
+export const cloneObject = <T>(object: T): T => {
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+  return deepClone(object as CloneableData) as T;
 };
 
 export const hasOwnProp = (object: unknown, property: PropertyKey): boolean => {
@@ -243,11 +280,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
  * @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
+  const randomSum = delay * maxDelayRatio * secureRandom(); // 0-(maxDelayRatio*100)% of the delay
   return delay + randomSum;
 };
 
@@ -335,3 +373,12 @@ 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;
+};