Skip to content

fix: improve search UX on initial store load #4843

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
merged 1 commit into from
Sep 5, 2024
Merged

fix: improve search UX on initial store load #4843

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 9 additions & 15 deletions static/js/store/pages/Packages/Packages.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { useState, useEffect, useRef, ReactNode } from "react";
import { useState, useRef, ReactNode } from "react";
import { useQuery } from "react-query";
import { useLocation, useSearchParams } from "react-router-dom";
import { v4 as uuidv4 } from "uuid";
Expand Down Expand Up @@ -48,17 +48,18 @@ function Packages(): ReactNode {

const { search } = useLocation();
const [searchParams, setSearchParams] = useSearchParams();
const [initialLoad, setInitialLoad] = useState(true);

const [hideFilters, setHideFilters] = useState(true);
const currentPage = searchParams.get("page") || "1";

let queryString = search;
if (!search || (!searchParams.get("categories") && !searchParams.get("q") && !searchParams.get("architecture"))) {
queryString = "?categories=featured";
queryString = `?categories=featured&page=${currentPage}`;
} else {
queryString += `&page=${currentPage}`;
}

const { data, status, refetch, isFetching } = useQuery(
const { data, status, isFetching } = useQuery(
["data", queryString],
() => getData(queryString),
{
Expand All @@ -69,17 +70,6 @@ function Packages(): ReactNode {
const searchRef = useRef<HTMLInputElement | null>(null);
const searchSummaryRef = useRef<HTMLDivElement>(null);

useEffect(() => {
if (initialLoad) {
if (!searchParams.get("categories") && !searchParams.get("q") && !searchParams.get("architecture")) {
searchParams.set("categories", "featured");
setSearchParams(searchParams);
}
setInitialLoad(false);
}
refetch();
}, [searchParams]);

const packagesCount = data?.packages ? data?.packages.length : 0;

const firstResultNumber = (parseInt(currentPage) - 1) * ITEMS_PER_PAGE + 1;
Expand Down Expand Up @@ -141,6 +131,10 @@ function Packages(): ReactNode {
}

const getResultsTitle = () => {
if (searchParams.get("q")) {
return "Snaps";
}

if (isFeatured) {
return "Featured snaps";
}
Expand Down
12 changes: 6 additions & 6 deletions static/js/store/pages/Packages/__tests__/Packages.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,11 +139,11 @@ const renderComponent = (
};

describe("Packages", () => {
test("featured categories are called by deafult", async () => {
test("featured categories are called by default", async () => {
renderComponent();
await waitFor(() => {
expect(global.fetch).toHaveBeenCalledWith(
"/store.json?categories=featured"
"/store.json?categories=featured&page=1"
);
});
});
Expand All @@ -154,7 +154,7 @@ describe("Packages", () => {
await user.click(screen.getByLabelText("Development"));
await waitFor(() => {
expect(global.fetch).toHaveBeenCalledWith(
"/store.json?categories=development"
"/store.json?categories=development&page=1"
);
});
});
Expand All @@ -167,7 +167,7 @@ describe("Packages", () => {
await user.click(screen.getByLabelText("Development"));
await waitFor(() => {
expect(global.fetch).toHaveBeenCalledWith(
"/store.json?categories=development&q=code"
"/store.json?categories=development&q=code&page=1"
);
});
});
Expand All @@ -178,7 +178,7 @@ describe("Packages", () => {
await user.type(screen.getByLabelText("Search Snapcraft"), "code");
await user.click(screen.getByRole("button", { name: "Search" }));
await waitFor(() => {
expect(global.fetch).toHaveBeenCalledWith("/store.json?q=code");
expect(global.fetch).toHaveBeenCalledWith("/store.json?q=code&page=1");
});
});

Expand Down Expand Up @@ -262,7 +262,7 @@ describe("Packages", () => {
await user.click(screen.getByLabelText("Development"));
await waitFor(() => {
expect(global.fetch).toHaveBeenCalledWith(
"/store.json?categories=development"
"/store.json?categories=development&page=1"
);
});
});
Expand Down