fix(plugin-chart-echarts): boxplot groupby incorrect (#1448)

* fix(plugin-chart-echarts): boxplot groupby incorrect

* add tests

* use formData instead of QueryObject

* lint

superset-frontend/temporary_superset_ui/superset-ui/packages/superset-ui-chart-controls/src/operators/boxplotOperator.ts

@@ -16,12 +16,7 @@
  * specific language governing permissions and limitationsxw
  * under the License.
  */
-import {
-  PostProcessingBoxplot,
-  getMetricLabel,
-  ensureIsArray,
-  QueryFormColumn,
-} from '@superset-ui/core';
+import { PostProcessingBoxplot, getMetricLabel, ensureIsArray } from '@superset-ui/core';
 import { PostProcessingFactory } from './types';
 
 type BoxPlotQueryObjectWhiskerType = PostProcessingBoxplot['options']['whisker_type'];
@@ -31,7 +26,7 @@ export const boxplotOperator: PostProcessingFactory<PostProcessingBoxplot | unde
   formData,
   queryObject,
 ) => {
-  const { whiskerOptions } = formData;
+  const { groupby, whiskerOptions } = formData;
 
   if (whiskerOptions) {
     let whiskerType: BoxPlotQueryObjectWhiskerType;
@@ -54,7 +49,7 @@ export const boxplotOperator: PostProcessingFactory<PostProcessingBoxplot | unde
       options: {
         whisker_type: whiskerType,
         percentiles,
-        groupby: ensureIsArray(queryObject.groupby as QueryFormColumn[]),
+        groupby: ensureIsArray(groupby),
         metrics: ensureIsArray(queryObject.metrics).map(getMetricLabel),
       },
     };

superset-frontend/temporary_superset_ui/superset-ui/packages/superset-ui-core/src/query/types/PostProcessing.ts

@@ -50,7 +50,7 @@ export enum PandasAxis {
   Column = 1,
 }
 
-interface Aggregates {
+export interface Aggregates {
   /**
    * The name of the generated aggregate column.
    */
@@ -186,3 +186,53 @@ export type PostProcessingRule =
   | PostProcessingCompare
   | PostProcessingSort
   | PostProcessingResample;
+
+export function isPostProcessingAggregation(
+  rule?: PostProcessingRule,
+): rule is PostProcessingAggregation {
+  return rule?.operation === 'aggregation';
+}
+
+export function isPostProcessingBoxplot(rule?: PostProcessingRule): rule is PostProcessingBoxplot {
+  return rule?.operation === 'boxplot';
+}
+
+export function isPostProcessingContribution(
+  rule?: PostProcessingRule,
+): rule is PostProcessingContribution {
+  return rule?.operation === 'contribution';
+}
+
+export function isPostProcessingPivot(rule?: PostProcessingRule): rule is PostProcessingPivot {
+  return rule?.operation === 'pivot';
+}
+
+export function isPostProcessingProphet(rule?: PostProcessingRule): rule is PostProcessingProphet {
+  return rule?.operation === 'prophet';
+}
+
+export function isPostProcessingDiff(rule?: PostProcessingRule): rule is PostProcessingDiff {
+  return rule?.operation === 'diff';
+}
+
+export function isPostProcessingRolling(rule?: PostProcessingRule): rule is PostProcessingRolling {
+  return rule?.operation === 'rolling';
+}
+
+export function isPostProcessingCum(rule?: PostProcessingRule): rule is PostProcessingCum {
+  return rule?.operation === 'cum';
+}
+
+export function isPostProcessingCompare(rule?: PostProcessingRule): rule is PostProcessingCompare {
+  return rule?.operation === 'compare';
+}
+
+export function isPostProcessingSort(rule?: PostProcessingRule): rule is PostProcessingSort {
+  return rule?.operation === 'sort';
+}
+
+export function isPostProcessingResample(
+  rule?: PostProcessingRule,
+): rule is PostProcessingResample {
+  return rule?.operation === 'resample';
+}

superset-frontend/temporary_superset_ui/superset-ui/packages/superset-ui-core/test/query/types/PostProcessing.test.ts

@@ -0,0 +1,223 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF 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 {
+  Aggregates,
+  isPostProcessingAggregation,
+  isPostProcessingBoxplot,
+  isPostProcessingCompare,
+  isPostProcessingContribution,
+  isPostProcessingCum,
+  isPostProcessingDiff,
+  isPostProcessingPivot,
+  isPostProcessingProphet,
+  isPostProcessingRolling,
+  isPostProcessingResample,
+  isPostProcessingSort,
+  PandasAxis,
+  PostProcessingAggregation,
+  PostProcessingBoxplot,
+  PostProcessingCompare,
+  PostProcessingContribution,
+  PostProcessingCum,
+  PostProcessingDiff,
+  PostProcessingPivot,
+  PostProcessingProphet,
+  PostProcessingResample,
+  PostProcessingRolling,
+  PostProcessingSort,
+} from '@superset-ui/core/src/query/types/PostProcessing';
+import { ComparisionType, RollingType, TimeGranularity } from '../../../src';
+
+const AGGREGATES_OPTION: Aggregates = {
+  bar: {
+    operator: 'max',
+    column: 'bar',
+    options: {},
+  },
+};
+
+const AGGREGATE_RULE: PostProcessingAggregation = {
+  operation: 'aggregation',
+  options: {
+    groupby: ['foo'],
+    aggregates: AGGREGATES_OPTION,
+  },
+};
+
+const BOXPLOT_RULE: PostProcessingBoxplot = {
+  operation: 'boxplot',
+  options: {
+    groupby: ['foo'],
+    metrics: ['bar'],
+    whisker_type: 'tukey',
+  },
+};
+
+const COMPARE_RULE: PostProcessingCompare = {
+  operation: 'compare',
+  options: {
+    source_columns: ['foo'],
+    compare_columns: ['bar'],
+    compare_type: ComparisionType.Percentage,
+    drop_original_columns: false,
+  },
+};
+
+const CONTRIBUTION_RULE: PostProcessingContribution = {
+  operation: 'contribution',
+  options: {
+    orientation: 'row',
+    columns: ['foo'],
+  },
+};
+
+const CUM_RULE: PostProcessingCum = {
+  operation: 'cum',
+  options: {
+    columns: ['foo'],
+    operator: 'min',
+    is_pivot_df: true,
+  },
+};
+
+const DIFF_RULE: PostProcessingDiff = {
+  operation: 'diff',
+  options: {
+    columns: ['foo'],
+    periods: 12,
+    axis: PandasAxis.Column,
+  },
+};
+
+const PIVOT_RULE: PostProcessingPivot = {
+  operation: 'pivot',
+  options: {
+    index: ['foo'],
+    columns: ['bar'],
+    aggregates: AGGREGATES_OPTION,
+    flatten_columns: true,
+    reset_index: true,
+  },
+};
+
+const PROPHET_RULE: PostProcessingProphet = {
+  operation: 'prophet',
+  options: {
+    time_grain: TimeGranularity.DAY,
+    periods: 365,
+    confidence_interval: 0.8,
+    yearly_seasonality: false,
+    weekly_seasonality: false,
+    daily_seasonality: false,
+  },
+};
+
+const RESAMPLE_RULE: PostProcessingResample = {
+  operation: 'resample',
+  options: {
+    method: 'method',
+    rule: 'rule',
+    fill_value: null,
+    time_column: 'foo',
+  },
+};
+
+const ROLLING_RULE: PostProcessingRolling = {
+  operation: 'rolling',
+  options: {
+    rolling_type: RollingType.Cumsum,
+    window: 12,
+    min_periods: 12,
+    columns: ['foo', 'bar'],
+    is_pivot_df: true,
+  },
+};
+
+const SORT_RULE: PostProcessingSort = {
+  operation: 'sort',
+  options: {
+    columns: { foo: true },
+  },
+};
+
+test('PostProcessingAggregation type guard', () => {
+  expect(isPostProcessingAggregation(AGGREGATE_RULE)).toEqual(true);
+  expect(isPostProcessingAggregation(BOXPLOT_RULE)).toEqual(false);
+  expect(isPostProcessingAggregation(undefined)).toEqual(false);
+});
+
+test('PostProcessingBoxplot type guard', () => {
+  expect(isPostProcessingBoxplot(BOXPLOT_RULE)).toEqual(true);
+  expect(isPostProcessingBoxplot(AGGREGATE_RULE)).toEqual(false);
+  expect(isPostProcessingBoxplot(undefined)).toEqual(false);
+});
+
+test('PostProcessingCompare type guard', () => {
+  expect(isPostProcessingCompare(COMPARE_RULE)).toEqual(true);
+  expect(isPostProcessingCompare(AGGREGATE_RULE)).toEqual(false);
+  expect(isPostProcessingCompare(undefined)).toEqual(false);
+});
+
+test('PostProcessingContribution type guard', () => {
+  expect(isPostProcessingContribution(CONTRIBUTION_RULE)).toEqual(true);
+  expect(isPostProcessingContribution(AGGREGATE_RULE)).toEqual(false);
+  expect(isPostProcessingContribution(undefined)).toEqual(false);
+});
+
+test('PostProcessingCum type guard', () => {
+  expect(isPostProcessingCum(CUM_RULE)).toEqual(true);
+  expect(isPostProcessingCum(AGGREGATE_RULE)).toEqual(false);
+  expect(isPostProcessingCum(undefined)).toEqual(false);
+});
+
+test('PostProcessingDiff type guard', () => {
+  expect(isPostProcessingDiff(DIFF_RULE)).toEqual(true);
+  expect(isPostProcessingDiff(AGGREGATE_RULE)).toEqual(false);
+  expect(isPostProcessingDiff(undefined)).toEqual(false);
+});
+
+test('PostProcessingPivot type guard', () => {
+  expect(isPostProcessingPivot(PIVOT_RULE)).toEqual(true);
+  expect(isPostProcessingPivot(AGGREGATE_RULE)).toEqual(false);
+  expect(isPostProcessingPivot(undefined)).toEqual(false);
+});
+
+test('PostProcessingProphet type guard', () => {
+  expect(isPostProcessingProphet(PROPHET_RULE)).toEqual(true);
+  expect(isPostProcessingProphet(AGGREGATE_RULE)).toEqual(false);
+  expect(isPostProcessingProphet(undefined)).toEqual(false);
+});
+
+test('PostProcessingResample type guard', () => {
+  expect(isPostProcessingResample(RESAMPLE_RULE)).toEqual(true);
+  expect(isPostProcessingResample(AGGREGATE_RULE)).toEqual(false);
+  expect(isPostProcessingResample(undefined)).toEqual(false);
+});
+
+test('PostProcessingRolling type guard', () => {
+  expect(isPostProcessingRolling(ROLLING_RULE)).toEqual(true);
+  expect(isPostProcessingRolling(AGGREGATE_RULE)).toEqual(false);
+  expect(isPostProcessingRolling(undefined)).toEqual(false);
+});
+
+test('PostProcessingSort type guard', () => {
+  expect(isPostProcessingSort(SORT_RULE)).toEqual(true);
+  expect(isPostProcessingSort(AGGREGATE_RULE)).toEqual(false);
+  expect(isPostProcessingSort(undefined)).toEqual(false);
+});

superset-frontend/temporary_superset_ui/superset-ui/plugins/plugin-chart-echarts/test/BoxPlot/buildQuery.test.ts

@@ -16,6 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+import { isPostProcessingBoxplot } from '@superset-ui/core';
 import buildQuery from '../../src/BoxPlot/buildQuery';
 import { BoxPlotQueryFormData } from '../../src/BoxPlot/types';
 
@@ -39,6 +40,9 @@ describe('BoxPlot buildQuery', () => {
     expect(query.metrics).toEqual(['foo']);
     expect(query.columns).toEqual(['ds', 'bar']);
     expect(query.series_columns).toEqual(['bar']);
+    const [rule] = query.post_processing || [];
+    expect(isPostProcessingBoxplot(rule)).toEqual(true);
+    expect(rule.options.groupby).toEqual(['bar']);
   });
 
   it('should build non-timeseries query object when columns is defined', () => {
@@ -47,5 +51,8 @@ describe('BoxPlot buildQuery', () => {
     expect(query.metrics).toEqual(['foo']);
     expect(query.columns).toEqual(['qwerty', 'bar']);
     expect(query.series_columns).toEqual(['bar']);
+    const [rule] = query.post_processing || [];
+    expect(isPostProcessingBoxplot(rule)).toEqual(true);
+    expect(rule.options.groupby).toEqual(['bar']);
   });
 });