-import Configuration from './Configuration';
-import { WebSocketCloseEventStatusString } from '../types/WebSocket';
-import { WorkerProcessType } from '../types/Worker';
-import { v4 as uuid } from 'uuid';
+import { getRandomValues, randomBytes, randomUUID } from 'node:crypto'
+import { env, nextTick } from 'node:process'
-export default class Utils {
- static generateUUID(): string {
- return uuid();
- }
+import {
+ formatDuration,
+ hoursToMinutes,
+ hoursToSeconds,
+ isDate,
+ millisecondsToHours,
+ millisecondsToMinutes,
+ millisecondsToSeconds,
+ minutesToSeconds,
+ secondsToMilliseconds
+} from 'date-fns'
+import { is } from 'rambda'
- static async sleep(milliSeconds: number): Promise<NodeJS.Timeout> {
- return new Promise((resolve) => setTimeout(resolve, milliSeconds));
- }
+import {
+ type JsonType,
+ MapStringifyFormat,
+ type TimestampedData,
+ WebSocketCloseEventStatusString
+} from '../types/index.js'
- static secondsToHHMMSS(seconds: number): string {
- return Utils.milliSecondsToHHMMSS(seconds * 1000);
- }
+export const logPrefix = (prefixString = ''): string => {
+ return `${new Date().toLocaleString()}${prefixString}`
+}
- static milliSecondsToHHMMSS(milliSeconds: number): string {
- return new Date(milliSeconds).toISOString().substr(11, 8);
- }
+export const generateUUID = (): `${string}-${string}-${string}-${string}-${string}` => {
+ return randomUUID()
+}
- 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 validateUUID = (
+ uuid: `${string}-${string}-${string}-${string}-${string}`
+): uuid is `${string}-${string}-${string}-${string}-${string}` => {
+ 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 convertToDate(value): Date {
- // Check
- if (!value) {
- return value;
- }
- // Check Type
- if (!(value instanceof Date)) {
- return new Date(value);
- }
- return value;
- }
+export const sleep = async (milliSeconds: number): Promise<NodeJS.Timeout> => {
+ return await new Promise<NodeJS.Timeout>(resolve =>
+ setTimeout(resolve as () => void, milliSeconds)
+ )
+}
- static convertToInt(value): number {
- let changedValue = value;
- if (!value) {
- return 0;
- }
- if (Number.isSafeInteger(value)) {
- return value;
- }
- // Check
- if (typeof value === 'string') {
- // Create Object
- changedValue = parseInt(value);
- }
- return changedValue;
+export const formatDurationMilliSeconds = (duration: number): string => {
+ duration = convertToInt(duration)
+ if (duration < 0) {
+ throw new RangeError('Duration cannot be negative')
}
-
- static convertToFloat(value): number {
- let changedValue = value;
- if (!value) {
- return 0;
- }
- // Check
- if (typeof value === 'string') {
- // Create Object
- changedValue = parseFloat(value);
- }
- return changedValue;
- }
-
- static convertToBoolean(value): 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;
+ 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 getRandomFloat(max: number, min = 0): number {
- return Math.random() < 0.5 ? (1 - Math.random()) * (max - min) + min : Math.random() * (max - min) + min;
- }
+export const formatDurationSeconds = (duration: number): string => {
+ return formatDurationMilliSeconds(secondsToMilliseconds(duration))
+}
- static getRandomInt(max: number, min = 0): number {
- if (min) {
- return Math.floor(Math.random() * (max - min + 1) + min);
- }
- return Math.floor(Math.random() * max + 1);
+// 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 roundTo(numberValue: number, scale: number): number {
- const roundPower = Math.pow(10, scale);
- return Math.round(numberValue * roundPower) / roundPower;
+export const convertToDate = (
+ value: Date | string | number | undefined | null
+): Date | undefined => {
+ if (value == null) {
+ return undefined
}
-
- static truncTo(numberValue: number, scale: number): number {
- const truncPower = Math.pow(10, scale);
- return Math.trunc(numberValue * truncPower) / truncPower;
+ if (isDate(value)) {
+ return value
}
-
- static getRandomFloatRounded(max: number, min = 0, scale = 2): number {
- if (min) {
- return Utils.roundTo(Utils.getRandomFloat(max, min), scale);
+ if (typeof value === 'string' || typeof value === 'number') {
+ const valueToDate = new Date(value)
+ if (isNaN(valueToDate.getTime())) {
+ throw new Error(`Cannot convert to date: '${value}'`)
}
- return Utils.roundTo(Utils.getRandomFloat(max), scale);
+ return valueToDate
}
+}
- static logPrefix(prefixString = ''): string {
- const date = new Date();
- return date.toLocaleString() + prefixString;
+export const convertToInt = (value: unknown): number => {
+ if (value == null) {
+ return 0
}
-
- static cloneObject<T>(object: T): T {
- return JSON.parse(JSON.stringify(object)) as T;
+ if (Number.isSafeInteger(value)) {
+ return value as number
+ }
+ if (typeof value === 'number') {
+ return Math.trunc(value)
+ }
+ let changedValue: number = value as number
+ if (typeof value === 'string') {
+ changedValue = parseInt(value)
}
+ if (isNaN(changedValue)) {
+ throw new Error(`Cannot convert to integer: '${String(value)}'`)
+ }
+ return changedValue
+}
- static isIterable(obj): boolean {
- if (obj) {
- return typeof obj[Symbol.iterator] === 'function';
- }
- return false;
+export const convertToFloat = (value: unknown): number => {
+ if (value == null) {
+ return 0
+ }
+ let changedValue: number = value as number
+ if (typeof value === 'string') {
+ changedValue = parseFloat(value)
+ }
+ if (isNaN(changedValue)) {
+ throw new Error(`Cannot convert to float: '${String(value)}'`)
}
+ return changedValue
+}
- static isEmptyJSon(document): boolean {
- // Empty?
- if (!document) {
- return true;
- }
- // Check type
- if (typeof document !== 'object') {
- return true;
+export const convertToBoolean = (value: unknown): boolean => {
+ let result = false
+ if (value != null) {
+ // Check the type
+ if (typeof value === 'boolean') {
+ return value
+ } else if (typeof value === 'string' && (value.toLowerCase() === 'true' || value === '1')) {
+ result = true
+ } else if (typeof value === 'number' && value === 1) {
+ result = true
}
- // Check
- return Object.keys(document).length === 0;
}
+ return result
+}
- static isString(value): boolean {
- return typeof value === 'string';
+export const getRandomFloat = (max = Number.MAX_VALUE, min = 0): number => {
+ if (max < min) {
+ throw new RangeError('Invalid interval')
+ }
+ if (max - min === Infinity) {
+ throw new RangeError('Invalid interval')
}
+ return (randomBytes(4).readUInt32LE() / 0xffffffff) * (max - min) + min
+}
+
+/**
+ * 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 isUndefined(value): boolean {
- return typeof value === 'undefined';
+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 isNullOrUndefined(value): boolean {
- // eslint-disable-next-line no-eq-null, eqeqeq
- if (value == null) {
- return true;
- }
- return false;
+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 isEmptyArray(object): boolean {
- if (!object) {
- return true;
- }
- if (Array.isArray(object) && object.length > 0) {
- return false;
- }
- return true;
- }
-
- static isEmptyObject(obj): 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 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 is(Function, fn) && fn.constructor.name === 'AsyncFunction'
+}
+
+export const isObject = (value: unknown): value is object => {
+ return value != null && !Array.isArray(value) && is(Object, value)
+}
+
+export const hasOwnProp = (value: unknown, property: PropertyKey): boolean => {
+ return isObject(value) && Object.hasOwn(value, property)
+}
+
+export const isCFEnvironment = (): boolean => {
+ return env.VCAP_APPLICATION != null
+}
+
+export const isNotEmptyString = (value: unknown): value is string => {
+ return typeof value === 'string' && value.trim().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 JSONStringify = <
+ T extends
+ | JsonType
+ | Array<Record<string, unknown>>
+ | Set<Record<string, unknown>>
+ | Map<string, Record<string, unknown>>
+>(
+ object: T,
+ space?: string | number,
+ mapFormat?: MapStringifyFormat
+ ): string => {
+ return JSON.stringify(
+ object,
+ (_, value: Record<string, unknown>) => {
+ if (is(Map, value)) {
+ switch (mapFormat) {
+ case MapStringifyFormat.object:
+ return { ...Object.fromEntries<Map<string, Record<string, unknown>>>(value.entries()) }
+ case MapStringifyFormat.array:
+ default:
+ return [...value]
+ }
+ } else if (is(Set, value)) {
+ return [...value] as JsonType[]
}
+ 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)';
}
-
- static workerPoolInUse(): boolean {
- return [WorkerProcessType.DYNAMIC_POOL, WorkerProcessType.STATIC_POOL].includes(Configuration.getWorkerProcess());
+ 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 workerDynamicPoolInUse(): boolean {
- return Configuration.getWorkerProcess() === WorkerProcessType.DYNAMIC_POOL;
+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
+}
+
+export const throwErrorInNextTick = (error: Error): void => {
+ nextTick(() => {
+ throw error
+ })
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff