A full-featured CRM built with React, shadcn/ui, and Supabase.
Debounce the global search with ra-core's useDebouncedEvent
François Zaninotto82228b824359
diff --git a/src/components/atomic-crm/search/GlobalSearchButton.test.tsx b/src/components/atomic-crm/search/GlobalSearchButton.test.tsxindex 20ffb48a..14c87f21 100644--- a/src/components/atomic-crm/search/GlobalSearchButton.test.tsx+++ b/src/components/atomic-crm/search/GlobalSearchButton.test.tsx@@ -1,4 +1,4 @@-import { page } from "vitest/browser";+import { page, userEvent } from "vitest/browser";import type { ComponentProps } from "react";import { beforeEach, describe, expect, it } from "vitest";import { render } from "vitest-browser-react";@@ -344,6 +344,21 @@ describe("GlobalSearchDialog", () => {await expect.element(screen.getByText("No result found")).toBeVisible();});++ it("forgets a term typed just before closing", async () => {+ const screen = await render(<Dialog />);++ await screen.getByPlaceholder(PLACEHOLDER).fill("Boulangerie");+ // closes before the search debounce elapses (this Dialog stays open, as+ // its open prop does not follow the close request)+ await userEvent.keyboard("{Escape}");+ await new Promise((resolve) => setTimeout(resolve, 500));++ await expect.element(screen.getByPlaceholder(PLACEHOLDER)).toHaveValue("");+ await expect+ .element(screen.getByText("Type at least 2 characters to search"))+ .toBeVisible();+ });});describe("GlobalSearchDialog on mobile", () => {diff --git a/src/components/atomic-crm/search/GlobalSearchButton.tsx b/src/components/atomic-crm/search/GlobalSearchButton.tsxindex 3a37115c..8bbdb990 100644--- a/src/components/atomic-crm/search/GlobalSearchButton.tsx+++ b/src/components/atomic-crm/search/GlobalSearchButton.tsx@@ -1,6 +1,6 @@import { useQuery } from "@tanstack/react-query";import { Search } from "lucide-react";-import { useDataProvider, useTranslate } from "ra-core";+import { useDataProvider, useDebouncedEvent, useTranslate } from "ra-core";import { useEffect, useMemo, useState } from "react";import { useNavigate } from "react-router";@@ -126,30 +126,18 @@ const MIN_SEARCH_LENGTH = 2;const DEBOUNCE_MS = 300;const MAX_RESULTS = 50;-const useDebouncedValue = <T,>(value: T, delay: number): T => {- const [debouncedValue, setDebouncedValue] = useState(value);-- useEffect(() => {- const timeout = setTimeout(() => setDebouncedValue(value), delay);- return () => clearTimeout(timeout);- }, [value, delay]);-- return debouncedValue;-};-/**- * Run the global search for a debounced search term.+ * Run the global search for an already debounced search term.** Stays idle until the term reaches MIN_SEARCH_LENGTH, so opening the dialog* does not fire a request. `resources` restricts the query server-side, so the* row cap is spent only on resources the current layout can actually link to.*/const useGlobalSearch = (- query: string,+ debouncedQuery: string,resources: readonly SearchResourceName[],) => {const dataProvider = useDataProvider<CrmDataProvider>();- const debouncedQuery = useDebouncedValue(query.trim(), DEBOUNCE_MS);const isEnabled = debouncedQuery.length >= MIN_SEARCH_LENGTH;const { data, isPending, error } = useQuery({@@ -167,7 +155,6 @@ const useGlobalSearch = (results: isEnabled ? (data ?? []) : [],isPending: isEnabled && isPending,error,- debouncedQuery,};};@@ -201,7 +188,12 @@ export const GlobalSearchDialog = ({const navigate = useNavigate();const isMobile = useIsMobile();const [query, setQuery] = useState("");- const { results, isPending, error, debouncedQuery } = useGlobalSearch(+ const [debouncedQuery, setDebouncedQuery] = useState("");+ const updateDebouncedQuery = useDebouncedEvent(+ setDebouncedQuery,+ DEBOUNCE_MS,+ );+ const { results, isPending, error } = useGlobalSearch(query,isMobile ? MOBILE_SEARCH_RESOURCES : DESKTOP_SEARCH_RESOURCES,);@@ -220,6 +212,9 @@ export const GlobalSearchDialog = ({const handleOpenChange = (nextOpen: boolean) => {if (!nextOpen) {setQuery("");+ setDebouncedQuery("");+ // replaces an update still pending from the last keystroke+ updateDebouncedQuery("");}onOpenChange(nextOpen);};@@ -262,7 +257,10 @@ export const GlobalSearchDialog = ({<CommandInputplaceholder={translate("crm.search.placeholder")}value={query}- onValueChange={setQuery}+ onValueChange={(value) => {+ setQuery(value);+ updateDebouncedQuery(value.trim());+ }}// keep the text clear of the dialog's close button, drawn over the// input's right endclassName="pr-8"