[7.x] Fix TSVB table trend slope value (#71087) (#71433)

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

package.json

@@ -252,7 +252,6 @@
     "redux-actions": "^2.6.5",
     "redux-thunk": "^2.3.0",
     "regenerator-runtime": "^0.13.3",
-    "regression": "2.0.1",
     "request": "^2.88.0",
     "require-in-the-middle": "^5.0.2",
     "reselect": "^4.0.0",

src/plugins/vis_type_timeseries/server/lib/vis_data/table/process_bucket.js

@@ -20,11 +20,20 @@
 import { buildProcessorFunction } from '../build_processor_function';
 import { processors } from '../response_processors/table';
 import { getLastValue } from '../../../../common/get_last_value';
-import regression from 'regression';
 import { first, get } from 'lodash';
 import { overwrite } from '../helpers';
 import { getActiveSeries } from '../helpers/get_active_series';
 
+function trendSinceLastBucket(data) {
+  if (data.length < 2) {
+    return 0;
+  }
+  const currentBucket = data[data.length - 1];
+  const prevBucket = data[data.length - 2];
+  const trend = (currentBucket[1] - prevBucket[1]) / currentBucket[1];
+  return Number.isNaN(trend) ? 0 : trend;
+}
+
 export function processBucket(panel) {
   return (bucket) => {
     const series = getActiveSeries(panel).map((series) => {
@@ -38,14 +47,12 @@ export function processBucket(panel) {
         };
         overwrite(bucket, series.id, { meta, timeseries });
       }
-
       const processor = buildProcessorFunction(processors, bucket, panel, series);
       const result = first(processor([]));
       if (!result) return null;
       const data = get(result, 'data', []);
-      const linearRegression = regression.linear(data);
+      result.slope = trendSinceLastBucket(data);
       result.last = getLastValue(data);
-      result.slope = linearRegression.equation[0];
       return result;
     });
     return { key: bucket.key, series };

src/plugins/vis_type_timeseries/server/lib/vis_data/table/process_bucket.test.js

@@ -0,0 +1,159 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { processBucket } from './process_bucket';
+
+function createValueObject(key, value, seriesId) {
+  return { key_as_string: `${key}`, doc_count: value, key, [seriesId]: { value } };
+}
+
+function createBucketsObjects(size, sort, seriesId) {
+  const values = Array(size)
+    .fill(1)
+    .map((_, i) => i + 1);
+  if (sort === 'flat') {
+    return values.map((_, i) => createValueObject(i, 1, seriesId));
+  }
+  if (sort === 'desc') {
+    return values.reverse().map((v, i) => createValueObject(i, v, seriesId));
+  }
+  return values.map((v, i) => createValueObject(i, v, seriesId));
+}
+
+function createPanel(series) {
+  return {
+    type: 'table',
+    time_field: '',
+    series: series.map((seriesId) => ({
+      id: seriesId,
+      metrics: [{ id: seriesId, type: 'count' }],
+      trend_arrows: 1,
+    })),
+  };
+}
+
+function createBuckets(series) {
+  return [
+    { key: 'A', trend: 'asc', size: 10 },
+    { key: 'B', trend: 'desc', size: 10 },
+    { key: 'C', trend: 'flat', size: 10 },
+    { key: 'D', trend: 'asc', size: 1, expectedTrend: 'flat' },
+  ].map(({ key, trend, size, expectedTrend }) => {
+    const baseObj = {
+      key,
+      expectedTrend: expectedTrend || trend,
+    };
+    for (const seriesId of series) {
+      baseObj[seriesId] = {
+        meta: {
+          timeField: 'timestamp',
+          seriesId: seriesId,
+        },
+        buckets: createBucketsObjects(size, trend, seriesId),
+      };
+    }
+    return baseObj;
+  });
+}
+
+function trendChecker(trend, slope) {
+  switch (trend) {
+    case 'asc':
+      return slope > 0;
+    case 'desc':
+      return slope <= 0;
+    case 'flat':
+      return slope === 0;
+    default:
+      throw Error(`Slope value ${slope} not valid for trend "${trend}"`);
+  }
+}
+
+describe('processBucket(panel)', () => {
+  describe('single metric panel', () => {
+    let panel;
+    const SERIES_ID = 'series-id';
+
+    beforeEach(() => {
+      panel = createPanel([SERIES_ID]);
+    });
+
+    test('return the correct trend direction', () => {
+      const bucketProcessor = processBucket(panel);
+      const buckets = createBuckets([SERIES_ID]);
+      for (const bucket of buckets) {
+        const result = bucketProcessor(bucket);
+        expect(result.key).toEqual(bucket.key);
+        expect(trendChecker(bucket.expectedTrend, result.series[0].slope)).toBeTruthy();
+      }
+    });
+
+    test('properly handle 0 values for trend', () => {
+      const bucketProcessor = processBucket(panel);
+      const bucketforNaNResult = {
+        key: 'NaNScenario',
+        expectedTrend: 'flat',
+        [SERIES_ID]: {
+          meta: {
+            timeField: 'timestamp',
+            seriesId: SERIES_ID,
+          },
+          buckets: [
+            // this is a flat case, but 0/0 has not a valid number result
+            createValueObject(0, 0, SERIES_ID),
+            createValueObject(1, 0, SERIES_ID),
+          ],
+        },
+      };
+      const result = bucketProcessor(bucketforNaNResult);
+      expect(result.key).toEqual(bucketforNaNResult.key);
+      expect(trendChecker(bucketforNaNResult.expectedTrend, result.series[0].slope)).toEqual(true);
+    });
+
+    test('have the side effect to create the timeseries property if missing on bucket', () => {
+      const bucketProcessor = processBucket(panel);
+      const buckets = createBuckets([SERIES_ID]);
+      for (const bucket of buckets) {
+        bucketProcessor(bucket);
+        expect(bucket[SERIES_ID].buckets).toBeUndefined();
+        expect(bucket[SERIES_ID].timeseries).toBeDefined();
+      }
+    });
+  });
+
+  describe('multiple metrics panel', () => {
+    let panel;
+    const SERIES = ['series-id-1', 'series-id-2'];
+
+    beforeEach(() => {
+      panel = createPanel(SERIES);
+    });
+
+    test('return the correct trend direction', () => {
+      const bucketProcessor = processBucket(panel);
+      const buckets = createBuckets(SERIES);
+      for (const bucket of buckets) {
+        const result = bucketProcessor(bucket);
+        expect(result.key).toEqual(bucket.key);
+        expect(trendChecker(bucket.expectedTrend, result.series[0].slope)).toBeTruthy();
+        expect(trendChecker(bucket.expectedTrend, result.series[1].slope)).toBeTruthy();
+      }
+    });
+  });
+});

yarn.lock

@@ -26792,11 +26792,6 @@ regjsparser@^0.6.4:
   dependencies:
     jsesc "~0.5.0"
 
-regression@2.0.1:
-  version "2.0.1"
-  resolved "https://registry.yarnpkg.com/regression/-/regression-2.0.1.tgz#8d29c3e8224a10850c35e337e85a8b2fac3b0c87"
-  integrity sha1-jSnD6CJKEIUMNeM36FqLL6w7DIc=
-
 rehype-parse@^6.0.0:
   version "6.0.0"
   resolved "https://registry.yarnpkg.com/rehype-parse/-/rehype-parse-6.0.0.tgz#f681555f2598165bee2c778b39f9073d17b16bca"