Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Fix #65501 - Resets search back to first page when filters change (#66104)

Brad Anderson76cf73dde5d1
diff --git a/e2e/test/scenarios/search/search-pagination.cy.spec.js b/e2e/test/scenarios/search/search-pagination.cy.spec.js
index 86207ba5e71..1250247cd76 100644
--- a/e2e/test/scenarios/search/search-pagination.cy.spec.js
+++ b/e2e/test/scenarios/search/search-pagination.cy.spec.js
@@ -25,35 +25,58 @@ describe("scenarios > search", () => {
H.getSearchBar().type(" ");
});
- it("should allow users to paginate results", () => {
- generateQuestions(TOTAL_ITEMS);
+ describe("multiple pages of results", () => {
+ before(() => {
+ cy.signInAsAdmin();
+ H.restore();
+ generateQuestions(TOTAL_ITEMS);
+ H.snapshot("many-questions");
+ });
+
+ beforeEach(() => {
+ H.restore("many-questions");
+ });
- cy.visit("/");
- H.commandPaletteSearch("generated_question");
- cy.findByLabelText("Previous page").should("be.disabled");
+ it("should allow users to paginate results", () => {
+ cy.visit("/");
+ H.commandPaletteSearch("generated_question");
+ cy.findByLabelText("Previous page").should("be.disabled");
- // First page
- // eslint-disable-next-line no-unscoped-text-selectors -- deprecated usage
- cy.findByText(`1 - ${PAGE_SIZE}`);
- cy.findByTestId("pagination-total").should("have.text", TOTAL_ITEMS);
- cy.findAllByTestId("search-result-item").should("have.length", PAGE_SIZE);
+ // First page
+ // eslint-disable-next-line no-unscoped-text-selectors -- deprecated usage
+ cy.findByText(`1 - ${PAGE_SIZE}`);
+ cy.findByTestId("pagination-total").should("have.text", TOTAL_ITEMS);
+ cy.findAllByTestId("search-result-item").should("have.length", PAGE_SIZE);
- cy.findByLabelText("Next page").click();
+ cy.findByLabelText("Next page").click();
- // Second page
- // eslint-disable-next-line no-unscoped-text-selectors -- deprecated usage
- cy.findByText(`${PAGE_SIZE + 1} - ${TOTAL_ITEMS}`);
- cy.findByTestId("pagination-total").should("have.text", TOTAL_ITEMS);
- cy.findAllByTestId("search-result-item").should("have.length", 1);
- cy.findByLabelText("Next page").should("be.disabled");
+ // Second page
+ // eslint-disable-next-line no-unscoped-text-selectors -- deprecated usage
+ cy.findByText(`${PAGE_SIZE + 1} - ${TOTAL_ITEMS}`);
+ cy.findByTestId("pagination-total").should("have.text", TOTAL_ITEMS);
+ cy.findAllByTestId("search-result-item").should("have.length", 1);
+ cy.findByLabelText("Next page").should("be.disabled");
- cy.findByLabelText("Previous page").click();
+ cy.findByLabelText("Previous page").click();
- // First page
- // eslint-disable-next-line no-unscoped-text-selectors -- deprecated usage
- cy.findByText(`1 - ${PAGE_SIZE}`);
- cy.findByTestId("pagination-total").should("have.text", TOTAL_ITEMS);
- cy.findAllByTestId("search-result-item").should("have.length", PAGE_SIZE);
+ // First page
+ // eslint-disable-next-line no-unscoped-text-selectors -- deprecated usage
+ cy.findByText(`1 - ${PAGE_SIZE}`);
+ cy.findByTestId("pagination-total").should("have.text", TOTAL_ITEMS);
+ cy.findAllByTestId("search-result-item").should("have.length", PAGE_SIZE);
+ });
+
+ it("should reset the page when filters change (metabase#65501)", () => {
+ cy.visit("/search?q=");
+ cy.findByLabelText("Next page").click();
+ cy.findByTestId("type-search-filter").click();
+ H.popover().findByText("Table").click();
+ H.popover().findByText("Apply").click();
+ cy.findByTestId("search-app")
+ .findByText("Didn't find anything")
+ .should("not.exist");
+ cy.findAllByTestId("search-result-item").should("exist");
+ });
});
});
diff --git a/frontend/src/metabase/search/containers/SearchApp.jsx b/frontend/src/metabase/search/containers/SearchApp.jsx
index cea98ee2e09..b8ed5bd7a05 100644
--- a/frontend/src/metabase/search/containers/SearchApp.jsx
+++ b/frontend/src/metabase/search/containers/SearchApp.jsx
@@ -9,7 +9,6 @@ import EmptyState from "metabase/common/components/EmptyState";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import { PaginationControls } from "metabase/common/components/PaginationControls";
import { NoObjectError } from "metabase/common/components/errors/NoObjectError";
-import { usePagination } from "metabase/common/hooks/use-pagination";
import Search from "metabase/entities/search";
import { usePageTitle } from "metabase/hooks/use-page-title";
import { useDispatch } from "metabase/lib/redux";
@@ -32,12 +31,19 @@ import {
} from "metabase/search/utils";
import { Box, Group, Paper, Text } from "metabase/ui";
+const getPageFromLocation = (location) => {
+ const maybePage = location.query?.page
+ ? parseInt(location.query.page, 10)
+ : 0;
+ return maybePage || 0;
+};
+
function SearchApp({ location }) {
const dispatch = useDispatch();
usePageTitle(t`Search`);
- const { handleNextPage, handlePreviousPage, page } = usePagination();
+ const page = getPageFromLocation(location);
const searchText = useMemo(
() => getSearchTextFromLocation(location),
@@ -75,6 +81,13 @@ function SearchApp({ location }) {
[onChangeLocation, searchText],
);
+ const advancePage = (howMany = 1) => {
+ onChangeLocation({
+ pathname: "search",
+ query: { q: searchText.trim(), ...searchFilters, page: page + howMany },
+ });
+ };
+
const { data, error, isFetching, requestId } = useSearchQuery(query);
const list = useMemo(() => {
return data?.data?.map((item) => Search.wrapEntity(item, dispatch)) ?? [];
@@ -122,8 +135,8 @@ function SearchApp({ location }) {
page={page}
itemsLength={list.length}
total={data.total}
- onNextPage={handleNextPage}
- onPreviousPage={handlePreviousPage}
+ onNextPage={() => advancePage(1)}
+ onPreviousPage={() => advancePage(-1)}
/>
</Group>
</Box>