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