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

chore(native-filters): Grid units, type guard, feature flag guard #22307

Merged
merged 6 commits into from
Dec 2, 2022
Merged
Show file tree
Hide file tree
Changes from all 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 @@ -91,7 +91,7 @@ export type Filter = {
description: string;
};

export type FilterWithDataMask = Filter & { dataMask?: DataMaskWithId };
export type FilterWithDataMask = Filter & { dataMask: DataMaskWithId };

export type Divider = Partial<Omit<Filter, 'id' | 'type'>> & {
id: string;
Expand All @@ -106,6 +106,15 @@ export function isNativeFilter(
return filterElement.type === NativeFilterType.NATIVE_FILTER;
}

export function isNativeFilterWithDataMask(
filterElement: Filter | Divider,
): filterElement is FilterWithDataMask {
return (
isNativeFilter(filterElement) &&
(filterElement as FilterWithDataMask).dataMask?.filterState?.value
);
}

export function isFilterDivider(
filterElement: Filter | Divider,
): filterElement is Divider {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,27 +21,50 @@ import {
isFilterDivider,
Filter,
NativeFilterType,
FilterWithDataMask,
Divider,
isNativeFilterWithDataMask,
} from '@superset-ui/core';

test('should do native filter type guard', () => {
const dummyFilter: Filter = {
cascadeParentIds: [],
defaultDataMask: {},
id: 'dummyID',
name: 'dummyName',
scope: { rootPath: [], excluded: [] },
filterType: 'dummyType',
targets: [{}],
controlValues: {},
type: NativeFilterType.NATIVE_FILTER,
description: 'dummyDesc',
};
expect(isNativeFilter(dummyFilter)).toBeTruthy();
expect(
isFilterDivider({
...dummyFilter,
type: NativeFilterType.DIVIDER,
title: 'dummyTitle',
}),
).toBeTruthy();
const filter: Filter = {
cascadeParentIds: [],
defaultDataMask: {},
id: 'filter_id',
name: 'Filter Name',
scope: { rootPath: [], excluded: [] },
filterType: 'filter_type',
targets: [{}],
controlValues: {},
type: NativeFilterType.NATIVE_FILTER,
description: 'Filter description.',
};

const filterWithDataMask: FilterWithDataMask = {
...filter,
dataMask: { id: 'data_mask_id', filterState: { value: 'Filter value' } },
};

const filterDivider: Divider = {
id: 'divider_id',
type: NativeFilterType.DIVIDER,
title: 'Divider title',
description: 'Divider description.',
};

test('filter type guard', () => {
expect(isNativeFilter(filter)).toBeTruthy();
expect(isNativeFilter(filterWithDataMask)).toBeTruthy();
expect(isNativeFilter(filterDivider)).toBeFalsy();
});

test('filter with dataMask type guard', () => {
expect(isNativeFilterWithDataMask(filter)).toBeFalsy();
expect(isNativeFilterWithDataMask(filterWithDataMask)).toBeTruthy();
expect(isNativeFilterWithDataMask(filterDivider)).toBeFalsy();
});

test('filter divider type guard', () => {
expect(isFilterDivider(filter)).toBeFalsy();
expect(isFilterDivider(filterWithDataMask)).toBeFalsy();
expect(isFilterDivider(filterDivider)).toBeTruthy();
});
4 changes: 3 additions & 1 deletion superset-frontend/src/dashboard/actions/hydrate.js
Original file line number Diff line number Diff line change
Expand Up @@ -430,7 +430,9 @@ export const hydrateDashboard =
conf: common?.conf,
},
filterBarOrientation:
metadata.filter_bar_orientation ?? FilterBarOrientation.VERTICAL,
(isFeatureEnabled(FeatureFlag.HORIZONTAL_FILTER_BAR) &&
metadata.filter_bar_orientation) ||
FilterBarOrientation.VERTICAL,
},
dataMask,
dashboardFilters,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ import {
css,
SupersetTheme,
t,
isNativeFilter,
isFeatureEnabled,
FeatureFlag,
isNativeFilterWithDataMask,
} from '@superset-ui/core';
import {
createHtmlPortalNode,
Expand Down Expand Up @@ -140,8 +140,8 @@ const FilterControls: FC<FilterControlsProps> = ({

const activeOverflowedFiltersInScope = useMemo(
() =>
overflowedFiltersInScope.filter(
filter => isNativeFilter(filter) && filter.dataMask?.filterState?.value,
overflowedFiltersInScope.filter(filter =>
isNativeFilterWithDataMask(filter),
).length,
[overflowedFiltersInScope],
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ const HorizontalOverflowDivider = ({
display: block;
font-size: ${theme.typography.sizes.s}px;
color: ${theme.colors.grayscale.base};
margin: ${theme.gridUnit * 2.5}px 0 0 0;
margin: ${theme.gridUnit * 2}px 0 0 0;
line-height: 1;
`}
>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ import {
DataMaskStateWithId,
Divider,
Filter,
FilterWithDataMask,
isFilterDivider,
} from '@superset-ui/core';
import { FilterBarOrientation } from 'src/dashboard/types';
Expand All @@ -38,7 +37,7 @@ export const useFilterControlFactory = (
) => {
const filters = useFilters();
const filterValues = useMemo(() => Object.values(filters), [filters]);
const filtersWithValues: (FilterWithDataMask | Divider)[] = useMemo(
const filtersWithValues: (Filter | Divider)[] = useMemo(
() =>
filterValues.map(filter => ({
...filter,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ import {
FilterConfiguration,
Divider,
isFilterDivider,
FilterWithDataMask,
} from '@superset-ui/core';
import { ActiveTabs, DashboardLayout, RootState } from '../../types';
import { TAB_TYPE } from '../../util/componentTypes';
Expand Down Expand Up @@ -110,15 +109,13 @@ function useIsFilterInScope() {
}));
}

export function useSelectFiltersInScope(
filters: (FilterWithDataMask | Divider)[],
) {
export function useSelectFiltersInScope(filters: (Filter | Divider)[]) {
const dashboardHasTabs = useDashboardHasTabs();
const isFilterInScope = useIsFilterInScope();

return useMemo(() => {
let filtersInScope: (FilterWithDataMask | Divider)[] = [];
const filtersOutOfScope: (FilterWithDataMask | Divider)[] = [];
let filtersInScope: (Filter | Divider)[] = [];
const filtersOutOfScope: (Filter | Divider)[] = [];

// we check native filters scopes only on dashboards with tabs
if (!dashboardHasTabs) {
Expand Down