Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(native-filters): Time native filter #12992

Merged
merged 22 commits into from
Feb 13, 2021
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ const FilterValue: React.FC<FilterProps> = ({
defaultValue,
currentValue,
inverseSelection,
inputRef,
});
if (!areObjectsEqual(formData || {}, newFormData)) {
setFormData(newFormData);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -249,8 +249,8 @@ export const FilterConfigForm: React.FC<FilterConfigFormProps> = ({
formFilter?.column &&
formFilter?.defaultValueQueriesData && (
<SuperChart
height={20}
width={220}
height={25}
width={250}
formData={newFormData}
queriesData={formFilter?.defaultValueQueriesData}
chartType={formFilter?.filterType}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -506,6 +506,7 @@ export function FilterConfigModal({
return (
<StyledModal
visible={isOpen}
maskClosable={false}
title={t('Filter configuration and scoping')}
width="55%"
destroyOnClose
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ export const findFilterScope = (
export const FilterTypeNames = {
[FilterType.filter_select]: t('Select'),
[FilterType.filter_range]: t('Range'),
[FilterType.filter_time]: t('Time'),
};

export const setFilterFieldValues = (
Expand All @@ -177,18 +178,3 @@ export const setFilterFieldValues = (

export const isScopingAll = (scope: Scope) =>
!scope || (scope.rootPath[0] === DASHBOARD_ROOT_ID && !scope.excluded.length);

type AppendFormData = {
filters: {
val?: number | string | null;
}[];
};

export const extractDefaultValue = {
[FilterType.filter_select]: (appendFormData: AppendFormData) =>
appendFormData.filters?.[0]?.val,
[FilterType.filter_range]: (appendFormData: AppendFormData) => ({
min: appendFormData.filters?.[0].val,
max: appendFormData.filters?.[1].val,
}),
};
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ export interface Scope {
export enum FilterType {
filter_select = 'filter_select',
filter_range = 'filter_range',
filter_time = 'filter_time',
}

/** The target of a filter is the datasource/column being filtered */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,12 @@ export default function DateFilterControl(props: DateFilterLabelProps) {
setShow(false);
}

function onOpen() {
setTimeRangeValue(value);
setFrame(guessFrame(value));
setShow(true);
}

function onHide() {
setTimeRangeValue(value);
setFrame(guessFrame(value));
Expand Down Expand Up @@ -355,7 +361,7 @@ export default function DateFilterControl(props: DateFilterLabelProps) {
<Label
className="pointer"
data-test="time-range-trigger"
onClick={() => setShow(true)}
onClick={onOpen}
>
{actualTimeRange}
</Label>
Expand Down
70 changes: 70 additions & 0 deletions superset-frontend/src/filters/components/Time/AntdTimeFilter.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
/**
* 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 { styled } from '@superset-ui/core';
import React, { useState, useEffect } from 'react';
import DateFilterControl from 'src/explore/components/controls/DateFilterControl/DateFilterControl';
import { AntdPluginFilterStylesProps } from '../types';
import { AntdPluginFilterTimeProps } from './types';

const DEFAULT_VALUE = 'Last week';

const Styles = styled.div<AntdPluginFilterStylesProps>`
height: ${({ height }) => height}px;
width: ${({ width }) => width}px;
overflow-x: scroll;
`;

export default function AntdTimeFilter(props: AntdPluginFilterTimeProps) {
const { formData, setExtraFormData, width } = props;
const { defaultValue, currentValue } = formData;

const [value, setValue] = useState<string>(defaultValue ?? DEFAULT_VALUE);

const handleTimeRangeChange = (timeRange: string): void => {
setExtraFormData({
// @ts-ignore
extraFormData: {
override_form_data: {
time_range: timeRange,
zhaoyongjie marked this conversation as resolved.
Show resolved Hide resolved
},
},
currentState: { value: timeRange },
});
setValue(timeRange);
};

useEffect(() => {
setValue(currentValue ?? DEFAULT_VALUE);
}, [currentValue]);

useEffect(() => {
setValue(defaultValue ?? DEFAULT_VALUE);
}, [defaultValue]);

return (
// @ts-ignore
<Styles width={width}>
<DateFilterControl
value={value}
name=""
Copy link
Member

@zhaoyongjie zhaoyongjie Feb 12, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one nit:
could we set a default name for DateFilterControl ?

onChange={handleTimeRangeChange}
/>
</Styles>
);
}
26 changes: 26 additions & 0 deletions superset-frontend/src/filters/components/Time/controlPanel.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
/**
* 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 { ControlPanelConfig } from '@superset-ui/chart-controls';

const config: ControlPanelConfig = {
// For control input types, see: superset-frontend/src/explore/components/controls/index.js
controlPanelSections: [],
};

export default config;
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 40 additions & 0 deletions superset-frontend/src/filters/components/Time/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
/**
* 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 { Behavior, ChartMetadata, ChartPlugin, t } from '@superset-ui/core';
import controlPanel from './controlPanel';
import transformProps from './transformProps';
import thumbnail from './images/thumbnail.png';

export default class TimeFilterPlugin extends ChartPlugin {
constructor() {
const metadata = new ChartMetadata({
name: t('Time range filter plugin'),
description: 'Custom time filter plugin',
behaviors: [Behavior.NATIVE_FILTER],
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it can be also CROSS_FILTER

thumbnail,
});

super({
controlPanel,
loadChart: () => import('./AntdTimeFilter'),
metadata,
transformProps,
});
}
}
37 changes: 37 additions & 0 deletions superset-frontend/src/filters/components/Time/transformProps.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
/**
* 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 { ChartProps } from '@superset-ui/core';
import { DEFAULT_FORM_DATA } from './types';

export default function transformProps(chartProps: ChartProps) {
const { formData, height, hooks, queriesData, width } = chartProps;
const { setExtraFormData } = hooks;
const { data } = queriesData[0];

return {
data,
formData: {
...DEFAULT_FORM_DATA,
...formData,
},
height,
setExtraFormData,
width,
};
}
44 changes: 44 additions & 0 deletions superset-frontend/src/filters/components/Time/types.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
/**
* 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 {
QueryFormData,
DataRecord,
SetExtraFormDataHook,
} from '@superset-ui/core';
import { AntdPluginFilterStylesProps } from '../types';

interface PluginFilterTimeCustomizeProps {
defaultValue?: string | null;
currentValue?: string | null;
}

export type AntdPluginFilterSelectQueryFormData = QueryFormData &
AntdPluginFilterStylesProps &
PluginFilterTimeCustomizeProps;

export type AntdPluginFilterTimeProps = AntdPluginFilterStylesProps & {
data: DataRecord[];
setExtraFormData: SetExtraFormDataHook;
formData: AntdPluginFilterSelectQueryFormData;
};

export const DEFAULT_FORM_DATA: PluginFilterTimeCustomizeProps = {
defaultValue: null,
currentValue: null,
};
1 change: 1 addition & 0 deletions superset-frontend/src/filters/components/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@
*/
export { default as AntdSelectFilterPlugin } from './Select';
export { default as AntdRangeFilterPlugin } from './Range';
export { default as TimeFilterPlugin } from './Time';
2 changes: 2 additions & 0 deletions superset-frontend/src/visualizations/presets/MainPreset.js
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ import {
import {
AntdSelectFilterPlugin,
AntdRangeFilterPlugin,
TimeFilterPlugin,
} from 'src/filters/components/';
import FilterBoxChartPlugin from '../FilterBox/FilterBoxChartPlugin';
import TimeTableChartPlugin from '../TimeTable/TimeTableChartPlugin';
Expand Down Expand Up @@ -113,6 +114,7 @@ export default class MainPreset extends Preset {
}),
new AntdSelectFilterPlugin().configure({ key: 'filter_select' }),
new AntdRangeFilterPlugin().configure({ key: 'filter_range' }),
new TimeFilterPlugin().configure({ key: 'filter_time' }),
],
});
}
Expand Down
2 changes: 2 additions & 0 deletions superset/utils/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -1036,6 +1036,8 @@ def merge_extra_filters( # pylint: disable=too-many-branches
extra_form_data = form_data.pop("extra_form_data", {})
append_form_data = extra_form_data.pop("append_form_data", {})
append_filters = append_form_data.get("filters", None)
override_form_data = extra_form_data.pop("override_form_data", {})
form_data.update(override_form_data)
if append_filters:
adhoc_filters.extend(
[to_adhoc({"isExtra": True, **fltr}) for fltr in append_filters if fltr]
Expand Down