refactor: factor out ATG and charging profiles sanity checks
[e-mobility-charging-stations-simulator.git] / src / utils / Utils.ts
index b253bfa222990656a565cbc744e6ac023a42e50c..73bb0ba927d2edce72ddf493635915a461d85051 100644 (file)
@@ -1,6 +1,17 @@
 import { randomBytes, randomInt, randomUUID } from 'node:crypto';
 import { inspect } from 'node:util';
 
+import {
+  formatDuration,
+  hoursToMinutes,
+  hoursToSeconds,
+  isDate,
+  millisecondsToHours,
+  millisecondsToMinutes,
+  millisecondsToSeconds,
+  minutesToSeconds,
+  secondsToMilliseconds,
+} from 'date-fns';
 import clone from 'just-clone';
 
 import { Constants } from './Constants';
@@ -16,50 +27,60 @@ export const generateUUID = (): string => {
 
 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
+    uuid,
   );
 };
 
 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 (seconds < 10) {
-    secondsStr = `0${seconds.toString()}`;
-  }
-  return `${hoursStr}:${minutesStr}:${secondsStr.substring(0, 6)}`;
+  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),
+  );
+  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 as Date).getTime());
+  }
+  return false;
 };
 
 export const convertToDate = (
-  value: Date | string | number | null | undefined
+  value: Date | string | number | null | undefined,
 ): Date | null | undefined => {
   if (isNullOrUndefined(value)) {
     return value as null | undefined;
   }
-  if (value instanceof Date) {
-    return value;
+  if (isDate(value)) {
+    return value as Date;
   }
   if (isString(value) || typeof value === 'number') {
-    return new Date(value);
+    return new Date(value!);
   }
   return null;
 };
@@ -79,6 +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()}`);
   }
   return changedValue;
@@ -93,6 +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()}`);
   }
   return changedValue;
@@ -155,11 +178,11 @@ export const getRandomFloatRounded = (max = Number.MAX_VALUE, min = 0, scale = 2
 export const getRandomFloatFluctuatedRounded = (
   staticValue: number,
   fluctuationPercent: number,
-  scale = 2
+  scale = 2,
 ): number => {
   if (fluctuationPercent < 0 || fluctuationPercent > 100) {
     throw new RangeError(
-      `Fluctuation percent must be between 0 and 100. Actual value: ${fluctuationPercent}`
+      `Fluctuation percent must be between 0 and 100. Actual value: ${fluctuationPercent}`,
     );
   }
   if (fluctuationPercent === 0) {
@@ -169,7 +192,7 @@ export const getRandomFloatFluctuatedRounded = (
   return getRandomFloatRounded(
     staticValue * (1 + fluctuationRatio),
     staticValue * (1 - fluctuationRatio),
-    scale
+    scale,
   );
 };
 
@@ -196,7 +219,7 @@ export const isCFEnvironment = (): boolean => {
 };
 
 export const isIterable = <T>(obj: T): boolean => {
-  return !isNullOrUndefined(obj) ? typeof obj[Symbol.iterator] === 'function' : false;
+  return !isNullOrUndefined(obj) ? typeof obj[Symbol.iterator as keyof T] === 'function' : false;
 };
 
 const isString = (value: unknown): boolean => {
@@ -247,11 +270,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;
 };
 
@@ -265,7 +289,7 @@ export const promiseWithTimeout = async <T>(
   timeoutError: Error,
   timeoutCallback: () => void = () => {
     /* This is intentional */
-  }
+  },
 ): Promise<T> => {
   // Create a timeout promise that rejects in timeout milliseconds
   const timeoutPromise = new Promise<never>((_, reject) => {
@@ -293,11 +317,11 @@ export const secureRandom = (): number => {
 
 export const JSONStringifyWithMapSupport = (
   obj: Record<string, unknown> | Record<string, unknown>[] | Map<unknown, unknown>,
-  space?: number
+  space?: number,
 ): string => {
   return JSON.stringify(
     obj,
-    (key, value: Record<string, unknown>) => {
+    (_, value: Record<string, unknown>) => {
       if (value instanceof Map) {
         return {
           dataType: 'Map',
@@ -306,7 +330,7 @@ export const JSONStringifyWithMapSupport = (
       }
       return value;
     },
-    space
+    space,
   );
 };
 
@@ -330,8 +354,21 @@ export const getWebSocketCloseEventStatusString = (code: number): string => {
       return '(For applications)';
     }
   }
-  if (!isUndefined(WebSocketCloseEventStatusString[code])) {
-    return WebSocketCloseEventStatusString[code] as string;
+  if (
+    !isUndefined(
+      WebSocketCloseEventStatusString[code as keyof typeof WebSocketCloseEventStatusString],
+    )
+  ) {
+    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 true;
+};