test(autocomplete): add tests for data-selected stamping and keyboard navigation

Covers the two bugs fixed in the previous commit:

- Verifies the first button gets data-selected="true" on initial render so the
  CSS highlight rule fires immediately (regression for the dep-array fix).
- Verifies the first button is also stamped when async search results load new
  buttons after the initial render (the original regression).
- Verifies keyboard navigation via the AUTOCOMPLETE_NAVIGATE_EVENT moves the
  selected index and that it clamps at the list boundaries.

Also adds an eslint-disable comment in AutocompleteMenu.tsx explaining why
the no-dep-array useLayoutEffect is intentional (setSelectedIndex is a stable
React setter; the conditional call cannot cause an infinite loop).
This commit is contained in:
Evie Gauthier committed 2026-03-17 16:38:39 -04:00
1 parent e033e36a1e
commit 0fb883bfaa
4 files changed
+202 -1

No files matched your search

+5
View File
@@ -0,0 +1,5 @@
---
default: patch
---
Fix autocomplete Enter key always selecting the first item and the first item not being highlighted on open.
@@ -0,0 +1,193 @@
import { type ReactNode } from 'react';
import { describe, it, expect, vi } from 'vitest';
import { render, act } from '@testing-library/react';
import {
AutocompleteMenu,
AUTOCOMPLETE_NAVIGATE_EVENT,
type AutocompleteNavigateDetail,
} from './AutocompleteMenu';
// ── Mocks ─────────────────────────────────────────────────────────────────────
vi.mock('focus-trap-react', () => ({
default: ({ children }: { children: ReactNode }) => <>{children}</>,
}));
vi.mock('folds', () => ({
Header: ({ children }: { children: ReactNode }) => <div>{children}</div>,
Menu: ({ children }: { children: ReactNode }) => <div>{children}</div>,
Scroll: ({ children, onKeyDown }: { children: ReactNode; onKeyDown?: unknown }) => (
// eslint-disable-next-line jsx-a11y/no-static-element-interactions
<div onKeyDown={onKeyDown as React.KeyboardEventHandler}>{children}</div>
),
config: { space: { S200: '8px' } },
Icons: {},
}));
vi.mock('$utils/keyboard', () => ({
preventScrollWithArrowKey: vi.fn(),
stopPropagation: vi.fn(() => true),
}));
vi.mock('$hooks/useAlive', () => ({
useAlive: () => () => true,
}));
// ── Helpers ───────────────────────────────────────────────────────────────────
function dispatchNavigate(container: HTMLElement, direction: 1 | -1) {
const menu = container.querySelector('[data-autocomplete-menu]');
if (!menu) throw new Error('data-autocomplete-menu element not found');
menu.dispatchEvent(
new CustomEvent<AutocompleteNavigateDetail>(AUTOCOMPLETE_NAVIGATE_EVENT, {
bubbles: true,
detail: { direction },
})
);
}
function renderMenu(children: ReactNode) {
return render(
<AutocompleteMenu headerContent={<span>header</span>} requestClose={() => {}}>
{children}
</AutocompleteMenu>
);
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('AutocompleteMenu — data-selected stamping', () => {
it('stamps the first button with data-selected="true" on initial render', () => {
const { container } = renderMenu(
<>
<button type="button">Item 0</button>
<button type="button">Item 1</button>
<button type="button">Item 2</button>
</>
);
const buttons = container.querySelectorAll<HTMLButtonElement>('button');
expect(buttons[0].getAttribute('data-selected')).toBe('true');
expect(buttons[1].getAttribute('data-selected')).toBe('false');
expect(buttons[2].getAttribute('data-selected')).toBe('false');
});
it('stamps buttons when children load after initial render (async results)', async () => {
// Start with no children (empty search, buttons not yet present)
const { container, rerender } = renderMenu(null);
// Simulate async search results arriving
await act(async () => {
rerender(
<AutocompleteMenu headerContent={<span>header</span>} requestClose={() => {}}>
<button type="button">Result A</button>
<button type="button">Result B</button>
</AutocompleteMenu>
);
});
const buttons = container.querySelectorAll<HTMLButtonElement>('button');
expect(buttons).toHaveLength(2);
// First button must be marked selected — this was the bug: with the old
// [selectedIndex] dep array the effect didn't re-run when buttons appeared.
expect(buttons[0].getAttribute('data-selected')).toBe('true');
expect(buttons[1].getAttribute('data-selected')).toBe('false');
});
it('resets selection to the first button when the item list changes', async () => {
const { container } = renderMenu(
<>
<button type="button">Item 0</button>
<button type="button">Item 1</button>
</>
);
// Navigate to the second item
act(() => dispatchNavigate(container, 1));
const before = container.querySelectorAll<HTMLButtonElement>('button');
expect(before[1].getAttribute('data-selected')).toBe('true');
// Re-render with a completely different set of buttons (new search results)
await act(async () => {
render(
<AutocompleteMenu headerContent={<span>header</span>} requestClose={() => {}}>
<button type="button">New A</button>
<button type="button">New B</button>
<button type="button">New C</button>
</AutocompleteMenu>,
{ container: container.firstElementChild?.parentElement ?? document.body }
);
});
});
});
describe('AutocompleteMenu — keyboard navigation', () => {
it('moves selection forward with direction +1', () => {
const { container } = renderMenu(
<>
<button type="button">Item 0</button>
<button type="button">Item 1</button>
<button type="button">Item 2</button>
</>
);
act(() => dispatchNavigate(container, 1));
const buttons = container.querySelectorAll<HTMLButtonElement>('button');
expect(buttons[0].getAttribute('data-selected')).toBe('false');
expect(buttons[1].getAttribute('data-selected')).toBe('true');
expect(buttons[2].getAttribute('data-selected')).toBe('false');
});
it('moves selection backward with direction -1', () => {
const { container } = renderMenu(
<>
<button type="button">Item 0</button>
<button type="button">Item 1</button>
<button type="button">Item 2</button>
</>
);
// Go to last item first
act(() => dispatchNavigate(container, 1));
act(() => dispatchNavigate(container, 1));
act(() => dispatchNavigate(container, -1));
const buttons = container.querySelectorAll<HTMLButtonElement>('button');
expect(buttons[0].getAttribute('data-selected')).toBe('false');
expect(buttons[1].getAttribute('data-selected')).toBe('true');
expect(buttons[2].getAttribute('data-selected')).toBe('false');
});
it('clamps selection at the first item when navigating backward at index 0', () => {
const { container } = renderMenu(
<>
<button type="button">Item 0</button>
<button type="button">Item 1</button>
</>
);
act(() => dispatchNavigate(container, -1));
const buttons = container.querySelectorAll<HTMLButtonElement>('button');
expect(buttons[0].getAttribute('data-selected')).toBe('true');
});
it('clamps selection at the last item when navigating forward past the end', () => {
const { container } = renderMenu(
<>
<button type="button">Item 0</button>
<button type="button">Item 1</button>
</>
);
act(() => dispatchNavigate(container, 1));
act(() => dispatchNavigate(container, 1)); // attempt to go past the end
const buttons = container.querySelectorAll<HTMLButtonElement>('button');
expect(buttons[0].getAttribute('data-selected')).toBe('false');
expect(buttons[1].getAttribute('data-selected')).toBe('true');
});
});
@@ -31,6 +31,9 @@ export function AutocompleteMenu({ headerContent, requestClose, children }: Auto
// Sync data-selected to DOM; reset to index 0 when the item list changes.
// No dep array — runs after every render so newly-loaded buttons are stamped
// immediately (buttons arrive async when search results load).
// setSelectedIndex is a stable React setter; the conditional call never
// triggers an infinite update chain (it only fires when button count changes).
// eslint-disable-next-line react-hooks/exhaustive-deps
useLayoutEffect(() => {
const buttons = Array.from(
itemsRef.current?.querySelectorAll<HTMLButtonElement>('button') ?? []
+1 -1
View File
@@ -833,7 +833,7 @@ export const RoomInput = forwardRef<HTMLDivElement, RoomInputProps>(
if (isKeyHotkey('enter', evt) && !isComposing(evt)) {
const selectedItem =
autocompleteMenu.querySelector<HTMLButtonElement>('button[data-selected="true"]') ??
autocompleteMenu.querySelector<HTMLButtonElement>('button[data-selected="true"]') ??
autocompleteMenu.querySelector<HTMLButtonElement>('button');
if (selectedItem) {