fix: chart empty state & result panel when multiple queries are execu…

…ted display incorrectly
apache · Jul 22, 2022 · 18443b3 · 18443b3
1 parent af1bddf
commit 18443b3
Show file tree

Hide file tree

Showing 6 changed files with 53 additions and 44 deletions.
diff --git a/superset-frontend/packages/superset-ui-core/src/chart/components/SuperChart.tsx b/superset-frontend/packages/superset-ui-core/src/chart/components/SuperChart.tsx
@@ -26,6 +26,7 @@ import { ParentSize } from '@vx/responsive';
 import { createSelector } from 'reselect';
 import { withTheme } from '@emotion/react';
 import { parseLength, Dimension } from '../../dimension';
+import getChartMetadataRegistry from '../registries/ChartMetadataRegistrySingleton';
 import SuperChartCore, { Props as SuperChartCoreProps } from './SuperChartCore';
 import DefaultFallbackComponent from './FallbackComponent';
 import ChartProps, { ChartPropsConfig } from '../models/ChartProps';
@@ -140,6 +141,9 @@ class SuperChart extends React.PureComponent<Props, {}> {
     this.core = core;
   };
 
+  private getQueryCount = () =>
+    getChartMetadataRegistry().get(this.props.chartType)?.queryObjectCount ?? 1;
+
   renderChart(width: number, height: number) {
     const {
       id,
@@ -174,9 +178,11 @@ class SuperChart extends React.PureComponent<Props, {}> {
     const noResultQueries =
       enableNoResults &&
       (!queriesData ||
-        queriesData.every(
-          ({ data }) => !data || (Array.isArray(data) && data.length === 0),
-        ));
+        queriesData
+          .slice(0, this.getQueryCount())
+          .every(
+            ({ data }) => !data || (Array.isArray(data) && data.length === 0),
+          ));
     if (noResultQueries) {
       chart = noResults || (
         <NoResultsComponent

diff --git a/superset-frontend/packages/superset-ui-core/src/chart/models/ChartMetadata.ts b/superset-frontend/packages/superset-ui-core/src/chart/models/ChartMetadata.ts
@@ -48,6 +48,7 @@ export interface ChartMetadataConfig {
   // label: ChartLabel.DEPRECATED which will display a "deprecated" label on the chart.
   label?: ChartLabel | null;
   labelExplanation?: string | null;
+  queryObjectCount?: number;
 }
 
 export default class ChartMetadata {
@@ -87,6 +88,8 @@ export default class ChartMetadata {
 
   labelExplanation?: string | null;
 
+  queryObjectCount: number;
+
   constructor(config: ChartMetadataConfig) {
     const {
       name,
@@ -106,6 +109,7 @@ export default class ChartMetadata {
       deprecated = false,
       label = null,
       labelExplanation = null,
+      queryObjectCount = 1,
     } = config;
 
     this.name = name;
@@ -134,6 +138,7 @@ export default class ChartMetadata {
     this.deprecated = deprecated;
     this.label = label;
     this.labelExplanation = labelExplanation;
+    this.queryObjectCount = queryObjectCount;
   }
 
   canBeAnnotationType(type: string): boolean {

diff --git a/superset-frontend/plugins/plugin-chart-echarts/src/MixedTimeseries/index.ts b/superset-frontend/plugins/plugin-chart-echarts/src/MixedTimeseries/index.ts
@@ -84,6 +84,7 @@ export default class EchartsTimeseriesChartPlugin extends ChartPlugin<
           t('Time'),
           t('Transformable'),
         ],
+        queryObjectCount: 2,
       }),
       // @ts-ignore
       transformProps,

diff --git a/superset-frontend/src/explore/components/DataTablesPane/components/useResultsPane.tsx b/superset-frontend/src/explore/components/DataTablesPane/components/useResultsPane.tsx
@@ -17,13 +17,17 @@
  * under the License.
  */
 import React, { useState, useEffect } from 'react';
-import { ensureIsArray, styled, t } from '@superset-ui/core';
+import {
+  ensureIsArray,
+  styled,
+  t,
+  getChartMetadataRegistry,
+} from '@superset-ui/core';
 import Loading from 'src/components/Loading';
 import { EmptyStateMedium } from 'src/components/EmptyState';
 import { getChartDataRequest } from 'src/components/Chart/chartAction';
 import { getClientErrorObject } from 'src/utils/getClientErrorObject';
 import { ResultsPaneProps, QueryResultInterface } from '../types';
-import { getQueryCount } from '../utils';
 import { SingleQueryResultPane } from './SingleQueryResultPane';
 import { TableControls } from './DataTableControls';
 
@@ -43,12 +47,14 @@ export const useResultsPane = ({
   isVisible,
   dataSize = 50,
 }: ResultsPaneProps): React.ReactElement[] => {
+  const metadata = getChartMetadataRegistry().get(
+    queryFormData?.viz_type || queryFormData?.vizType,
+  );
+
   const [resultResp, setResultResp] = useState<QueryResultInterface[]>([]);
   const [isLoading, setIsLoading] = useState<boolean>(true);
   const [responseError, setResponseError] = useState<string>('');
-  const queryCount = getQueryCount(
-    queryFormData?.viz_type || queryFormData?.vizType,
-  );
+  const queryCount = metadata?.queryObjectCount ?? 1;
 
   useEffect(() => {
     // it's an invalid formData when gets a errorMessage
@@ -122,15 +128,17 @@ export const useResultsPane = ({
     );
   }
 
-  return resultResp.map((result, idx) => (
-    <SingleQueryResultPane
-      data={result.data}
-      colnames={result.colnames}
-      coltypes={result.coltypes}
-      dataSize={dataSize}
-      datasourceId={queryFormData.datasource}
-      key={idx}
-      isVisible={isVisible}
-    />
-  ));
+  return resultResp
+    .slice(0, queryCount)
+    .map((result, idx) => (
+      <SingleQueryResultPane
+        data={result.data}
+        colnames={result.colnames}
+        coltypes={result.coltypes}
+        dataSize={dataSize}
+        datasourceId={queryFormData.datasource}
+        key={idx}
+        isVisible={isVisible}
+      />
+    ));
 };
diff --git a/superset-frontend/src/explore/components/DataTablesPane/test/ResultsPaneOnDashboard.test.tsx b/superset-frontend/src/explore/components/DataTablesPane/test/ResultsPaneOnDashboard.test.tsx
@@ -24,7 +24,7 @@ import {
   waitForElementToBeRemoved,
 } from 'spec/helpers/testing-library';
 import { exploreActions } from 'src/explore/actions/exploreActions';
-import { promiseTimeout } from '@superset-ui/core';
+import { ChartMetadata, ChartPlugin, promiseTimeout } from '@superset-ui/core';
 import { ResultsPaneOnDashboard } from '../components';
 import { createResultsPaneOnDashboardProps } from './fixture';
 
@@ -147,6 +147,19 @@ describe('ResultsPaneOnDashboard', () => {
   });
 
   test('multiple results pane', async () => {
+    const FakeChart = () => <span>test</span>;
+    const metadata = new ChartMetadata({
+      name: 'test-chart',
+      thumbnail: '',
+      queryObjectCount: 2,
+    });
+
+    const plugin = new ChartPlugin({
+      metadata,
+      Chart: FakeChart,
+    });
+    plugin.configure({ key: 'mixed_timeseries' }).register();
+
     const props = createResultsPaneOnDashboardProps({
       sliceId: 196,
       vizType: 'mixed_timeseries',

diff --git a/superset-frontend/src/explore/components/DataTablesPane/utils.ts b/superset-frontend/src/explore/components/DataTablesPane/utils.ts