build(deps-dev): apply updates
[e-mobility-charging-stations-simulator.git] / tests / utils / Utils.test.ts
index efd0470db275e4ac25deede04fe75d2b70983a69..11b9973eacc8db0160f79f924d54d98204b2f554 100644 (file)
@@ -1,11 +1,16 @@
+import { randomInt } from 'node:crypto'
+import { version } from 'node:process'
 import { describe, it } from 'node:test'
 
 import { hoursToMilliseconds, hoursToSeconds } from 'date-fns'
 import { expect } from 'expect'
+import { CircularBuffer } from 'mnemonist'
+import { satisfies } from 'semver'
 
+import type { TimestampedData } from '../../src/types/index.js'
 import { Constants } from '../../src/utils/Constants.js'
 import {
-  cloneObject,
+  clone,
   convertToBoolean,
   convertToDate,
   convertToFloat,
@@ -15,19 +20,14 @@ import {
   formatDurationSeconds,
   generateUUID,
   getRandomFloat,
-  getRandomInteger,
   hasOwnProp,
+  insertAt,
   isArraySorted,
-  isEmptyArray,
-  isEmptyObject,
-  isEmptyString,
+  isAsyncFunction,
   isNotEmptyArray,
   isNotEmptyString,
   isObject,
   isValidDate,
-  max,
-  min,
-  once,
   roundTo,
   secureRandom,
   sleep,
@@ -68,7 +68,7 @@ await describe('Utils test suite', async () => {
     expect(formatDurationSeconds(hoursToSeconds(4380))).toBe('182 days 12 hours')
   })
 
-  await it('Verify isValidTime()', () => {
+  await it('Verify isValidDate()', () => {
     expect(isValidDate(undefined)).toBe(false)
     expect(isValidDate(-1)).toBe(true)
     expect(isValidDate(0)).toBe(true)
@@ -80,7 +80,7 @@ await describe('Utils test suite', async () => {
 
   await it('Verify convertToDate()', () => {
     expect(convertToDate(undefined)).toBe(undefined)
-    expect(convertToDate(null)).toBe(null)
+    expect(convertToDate(null)).toBe(undefined)
     expect(() => convertToDate('')).toThrow(new Error("Cannot convert to date: ''"))
     expect(() => convertToDate('00:70:61')).toThrow(new Error("Cannot convert to date: '00:70:61'"))
     expect(convertToDate(0)).toStrictEqual(new Date('1970-01-01T00:00:00.000Z'))
@@ -98,7 +98,7 @@ await describe('Utils test suite', async () => {
     expect(convertToInt(undefined)).toBe(0)
     expect(convertToInt(null)).toBe(0)
     expect(convertToInt(0)).toBe(0)
-    const randomInteger = getRandomInteger()
+    const randomInteger = randomInt(Constants.MAX_RANDOM_INTEGER)
     expect(convertToInt(randomInteger)).toEqual(randomInteger)
     expect(convertToInt('-1')).toBe(-1)
     expect(convertToInt('1')).toBe(1)
@@ -160,36 +160,6 @@ await describe('Utils test suite', async () => {
     expect(random).toBeLessThan(1)
   })
 
-  await it('Verify getRandomInteger()', () => {
-    let randomInteger = getRandomInteger()
-    expect(Number.isSafeInteger(randomInteger)).toBe(true)
-    expect(randomInteger).toBeGreaterThanOrEqual(0)
-    expect(randomInteger).toBeLessThanOrEqual(Constants.MAX_RANDOM_INTEGER)
-    expect(randomInteger).not.toEqual(getRandomInteger())
-    randomInteger = getRandomInteger(0, -Constants.MAX_RANDOM_INTEGER)
-    expect(randomInteger).toBeGreaterThanOrEqual(-Constants.MAX_RANDOM_INTEGER)
-    expect(randomInteger).toBeLessThanOrEqual(0)
-    expect(() => getRandomInteger(0, 1)).toThrow(
-      'The value of "max" is out of range. It must be greater than the value of "min" (1). Received 1'
-    )
-    expect(() => getRandomInteger(-1)).toThrow(
-      'The value of "max" is out of range. It must be greater than the value of "min" (0). Received 0'
-    )
-    expect(() => getRandomInteger(Constants.MAX_RANDOM_INTEGER + 1)).toThrow(
-      `The value of "max" is out of range. It must be <= ${
-        Constants.MAX_RANDOM_INTEGER + 1
-      }. Received 281_474_976_710_656`
-    )
-    randomInteger = getRandomInteger(2, 1)
-    expect(randomInteger).toBeGreaterThanOrEqual(1)
-    expect(randomInteger).toBeLessThanOrEqual(2)
-    const maximum = 2.2
-    const minimum = 1.1
-    randomInteger = getRandomInteger(maximum, minimum)
-    expect(randomInteger).toBeLessThanOrEqual(Math.floor(maximum))
-    expect(randomInteger).toBeGreaterThanOrEqual(Math.ceil(minimum))
-  })
-
   await it('Verify roundTo()', () => {
     expect(roundTo(0, 2)).toBe(0)
     expect(roundTo(0.5, 0)).toBe(1)
@@ -221,14 +191,19 @@ await describe('Utils test suite', async () => {
   })
 
   await it('Verify extractTimeSeriesValues()', () => {
-    expect(extractTimeSeriesValues([])).toEqual([])
-    expect(extractTimeSeriesValues([{ timestamp: Date.now(), value: 1.1 }])).toEqual([1.1])
     expect(
-      extractTimeSeriesValues([
-        { timestamp: Date.now(), value: 1.1 },
-        { timestamp: Date.now(), value: 2.2 }
-      ])
-    ).toEqual([1.1, 2.2])
+      extractTimeSeriesValues(
+        new CircularBuffer<TimestampedData>(Array, Constants.DEFAULT_CIRCULAR_BUFFER_CAPACITY)
+      )
+    ).toEqual([])
+    const circularBuffer = new CircularBuffer<TimestampedData>(
+      Array,
+      Constants.DEFAULT_CIRCULAR_BUFFER_CAPACITY
+    )
+    circularBuffer.push({ timestamp: Date.now(), value: 1.1 })
+    circularBuffer.push({ timestamp: Date.now(), value: 2.2 })
+    circularBuffer.push({ timestamp: Date.now(), value: 3.3 })
+    expect(extractTimeSeriesValues(circularBuffer)).toEqual([1.1, 2.2, 3.3])
   })
 
   await it('Verify isObject()', () => {
@@ -248,33 +223,112 @@ await describe('Utils test suite', async () => {
     expect(isObject(new WeakSet())).toBe(true)
   })
 
-  await it('Verify cloneObject()', () => {
+  await it('Verify isAsyncFunction()', () => {
+    expect(isAsyncFunction(null)).toBe(false)
+    expect(isAsyncFunction(undefined)).toBe(false)
+    expect(isAsyncFunction(true)).toBe(false)
+    expect(isAsyncFunction(false)).toBe(false)
+    expect(isAsyncFunction(0)).toBe(false)
+    expect(isAsyncFunction('')).toBe(false)
+    expect(isAsyncFunction([])).toBe(false)
+    expect(isAsyncFunction(new Date())).toBe(false)
+    // eslint-disable-next-line prefer-regex-literals
+    expect(isAsyncFunction(/[a-z]/i)).toBe(false)
+    expect(isAsyncFunction(new Error())).toBe(false)
+    expect(isAsyncFunction(new Map())).toBe(false)
+    expect(isAsyncFunction(new Set())).toBe(false)
+    expect(isAsyncFunction(new WeakMap())).toBe(false)
+    expect(isAsyncFunction(new WeakSet())).toBe(false)
+    expect(isAsyncFunction(new Int8Array())).toBe(false)
+    expect(isAsyncFunction(new Uint8Array())).toBe(false)
+    expect(isAsyncFunction(new Uint8ClampedArray())).toBe(false)
+    expect(isAsyncFunction(new Int16Array())).toBe(false)
+    expect(isAsyncFunction(new Uint16Array())).toBe(false)
+    expect(isAsyncFunction(new Int32Array())).toBe(false)
+    expect(isAsyncFunction(new Uint32Array())).toBe(false)
+    expect(isAsyncFunction(new Float32Array())).toBe(false)
+    expect(isAsyncFunction(new Float64Array())).toBe(false)
+    expect(isAsyncFunction(new BigInt64Array())).toBe(false)
+    expect(isAsyncFunction(new BigUint64Array())).toBe(false)
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    expect(isAsyncFunction(new Promise(() => {}))).toBe(false)
+    expect(isAsyncFunction(new WeakRef({}))).toBe(false)
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    expect(isAsyncFunction(new FinalizationRegistry(() => {}))).toBe(false)
+    expect(isAsyncFunction(new ArrayBuffer(16))).toBe(false)
+    expect(isAsyncFunction(new SharedArrayBuffer(16))).toBe(false)
+    expect(isAsyncFunction(new DataView(new ArrayBuffer(16)))).toBe(false)
+    expect(isAsyncFunction({})).toBe(false)
+    expect(isAsyncFunction({ a: 1 })).toBe(false)
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    expect(isAsyncFunction(() => {})).toBe(false)
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    expect(isAsyncFunction(function () {})).toBe(false)
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    expect(isAsyncFunction(function named () {})).toBe(false)
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    expect(isAsyncFunction(async () => {})).toBe(true)
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    expect(isAsyncFunction(async function () {})).toBe(true)
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    expect(isAsyncFunction(async function named () {})).toBe(true)
+    class TestClass {
+      // eslint-disable-next-line @typescript-eslint/no-empty-function
+      public testSync (): void {}
+      // eslint-disable-next-line @typescript-eslint/no-empty-function
+      public async testAsync (): Promise<void> {}
+      // eslint-disable-next-line @typescript-eslint/no-empty-function
+      public testArrowSync = (): void => {}
+      // eslint-disable-next-line @typescript-eslint/no-empty-function
+      public testArrowAsync = async (): Promise<void> => {}
+      // eslint-disable-next-line @typescript-eslint/no-empty-function
+      public static testStaticSync (): void {}
+      // eslint-disable-next-line @typescript-eslint/no-empty-function
+      public static async testStaticAsync (): Promise<void> {}
+    }
+    const testClass = new TestClass()
+    // eslint-disable-next-line @typescript-eslint/unbound-method
+    expect(isAsyncFunction(testClass.testSync)).toBe(false)
+    // eslint-disable-next-line @typescript-eslint/unbound-method
+    expect(isAsyncFunction(testClass.testAsync)).toBe(true)
+    expect(isAsyncFunction(testClass.testArrowSync)).toBe(false)
+    expect(isAsyncFunction(testClass.testArrowAsync)).toBe(true)
+    // eslint-disable-next-line @typescript-eslint/unbound-method
+    expect(isAsyncFunction(TestClass.testStaticSync)).toBe(false)
+    // eslint-disable-next-line @typescript-eslint/unbound-method
+    expect(isAsyncFunction(TestClass.testStaticAsync)).toBe(true)
+  })
+
+  await it('Verify clone()', () => {
     const obj = { 1: 1 }
-    expect(cloneObject(obj)).toStrictEqual(obj)
-    expect(cloneObject(obj) === obj).toBe(false)
+    expect(clone(obj)).toStrictEqual(obj)
+    expect(clone(obj) === obj).toBe(false)
     const nestedObj = { 1: obj, 2: obj }
-    expect(cloneObject(nestedObj)).toStrictEqual(nestedObj)
-    expect(cloneObject(nestedObj) === nestedObj).toBe(false)
+    expect(clone(nestedObj)).toStrictEqual(nestedObj)
+    expect(clone(nestedObj) === nestedObj).toBe(false)
     const array = [1, 2]
-    expect(cloneObject(array)).toStrictEqual(array)
-    expect(cloneObject(array) === array).toBe(false)
+    expect(clone(array)).toStrictEqual(array)
+    expect(clone(array) === array).toBe(false)
     const objArray = [obj, obj]
-    expect(cloneObject(objArray)).toStrictEqual(objArray)
-    expect(cloneObject(objArray) === objArray).toBe(false)
+    expect(clone(objArray)).toStrictEqual(objArray)
+    expect(clone(objArray) === objArray).toBe(false)
     const date = new Date()
-    expect(cloneObject(date)).toStrictEqual(date)
-    expect(cloneObject(date) === date).toBe(false)
+    expect(clone(date)).toStrictEqual(date)
+    expect(clone(date) === date).toBe(false)
+    if (satisfies(version, '>=21.0.0')) {
+      const url = new URL('https://domain.tld')
+      expect(() => clone(url)).toThrowError(new Error('Cannot clone object of unsupported type.'))
+    }
     const map = new Map([['1', '2']])
-    expect(cloneObject(map)).toStrictEqual({})
+    expect(clone(map)).toStrictEqual(map)
+    expect(clone(map) === map).toBe(false)
     const set = new Set(['1'])
-    expect(cloneObject(set)).toStrictEqual({})
-    // The URL object seems to have not enumerable properties
-    const url = new URL('https://domain.tld')
-    expect(cloneObject(url)).toStrictEqual({})
+    expect(clone(set)).toStrictEqual(set)
+    expect(clone(set) === set).toBe(false)
     const weakMap = new WeakMap([[{ 1: 1 }, { 2: 2 }]])
-    expect(cloneObject(weakMap)).toStrictEqual({})
+    expect(() => clone(weakMap)).toThrowError(new Error('#<WeakMap> could not be cloned.'))
     const weakSet = new WeakSet([{ 1: 1 }, { 2: 2 }])
-    expect(cloneObject(weakSet)).toStrictEqual({})
+    expect(() => clone(weakSet)).toThrowError(new Error('#<WeakSet> could not be cloned.'))
   })
 
   await it('Verify hasOwnProp()', () => {
@@ -293,24 +347,6 @@ await describe('Utils test suite', async () => {
     expect(hasOwnProp({ 1: '1' }, 2)).toBe(false)
   })
 
-  await it('Verify isEmptyString()', () => {
-    expect(isEmptyString('')).toBe(true)
-    expect(isEmptyString(' ')).toBe(true)
-    expect(isEmptyString('     ')).toBe(true)
-    expect(isEmptyString('test')).toBe(false)
-    expect(isEmptyString(' test')).toBe(false)
-    expect(isEmptyString('test ')).toBe(false)
-    expect(isEmptyString(undefined)).toBe(true)
-    expect(isEmptyString(null)).toBe(true)
-    expect(isEmptyString(0)).toBe(false)
-    expect(isEmptyString({})).toBe(false)
-    expect(isEmptyString([])).toBe(false)
-    expect(isEmptyString(new Map())).toBe(false)
-    expect(isEmptyString(new Set())).toBe(false)
-    expect(isEmptyString(new WeakMap())).toBe(false)
-    expect(isEmptyString(new WeakSet())).toBe(false)
-  })
-
   await it('Verify isNotEmptyString()', () => {
     expect(isNotEmptyString('')).toBe(false)
     expect(isNotEmptyString(' ')).toBe(false)
@@ -329,22 +365,6 @@ await describe('Utils test suite', async () => {
     expect(isNotEmptyString(new WeakSet())).toBe(false)
   })
 
-  await it('Verify isEmptyArray()', () => {
-    expect(isEmptyArray([])).toBe(true)
-    expect(isEmptyArray([1, 2])).toBe(false)
-    expect(isEmptyArray(['1', '2'])).toBe(false)
-    expect(isEmptyArray(undefined)).toBe(false)
-    expect(isEmptyArray(null)).toBe(false)
-    expect(isEmptyArray('')).toBe(false)
-    expect(isEmptyArray('test')).toBe(false)
-    expect(isEmptyArray(0)).toBe(false)
-    expect(isEmptyArray({})).toBe(false)
-    expect(isEmptyArray(new Map())).toBe(false)
-    expect(isEmptyArray(new Set())).toBe(false)
-    expect(isEmptyArray(new WeakMap())).toBe(false)
-    expect(isEmptyArray(new WeakSet())).toBe(false)
-  })
-
   await it('Verify isNotEmptyArray()', () => {
     expect(isNotEmptyArray([])).toBe(false)
     expect(isNotEmptyArray([1, 2])).toBe(true)
@@ -361,13 +381,9 @@ await describe('Utils test suite', async () => {
     expect(isNotEmptyArray(new WeakSet())).toBe(false)
   })
 
-  await it('Verify isEmptyObject()', () => {
-    expect(isEmptyObject({})).toBe(true)
-    expect(isEmptyObject({ 1: 1, 2: 2 })).toBe(false)
-    expect(isEmptyObject(new Map())).toBe(false)
-    expect(isEmptyObject(new Set())).toBe(false)
-    expect(isEmptyObject(new WeakMap())).toBe(false)
-    expect(isEmptyObject(new WeakSet())).toBe(false)
+  await it('Verify insertAt()', () => {
+    expect(insertAt('test', 'ing', 'test'.length)).toBe('testing')
+    expect(insertAt('test', 'ing', 2)).toBe('teingst')
   })
 
   await it('Verify isArraySorted()', () => {
@@ -385,35 +401,4 @@ await describe('Utils test suite', async () => {
     expect(isArraySorted<number>([1, 2, 3, 5, 4], (a, b) => a - b)).toBe(false)
     expect(isArraySorted<number>([2, 1, 3, 4, 5], (a, b) => a - b)).toBe(false)
   })
-
-  await it('Verify once()', () => {
-    let called = 0
-    const fn = (): number => ++called
-    const onceFn = once(fn, this)
-    const result1 = onceFn()
-    expect(called).toBe(1)
-    expect(result1).toBe(1)
-    const result2 = onceFn()
-    expect(called).toBe(1)
-    expect(result2).toBe(1)
-    const result3 = onceFn()
-    expect(called).toBe(1)
-    expect(result3).toBe(1)
-  })
-
-  await it('Verify min()', () => {
-    expect(min()).toBe(Infinity)
-    expect(min(0, 1)).toBe(0)
-    expect(min(1, 0)).toBe(0)
-    expect(min(0, -1)).toBe(-1)
-    expect(min(-1, 0)).toBe(-1)
-  })
-
-  await it('Verify max()', () => {
-    expect(max()).toBe(-Infinity)
-    expect(max(0, 1)).toBe(1)
-    expect(max(1, 0)).toBe(1)
-    expect(max(0, -1)).toBe(0)
-    expect(max(-1, 0)).toBe(0)
-  })
 })