fix(plugin-chart-echarts): add series deduplication (#1046)

* fix(plugin-chart-echarts): add series deduplication * refactor function
apache · Nov 26, 2021 · 6377933 · 6377933
1 parent 53df21d
commit 6377933
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 2 deletions.
diff --git a/...ary_superset_ui/superset-ui/plugins/plugin-chart-echarts/src/Timeseries/transformProps.ts b/...ary_superset_ui/superset-ui/plugins/plugin-chart-echarts/src/Timeseries/transformProps.ts
@@ -36,7 +36,12 @@ import { EChartsOption, SeriesOption } from 'echarts';
 import { DEFAULT_FORM_DATA, EchartsTimeseriesFormData } from './types';
 import { EchartsProps, ForecastSeriesEnum, ProphetValue, LegendOrientation } from '../types';
 import { parseYAxisBound } from '../utils/controls';
-import { extractTimeseriesSeries, getChartPadding, getLegendProps } from '../utils/series';
+import {
+  dedupSeries,
+  extractTimeseriesSeries,
+  getChartPadding,
+  getLegendProps,
+} from '../utils/series';
 import { extractAnnotationLabels } from '../utils/annotation';
 import {
   extractForecastSeriesContext,
@@ -214,7 +219,7 @@ export default function transformProps(chartProps: ChartProps): EchartsProps {
         .map(entry => entry.name || '')
         .concat(extractAnnotationLabels(annotationLayers, annotationData)),
     },
-    series,
+    series: dedupSeries(series),
     toolbox: {
       show: zoomable,
       top: TIMESERIES_CONSTANTS.toolboxTop,

diff --git a/...ontend/temporary_superset_ui/superset-ui/plugins/plugin-chart-echarts/src/utils/series.ts b/...ontend/temporary_superset_ui/superset-ui/plugins/plugin-chart-echarts/src/utils/series.ts
@@ -184,3 +184,19 @@ export function getChartPadding(
     bottom: bottom + (orientation === LegendOrientation.Bottom ? legendMargin : 0),
   };
 }
+
+export function dedupSeries(series: SeriesOption[]): SeriesOption[] {
+  const counter = new Map<string, number>();
+  return series.map(row => {
+    let { id } = row;
+    if (id === undefined) return row;
+    id = String(id);
+    const count = counter.get(id) || 0;
+    const suffix = count > 0 ? ` (${count})` : '';
+    counter.set(id, count + 1);
+    return {
+      ...row,
+      id: `${id}${suffix}`,
+    };
+  });
+}
diff --git a/.../temporary_superset_ui/superset-ui/plugins/plugin-chart-echarts/test/utils/series.test.ts b/.../temporary_superset_ui/superset-ui/plugins/plugin-chart-echarts/test/utils/series.test.ts
@@ -18,6 +18,7 @@
  */
 import { getNumberFormatter, getTimeFormatter } from '@superset-ui/core';
 import {
+  dedupSeries,
   extractGroupbyLabel,
   extractTimeseriesSeries,
   formatSeriesName,
@@ -328,4 +329,25 @@ describe('formatSeriesName', () => {
       });
     });
   });
+
+  describe('dedupSeries', () => {
+    it('should deduplicate ids in series', () => {
+      expect(
+        dedupSeries([
+          {
+            id: 'foo',
+          },
+          {
+            id: 'bar',
+          },
+          {
+            id: 'foo',
+          },
+          {
+            id: 'foo',
+          },
+        ]),
+      ).toEqual([{ id: 'foo' }, { id: 'bar' }, { id: 'foo (1)' }, { id: 'foo (2)' }]);
+    });
+  });
 });