Skip to content

fix: show_filters URL parameter is not working #29422

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

Merged
Vitor-Avila merged 3 commits into from
Apr 3, 2025
Merged

fix: show_filters URL parameter is not working #29422

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cfbda81
fix show_filters not working
Jul 1, 2024
abac881
Merge branch 'master' into bugfix/hide-filters
rusackas Apr 2, 2025
2c2e9f5
Reusing old logic before #23228
Vitor-Avila Apr 2, 2025
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
42 changes: 42 additions & 0 deletions superset-frontend/src/dashboard/components/DashboardBuilder/DashboardBuilder.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import {
import { storeWithState } from 'spec/fixtures/mockStore';
import mockState from 'spec/fixtures/mockState';
import { DASHBOARD_ROOT_ID } from 'src/dashboard/util/constants';
import * as useNativeFiltersModule from './state';

fetchMock.get('glob:*/csstemplateasyncmodelview/api/read', {});
fetchMock.put('glob:*/api/v1/dashboard/*', {});
Expand Down Expand Up @@ -262,4 +263,45 @@ describe('DashboardBuilder', () => {
const filterbar = getByTestId('dashboard-filters-panel');
expect(filterbar).toHaveStyleRule('width', `${expectedValue}px`);
});

it('should not render the filter bar when nativeFiltersEnabled is false', () => {
jest.spyOn(useNativeFiltersModule, 'useNativeFilters').mockReturnValue({
showDashboard: true,
missingInitialFilters: [],
dashboardFiltersOpen: true,
toggleDashboardFiltersOpen: jest.fn(),
nativeFiltersEnabled: false,
});
const { queryByTestId } = setup();

expect(queryByTestId('dashboard-filters-panel')).not.toBeInTheDocument();
});

it('should render the filter bar when nativeFiltersEnabled is true and not in edit mode', () => {
jest.spyOn(useNativeFiltersModule, 'useNativeFilters').mockReturnValue({
showDashboard: true,
missingInitialFilters: [],
dashboardFiltersOpen: true,
toggleDashboardFiltersOpen: jest.fn(),
nativeFiltersEnabled: true,
});
const { queryByTestId } = setup();

expect(queryByTestId('dashboard-filters-panel')).toBeInTheDocument();
});

it('should not render the filter bar when in edit mode even if nativeFiltersEnabled is true', () => {
jest.spyOn(useNativeFiltersModule, 'useNativeFilters').mockReturnValue({
showDashboard: true,
missingInitialFilters: [],
dashboardFiltersOpen: true,
toggleDashboardFiltersOpen: jest.fn(),
nativeFiltersEnabled: true,
});
const { queryByTestId } = setup({
dashboardState: { ...mockState.dashboardState, editMode: true },
});

expect(queryByTestId('dashboard-filters-panel')).not.toBeInTheDocument();
});
});
2 changes: 1 addition & 1 deletion superset-frontend/src/dashboard/components/DashboardBuilder/DashboardBuilder.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -467,7 +467,7 @@ const DashboardBuilder = () => {
ELEMENT_ON_SCREEN_OPTIONS,
);

const showFilterBar = !editMode;
const showFilterBar = !editMode && nativeFiltersEnabled;

const offset =
FILTER_BAR_HEADER_HEIGHT +
Expand Down
5 changes: 4 additions & 1 deletion superset-frontend/src/dashboard/components/DashboardBuilder/state.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ import {
// eslint-disable-next-line import/prefer-default-export
export const useNativeFilters = () => {
const [isInitialized, setIsInitialized] = useState(false);
const showNativeFilters = useSelector<RootState, boolean>(
state => getUrlParam(URL_PARAMS.showFilters) ?? true,
Copy link
Member

@michael-s-molina michael-s-molina Apr 3, 2025

Choose a reason for hiding this comment

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

@Vitor-Avila The original code had && state.dashboardInfo.metadata?.show_native_filters. Isn't that needed anymore?

Copy link
Contributor

@Vitor-Avila Vitor-Avila Apr 3, 2025

Choose a reason for hiding this comment

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

@michael-s-molina my understanding is that the original PR fully removed metadata.show_native_filters (from all places). I suspect the reason for it is that this metadata config was intended to permanently hide the native filters on dashboards that had filter box, until it was fully migrated. So I don't think we need that back. If we want to bring that logic, we would need to re-update the schemas, and logic in other places too.

Not sure if you had a chance to test in that ephemeral but I believe things are working properly with these changes.

);
const canEdit = useSelector<RootState, boolean>(
({ dashboardInfo }) => dashboardInfo.dash_edit_perm,
);
Expand All @@ -41,7 +44,7 @@ export const useNativeFilters = () => {
);

const nativeFiltersEnabled =
canEdit || (!canEdit && filterValues.length !== 0);
showNativeFilters && (canEdit || (!canEdit && filterValues.length !== 0));

const requiredFirstFilter = useMemo(
() => filterValues.filter(filter => filter.requiredFirst),
Expand Down
Loading