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.

Sign up for GitHub

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

fix(dashboard): Fill form with the latest values when undo in native filters #16851

Merged
merged 6 commits into from
Sep 27, 2021
Merged

fix(dashboard): Fill form with the latest values when undo in native filters #16851

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
74984dc
Set undoFormValues
geido Sep 25, 2021
c67f0b6
Reorganize
geido Sep 25, 2021
fe5c420
Revert check
geido Sep 25, 2021
169508e
Fix and clean up
geido Sep 25, 2021
f6151c6
Fix pre-filter and sort values
geido Sep 27, 2021
3e9c827
Merge branch 'master' of https://github.com/apache/superset into fix/…
geido Sep 27, 2021
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
155 changes: 89 additions & 66 deletions ...board/components/nativeFilters/FiltersConfigModal/FiltersConfigForm/FiltersConfigForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,12 +315,15 @@ const FiltersConfigForm = (
const [activeFilterPanelKey, setActiveFilterPanelKey] = useState<
string | string[]
>(FilterPanels.basic.key);

const [undoFormValues, setUndoFormValues] = useState<Record<
string,
any
> | null>(null);
const forceUpdate = useForceUpdate();
const [datasetDetails, setDatasetDetails] = useState<Record<string, any>>();
const defaultFormFilter = useMemo(() => ({}), []);
const formFilter =
form.getFieldValue('filters')?.[filterId] || defaultFormFilter;
const formValues = form.getFieldValue('filters')?.[filterId];
const formFilter = formValues || undoFormValues || defaultFormFilter;

const nativeFilterItems = getChartMetadataRegistry().items;
const nativeFilterVizTypes = Object.entries(nativeFilterItems)
Expand All @@ -346,11 +349,11 @@ const FiltersConfigForm = (

const showTimeRangePicker = useMemo(() => {
const currentDataset = Object.values(loadedDatasets).find(
dataset => dataset.id === formFilter.dataset?.value,
dataset => dataset.id === formFilter?.dataset?.value,
);

return currentDataset ? hasTemporalColumns(currentDataset) : true;
}, [formFilter.dataset?.value, loadedDatasets]);
}, [formFilter?.dataset?.value, loadedDatasets]);

// @ts-ignore
const hasDataset = !!nativeFilterItems[formFilter?.filterType]?.value
Expand All @@ -368,7 +371,7 @@ const FiltersConfigForm = (
forceUpdate,
form,
filterId,
filterType: formFilter.filterType,
filterType: formFilter?.filterType,
filterToEdit,
formFilter,
removed,
Expand All @@ -380,31 +383,6 @@ const FiltersConfigForm = (
// @ts-ignore
const enableNoResults = !!nativeFilterItem.value?.enableNoResults;

useEffect(() => {
if (datasetId) {
cachedSupersetGet({
endpoint: `/api/v1/dataset/${datasetId}`,
})
.then((response: JsonResponse) => {
setMetrics(response.json?.result?.metrics);
const dataset = response.json?.result;
// modify the response to fit structure expected by AdhocFilterControl
dataset.type = dataset.datasource_type;
dataset.filter_select = true;
setDatasetDetails(dataset);
})
.catch((response: SupersetApiError) => {
addDangerToast(response.message);
});
}
}, [datasetId]);

useImperativeHandle(ref, () => ({
changeTab(tab: 'configuration' | 'scoping') {
setActiveTabKey(tab);
},
}));

const hasMetrics = hasColumn && !!metrics.length;

const hasFilledDataset =
Expand All @@ -418,8 +396,6 @@ const FiltersConfigForm = (

const isDataDirty = formFilter?.isDataDirty ?? true;

useBackendFormUpdate(form, filterId);

const setNativeFilterFieldValuesWrapper = (values: object) => {
setNativeFilterFieldValues(form, filterId, values);
setError('');
Expand Down Expand Up @@ -513,20 +489,6 @@ const FiltersConfigForm = (
const showDataset =
!datasetId || datasetDetails || formFilter?.dataset?.label;

useEffect(() => {
if (hasDataset && hasFilledDataset && hasDefaultValue && isDataDirty) {
refreshHandler();
}
}, [
hasDataset,
hasFilledDataset,
hasDefaultValue,
formFilter,
isDataDirty,
refreshHandler,
showDataset,
]);

const formChanged = useCallback(() => {
form.setFields([
{
Expand All @@ -550,15 +512,21 @@ const FiltersConfigForm = (
}));

const parentFilter = parentFilterOptions.find(
({ value }) => value === filterToEdit?.cascadeParentIds[0],
({ value }) =>
value === formFilter?.parentFilter?.value ||
value === filterToEdit?.cascadeParentIds?.[0],
);

const hasParentFilter = !!parentFilter;

const hasPreFilter =
!!filterToEdit?.adhoc_filters || !!filterToEdit?.time_range;
!!formFilter?.adhoc_filters ||
!!formFilter?.time_range ||
!!filterToEdit?.adhoc_filters?.length ||
!!filterToEdit?.time_range;
Comment on lines -559 to +526
Copy link
Member

Choose a reason for hiding this comment

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

should we also change it to formFilter?.adhoc_filters?.length || like it is later for filterToEdit, just in case?

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks for your feedback! It appears that when the form doesn't have any filters it will just return undefined, reason why I am only checking for that here


const hasSorting =
typeof formFilter?.controlValues?.sortAscending === 'boolean' ||
typeof filterToEdit?.controlValues?.sortAscending === 'boolean';

let sort = filterToEdit?.controlValues?.sortAscending;
Expand Down Expand Up @@ -604,7 +572,7 @@ const FiltersConfigForm = (
formFilter?.filterType === 'filter_range';

const initialDefaultValue =
formFilter.filterType === filterToEdit?.filterType
formFilter?.filterType === filterToEdit?.filterType
? filterToEdit?.defaultDataMask
: null;

Expand All @@ -622,6 +590,62 @@ const FiltersConfigForm = (
.some(key => controlItems[key].checked);
}

const ParentSelect = ({
value,
...rest
}: {
value?: { value: string | number };
}) => (
<Select
ariaLabel={t('Parent filter')}
placeholder={t('None')}
options={parentFilterOptions}
allowClear
value={value?.value}
{...rest}
/>
);

useEffect(() => {
if (datasetId) {
cachedSupersetGet({
endpoint: `/api/v1/dataset/${datasetId}`,
})
.then((response: JsonResponse) => {
setMetrics(response.json?.result?.metrics);
const dataset = response.json?.result;
// modify the response to fit structure expected by AdhocFilterControl
dataset.type = dataset.datasource_type;
dataset.filter_select = true;
setDatasetDetails(dataset);
})
.catch((response: SupersetApiError) => {
addDangerToast(response.message);
});
}
}, [datasetId]);

useImperativeHandle(ref, () => ({
changeTab(tab: 'configuration' | 'scoping') {
setActiveTabKey(tab);
},
}));

useBackendFormUpdate(form, filterId);

useEffect(() => {
if (hasDataset && hasFilledDataset && hasDefaultValue && isDataDirty) {
refreshHandler();
}
}, [
hasDataset,
hasFilledDataset,
hasDefaultValue,
isDataDirty,
refreshHandler,
showDataset,
]);

useEffect(() => {
const activeFilterPanelKey = [FilterPanels.basic.key];
if (hasCheckedAdvancedControl) {
Expand Down Expand Up @@ -652,21 +676,20 @@ const FiltersConfigForm = (
JSON.stringify(loadedDatasets),
]);

const ParentSelect = ({
value,
...rest
}: {
value?: { value: string | number };
}) => (
<Select
ariaLabel={t('Parent filter')}
placeholder={t('None')}
options={parentFilterOptions}
allowClear
value={value?.value}
{...rest}
/>
);
useEffect(() => {
// just removed, saving current form items for eventual undo
if (removed) {
setUndoFormValues(formValues);
}
}, [removed]);

useEffect(() => {
// the filter was just restored after undo
if (undoFormValues && !removed) {
setNativeFilterFieldValues(form, filterId, undoFormValues);
setUndoFormValues(null);
}
}, [formValues, filterId, form, removed, undoFormValues]);

if (removed) {
return <RemovedFilter onClick={() => restoreFilter(filterId)} />;
Expand Down Expand Up @@ -814,7 +837,7 @@ const FiltersConfigForm = (
formChanged();
}}
>
{formFilter.filterType && (
{!removed && (
<StyledRowSubFormItem
name={['filters', filterId, 'defaultDataMask']}
initialValue={initialDefaultValue}
Expand Down