forked from apache/superset
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Normalize orderby clause (apache#1206)
* feat: normalize orderby clause * fix ut
- Loading branch information
1 parent
f4f5e8c
commit 33f8b4c
Showing
4 changed files
with
257 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
64 changes: 64 additions & 0 deletions
64
...temporary_superset_ui/superset-ui/packages/superset-ui-core/src/query/normalizeOrderBy.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
/** | ||
* 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 isEmpty from 'lodash/isEmpty'; | ||
import isBoolean from 'lodash/isBoolean'; | ||
|
||
import { QueryObject } from './types'; | ||
|
||
export default function normalizeOrderBy(queryObject: QueryObject): QueryObject { | ||
if (Array.isArray(queryObject.orderby) && queryObject.orderby.length > 0) { | ||
// ensure a valid orderby clause | ||
const orderbyClause = queryObject.orderby[0]; | ||
if ( | ||
Array.isArray(orderbyClause) && | ||
orderbyClause.length === 2 && | ||
!isEmpty(orderbyClause[0]) && | ||
isBoolean(orderbyClause[1]) | ||
) { | ||
return queryObject; | ||
} | ||
} | ||
|
||
// ensure that remove invalid orderby clause | ||
const cloneQueryObject = { ...queryObject }; | ||
delete cloneQueryObject.timeseries_limit_metric; | ||
delete cloneQueryObject.order_desc; | ||
delete cloneQueryObject.orderby; | ||
|
||
const isAsc = !queryObject.order_desc; | ||
if ( | ||
queryObject.timeseries_limit_metric !== undefined && | ||
queryObject.timeseries_limit_metric !== null && | ||
!isEmpty(queryObject.timeseries_limit_metric) | ||
) { | ||
return { | ||
...cloneQueryObject, | ||
orderby: [[queryObject.timeseries_limit_metric, isAsc]], | ||
}; | ||
} | ||
|
||
if (Array.isArray(queryObject.metrics) && queryObject.metrics.length > 0) { | ||
return { | ||
...cloneQueryObject, | ||
orderby: [[queryObject.metrics[0], isAsc]], | ||
}; | ||
} | ||
|
||
return cloneQueryObject; | ||
} |
150 changes: 150 additions & 0 deletions
150
...ary_superset_ui/superset-ui/packages/superset-ui-core/test/query/normalizeOrderBy.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,150 @@ | ||
/** | ||
* 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 { normalizeOrderBy, QueryObject } from '@superset-ui/core/src/query'; | ||
|
||
describe('normalizeOrderBy', () => { | ||
it('should not change original queryObject when orderby populated', () => { | ||
const query: QueryObject = { | ||
datasource: '5__table', | ||
viz_type: 'table', | ||
time_range: '1 year ago : 2013', | ||
orderby: [['count(*)', true]], | ||
}; | ||
expect(normalizeOrderBy(query)).toEqual(query); | ||
}); | ||
|
||
it('has timeseries_limit_metric in queryObject', () => { | ||
const query: QueryObject = { | ||
datasource: '5__table', | ||
viz_type: 'table', | ||
time_range: '1 year ago : 2013', | ||
metrics: ['count(*)'], | ||
timeseries_limit_metric: { | ||
expressionType: 'SIMPLE', | ||
column: { | ||
id: 1, | ||
column_name: 'sales', | ||
}, | ||
aggregate: 'SUM', | ||
}, | ||
order_desc: true, | ||
}; | ||
const expectedQueryObject = normalizeOrderBy(query); | ||
expect(expectedQueryObject).not.toHaveProperty('timeseries_limit_metric'); | ||
expect(expectedQueryObject).not.toHaveProperty('order_desc'); | ||
expect(expectedQueryObject).toEqual({ | ||
datasource: '5__table', | ||
viz_type: 'table', | ||
time_range: '1 year ago : 2013', | ||
metrics: ['count(*)'], | ||
orderby: [ | ||
[ | ||
{ | ||
expressionType: 'SIMPLE', | ||
column: { | ||
id: 1, | ||
column_name: 'sales', | ||
}, | ||
aggregate: 'SUM', | ||
}, | ||
false, | ||
], | ||
], | ||
}); | ||
}); | ||
|
||
it('has metrics in queryObject', () => { | ||
const query: QueryObject = { | ||
datasource: '5__table', | ||
viz_type: 'table', | ||
time_range: '1 year ago : 2013', | ||
metrics: ['count(*)'], | ||
order_desc: true, | ||
}; | ||
const expectedQueryObject = normalizeOrderBy(query); | ||
expect(expectedQueryObject).not.toHaveProperty('timeseries_limit_metric'); | ||
expect(expectedQueryObject).not.toHaveProperty('order_desc'); | ||
expect(expectedQueryObject).toEqual({ | ||
datasource: '5__table', | ||
viz_type: 'table', | ||
time_range: '1 year ago : 2013', | ||
metrics: ['count(*)'], | ||
orderby: [['count(*)', false]], | ||
}); | ||
}); | ||
|
||
it('should not change', () => { | ||
const query: QueryObject = { | ||
datasource: '5__table', | ||
viz_type: 'table', | ||
time_range: '1 year ago : 2013', | ||
}; | ||
expect(normalizeOrderBy(query)).toEqual(query); | ||
}); | ||
|
||
it('remove empty orderby', () => { | ||
const query: QueryObject = { | ||
datasource: '5__table', | ||
viz_type: 'table', | ||
time_range: '1 year ago : 2013', | ||
orderby: [], | ||
}; | ||
expect(normalizeOrderBy(query)).not.toHaveProperty('orderby'); | ||
}); | ||
|
||
it('remove orderby with an empty array', () => { | ||
const query: QueryObject = { | ||
datasource: '5__table', | ||
viz_type: 'table', | ||
time_range: '1 year ago : 2013', | ||
orderby: [[]], | ||
}; | ||
expect(normalizeOrderBy(query)).not.toHaveProperty('orderby'); | ||
}); | ||
|
||
it('remove orderby with an empty metric', () => { | ||
const query: QueryObject = { | ||
datasource: '5__table', | ||
viz_type: 'table', | ||
time_range: '1 year ago : 2013', | ||
orderby: [['', true]], | ||
}; | ||
expect(normalizeOrderBy(query)).not.toHaveProperty('orderby'); | ||
}); | ||
|
||
it('remove orderby with an empty adhoc metric', () => { | ||
const query: QueryObject = { | ||
datasource: '5__table', | ||
viz_type: 'table', | ||
time_range: '1 year ago : 2013', | ||
orderby: [[{}, true]], | ||
}; | ||
expect(normalizeOrderBy(query)).not.toHaveProperty('orderby'); | ||
}); | ||
|
||
it('remove orderby with an non-boolean type', () => { | ||
const query: QueryObject = { | ||
datasource: '5__table', | ||
viz_type: 'table', | ||
time_range: '1 year ago : 2013', | ||
orderby: [['count(*)', 'true']], | ||
}; | ||
expect(normalizeOrderBy(query)).not.toHaveProperty('orderby'); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters