Added stresstest

Author: JaapvanEkris

app/engine/utils/Series.test.js

@@ -1,15 +1,19 @@
 'use strict'
-/*
-  Open Rowing Monitor, https://github.com/JaapvanEkris/openrowingmonitor
-*/
 /**
- * As this object is fundamental for most other utility objects, we must test its behaviour quite thoroughly
+ * @copyright [OpenRowingMonitor]{@link https://github.com/JaapvanEkris/openrowingmonitor}
+ *
+ * @file Tests of the Series object. As this object is fundamental for most other utility objects, we must test its behaviour quite thoroughly
+ * Please note: this file contains commented out stress tests of the length(), sum(), average() functions, to detect any issues with numerical stability
+ * As these tests tend to run in the dozens of minutes, we do not run them systematically, but they should be run when the series object is changed.
  */
 import { test } from 'uvu'
 import * as assert from 'uvu/assert'
 
 import { createSeries } from './Series.js'
 
+/**
+ * @description Test behaviour for no datapoints
+ */
 test('Series behaviour with an empty series', () => {
   const dataSeries = createSeries(3)
   testLength(dataSeries, 0)
@@ -26,6 +30,9 @@ test('Series behaviour with an empty series', () => {
   testMaximum(dataSeries, 0)
 })
 
+/**
+ * @description Test behaviour for a single datapoint
+ */
 test('Series behaviour with a single pushed value. Series = [9]', () => {
   const dataSeries = createSeries(3)
   dataSeries.push(9)
@@ -43,6 +50,9 @@ test('Series behaviour with a single pushed value. Series = [9]', () => {
   testMaximum(dataSeries, 9)
 })
 
+/**
+ * @description Test behaviour for two datapoints
+ */
 test('Series behaviour with a second pushed value. Series = [9, 3]', () => {
   const dataSeries = createSeries(3)
   dataSeries.push(9)
@@ -61,6 +71,9 @@ test('Series behaviour with a second pushed value. Series = [9, 3]', () => {
   testMaximum(dataSeries, 9)
 })
 
+/**
+ * @description Test behaviour for three datapoints
+ */
 test('Series behaviour with a third pushed value. Series = [9, 3, 6]', () => {
   const dataSeries = createSeries(3)
   dataSeries.push(9)
@@ -80,6 +93,9 @@ test('Series behaviour with a third pushed value. Series = [9, 3, 6]', () => {
   testMaximum(dataSeries, 9)
 })
 
+/**
+ * @description Test behaviour for four datapoints
+ */
 test('Series behaviour with a fourth pushed value. Series = [3, 6, 12]', () => {
   const dataSeries = createSeries(3)
   dataSeries.push(9)
@@ -100,6 +116,9 @@ test('Series behaviour with a fourth pushed value. Series = [3, 6, 12]', () => {
   testMaximum(dataSeries, 12)
 })
 
+/**
+ * @description Test behaviour for five datapoints
+ */
 test('Series behaviour with a fifth pushed value. Series = [6, 12, -3]', () => {
   const dataSeries = createSeries(3)
   dataSeries.push(9)
@@ -121,6 +140,9 @@ test('Series behaviour with a fifth pushed value. Series = [6, 12, -3]', () => {
   testMaximum(dataSeries, 12)
 })
 
+/**
+ * @description Test behaviour for recalculations of the min/max values
+ */
 test('Series behaviour pushing out the min and max value and forcing a recalculate of min/max via the array.', () => {
   const dataSeries = createSeries(3)
   dataSeries.push(9)
@@ -136,6 +158,9 @@ test('Series behaviour pushing out the min and max value and forcing a recalcula
   testMaximum(dataSeries, 6)
 })
 
+/**
+ * @description Test behaviour for recalculations of the min/max values
+ */
 test('Series behaviour pushing out the min and max value, replacing them just in time.', () => {
   const dataSeries = createSeries(3)
   dataSeries.push(9)
@@ -151,6 +176,9 @@ test('Series behaviour pushing out the min and max value, replacing them just in
   testMaximum(dataSeries, 12)
 })
 
+/**
+ * @description Test behaviour after a reset()
+ */
 test('Series behaviour with a five pushed values followed by a reset, Series = []', () => {
   const dataSeries = createSeries(3)
   dataSeries.push(9)
@@ -171,6 +199,43 @@ test('Series behaviour with a five pushed values followed by a reset, Series = [
   testMedian(dataSeries, 0)
 })
 
+/* These stress tests test the reliability of the sum(), average() and length() function after a huge number of updates
+// This specific test takes a long time (over 10 minutes), so only run them manually when changing the series module
+// Javascript maximum array length is 4294967295, as heap memory is limited, we stay with 2^25 datapoints
+test('Stress test of the series object, 33.554.432 (2^25) datapoints', () => {
+  const dataSeries = createSeries()
+  let j = 0
+  let randomvalue
+  while (j < 16777216) {
+    randomvalue = Math.random()
+    dataSeries.push(randomvalue)
+    dataSeries.push(1 - randomvalue)
+    j++
+  }
+  testLength(dataSeries, 33554432)
+  testSum(dataSeries, 16777216)
+  testAverage(dataSeries, 0.5)
+  testMedian(dataSeries, 0.5)
+})
+
+// Javascript maximum array length is 4294967295, as heap memory is limited, we stay with 2^25 datapoints
+// This test takes several hours (!) due to the many large array shifts, so only run them manually when changing the series module
+test('Stress test of the series object, 67.108.864 datapoints, with a maxLength of 33.554.432 (2^25)', () => {
+  const dataSeries = createSeries(33554432)
+  let j = 0
+  let randomvalue
+  while (j < 33554432) {
+    randomvalue = Math.random()
+    dataSeries.push(randomvalue)
+    dataSeries.push(1 - randomvalue)
+    j++
+  }
+  testLength(dataSeries, 33554432)
+  testSum(dataSeries, 16777216)
+  testAverage(dataSeries, 0.5)
+  testMedian(dataSeries, 0.5)
+}) */
+
 function testLength (series, expectedValue) {
   assert.ok(series.length() === expectedValue, `Expected length should be ${expectedValue}, encountered ${series.length()}`)
 }