/** * 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 { SqlaFormData } from '@superset-ui/core'; import buildQuery from '../../src/Timeseries/buildQuery'; describe('Timeseries buildQuery', () => { const formData = { datasource: '5__table', granularity_sqla: 'ds', metrics: ['bar', 'baz'], viz_type: 'my_chart', }; it('should build groupby with series in form data', () => { const queryContext = buildQuery(formData); const [query] = queryContext.queries; expect(query.metrics).toEqual(['bar', 'baz']); }); it('should order by timeseries limit if orderby unspecified', () => { const queryContext = buildQuery({ ...formData, timeseries_limit_metric: 'bar', order_desc: true, }); const [query] = queryContext.queries; expect(query.metrics).toEqual(['bar', 'baz']); expect(query.series_limit_metric).toEqual('bar'); expect(query.order_desc).toEqual(true); expect(query.orderby).toEqual([['bar', false]]); }); it('should not order by timeseries limit if orderby provided', () => { const queryContext = buildQuery({ ...formData, timeseries_limit_metric: 'bar', order_desc: true, orderby: [['foo', true]], }); const [query] = queryContext.queries; expect(query.metrics).toEqual(['bar', 'baz']); expect(query.series_limit_metric).toEqual('bar'); expect(query.order_desc).toEqual(true); expect(query.orderby).toEqual([['foo', true]]); }); }); describe('GENERIC_CHART_AXES is enabled', () => { let windowSpy: any; beforeAll(() => { // @ts-ignore windowSpy = jest.spyOn(window, 'window', 'get').mockImplementation(() => ({ featureFlags: { GENERIC_CHART_AXES: true, }, })); }); afterAll(() => { windowSpy.mockRestore(); }); const formData: SqlaFormData = { datasource: '5__table', viz_type: 'table', granularity_sqla: 'time_column', time_grain_sqla: 'P1Y', time_range: '1 year ago : 2013', groupby: ['col1'], metrics: ['count(*)'], }; it("shouldn't convert queryObject", () => { const { queries } = buildQuery(formData); expect(queries[0]).toEqual( expect.objectContaining({ granularity: 'time_column', time_range: '1 year ago : 2013', extras: { time_grain_sqla: 'P1Y', having: '', where: '' }, columns: ['col1'], series_columns: ['col1'], metrics: ['count(*)'], is_timeseries: true, post_processing: [ { operation: 'pivot', options: { aggregates: { 'count(*)': { operator: 'mean' } }, columns: ['col1'], drop_missing_columns: true, index: ['__timestamp'], }, }, { operation: 'flatten' }, ], }), ); }); it('should convert queryObject', () => { const { queries } = buildQuery({ ...formData, x_axis: 'time_column' }); expect(queries[0]).toEqual( expect.objectContaining({ granularity: 'time_column', time_range: '1 year ago : 2013', extras: { having: '', where: '' }, columns: [ { columnType: 'BASE_AXIS', expressionType: 'SQL', label: 'time_column', sqlExpression: 'time_column', timeGrain: 'P1Y', }, 'col1', ], series_columns: ['col1'], metrics: ['count(*)'], post_processing: [ { operation: 'pivot', options: { aggregates: { 'count(*)': { operator: 'mean' } }, columns: ['col1'], drop_missing_columns: true, index: ['time_column'], }, }, { operation: 'flatten' }, ], }), ); }); }); describe('GENERIC_CHART_AXES is disabled', () => { let windowSpy: any; beforeAll(() => { // @ts-ignore windowSpy = jest.spyOn(window, 'window', 'get').mockImplementation(() => ({ featureFlags: { GENERIC_CHART_AXES: false, }, })); }); afterAll(() => { windowSpy.mockRestore(); }); const formData: SqlaFormData = { datasource: '5__table', viz_type: 'table', granularity_sqla: 'time_column', time_grain_sqla: 'P1Y', time_range: '1 year ago : 2013', groupby: ['col1'], metrics: ['count(*)'], }; it("shouldn't convert queryObject", () => { const { queries } = buildQuery(formData); expect(queries[0]).toEqual( expect.objectContaining({ granularity: 'time_column', time_range: '1 year ago : 2013', extras: { time_grain_sqla: 'P1Y', having: '', where: '' }, columns: ['col1'], series_columns: ['col1'], metrics: ['count(*)'], is_timeseries: true, post_processing: [ { operation: 'pivot', options: { aggregates: { 'count(*)': { operator: 'mean' } }, columns: ['col1'], drop_missing_columns: true, index: ['__timestamp'], }, }, { operation: 'flatten' }, ], }), ); }); it('should convert queryObject', () => { const { queries } = buildQuery({ ...formData, x_axis: 'time_column' }); expect(queries[0]).toEqual( expect.objectContaining({ granularity: 'time_column', time_range: '1 year ago : 2013', extras: { having: '', where: '' }, columns: [ { columnType: 'BASE_AXIS', expressionType: 'SQL', label: 'time_column', sqlExpression: 'time_column', timeGrain: 'P1Y', }, 'col1', ], series_columns: ['col1'], metrics: ['count(*)'], post_processing: [ { operation: 'pivot', options: { aggregates: { 'count(*)': { operator: 'mean' } }, columns: ['col1'], drop_missing_columns: true, index: ['time_column'], }, }, { operation: 'flatten' }, ], }), ); }); });