-import Configuration from './Configuration';
-import { WebSocketCloseEventStatusString } from '../types/WebSocket';
-import { WorkerProcessType } from '../types/Worker';
+import crypto from 'crypto';
import { v4 as uuid } from 'uuid';
export default class Utils {
- static logPrefix(prefixString = ''): string {
+ public static logPrefix(prefixString = ''): string {
return new Date().toLocaleString() + prefixString;
}
- static generateUUID(): string {
+ public static generateUUID(): string {
return uuid();
}
- static async sleep(milliSeconds: number): Promise<NodeJS.Timeout> {
- return new Promise((resolve) => setTimeout(resolve, milliSeconds));
+ public static async sleep(milliSeconds: number): Promise<NodeJS.Timeout> {
+ return new Promise((resolve) => setTimeout(resolve as () => void, milliSeconds));
}
- static secondsToHHMMSS(seconds: number): string {
- return Utils.milliSecondsToHHMMSS(seconds * 1000);
- }
+ public static formatDurationMilliSeconds(duration: number): string {
+ duration = Utils.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();
- static milliSecondsToHHMMSS(milliSeconds: number): string {
- return new Date(milliSeconds).toISOString().substr(11, 8);
+ 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);
}
- 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);
- }
- }
+ public static formatDurationSeconds(duration: number): string {
+ return Utils.formatDurationMilliSeconds(duration * 1000);
}
- static convertToDate(value: any): Date {
+ public static convertToDate(value: unknown): Date {
// Check
if (!value) {
- return value;
+ return value as Date;
}
// Check Type
if (!(value instanceof Date)) {
- return new Date(value);
+ return new Date(value as string);
}
return value;
}
- static convertToInt(value: any): number {
- let changedValue = value;
+ public static convertToInt(value: unknown): number {
+ let changedValue: number = value as number;
if (!value) {
return 0;
}
if (Number.isSafeInteger(value)) {
- return value;
+ return value as number;
}
// Check
- if (typeof value === 'string') {
+ if (Utils.isString(value)) {
// Create Object
- changedValue = parseInt(value);
+ changedValue = parseInt(value as string);
}
return changedValue;
}
- static convertToFloat(value: any): number {
- let changedValue = value;
+ public static convertToFloat(value: unknown): number {
+ let changedValue: number = value as number;
if (!value) {
return 0;
}
// Check
- if (typeof value === 'string') {
+ if (Utils.isString(value)) {
// Create Object
- changedValue = parseFloat(value);
+ changedValue = parseFloat(value as string);
}
return changedValue;
}
- static convertToBoolean(value: any): boolean {
+ public static convertToBoolean(value: unknown): boolean {
let result = false;
// Check boolean
if (value) {
result = value;
} else {
// Convert
- result = (value === 'true');
+ result = value === 'true';
}
}
return result;
}
- static getRandomFloat(max: number, min = 0): number {
- return Math.random() < 0.5 ? (1 - Math.random()) * (max - min) + min : Math.random() * (max - min) + min;
+ public static getRandomFloat(max: number, min = 0, negative = false): number {
+ if (max < min || min < 0 || max < 0) {
+ throw new RangeError('Invalid interval');
+ }
+ const randomPositiveFloat = crypto.randomBytes(4).readUInt32LE() / 0xffffffff;
+ const sign = negative && randomPositiveFloat < 0.5 ? -1 : 1;
+ return sign * (randomPositiveFloat * (max - min) + min);
}
- static getRandomInt(max: number, min = 0): number {
+ public static getRandomInteger(max: number, min = 0): number {
+ if (max < 0) {
+ throw new RangeError('Invalid interval');
+ }
+ max = Math.floor(max);
if (min) {
- return Math.floor(Math.random() * (max - min + 1) + min);
+ if (max < min || min < 0) {
+ throw new RangeError('Invalid interval');
+ }
+ min = Math.ceil(min);
+ return Math.floor(Utils.secureRandom() * (max - min + 1)) + min;
}
- return Math.floor(Math.random() * max + 1);
+ return Math.floor(Utils.secureRandom() * (max + 1));
}
- static roundTo(numberValue: number, scale: number): number {
+ public static roundTo(numberValue: number, scale: number): number {
const roundPower = Math.pow(10, scale);
return Math.round(numberValue * roundPower) / roundPower;
}
- static truncTo(numberValue: number, scale: number): number {
+ public static truncTo(numberValue: number, scale: number): number {
const truncPower = Math.pow(10, scale);
return Math.trunc(numberValue * truncPower) / truncPower;
}
- static getRandomFloatRounded(max: number, min = 0, scale = 2): number {
+ public static getRandomFloatRounded(max: number, min = 0, scale = 2): number {
if (min) {
return Utils.roundTo(Utils.getRandomFloat(max, min), scale);
}
return Utils.roundTo(Utils.getRandomFloat(max), scale);
}
- static getRandomFloatFluctuatedRounded(staticValue: number, fluctuationPercent: number, scale = 2): number {
+ public static getRandomFloatFluctuatedRounded(
+ staticValue: number,
+ fluctuationPercent: number,
+ scale = 2
+ ): number {
if (fluctuationPercent === 0) {
return Utils.roundTo(staticValue, scale);
}
- return Utils.getRandomFloatRounded(staticValue + staticValue * (fluctuationPercent / 100), staticValue - staticValue * (fluctuationPercent / 100), scale);
+ const fluctuationRatio = fluctuationPercent / 100;
+ return Utils.getRandomFloatRounded(
+ staticValue * (1 + fluctuationRatio),
+ staticValue * (1 - fluctuationRatio),
+ scale
+ );
}
- static cloneObject<T>(object: T): T {
+ public static cloneObject<T>(object: T): T {
return JSON.parse(JSON.stringify(object)) as T;
}
- static isIterable<T>(obj: T): boolean {
- if (obj) {
- return typeof obj[Symbol.iterator] === 'function';
- }
- return false;
+ public static isIterable<T>(obj: T): boolean {
+ return obj ? typeof obj[Symbol.iterator] === 'function' : false;
}
- static isEmptyJSon(document: any): boolean {
- // Empty?
- if (!document) {
- return true;
- }
- // Check type
- if (typeof document !== 'object') {
- return true;
- }
- // Check
- return Object.keys(document).length === 0;
+ public static isString(value: unknown): boolean {
+ return typeof value === 'string';
}
- static isString(value: any): boolean {
- return typeof value === 'string';
+ public static isEmptyString(value: unknown): boolean {
+ return Utils.isString(value) && (value as string).length === 0;
}
- static isUndefined(value: any): boolean {
+ public static isUndefined(value: unknown): boolean {
return typeof value === 'undefined';
}
- static isNullOrUndefined(value: any): boolean {
- // eslint-disable-next-line no-eq-null, eqeqeq
- if (value == null) {
- return true;
- }
- return false;
+ public static isNullOrUndefined(value: unknown): boolean {
+ // eslint-disable-next-line eqeqeq, no-eq-null
+ return value == null ? true : false;
}
- static isEmptyArray(object: any): boolean {
+ public static isEmptyArray(object: unknown): boolean {
if (!object) {
return true;
}
return true;
}
- static isEmptyObject(obj: any): boolean {
+ public static isEmptyObject(obj: object): boolean {
return !Object.keys(obj).length;
}
- static insertAt = (str: string, subStr: string, pos: number): string => `${str.slice(0, pos)}${subStr}${str.slice(pos)}`;
+ public 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
+ * @param [retryNumber=0]
+ * @returns delay in milliseconds
*/
- static exponentialDelay(retryNumber = 0): number {
+ public static exponentialDelay(retryNumber = 0): number {
const delay = Math.pow(2, retryNumber) * 100;
- const randomSum = delay * 0.2 * Math.random(); // 0-20% of the delay
+ const randomSum = delay * 0.2 * Utils.secureRandom(); // 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)';
- }
+ public static async promiseWithTimeout<T>(
+ promise: Promise<T>,
+ timeoutMs: number,
+ timeoutError: Error,
+ timeoutCallback: () => void = () => {
+ /* This is intentional */
}
- if (!Utils.isUndefined(WebSocketCloseEventStatusString[code])) {
- return WebSocketCloseEventStatusString[code] as string;
- }
- return '(Unknown)';
- }
+ ): Promise<T> {
+ // Create a timeout promise that rejects in timeout milliseconds
+ const timeoutPromise = new Promise<never>((_, reject) => {
+ setTimeout(() => {
+ timeoutCallback();
+ reject(timeoutError);
+ }, timeoutMs);
+ });
- static workerPoolInUse(): boolean {
- return [WorkerProcessType.DYNAMIC_POOL, WorkerProcessType.STATIC_POOL].includes(Configuration.getWorkerProcess());
+ // Returns a race between timeout promise and the passed promise
+ return Promise.race<T>([promise, timeoutPromise]);
}
- static workerDynamicPoolInUse(): boolean {
- return Configuration.getWorkerProcess() === WorkerProcessType.DYNAMIC_POOL;
+ /**
+ * Generate a cryptographically secure random number in the [0,1[ range
+ *
+ * @returns
+ */
+ public static secureRandom(): number {
+ return crypto.randomBytes(4).readUInt32LE() / 0x100000000;
}
}