Commit | Line | Data |
---|---|---|
52ed5cf0 | 1 | import crypto from 'node:crypto'; |
764d2c91 | 2 | import util from 'node:util'; |
8114d10e | 3 | |
088ee3c1 JB |
4 | import clone from 'just-clone'; |
5 | ||
878e026c | 6 | import { Constants } from './Constants'; |
268a74bb | 7 | import { WebSocketCloseEventStatusString } from '../types'; |
5e3cb728 | 8 | |
268a74bb | 9 | export class Utils { |
d5bd1c00 JB |
10 | private constructor() { |
11 | // This is intentional | |
12 | } | |
13 | ||
8b7072dc | 14 | public static logPrefix = (prefixString = ''): string => { |
a1e5fe4e | 15 | return `${new Date().toLocaleString()}${prefixString}`; |
8b7072dc | 16 | }; |
147d0e0f | 17 | |
0f16a662 | 18 | public static generateUUID(): string { |
03eacbe5 JB |
19 | return crypto.randomUUID(); |
20 | } | |
21 | ||
22 | public static validateUUID(uuid: string): boolean { | |
8bd02502 JB |
23 | 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( |
24 | uuid | |
25 | ); | |
7dde0b73 JB |
26 | } |
27 | ||
0f16a662 | 28 | public static async sleep(milliSeconds: number): Promise<NodeJS.Timeout> { |
72092cfc | 29 | return new Promise((resolve) => setTimeout(resolve as () => void, milliSeconds)); |
7dde0b73 JB |
30 | } |
31 | ||
d7d1db72 JB |
32 | public static formatDurationMilliSeconds(duration: number): string { |
33 | duration = Utils.convertToInt(duration); | |
34 | const hours = Math.floor(duration / (3600 * 1000)); | |
e7aeea18 JB |
35 | const minutes = Math.floor((duration / 1000 - hours * 3600) / 60); |
36 | const seconds = duration / 1000 - hours * 3600 - minutes * 60; | |
a3868ec4 JB |
37 | let hoursStr = hours.toString(); |
38 | let minutesStr = minutes.toString(); | |
39 | let secondsStr = seconds.toString(); | |
d7d1db72 JB |
40 | |
41 | if (hours < 10) { | |
44eb6026 | 42 | hoursStr = `0${hours.toString()}`; |
d7d1db72 JB |
43 | } |
44 | if (minutes < 10) { | |
44eb6026 | 45 | minutesStr = `0${minutes.toString()}`; |
d7d1db72 JB |
46 | } |
47 | if (seconds < 10) { | |
44eb6026 | 48 | secondsStr = `0${seconds.toString()}`; |
d7d1db72 | 49 | } |
44eb6026 | 50 | return `${hoursStr}:${minutesStr}:${secondsStr.substring(0, 6)}`; |
9ac86a7e JB |
51 | } |
52 | ||
d7d1db72 JB |
53 | public static formatDurationSeconds(duration: number): string { |
54 | return Utils.formatDurationMilliSeconds(duration * 1000); | |
7dde0b73 JB |
55 | } |
56 | ||
b1340ec1 JB |
57 | public static convertToDate( |
58 | value: Date | string | number | null | undefined | |
59 | ): Date | null | undefined { | |
d439da5c JB |
60 | if (Utils.isNullOrUndefined(value)) { |
61 | return value as null | undefined; | |
62 | } | |
63 | if (value instanceof Date) { | |
64 | return value; | |
560bcf5b | 65 | } |
d439da5c | 66 | if (Utils.isString(value) || typeof value === 'number') { |
b1340ec1 | 67 | return new Date(value); |
7dde0b73 | 68 | } |
d439da5c | 69 | return null; |
7dde0b73 JB |
70 | } |
71 | ||
0f16a662 | 72 | public static convertToInt(value: unknown): number { |
72766a82 | 73 | if (!value) { |
7dde0b73 JB |
74 | return 0; |
75 | } | |
69bafbed | 76 | let changedValue: number = value as number; |
72766a82 | 77 | if (Number.isSafeInteger(value)) { |
95926c9b | 78 | return value as number; |
72766a82 | 79 | } |
df645d8f | 80 | if (typeof value === 'number') { |
b1340ec1 | 81 | return Math.trunc(value); |
df645d8f | 82 | } |
3df786f9 JB |
83 | if (Utils.isString(value)) { |
84 | changedValue = parseInt(value as string); | |
85 | } | |
b1340ec1 JB |
86 | if (isNaN(changedValue)) { |
87 | throw new Error(`Cannot convert to integer: ${value.toString()}`); | |
88 | } | |
72766a82 | 89 | return changedValue; |
7dde0b73 JB |
90 | } |
91 | ||
0f16a662 | 92 | public static convertToFloat(value: unknown): number { |
72766a82 | 93 | if (!value) { |
7dde0b73 JB |
94 | return 0; |
95 | } | |
69bafbed | 96 | let changedValue: number = value as number; |
087a502d | 97 | if (Utils.isString(value)) { |
73d09045 | 98 | changedValue = parseFloat(value as string); |
7dde0b73 | 99 | } |
b1340ec1 JB |
100 | if (isNaN(changedValue)) { |
101 | throw new Error(`Cannot convert to float: ${value.toString()}`); | |
102 | } | |
72766a82 | 103 | return changedValue; |
7dde0b73 JB |
104 | } |
105 | ||
0f16a662 | 106 | public static convertToBoolean(value: unknown): boolean { |
a6e68f34 | 107 | let result = false; |
a6e68f34 JB |
108 | if (value) { |
109 | // Check the type | |
110 | if (typeof value === 'boolean') { | |
b1340ec1 | 111 | return value; |
df645d8f JB |
112 | } else if ( |
113 | Utils.isString(value) && | |
114 | ((value as string).toLowerCase() === 'true' || value === '1') | |
115 | ) { | |
116 | result = true; | |
117 | } else if (typeof value === 'number' && value === 1) { | |
118 | result = true; | |
a6e68f34 JB |
119 | } |
120 | } | |
121 | return result; | |
122 | } | |
123 | ||
2f45578b JB |
124 | public static getRandomFloat(max = Number.MAX_VALUE, min = 0): number { |
125 | if (max < min) { | |
126 | throw new RangeError('Invalid interval'); | |
127 | } | |
128 | if (max - min === Infinity) { | |
b322b8b4 JB |
129 | throw new RangeError('Invalid interval'); |
130 | } | |
602d810a | 131 | return (crypto.randomBytes(4).readUInt32LE() / 0xffffffff) * (max - min) + min; |
560bcf5b JB |
132 | } |
133 | ||
59395dc1 | 134 | public static getRandomInteger(max = Constants.MAX_RANDOM_INTEGER, min = 0): number { |
fd00fa2e | 135 | max = Math.floor(max); |
1f86b121 | 136 | if (!Utils.isNullOrUndefined(min) && min !== 0) { |
fd00fa2e | 137 | min = Math.ceil(min); |
59395dc1 | 138 | return Math.floor(crypto.randomInt(min, max + 1)); |
7dde0b73 | 139 | } |
59395dc1 | 140 | return Math.floor(crypto.randomInt(max + 1)); |
560bcf5b JB |
141 | } |
142 | ||
0f16a662 | 143 | public static roundTo(numberValue: number, scale: number): number { |
ad3de6c4 | 144 | const roundPower = Math.pow(10, scale); |
035742f7 | 145 | return Math.round(numberValue * roundPower) / roundPower; |
560bcf5b JB |
146 | } |
147 | ||
0f16a662 | 148 | public static truncTo(numberValue: number, scale: number): number { |
6d3a11a0 | 149 | const truncPower = Math.pow(10, scale); |
035742f7 | 150 | return Math.trunc(numberValue * truncPower) / truncPower; |
6d3a11a0 JB |
151 | } |
152 | ||
b5e5892d | 153 | public static getRandomFloatRounded(max = Number.MAX_VALUE, min = 0, scale = 2): number { |
560bcf5b JB |
154 | if (min) { |
155 | return Utils.roundTo(Utils.getRandomFloat(max, min), scale); | |
156 | } | |
157 | return Utils.roundTo(Utils.getRandomFloat(max), scale); | |
7dde0b73 JB |
158 | } |
159 | ||
e7aeea18 JB |
160 | public static getRandomFloatFluctuatedRounded( |
161 | staticValue: number, | |
162 | fluctuationPercent: number, | |
163 | scale = 2 | |
164 | ): number { | |
9ccca265 JB |
165 | if (fluctuationPercent === 0) { |
166 | return Utils.roundTo(staticValue, scale); | |
167 | } | |
97ef739c | 168 | const fluctuationRatio = fluctuationPercent / 100; |
e7aeea18 JB |
169 | return Utils.getRandomFloatRounded( |
170 | staticValue * (1 + fluctuationRatio), | |
171 | staticValue * (1 - fluctuationRatio), | |
172 | scale | |
173 | ); | |
9ccca265 JB |
174 | } |
175 | ||
91ecff2d | 176 | public static isObject(item: unknown): boolean { |
98fc1389 JB |
177 | return ( |
178 | Utils.isNullOrUndefined(item) === false && | |
179 | typeof item === 'object' && | |
180 | Array.isArray(item) === false | |
181 | ); | |
91ecff2d JB |
182 | } |
183 | ||
088ee3c1 JB |
184 | public static cloneObject<T extends object>(object: T): T { |
185 | return clone<T>(object); | |
2e6f5966 | 186 | } |
facd8ebd | 187 | |
ef4932d8 | 188 | public static hasOwnProp(object: unknown, property: PropertyKey): boolean { |
c5f2c258 | 189 | return Utils.isObject(object) && Object.hasOwn(object as object, property); |
dada83ec JB |
190 | } |
191 | ||
192 | public static isCFEnvironment(): boolean { | |
9bb1159e | 193 | return !Utils.isNullOrUndefined(process.env.VCAP_APPLICATION); |
dada83ec JB |
194 | } |
195 | ||
afb26ef1 | 196 | public static isIterable<T>(obj: T): boolean { |
1895299d | 197 | return !Utils.isNullOrUndefined(obj) ? typeof obj[Symbol.iterator] === 'function' : false; |
67e9cccf JB |
198 | } |
199 | ||
0f16a662 | 200 | public static isString(value: unknown): boolean { |
560bcf5b JB |
201 | return typeof value === 'string'; |
202 | } | |
203 | ||
e8191622 | 204 | public static isEmptyString(value: unknown): boolean { |
5a2a53cf JB |
205 | return ( |
206 | Utils.isNullOrUndefined(value) || | |
207 | (Utils.isString(value) && (value as string).trim().length === 0) | |
208 | ); | |
209 | } | |
210 | ||
211 | public static isNotEmptyString(value: unknown): boolean { | |
212 | return Utils.isString(value) && (value as string).trim().length > 0; | |
e8191622 JB |
213 | } |
214 | ||
0f16a662 | 215 | public static isUndefined(value: unknown): boolean { |
72092cfc | 216 | return value === undefined; |
ead548f2 JB |
217 | } |
218 | ||
0f16a662 | 219 | public static isNullOrUndefined(value: unknown): boolean { |
7558b3a6 | 220 | // eslint-disable-next-line eqeqeq, no-eq-null |
1732e614 | 221 | return value == null; |
facd8ebd | 222 | } |
4a56deef | 223 | |
bd5d98e0 | 224 | public static isEmptyArray(object: unknown): boolean { |
5d0b9ffc | 225 | return Array.isArray(object) && object.length === 0; |
53ac516c JB |
226 | } |
227 | ||
bd5d98e0 | 228 | public static isNotEmptyArray(object: unknown): boolean { |
5d0b9ffc | 229 | return Array.isArray(object) && object.length > 0; |
4a56deef | 230 | } |
7abfea5f | 231 | |
94ec7e96 | 232 | public static isEmptyObject(obj: object): boolean { |
5e5ba121 | 233 | if (obj?.constructor !== Object) { |
d20581ee JB |
234 | return false; |
235 | } | |
87f82a94 JB |
236 | // Iterates over the keys of an object, if |
237 | // any exist, return false. | |
238 | for (const _ in obj) { | |
239 | return false; | |
240 | } | |
241 | return true; | |
7abfea5f | 242 | } |
7ec46a9a | 243 | |
e7aeea18 JB |
244 | public static insertAt = (str: string, subStr: string, pos: number): string => |
245 | `${str.slice(0, pos)}${subStr}${str.slice(pos)}`; | |
032d6efc JB |
246 | |
247 | /** | |
0e4fa348 | 248 | * @param retryNumber - the number of retries that have already been attempted |
81797102 | 249 | * @returns delay in milliseconds |
032d6efc | 250 | */ |
517ffa58 | 251 | public static exponentialDelay(retryNumber = 0, maxDelayRatio = 0.2): number { |
032d6efc | 252 | const delay = Math.pow(2, retryNumber) * 100; |
517ffa58 | 253 | const randomSum = delay * maxDelayRatio * Utils.secureRandom(); // 0-20% of the delay |
032d6efc JB |
254 | return delay + randomSum; |
255 | } | |
32a1eb7a | 256 | |
764d2c91 JB |
257 | public static isPromisePending(promise: Promise<unknown>): boolean { |
258 | return util.inspect(promise).includes('pending'); | |
259 | } | |
260 | ||
6d9abcc2 | 261 | public static async promiseWithTimeout<T>( |
e7aeea18 JB |
262 | promise: Promise<T>, |
263 | timeoutMs: number, | |
264 | timeoutError: Error, | |
265 | timeoutCallback: () => void = () => { | |
266 | /* This is intentional */ | |
267 | } | |
6d9abcc2 JB |
268 | ): Promise<T> { |
269 | // Create a timeout promise that rejects in timeout milliseconds | |
270 | const timeoutPromise = new Promise<never>((_, reject) => { | |
271 | setTimeout(() => { | |
764d2c91 JB |
272 | if (Utils.isPromisePending(promise)) { |
273 | timeoutCallback(); | |
59395dc1 | 274 | // FIXME: The original promise shall be canceled |
764d2c91 | 275 | } |
6d9abcc2 JB |
276 | reject(timeoutError); |
277 | }, timeoutMs); | |
278 | }); | |
279 | ||
280 | // Returns a race between timeout promise and the passed promise | |
281 | return Promise.race<T>([promise, timeoutPromise]); | |
282 | } | |
283 | ||
c37528f1 | 284 | /** |
0f16a662 | 285 | * Generate a cryptographically secure random number in the [0,1[ range |
c37528f1 JB |
286 | * |
287 | * @returns | |
288 | */ | |
0f16a662 | 289 | public static secureRandom(): number { |
c37528f1 JB |
290 | return crypto.randomBytes(4).readUInt32LE() / 0x100000000; |
291 | } | |
fe791818 JB |
292 | |
293 | public static JSONStringifyWithMapSupport( | |
edd13439 | 294 | obj: Record<string, unknown> | Record<string, unknown>[] | Map<unknown, unknown>, |
fe791818 JB |
295 | space?: number |
296 | ): string { | |
297 | return JSON.stringify( | |
298 | obj, | |
299 | (key, value: Record<string, unknown>) => { | |
300 | if (value instanceof Map) { | |
301 | return { | |
302 | dataType: 'Map', | |
303 | value: [...value], | |
304 | }; | |
305 | } | |
306 | return value; | |
307 | }, | |
308 | space | |
309 | ); | |
310 | } | |
5e3cb728 JB |
311 | |
312 | /** | |
313 | * Convert websocket error code to human readable string message | |
314 | * | |
0e4fa348 | 315 | * @param code - websocket error code |
5e3cb728 JB |
316 | * @returns human readable string message |
317 | */ | |
318 | public static getWebSocketCloseEventStatusString(code: number): string { | |
319 | if (code >= 0 && code <= 999) { | |
320 | return '(Unused)'; | |
321 | } else if (code >= 1016) { | |
322 | if (code <= 1999) { | |
323 | return '(For WebSocket standard)'; | |
324 | } else if (code <= 2999) { | |
325 | return '(For WebSocket extensions)'; | |
326 | } else if (code <= 3999) { | |
327 | return '(For libraries and frameworks)'; | |
328 | } else if (code <= 4999) { | |
329 | return '(For applications)'; | |
330 | } | |
331 | } | |
332 | if (!Utils.isUndefined(WebSocketCloseEventStatusString[code])) { | |
333 | return WebSocketCloseEventStatusString[code] as string; | |
334 | } | |
335 | return '(Unknown)'; | |
336 | } | |
7dde0b73 | 337 | } |