Merge pull request #7434 from GeorgiZhelev/autocomplete-faster-local-search

Skip 400ms search throttle for in-memory autocomplete filtering

Author: gonzaloriestra

.changeset/autocomplete-instant-local-search.md

@@ -0,0 +1,5 @@
+---
+'@shopify/cli-kit': patch
+---
+
+Make the autocomplete prompt feel instant when filtering against in-memory choices.

packages/cli-kit/src/private/node/ui/components/AutocompletePrompt.test.tsx

@@ -620,6 +620,34 @@ describe('AutocompletePrompt', async () => {
     `)
   })
 
+  test('searchDebounceMs: 0 invokes search on every keystroke without throttling', async () => {
+    const search = vi.fn(async (term: string) => ({
+      data: DATABASE.filter((item) => item.label.includes(term)),
+    }))
+
+    const renderInstance = render(
+      <AutocompletePrompt
+        message="Associate your project with the org Castile Ventures?"
+        choices={DATABASE}
+        onSubmit={() => {}}
+        search={search}
+        searchDebounceMs={0}
+      />,
+    )
+
+    await waitForInputsToBeReady()
+    await sendInputAndWaitForChange(renderInstance, 'f')
+    await sendInputAndWaitForChange(renderInstance, 'i')
+    await sendInputAndWaitForChange(renderInstance, 'r')
+
+    // With the default 400ms throttle, three rapid keystrokes coalesce to ~2 calls
+    // (leading + trailing edge). With searchDebounceMs=0, each keystroke fires.
+    expect(search).toHaveBeenCalledTimes(3)
+    expect(search).toHaveBeenNthCalledWith(1, 'f')
+    expect(search).toHaveBeenNthCalledWith(2, 'fi')
+    expect(search).toHaveBeenNthCalledWith(3, 'fir')
+  })
+
   test('displays an error message if the search fails', async () => {
     const search = (_term: string) => {
       return Promise.reject(new Error('Something went wrong'))

packages/cli-kit/src/private/node/ui/components/AutocompletePrompt.tsx

@@ -28,9 +28,17 @@ export interface AutocompletePromptProps<T> {
   abortSignal?: AbortSignal
   infoMessage?: InfoMessageProps['message']
   groupOrder?: string[]
+  /**
+   * Throttle window in milliseconds applied to the search callback. Defaults to 400ms,
+   * which is appropriate for remote/paginated backends. In-memory consumers (where the
+   * search callback resolves synchronously) can pass 0 for instant filtering on every
+   * keystroke.
+   */
+  searchDebounceMs?: number
 }
 
 const MIN_NUMBER_OF_ITEMS_FOR_SEARCH = 5
+const DEFAULT_SEARCH_DEBOUNCE_MS = 400
 
 function AutocompletePrompt<T>({
   message,
@@ -42,6 +50,7 @@ function AutocompletePrompt<T>({
   abortSignal,
   infoMessage,
   groupOrder,
+  searchDebounceMs = DEFAULT_SEARCH_DEBOUNCE_MS,
 }: React.PropsWithChildren<AutocompletePromptProps<T>>): ReactElement | null {
   const complete = useComplete()
   const [searchTerm, setSearchTerm] = useState('')
@@ -121,10 +130,10 @@ function AutocompletePrompt<T>({
               clearTimeout(setLoadingWhenSlow.current)
             })
         },
-        400,
+        searchDebounceMs,
         {leading: true, trailing: true},
       ),
-    [paginatedSearch, setPromptState],
+    [paginatedSearch, setPromptState, searchDebounceMs],
   )
 
   return (

packages/cli-kit/src/public/node/ui.tsx

@@ -417,6 +417,11 @@ export async function renderAutocompletePrompt<T>(
 ): Promise<T> {
   throwInNonTTY({message: props.message, stdin: renderOptions?.stdin}, uiDebugOptions)
 
+  // The default search filters in-memory choices synchronously, so it doesn't need
+  // throttling. Skipping the throttle makes the keystroke-to-result latency feel
+  // instant. Callers that supply their own (typically remote/paginated) search keep
+  // the component's default throttle unless they opt out via `searchDebounceMs`.
+  const usingDefaultSearch = props.search === undefined
   const newProps = {
     search(term: string) {
       const lowerTerm = term.toLowerCase()
@@ -426,6 +431,7 @@ export async function renderAutocompletePrompt<T>(
         }),
       })
     },
+    ...(usingDefaultSearch ? {searchDebounceMs: 0} : {}),
     ...props,
   }