Commit | Line | Data |
---|---|---|
66a7748d JB |
1 | import { getRandomValues, randomBytes, randomInt, randomUUID } from 'node:crypto' |
2 | import { env, nextTick } from 'node:process' | |
8114d10e | 3 | |
f0c6601c JB |
4 | import { |
5 | formatDuration, | |
be4c6702 JB |
6 | hoursToMinutes, |
7 | hoursToSeconds, | |
b5c19509 | 8 | isDate, |
f0c6601c JB |
9 | millisecondsToHours, |
10 | millisecondsToMinutes, | |
11 | millisecondsToSeconds, | |
be4c6702 | 12 | minutesToSeconds, |
66a7748d JB |
13 | secondsToMilliseconds |
14 | } from 'date-fns' | |
088ee3c1 | 15 | |
66a7748d JB |
16 | import { Constants } from './Constants.js' |
17 | import { type TimestampedData, WebSocketCloseEventStatusString } from '../types/index.js' | |
5e3cb728 | 18 | |
9bf0ef23 | 19 | export const logPrefix = (prefixString = ''): string => { |
66a7748d JB |
20 | return `${new Date().toLocaleString()}${prefixString}` |
21 | } | |
d5bd1c00 | 22 | |
9bf0ef23 | 23 | export const generateUUID = (): string => { |
66a7748d JB |
24 | return randomUUID() |
25 | } | |
147d0e0f | 26 | |
9bf0ef23 | 27 | export const validateUUID = (uuid: string): boolean => { |
66a7748d JB |
28 | 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) |
29 | } | |
03eacbe5 | 30 | |
9bf0ef23 | 31 | export const sleep = async (milliSeconds: number): Promise<NodeJS.Timeout> => { |
66a7748d JB |
32 | return await new Promise<NodeJS.Timeout>((resolve) => |
33 | setTimeout(resolve as () => void, milliSeconds) | |
34 | ) | |
35 | } | |
7dde0b73 | 36 | |
9bf0ef23 | 37 | export const formatDurationMilliSeconds = (duration: number): string => { |
66a7748d | 38 | duration = convertToInt(duration) |
17b07e47 | 39 | if (duration < 0) { |
66a7748d | 40 | throw new RangeError('Duration cannot be negative') |
17b07e47 | 41 | } |
66a7748d JB |
42 | const days = Math.floor(duration / (24 * 3600 * 1000)) |
43 | const hours = Math.floor(millisecondsToHours(duration) - days * 24) | |
be4c6702 | 44 | const minutes = Math.floor( |
66a7748d JB |
45 | millisecondsToMinutes(duration) - days * 24 * 60 - hoursToMinutes(hours) |
46 | ) | |
f0c6601c | 47 | const seconds = Math.floor( |
be4c6702 JB |
48 | millisecondsToSeconds(duration) - |
49 | days * 24 * 3600 - | |
50 | hoursToSeconds(hours) - | |
66a7748d JB |
51 | minutesToSeconds(minutes) |
52 | ) | |
d7ceb0f0 | 53 | if (days === 0 && hours === 0 && minutes === 0 && seconds === 0) { |
66a7748d | 54 | return formatDuration({ seconds }, { zero: true }) |
d7ceb0f0 JB |
55 | } |
56 | return formatDuration({ | |
57 | days, | |
58 | hours, | |
59 | minutes, | |
66a7748d JB |
60 | seconds |
61 | }) | |
62 | } | |
7dde0b73 | 63 | |
9bf0ef23 | 64 | export const formatDurationSeconds = (duration: number): string => { |
66a7748d JB |
65 | return formatDurationMilliSeconds(secondsToMilliseconds(duration)) |
66 | } | |
7dde0b73 | 67 | |
0bd926c1 JB |
68 | // More efficient time validation function than the one provided by date-fns |
69 | export const isValidTime = (date: unknown): boolean => { | |
b5c19509 | 70 | if (typeof date === 'number') { |
66a7748d | 71 | return !isNaN(date) |
b5c19509 | 72 | } else if (isDate(date)) { |
66a7748d | 73 | return !isNaN(date.getTime()) |
b5c19509 | 74 | } |
66a7748d JB |
75 | return false |
76 | } | |
b5c19509 | 77 | |
a78c196b | 78 | export const convertToDate = ( |
66a7748d | 79 | value: Date | string | number | null | undefined |
a78c196b | 80 | ): Date | null | undefined => { |
66a7748d JB |
81 | if (value == null) { |
82 | return value | |
7dde0b73 | 83 | } |
0bd926c1 | 84 | if (isDate(value)) { |
66a7748d | 85 | return value |
a6e68f34 | 86 | } |
9bf0ef23 | 87 | if (isString(value) || typeof value === 'number') { |
66a7748d | 88 | const valueToDate = new Date(value) |
85cce27f | 89 | if (isNaN(valueToDate.getTime())) { |
66a7748d | 90 | throw new Error(`Cannot convert to date: '${value}'`) |
43ff25b8 | 91 | } |
66a7748d | 92 | return valueToDate |
560bcf5b | 93 | } |
66a7748d | 94 | } |
560bcf5b | 95 | |
9bf0ef23 | 96 | export const convertToInt = (value: unknown): number => { |
66a7748d JB |
97 | if (value == null) { |
98 | return 0 | |
560bcf5b | 99 | } |
66a7748d | 100 | let changedValue: number = value as number |
9bf0ef23 | 101 | if (Number.isSafeInteger(value)) { |
66a7748d | 102 | return value as number |
6d3a11a0 | 103 | } |
9bf0ef23 | 104 | if (typeof value === 'number') { |
66a7748d | 105 | return Math.trunc(value) |
7dde0b73 | 106 | } |
9bf0ef23 | 107 | if (isString(value)) { |
66a7748d | 108 | changedValue = parseInt(value as string) |
9ccca265 | 109 | } |
9bf0ef23 | 110 | if (isNaN(changedValue)) { |
66a7748d | 111 | throw new Error(`Cannot convert to integer: '${String(value)}'`) |
dada83ec | 112 | } |
66a7748d JB |
113 | return changedValue |
114 | } | |
dada83ec | 115 | |
9bf0ef23 | 116 | export const convertToFloat = (value: unknown): number => { |
66a7748d JB |
117 | if (value == null) { |
118 | return 0 | |
dada83ec | 119 | } |
66a7748d | 120 | let changedValue: number = value as number |
9bf0ef23 | 121 | if (isString(value)) { |
66a7748d | 122 | changedValue = parseFloat(value as string) |
560bcf5b | 123 | } |
9bf0ef23 | 124 | if (isNaN(changedValue)) { |
66a7748d | 125 | throw new Error(`Cannot convert to float: '${String(value)}'`) |
5a2a53cf | 126 | } |
66a7748d JB |
127 | return changedValue |
128 | } | |
5a2a53cf | 129 | |
9bf0ef23 | 130 | export const convertToBoolean = (value: unknown): boolean => { |
66a7748d | 131 | let result = false |
a78c196b | 132 | if (value != null) { |
9bf0ef23 JB |
133 | // Check the type |
134 | if (typeof value === 'boolean') { | |
66a7748d | 135 | return value |
9bf0ef23 | 136 | } else if (isString(value) && ((value as string).toLowerCase() === 'true' || value === '1')) { |
66a7748d | 137 | result = true |
9bf0ef23 | 138 | } else if (typeof value === 'number' && value === 1) { |
66a7748d | 139 | result = true |
e7aeea18 | 140 | } |
c37528f1 | 141 | } |
66a7748d JB |
142 | return result |
143 | } | |
9bf0ef23 JB |
144 | |
145 | export const getRandomFloat = (max = Number.MAX_VALUE, min = 0): number => { | |
146 | if (max < min) { | |
66a7748d | 147 | throw new RangeError('Invalid interval') |
9bf0ef23 JB |
148 | } |
149 | if (max - min === Infinity) { | |
66a7748d | 150 | throw new RangeError('Invalid interval') |
9bf0ef23 | 151 | } |
66a7748d JB |
152 | return (randomBytes(4).readUInt32LE() / 0xffffffff) * (max - min) + min |
153 | } | |
9bf0ef23 JB |
154 | |
155 | export const getRandomInteger = (max = Constants.MAX_RANDOM_INTEGER, min = 0): number => { | |
66a7748d JB |
156 | max = Math.floor(max) |
157 | if (min != null && min !== 0) { | |
158 | min = Math.ceil(min) | |
159 | return Math.floor(randomInt(min, max + 1)) | |
9bf0ef23 | 160 | } |
66a7748d JB |
161 | return Math.floor(randomInt(max + 1)) |
162 | } | |
9bf0ef23 JB |
163 | |
164 | /** | |
165 | * Rounds the given number to the given scale. | |
166 | * The rounding is done using the "round half away from zero" method. | |
167 | * | |
168 | * @param numberValue - The number to round. | |
169 | * @param scale - The scale to round to. | |
170 | * @returns The rounded number. | |
171 | */ | |
172 | export const roundTo = (numberValue: number, scale: number): number => { | |
66a7748d JB |
173 | const roundPower = Math.pow(10, scale) |
174 | return Math.round(numberValue * roundPower * (1 + Number.EPSILON)) / roundPower | |
175 | } | |
9bf0ef23 JB |
176 | |
177 | export const getRandomFloatRounded = (max = Number.MAX_VALUE, min = 0, scale = 2): number => { | |
66a7748d JB |
178 | if (min != null && min !== 0) { |
179 | return roundTo(getRandomFloat(max, min), scale) | |
9bf0ef23 | 180 | } |
66a7748d JB |
181 | return roundTo(getRandomFloat(max), scale) |
182 | } | |
9bf0ef23 JB |
183 | |
184 | export const getRandomFloatFluctuatedRounded = ( | |
185 | staticValue: number, | |
186 | fluctuationPercent: number, | |
66a7748d | 187 | scale = 2 |
9bf0ef23 JB |
188 | ): number => { |
189 | if (fluctuationPercent < 0 || fluctuationPercent > 100) { | |
190 | throw new RangeError( | |
66a7748d JB |
191 | `Fluctuation percent must be between 0 and 100. Actual value: ${fluctuationPercent}` |
192 | ) | |
fe791818 | 193 | } |
9bf0ef23 | 194 | if (fluctuationPercent === 0) { |
66a7748d | 195 | return roundTo(staticValue, scale) |
9bf0ef23 | 196 | } |
66a7748d | 197 | const fluctuationRatio = fluctuationPercent / 100 |
9bf0ef23 JB |
198 | return getRandomFloatRounded( |
199 | staticValue * (1 + fluctuationRatio), | |
200 | staticValue * (1 - fluctuationRatio), | |
66a7748d JB |
201 | scale |
202 | ) | |
203 | } | |
9bf0ef23 | 204 | |
66a7748d JB |
205 | export const extractTimeSeriesValues = (timeSeries: TimestampedData[]): number[] => { |
206 | return timeSeries.map((timeSeriesItem) => timeSeriesItem.value) | |
207 | } | |
da55bd34 | 208 | |
9bf0ef23 | 209 | export const isObject = (item: unknown): boolean => { |
aa63c9b7 | 210 | return item != null && typeof item === 'object' && !Array.isArray(item) |
66a7748d | 211 | } |
9bf0ef23 | 212 | |
32f5e42d JB |
213 | type CloneableData = |
214 | | number | |
215 | | string | |
216 | | boolean | |
217 | | null | |
218 | | undefined | |
219 | | Date | |
220 | | CloneableData[] | |
66a7748d | 221 | | { [key: string]: CloneableData } |
32f5e42d | 222 | |
66a7748d | 223 | type FormatKey = (key: string) => string |
661ac64b | 224 | |
015f3404 | 225 | const deepClone = <I extends CloneableData, O extends CloneableData = I>( |
661ac64b JB |
226 | value: I, |
227 | formatKey?: FormatKey, | |
66a7748d | 228 | refs: Map<I, O> = new Map<I, O>() |
015f3404 | 229 | ): O => { |
66a7748d | 230 | const ref = refs.get(value) |
661ac64b | 231 | if (ref !== undefined) { |
66a7748d | 232 | return ref |
661ac64b JB |
233 | } |
234 | if (Array.isArray(value)) { | |
66a7748d JB |
235 | const clone: CloneableData[] = [] |
236 | refs.set(value, clone as O) | |
661ac64b | 237 | for (let i = 0; i < value.length; i++) { |
66a7748d | 238 | clone[i] = deepClone(value[i], formatKey, refs) |
661ac64b | 239 | } |
66a7748d | 240 | return clone as O |
661ac64b JB |
241 | } |
242 | if (value instanceof Date) { | |
66a7748d | 243 | return new Date(value.valueOf()) as O |
661ac64b JB |
244 | } |
245 | if (typeof value !== 'object' || value === null) { | |
66a7748d | 246 | return value as unknown as O |
661ac64b | 247 | } |
66a7748d JB |
248 | const clone: Record<string, CloneableData> = {} |
249 | refs.set(value, clone as O) | |
661ac64b JB |
250 | for (const key of Object.keys(value)) { |
251 | clone[typeof formatKey === 'function' ? formatKey(key) : key] = deepClone( | |
252 | value[key], | |
253 | formatKey, | |
66a7748d JB |
254 | refs |
255 | ) | |
661ac64b | 256 | } |
66a7748d JB |
257 | return clone as O |
258 | } | |
661ac64b | 259 | |
32f5e42d | 260 | export const cloneObject = <T>(object: T): T => { |
66a7748d JB |
261 | return deepClone(object as CloneableData) as T |
262 | } | |
9bf0ef23 JB |
263 | |
264 | export const hasOwnProp = (object: unknown, property: PropertyKey): boolean => { | |
66a7748d JB |
265 | return isObject(object) && Object.hasOwn(object as object, property) |
266 | } | |
9bf0ef23 JB |
267 | |
268 | export const isCFEnvironment = (): boolean => { | |
aa63c9b7 | 269 | return env.VCAP_APPLICATION != null |
66a7748d | 270 | } |
9bf0ef23 JB |
271 | |
272 | export const isIterable = <T>(obj: T): boolean => { | |
aa63c9b7 | 273 | return obj != null ? typeof obj[Symbol.iterator as keyof T] === 'function' : false |
66a7748d | 274 | } |
9bf0ef23 JB |
275 | |
276 | const isString = (value: unknown): boolean => { | |
66a7748d JB |
277 | return typeof value === 'string' |
278 | } | |
9bf0ef23 JB |
279 | |
280 | export const isEmptyString = (value: unknown): boolean => { | |
aa63c9b7 | 281 | return value == null || (isString(value) && (value as string).trim().length === 0) |
66a7748d | 282 | } |
9bf0ef23 JB |
283 | |
284 | export const isNotEmptyString = (value: unknown): boolean => { | |
66a7748d JB |
285 | return isString(value) && (value as string).trim().length > 0 |
286 | } | |
9bf0ef23 | 287 | |
9bf0ef23 | 288 | export const isEmptyArray = (object: unknown): boolean => { |
66a7748d JB |
289 | return Array.isArray(object) && object.length === 0 |
290 | } | |
9bf0ef23 JB |
291 | |
292 | export const isNotEmptyArray = (object: unknown): boolean => { | |
66a7748d JB |
293 | return Array.isArray(object) && object.length > 0 |
294 | } | |
9bf0ef23 JB |
295 | |
296 | export const isEmptyObject = (obj: object): boolean => { | |
297 | if (obj?.constructor !== Object) { | |
66a7748d | 298 | return false |
9bf0ef23 JB |
299 | } |
300 | // Iterates over the keys of an object, if | |
301 | // any exist, return false. | |
66a7748d | 302 | // eslint-disable-next-line no-unreachable-loop |
9bf0ef23 | 303 | for (const _ in obj) { |
66a7748d | 304 | return false |
9bf0ef23 | 305 | } |
66a7748d JB |
306 | return true |
307 | } | |
9bf0ef23 JB |
308 | |
309 | export const insertAt = (str: string, subStr: string, pos: number): string => | |
66a7748d | 310 | `${str.slice(0, pos)}${subStr}${str.slice(pos)}` |
9bf0ef23 JB |
311 | |
312 | /** | |
313 | * Computes the retry delay in milliseconds using an exponential backoff algorithm. | |
314 | * | |
315 | * @param retryNumber - the number of retries that have already been attempted | |
45abd3c6 | 316 | * @param delayFactor - the base delay factor in milliseconds |
9bf0ef23 JB |
317 | * @returns delay in milliseconds |
318 | */ | |
45abd3c6 | 319 | export const exponentialDelay = (retryNumber = 0, delayFactor = 100): number => { |
66a7748d JB |
320 | const delay = Math.pow(2, retryNumber) * delayFactor |
321 | const randomSum = delay * 0.2 * secureRandom() // 0-20% of the delay | |
322 | return delay + randomSum | |
323 | } | |
9bf0ef23 | 324 | |
9bf0ef23 JB |
325 | /** |
326 | * Generates a cryptographically secure random number in the [0,1[ range | |
327 | * | |
ab93b184 | 328 | * @returns A number in the [0,1[ range |
9bf0ef23 JB |
329 | */ |
330 | export const secureRandom = (): number => { | |
66a7748d JB |
331 | return getRandomValues(new Uint32Array(1))[0] / 0x100000000 |
332 | } | |
9bf0ef23 JB |
333 | |
334 | export const JSONStringifyWithMapSupport = ( | |
66a7748d JB |
335 | obj: Record<string, unknown> | Array<Record<string, unknown>> | Map<unknown, unknown>, |
336 | space?: number | |
9bf0ef23 JB |
337 | ): string => { |
338 | return JSON.stringify( | |
339 | obj, | |
58ddf341 | 340 | (_, value: Record<string, unknown>) => { |
9bf0ef23 JB |
341 | if (value instanceof Map) { |
342 | return { | |
343 | dataType: 'Map', | |
66a7748d JB |
344 | value: [...value] |
345 | } | |
9bf0ef23 | 346 | } |
66a7748d | 347 | return value |
9bf0ef23 | 348 | }, |
66a7748d JB |
349 | space |
350 | ) | |
351 | } | |
9bf0ef23 JB |
352 | |
353 | /** | |
354 | * Converts websocket error code to human readable string message | |
355 | * | |
356 | * @param code - websocket error code | |
357 | * @returns human readable string message | |
358 | */ | |
359 | export const getWebSocketCloseEventStatusString = (code: number): string => { | |
360 | if (code >= 0 && code <= 999) { | |
66a7748d | 361 | return '(Unused)' |
9bf0ef23 JB |
362 | } else if (code >= 1016) { |
363 | if (code <= 1999) { | |
66a7748d | 364 | return '(For WebSocket standard)' |
9bf0ef23 | 365 | } else if (code <= 2999) { |
66a7748d | 366 | return '(For WebSocket extensions)' |
9bf0ef23 | 367 | } else if (code <= 3999) { |
66a7748d | 368 | return '(For libraries and frameworks)' |
9bf0ef23 | 369 | } else if (code <= 4999) { |
66a7748d | 370 | return '(For applications)' |
5e3cb728 | 371 | } |
5e3cb728 | 372 | } |
a37fc6dc | 373 | if ( |
300418e9 JB |
374 | WebSocketCloseEventStatusString[code as keyof typeof WebSocketCloseEventStatusString] !== |
375 | undefined | |
a37fc6dc | 376 | ) { |
66a7748d | 377 | return WebSocketCloseEventStatusString[code as keyof typeof WebSocketCloseEventStatusString] |
9bf0ef23 | 378 | } |
66a7748d JB |
379 | return '(Unknown)' |
380 | } | |
80c58041 | 381 | |
991fb26b JB |
382 | export const isArraySorted = <T>(array: T[], compareFn: (a: T, b: T) => number): boolean => { |
383 | for (let index = 0; index < array.length - 1; ++index) { | |
384 | if (compareFn(array[index], array[index + 1]) > 0) { | |
66a7748d | 385 | return false |
80c58041 JB |
386 | } |
387 | } | |
66a7748d JB |
388 | return true |
389 | } | |
5f742aac JB |
390 | |
391 | // eslint-disable-next-line @typescript-eslint/no-explicit-any | |
392 | export const once = <T, A extends any[], R>( | |
393 | fn: (...args: A) => R, | |
66a7748d | 394 | context: T |
5f742aac | 395 | ): ((...args: A) => R) => { |
66a7748d | 396 | let result: R |
5f742aac | 397 | return (...args: A) => { |
66a7748d JB |
398 | if (fn != null) { |
399 | result = fn.apply<T, A, R>(context, args) | |
400 | ;(fn as unknown as undefined) = (context as unknown as undefined) = undefined | |
5f742aac | 401 | } |
66a7748d JB |
402 | return result |
403 | } | |
404 | } | |
5adf6ca4 JB |
405 | |
406 | export const min = (...args: number[]): number => | |
66a7748d | 407 | args.reduce((minimum, num) => (minimum < num ? minimum : num), Infinity) |
5adf6ca4 JB |
408 | |
409 | export const max = (...args: number[]): number => | |
66a7748d | 410 | args.reduce((maximum, num) => (maximum > num ? maximum : num), -Infinity) |
29dff95e JB |
411 | |
412 | export const throwErrorInNextTick = (error: Error): void => { | |
413 | nextTick(() => { | |
66a7748d JB |
414 | throw error |
415 | }) | |
416 | } |