2021-10-28 06:27:35 -04:00
|
|
|
/*
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
|
2023-04-25 22:44:50 -04:00
|
|
|
import { TimeGranularity } from '@superset-ui/core';
|
|
|
|
import * as supersetCoreModule from '@superset-ui/core';
|
2021-04-14 05:35:08 -04:00
|
|
|
import buildQuery from '../../src/plugin/buildQuery';
|
2022-03-27 22:20:06 -04:00
|
|
|
import { PivotTableQueryFormData } from '../../src/types';
|
2021-04-14 05:35:08 -04:00
|
|
|
|
2023-07-13 10:33:16 -04:00
|
|
|
const formData: PivotTableQueryFormData = {
|
|
|
|
groupbyRows: ['row1', 'row2'],
|
|
|
|
groupbyColumns: ['col1', 'col2'],
|
|
|
|
metrics: ['metric1', 'metric2'],
|
|
|
|
tableRenderer: 'Table With Subtotal',
|
|
|
|
colOrder: 'key_a_to_z',
|
|
|
|
rowOrder: 'key_a_to_z',
|
|
|
|
aggregateFunction: 'Sum',
|
|
|
|
transposePivot: true,
|
|
|
|
rowSubtotalPosition: true,
|
|
|
|
colSubtotalPosition: true,
|
|
|
|
colTotals: true,
|
2023-08-14 08:20:32 -04:00
|
|
|
colSubTotals: true,
|
2023-07-13 10:33:16 -04:00
|
|
|
rowTotals: true,
|
2023-08-14 08:20:32 -04:00
|
|
|
rowSubTotals: true,
|
2023-07-13 10:33:16 -04:00
|
|
|
valueFormat: 'SMART_NUMBER',
|
|
|
|
datasource: '5__table',
|
|
|
|
viz_type: 'my_chart',
|
|
|
|
width: 800,
|
|
|
|
height: 600,
|
|
|
|
combineMetric: false,
|
|
|
|
verboseMap: {},
|
|
|
|
columnFormats: {},
|
|
|
|
currencyFormats: {},
|
|
|
|
metricColorFormatters: [],
|
|
|
|
dateFormatters: {},
|
|
|
|
setDataMask: () => {},
|
|
|
|
legacy_order_by: 'count',
|
|
|
|
order_desc: true,
|
|
|
|
margin: 0,
|
|
|
|
time_grain_sqla: TimeGranularity.MONTH,
|
|
|
|
temporal_columns_lookup: { col1: true },
|
2023-08-02 13:22:45 -04:00
|
|
|
currencyFormat: { symbol: 'USD', symbolPosition: 'prefix' },
|
2023-07-13 10:33:16 -04:00
|
|
|
};
|
|
|
|
|
|
|
|
test('should build groupby with series in form data', () => {
|
|
|
|
const queryContext = buildQuery(formData);
|
|
|
|
const [query] = queryContext.queries;
|
|
|
|
expect(query.columns).toEqual(['col1', 'col2', 'row1', 'row2']);
|
|
|
|
});
|
|
|
|
|
|
|
|
test('should work with old charts after GENERIC_CHART_AXES is enabled', () => {
|
|
|
|
Object.defineProperty(supersetCoreModule, 'hasGenericChartAxes', {
|
|
|
|
value: true,
|
|
|
|
});
|
|
|
|
const modifiedFormData = {
|
|
|
|
...formData,
|
|
|
|
time_grain_sqla: TimeGranularity.MONTH,
|
|
|
|
granularity_sqla: 'col1',
|
2021-04-14 05:35:08 -04:00
|
|
|
};
|
2023-07-13 10:33:16 -04:00
|
|
|
const queryContext = buildQuery(modifiedFormData);
|
|
|
|
const [query] = queryContext.queries;
|
|
|
|
expect(query.columns).toEqual([
|
|
|
|
{
|
|
|
|
timeGrain: 'P1M',
|
|
|
|
columnType: 'BASE_AXIS',
|
|
|
|
sqlExpression: 'col1',
|
|
|
|
label: 'col1',
|
|
|
|
expressionType: 'SQL',
|
|
|
|
},
|
|
|
|
'col2',
|
|
|
|
'row1',
|
|
|
|
'row2',
|
|
|
|
]);
|
|
|
|
});
|
2021-04-14 05:35:08 -04:00
|
|
|
|
2023-07-13 10:33:16 -04:00
|
|
|
test('should prefer extra_form_data.time_grain_sqla over formData.time_grain_sqla', () => {
|
|
|
|
Object.defineProperty(supersetCoreModule, 'hasGenericChartAxes', {
|
|
|
|
value: true,
|
2021-04-14 05:35:08 -04:00
|
|
|
});
|
2023-07-13 10:33:16 -04:00
|
|
|
const modifiedFormData = {
|
|
|
|
...formData,
|
|
|
|
extra_form_data: { time_grain_sqla: TimeGranularity.QUARTER },
|
|
|
|
};
|
|
|
|
const queryContext = buildQuery(modifiedFormData);
|
|
|
|
const [query] = queryContext.queries;
|
|
|
|
expect(query.columns?.[0]).toEqual({
|
|
|
|
timeGrain: TimeGranularity.QUARTER,
|
|
|
|
columnType: 'BASE_AXIS',
|
|
|
|
sqlExpression: 'col1',
|
|
|
|
label: 'col1',
|
|
|
|
expressionType: 'SQL',
|
|
|
|
});
|
|
|
|
});
|
2023-04-25 22:44:50 -04:00
|
|
|
|
2023-07-13 10:33:16 -04:00
|
|
|
test('should fallback to formData.time_grain_sqla if extra_form_data.time_grain_sqla is not set', () => {
|
|
|
|
Object.defineProperty(supersetCoreModule, 'hasGenericChartAxes', {
|
|
|
|
value: true,
|
|
|
|
});
|
|
|
|
const queryContext = buildQuery(formData);
|
|
|
|
const [query] = queryContext.queries;
|
|
|
|
expect(query.columns?.[0]).toEqual({
|
|
|
|
timeGrain: formData.time_grain_sqla,
|
|
|
|
columnType: 'BASE_AXIS',
|
|
|
|
sqlExpression: 'col1',
|
|
|
|
label: 'col1',
|
|
|
|
expressionType: 'SQL',
|
2023-04-25 22:44:50 -04:00
|
|
|
});
|
2021-04-14 05:35:08 -04:00
|
|
|
});
|
2023-11-06 12:51:28 -05:00
|
|
|
|
|
|
|
test('should not omit extras.time_grain_sqla from queryContext so dashboards apply them', () => {
|
|
|
|
Object.defineProperty(supersetCoreModule, 'hasGenericChartAxes', {
|
|
|
|
value: true,
|
|
|
|
});
|
|
|
|
const modifiedFormData = {
|
|
|
|
...formData,
|
|
|
|
extra_form_data: { time_grain_sqla: TimeGranularity.QUARTER },
|
|
|
|
};
|
|
|
|
const queryContext = buildQuery(modifiedFormData);
|
|
|
|
const [query] = queryContext.queries;
|
|
|
|
expect(query.extras?.time_grain_sqla).toEqual(TimeGranularity.QUARTER);
|
|
|
|
});
|