tests/utils/Utils.test.ts

   1 import { describe, it } from 'node:test';
   2
   3 import { hoursToMilliseconds, hoursToSeconds } from 'date-fns';
   4 import { expect } from 'expect';
   5
   6 import { Constants } from '../../src/utils/Constants';
   7 import {
   8   cloneObject,
   9   convertToBoolean,
  10   convertToDate,
  11   convertToFloat,
  12   convertToInt,
  13   extractTimeSeriesValues,
  14   formatDurationMilliSeconds,
  15   formatDurationSeconds,
  16   generateUUID,
  17   getRandomFloat,
  18   getRandomInteger,
  19   hasOwnProp,
  20   isArraySorted,
  21   isEmptyArray,
  22   isEmptyObject,
  23   isEmptyString,
  24   isIterable,
  25   isNotEmptyArray,
  26   isNotEmptyString,
  27   isNullOrUndefined,
  28   isObject,
  29   isUndefined,
  30   isValidTime,
  31   max,
  32   min,
  33   once,
  34   roundTo,
  35   secureRandom,
  36   sleep,
  37   validateUUID,
  38 } from '../../src/utils/Utils';
  39
  40 await describe('Utils test suite', async () => {
  41   await it('Verify generateUUID()/validateUUID()', () => {
  42     const uuid = generateUUID();
  43     expect(uuid).toBeDefined();
  44     expect(uuid.length).toEqual(36);
  45     expect(validateUUID(uuid)).toBe(true);
  46     expect(validateUUID('abcdef00-0000-4000-0000-000000000000')).toBe(true);
  47     expect(validateUUID('')).toBe(false);
  48     // Shall invalidate Nil UUID
  49     expect(validateUUID('00000000-0000-0000-0000-000000000000')).toBe(false);
  50     expect(validateUUID('987FBC9-4BED-3078-CF07A-9141BA07C9F3')).toBe(false);
  51   });
  52
  53   await it('Verify sleep()', async () => {
  54     const start = performance.now();
  55     await sleep(1000);
  56     const stop = performance.now();
  57     expect(stop - start).toBeGreaterThanOrEqual(1000);
  58   });
  59
  60   await it('Verify formatDurationMilliSeconds()', () => {
  61     expect(formatDurationMilliSeconds(0)).toBe('0 seconds');
  62     expect(formatDurationMilliSeconds(900)).toBe('0 seconds');
  63     expect(formatDurationMilliSeconds(1000)).toBe('1 second');
  64     expect(formatDurationMilliSeconds(hoursToMilliseconds(4380))).toBe('182 days 12 hours');
  65   });
  66
  67   await it('Verify formatDurationSeconds()', () => {
  68     expect(formatDurationSeconds(0)).toBe('0 seconds');
  69     expect(formatDurationSeconds(0.9)).toBe('0 seconds');
  70     expect(formatDurationSeconds(1)).toBe('1 second');
  71     expect(formatDurationSeconds(hoursToSeconds(4380))).toBe('182 days 12 hours');
  72   });
  73
  74   await it('Verify isValidTime()', () => {
  75     expect(isValidTime(undefined)).toBe(false);
  76     expect(isValidTime(null)).toBe(false);
  77     expect(isValidTime('')).toBe(false);
  78     expect(isValidTime({})).toBe(false);
  79     expect(isValidTime([])).toBe(false);
  80     expect(isValidTime(new Map())).toBe(false);
  81     expect(isValidTime(new Set())).toBe(false);
  82     expect(isValidTime(new WeakMap())).toBe(false);
  83     expect(isValidTime(new WeakSet())).toBe(false);
  84     expect(isValidTime(-1)).toBe(true);
  85     expect(isValidTime(0)).toBe(true);
  86     expect(isValidTime(1)).toBe(true);
  87     expect(isValidTime(-0.5)).toBe(true);
  88     expect(isValidTime(0.5)).toBe(true);
  89     expect(isValidTime(new Date())).toBe(true);
  90   });
  91
  92   await it('Verify convertToDate()', () => {
  93     expect(convertToDate(undefined)).toBe(undefined);
  94     expect(() => convertToDate('')).toThrow(new Error("Cannot convert to date: ''"));
  95     expect(() => convertToDate('00:70:61')).toThrow(
  96       new Error("Cannot convert to date: '00:70:61'"),
  97     );
  98     expect(convertToDate(0)).toStrictEqual(new Date('1970-01-01T00:00:00.000Z'));
  99     expect(convertToDate(-1)).toStrictEqual(new Date('1969-12-31T23:59:59.999Z'));
 100     const dateStr = '2020-01-01T00:00:00.000Z';
 101     let date = convertToDate(dateStr);
 102     expect(date).toBeInstanceOf(Date);
 103     expect(date).toStrictEqual(new Date(dateStr));
 104     date = convertToDate(new Date(dateStr));
 105     expect(date).toBeInstanceOf(Date);
 106     expect(date).toStrictEqual(new Date(dateStr));
 107   });
 108
 109   await it('Verify convertToInt()', () => {
 110     expect(convertToInt(undefined)).toBe(0);
 111     expect(convertToInt(null)).toBe(0);
 112     expect(convertToInt(0)).toBe(0);
 113     const randomInteger = getRandomInteger();
 114     expect(convertToInt(randomInteger)).toEqual(randomInteger);
 115     expect(convertToInt('-1')).toBe(-1);
 116     expect(convertToInt('1')).toBe(1);
 117     expect(convertToInt('1.1')).toBe(1);
 118     expect(convertToInt('1.9')).toBe(1);
 119     expect(convertToInt('1.999')).toBe(1);
 120     expect(convertToInt(-1)).toBe(-1);
 121     expect(convertToInt(1)).toBe(1);
 122     expect(convertToInt(1.1)).toBe(1);
 123     expect(convertToInt(1.9)).toBe(1);
 124     expect(convertToInt(1.999)).toBe(1);
 125     expect(() => {
 126       convertToInt('NaN');
 127     }).toThrow("Cannot convert to integer: 'NaN'");
 128   });
 129
 130   await it('Verify convertToFloat()', () => {
 131     expect(convertToFloat(undefined)).toBe(0);
 132     expect(convertToFloat(null)).toBe(0);
 133     expect(convertToFloat(0)).toBe(0);
 134     const randomFloat = getRandomFloat();
 135     expect(convertToFloat(randomFloat)).toEqual(randomFloat);
 136     expect(convertToFloat('-1')).toBe(-1);
 137     expect(convertToFloat('1')).toBe(1);
 138     expect(convertToFloat('1.1')).toBe(1.1);
 139     expect(convertToFloat('1.9')).toBe(1.9);
 140     expect(convertToFloat('1.999')).toBe(1.999);
 141     expect(convertToFloat(-1)).toBe(-1);
 142     expect(convertToFloat(1)).toBe(1);
 143     expect(convertToFloat(1.1)).toBe(1.1);
 144     expect(convertToFloat(1.9)).toBe(1.9);
 145     expect(convertToFloat(1.999)).toBe(1.999);
 146     expect(() => {
 147       convertToFloat('NaN');
 148     }).toThrow("Cannot convert to float: 'NaN'");
 149   });
 150
 151   await it('Verify convertToBoolean()', () => {
 152     expect(convertToBoolean(undefined)).toBe(false);
 153     expect(convertToBoolean(null)).toBe(false);
 154     expect(convertToBoolean('true')).toBe(true);
 155     expect(convertToBoolean('false')).toBe(false);
 156     expect(convertToBoolean('TRUE')).toBe(true);
 157     expect(convertToBoolean('FALSE')).toBe(false);
 158     expect(convertToBoolean('1')).toBe(true);
 159     expect(convertToBoolean('0')).toBe(false);
 160     expect(convertToBoolean(1)).toBe(true);
 161     expect(convertToBoolean(0)).toBe(false);
 162     expect(convertToBoolean(true)).toBe(true);
 163     expect(convertToBoolean(false)).toBe(false);
 164     expect(convertToBoolean('')).toBe(false);
 165     expect(convertToBoolean('NoNBoolean')).toBe(false);
 166   });
 167
 168   await it('Verify secureRandom()', () => {
 169     const random = secureRandom();
 170     expect(typeof random === 'number').toBe(true);
 171     expect(random).toBeGreaterThanOrEqual(0);
 172     expect(random).toBeLessThan(1);
 173   });
 174
 175   await it('Verify getRandomInteger()', () => {
 176     let randomInteger = getRandomInteger();
 177     expect(Number.isSafeInteger(randomInteger)).toBe(true);
 178     expect(randomInteger).toBeGreaterThanOrEqual(0);
 179     expect(randomInteger).toBeLessThanOrEqual(Constants.MAX_RANDOM_INTEGER);
 180     expect(randomInteger).not.toEqual(getRandomInteger());
 181     randomInteger = getRandomInteger(0, -Constants.MAX_RANDOM_INTEGER);
 182     expect(randomInteger).toBeGreaterThanOrEqual(-Constants.MAX_RANDOM_INTEGER);
 183     expect(randomInteger).toBeLessThanOrEqual(0);
 184     expect(() => getRandomInteger(0, 1)).toThrow(
 185       'The value of "max" is out of range. It must be greater than the value of "min" (1). Received 1',
 186     );
 187     expect(() => getRandomInteger(-1)).toThrow(
 188       'The value of "max" is out of range. It must be greater than the value of "min" (0). Received 0',
 189     );
 190     expect(() => getRandomInteger(Constants.MAX_RANDOM_INTEGER + 1)).toThrow(
 191       `The value of "max" is out of range. It must be <= ${
 192         Constants.MAX_RANDOM_INTEGER + 1
 193       }. Received 281_474_976_710_656`,
 194     );
 195     randomInteger = getRandomInteger(2, 1);
 196     expect(randomInteger).toBeGreaterThanOrEqual(1);
 197     expect(randomInteger).toBeLessThanOrEqual(2);
 198     const maximum = 2.2,
 199       minimum = 1.1;
 200     randomInteger = getRandomInteger(maximum, minimum);
 201     expect(randomInteger).toBeLessThanOrEqual(Math.floor(maximum));
 202     expect(randomInteger).toBeGreaterThanOrEqual(Math.ceil(minimum));
 203   });
 204
 205   await it('Verify roundTo()', () => {
 206     expect(roundTo(0, 2)).toBe(0);
 207     expect(roundTo(0.5, 0)).toBe(1);
 208     expect(roundTo(0.5, 2)).toBe(0.5);
 209     expect(roundTo(-0.5, 0)).toBe(-1);
 210     expect(roundTo(-0.5, 2)).toBe(-0.5);
 211     expect(roundTo(1.005, 0)).toBe(1);
 212     expect(roundTo(1.005, 2)).toBe(1.01);
 213     expect(roundTo(2.175, 2)).toBe(2.18);
 214     expect(roundTo(5.015, 2)).toBe(5.02);
 215     expect(roundTo(-1.005, 2)).toBe(-1.01);
 216     expect(roundTo(-2.175, 2)).toBe(-2.18);
 217     expect(roundTo(-5.015, 2)).toBe(-5.02);
 218   });
 219
 220   await it('Verify getRandomFloat()', () => {
 221     let randomFloat = getRandomFloat();
 222     expect(typeof randomFloat === 'number').toBe(true);
 223     expect(randomFloat).toBeGreaterThanOrEqual(0);
 224     expect(randomFloat).toBeLessThanOrEqual(Number.MAX_VALUE);
 225     expect(randomFloat).not.toEqual(getRandomFloat());
 226     expect(() => getRandomFloat(0, 1)).toThrow(new RangeError('Invalid interval'));
 227     expect(() => getRandomFloat(Number.MAX_VALUE, -Number.MAX_VALUE)).toThrow(
 228       new RangeError('Invalid interval'),
 229     );
 230     randomFloat = getRandomFloat(0, -Number.MAX_VALUE);
 231     expect(randomFloat).toBeGreaterThanOrEqual(-Number.MAX_VALUE);
 232     expect(randomFloat).toBeLessThanOrEqual(0);
 233   });
 234
 235   await it('Verify extractTimeSeriesValues()', () => {
 236     expect(extractTimeSeriesValues([])).toEqual([]);
 237     expect(extractTimeSeriesValues([{ timestamp: Date.now(), value: 1.1 }])).toEqual([1.1]);
 238     expect(
 239       extractTimeSeriesValues([
 240         { timestamp: Date.now(), value: 1.1 },
 241         { timestamp: Date.now(), value: 2.2 },
 242       ]),
 243     ).toEqual([1.1, 2.2]);
 244   });
 245
 246   await it('Verify isObject()', () => {
 247     expect(isObject('test')).toBe(false);
 248     expect(isObject(undefined)).toBe(false);
 249     expect(isObject(null)).toBe(false);
 250     expect(isObject(0)).toBe(false);
 251     expect(isObject([])).toBe(false);
 252     expect(isObject([0, 1])).toBe(false);
 253     expect(isObject(['0', '1'])).toBe(false);
 254     expect(isObject({})).toBe(true);
 255     expect(isObject({ 1: 1 })).toBe(true);
 256     expect(isObject({ '1': '1' })).toBe(true);
 257     expect(isObject(new Map())).toBe(true);
 258     expect(isObject(new Set())).toBe(true);
 259     expect(isObject(new WeakMap())).toBe(true);
 260     expect(isObject(new WeakSet())).toBe(true);
 261   });
 262
 263   await it('Verify cloneObject()', () => {
 264     const obj = { 1: 1 };
 265     expect(cloneObject(obj)).toStrictEqual(obj);
 266     expect(cloneObject(obj) === obj).toBe(false);
 267     const nestedObj = { 1: obj, 2: obj };
 268     expect(cloneObject(nestedObj)).toStrictEqual(nestedObj);
 269     expect(cloneObject(nestedObj) === nestedObj).toBe(false);
 270     const array = [1, 2];
 271     expect(cloneObject(array)).toStrictEqual(array);
 272     expect(cloneObject(array) === array).toBe(false);
 273     const objArray = [obj, obj];
 274     expect(cloneObject(objArray)).toStrictEqual(objArray);
 275     expect(cloneObject(objArray) === objArray).toBe(false);
 276     const date = new Date();
 277     expect(cloneObject(date)).toStrictEqual(date);
 278     expect(cloneObject(date) === date).toBe(false);
 279     const map = new Map([['1', '2']]);
 280     expect(cloneObject(map)).toStrictEqual({});
 281     const set = new Set(['1']);
 282     expect(cloneObject(set)).toStrictEqual({});
 283     // The URL object seems to have not enumerable properties
 284     const url = new URL('https://domain.tld');
 285     expect(cloneObject(url)).toStrictEqual({});
 286     const weakMap = new WeakMap([[{ 1: 1 }, { 2: 2 }]]);
 287     expect(cloneObject(weakMap)).toStrictEqual({});
 288     const weakSet = new WeakSet([{ 1: 1 }, { 2: 2 }]);
 289     expect(cloneObject(weakSet)).toStrictEqual({});
 290   });
 291
 292   await it('Verify hasOwnProp()', () => {
 293     expect(hasOwnProp('test', '')).toBe(false);
 294     expect(hasOwnProp(undefined, '')).toBe(false);
 295     expect(hasOwnProp(null, '')).toBe(false);
 296     expect(hasOwnProp([], '')).toBe(false);
 297     expect(hasOwnProp({}, '')).toBe(false);
 298     expect(hasOwnProp({ 1: 1 }, 1)).toBe(true);
 299     expect(hasOwnProp({ 1: 1 }, '1')).toBe(true);
 300     expect(hasOwnProp({ 1: 1 }, 2)).toBe(false);
 301     expect(hasOwnProp({ 1: 1 }, '2')).toBe(false);
 302     expect(hasOwnProp({ '1': '1' }, '1')).toBe(true);
 303     expect(hasOwnProp({ '1': '1' }, 1)).toBe(true);
 304     expect(hasOwnProp({ '1': '1' }, '2')).toBe(false);
 305     expect(hasOwnProp({ '1': '1' }, 2)).toBe(false);
 306   });
 307
 308   await it('Verify isIterable()', () => {
 309     expect(isIterable('')).toBe(true);
 310     expect(isIterable(' ')).toBe(true);
 311     expect(isIterable('test')).toBe(true);
 312     expect(isIterable(undefined)).toBe(false);
 313     expect(isIterable(null)).toBe(false);
 314     expect(isIterable(0)).toBe(false);
 315     expect(isIterable([0, 1])).toBe(true);
 316     expect(isIterable({ 1: 1 })).toBe(false);
 317     expect(isIterable(new Map())).toBe(true);
 318     expect(isIterable(new Set())).toBe(true);
 319     expect(isIterable(new WeakMap())).toBe(false);
 320     expect(isIterable(new WeakSet())).toBe(false);
 321   });
 322
 323   await it('Verify isEmptyString()', () => {
 324     expect(isEmptyString('')).toBe(true);
 325     expect(isEmptyString(' ')).toBe(true);
 326     expect(isEmptyString('     ')).toBe(true);
 327     expect(isEmptyString('test')).toBe(false);
 328     expect(isEmptyString(' test')).toBe(false);
 329     expect(isEmptyString('test ')).toBe(false);
 330     expect(isEmptyString(undefined)).toBe(true);
 331     expect(isEmptyString(null)).toBe(true);
 332     expect(isEmptyString(0)).toBe(false);
 333     expect(isEmptyString({})).toBe(false);
 334     expect(isEmptyString([])).toBe(false);
 335     expect(isEmptyString(new Map())).toBe(false);
 336     expect(isEmptyString(new Set())).toBe(false);
 337     expect(isEmptyString(new WeakMap())).toBe(false);
 338     expect(isEmptyString(new WeakSet())).toBe(false);
 339   });
 340
 341   await it('Verify isNotEmptyString()', () => {
 342     expect(isNotEmptyString('')).toBe(false);
 343     expect(isNotEmptyString(' ')).toBe(false);
 344     expect(isNotEmptyString('     ')).toBe(false);
 345     expect(isNotEmptyString('test')).toBe(true);
 346     expect(isNotEmptyString(' test')).toBe(true);
 347     expect(isNotEmptyString('test ')).toBe(true);
 348     expect(isNotEmptyString(undefined)).toBe(false);
 349     expect(isNotEmptyString(null)).toBe(false);
 350     expect(isNotEmptyString(0)).toBe(false);
 351     expect(isNotEmptyString({})).toBe(false);
 352     expect(isNotEmptyString([])).toBe(false);
 353     expect(isNotEmptyString(new Map())).toBe(false);
 354     expect(isNotEmptyString(new Set())).toBe(false);
 355     expect(isNotEmptyString(new WeakMap())).toBe(false);
 356     expect(isNotEmptyString(new WeakSet())).toBe(false);
 357   });
 358
 359   await it('Verify isUndefined()', () => {
 360     expect(isUndefined(undefined)).toBe(true);
 361     expect(isUndefined(null)).toBe(false);
 362     expect(isUndefined('')).toBe(false);
 363     expect(isUndefined(0)).toBe(false);
 364     expect(isUndefined({})).toBe(false);
 365     expect(isUndefined([])).toBe(false);
 366     expect(isUndefined(new Map())).toBe(false);
 367     expect(isUndefined(new Set())).toBe(false);
 368     expect(isUndefined(new WeakMap())).toBe(false);
 369     expect(isUndefined(new WeakSet())).toBe(false);
 370   });
 371
 372   await it('Verify isNullOrUndefined()', () => {
 373     expect(isNullOrUndefined(undefined)).toBe(true);
 374     expect(isNullOrUndefined(null)).toBe(true);
 375     expect(isNullOrUndefined('')).toBe(false);
 376     expect(isNullOrUndefined(0)).toBe(false);
 377     expect(isNullOrUndefined({})).toBe(false);
 378     expect(isNullOrUndefined([])).toBe(false);
 379     expect(isNullOrUndefined(new Map())).toBe(false);
 380     expect(isNullOrUndefined(new Set())).toBe(false);
 381     expect(isNullOrUndefined(new WeakMap())).toBe(false);
 382     expect(isNullOrUndefined(new WeakSet())).toBe(false);
 383   });
 384
 385   await it('Verify isEmptyArray()', () => {
 386     expect(isEmptyArray([])).toBe(true);
 387     expect(isEmptyArray([1, 2])).toBe(false);
 388     expect(isEmptyArray(['1', '2'])).toBe(false);
 389     expect(isEmptyArray(undefined)).toBe(false);
 390     expect(isEmptyArray(null)).toBe(false);
 391     expect(isEmptyArray('')).toBe(false);
 392     expect(isEmptyArray('test')).toBe(false);
 393     expect(isEmptyArray(0)).toBe(false);
 394     expect(isEmptyArray({})).toBe(false);
 395     expect(isEmptyArray(new Map())).toBe(false);
 396     expect(isEmptyArray(new Set())).toBe(false);
 397     expect(isEmptyArray(new WeakMap())).toBe(false);
 398     expect(isEmptyArray(new WeakSet())).toBe(false);
 399   });
 400
 401   await it('Verify isNotEmptyArray()', () => {
 402     expect(isNotEmptyArray([])).toBe(false);
 403     expect(isNotEmptyArray([1, 2])).toBe(true);
 404     expect(isNotEmptyArray(['1', '2'])).toBe(true);
 405     expect(isNotEmptyArray(undefined)).toBe(false);
 406     expect(isNotEmptyArray(null)).toBe(false);
 407     expect(isNotEmptyArray('')).toBe(false);
 408     expect(isNotEmptyArray('test')).toBe(false);
 409     expect(isNotEmptyArray(0)).toBe(false);
 410     expect(isNotEmptyArray({})).toBe(false);
 411     expect(isNotEmptyArray(new Map())).toBe(false);
 412     expect(isNotEmptyArray(new Set())).toBe(false);
 413     expect(isNotEmptyArray(new WeakMap())).toBe(false);
 414     expect(isNotEmptyArray(new WeakSet())).toBe(false);
 415   });
 416
 417   await it('Verify isEmptyObject()', () => {
 418     expect(isEmptyObject({})).toBe(true);
 419     expect(isEmptyObject({ 1: 1, 2: 2 })).toBe(false);
 420     expect(isEmptyObject(new Map())).toBe(false);
 421     expect(isEmptyObject(new Set())).toBe(false);
 422     expect(isEmptyObject(new WeakMap())).toBe(false);
 423     expect(isEmptyObject(new WeakSet())).toBe(false);
 424   });
 425
 426   await it('Verify isArraySorted()', () => {
 427     expect(
 428       isArraySorted([], (a, b) => {
 429         return a - b;
 430       }),
 431     ).toBe(true);
 432     expect(
 433       isArraySorted([1], (a, b) => {
 434         return a - b;
 435       }),
 436     ).toBe(true);
 437     expect(isArraySorted<number>([1, 2, 3, 4, 5], (a, b) => a - b)).toBe(true);
 438     expect(isArraySorted<number>([1, 2, 3, 5, 4], (a, b) => a - b)).toBe(false);
 439     expect(isArraySorted<number>([2, 1, 3, 4, 5], (a, b) => a - b)).toBe(false);
 440   });
 441
 442   await it('Verify once()', () => {
 443     let called = 0;
 444     const fn = () => ++called;
 445     const onceFn = once(fn, this);
 446     const result1 = onceFn();
 447     expect(called).toBe(1);
 448     expect(result1).toBe(1);
 449     const result2 = onceFn();
 450     expect(called).toBe(1);
 451     expect(result2).toBe(1);
 452     const result3 = onceFn();
 453     expect(called).toBe(1);
 454     expect(result3).toBe(1);
 455   });
 456
 457   await it('Verify min()', () => {
 458     expect(min()).toBe(Infinity);
 459     expect(min(0, 1)).toBe(0);
 460     expect(min(1, 0)).toBe(0);
 461     expect(min(0, -1)).toBe(-1);
 462     expect(min(-1, 0)).toBe(-1);
 463   });
 464
 465   await it('Verify max()', () => {
 466     expect(max()).toBe(-Infinity);
 467     expect(max(0, 1)).toBe(1);
 468     expect(max(1, 0)).toBe(1);
 469     expect(max(0, -1)).toBe(0);
 470     expect(max(-1, 0)).toBe(0);
 471   });
 472 });