Skip to content

Commit

Permalink
fix(query-builder): Update selection index more often (#73084)
Browse files Browse the repository at this point in the history
The selection index is used to determine which suggestions to show based
on where your cursor is, but it wasn't getting updated when clicking or
when the input was reset, which was causing some bugs that prevented the
user from selecting a key.
  • Loading branch information
malwilley committed Jun 20, 2024
1 parent b0e481d commit c7ac420
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 5 deletions.
5 changes: 4 additions & 1 deletion static/app/components/searchQueryBuilder/combobox.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ type SearchQueryBuilderComboboxProps<T extends SelectOptionOrSectionWithKey<stri
filterValue?: string;
isLoading?: boolean;
maxOptions?: number;
onClick?: (e: React.MouseEvent) => void;
/**
* Called when the user explicitly closes the combobox with the escape key.
*/
Expand Down Expand Up @@ -300,6 +301,7 @@ function SearchQueryBuilderComboboxInner<T extends SelectOptionOrSectionWithKey<
onPaste,
displayTabbedMenu,
isLoading,
onClick,
}: SearchQueryBuilderComboboxProps<T>,
ref: ForwardedRef<HTMLInputElement>
) {
Expand Down Expand Up @@ -438,8 +440,9 @@ function SearchQueryBuilderComboboxInner<T extends SelectOptionOrSectionWithKey<
e.stopPropagation();
inputProps.onClick?.(e);
state.toggle();
onClick?.(e);
},
[inputProps, state]
[inputProps, state, onClick]
);

return (
Expand Down
27 changes: 23 additions & 4 deletions static/app/components/searchQueryBuilder/input.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -221,15 +221,19 @@ function SearchQueryBuilderInputInternal({
state,
rowRef,
}: SearchQueryBuilderInputInternalProps) {
const inputRef = useRef<HTMLInputElement>(null);
const trimmedTokenValue = token.text.trim();
const [inputValue, setInputValue] = useState(trimmedTokenValue);
// TODO(malwilley): Use input ref to update cursor position on mount
const [selectionIndex, setSelectionIndex] = useState(0);

const updateSelectionIndex = useCallback(() => {
setSelectionIndex(inputRef.current?.selectionStart ?? 0);
}, []);

const resetInputValue = useCallback(() => {
setInputValue(trimmedTokenValue);
// TODO(malwilley): Reset cursor position using ref
}, [trimmedTokenValue]);
updateSelectionIndex();
}, [trimmedTokenValue, updateSelectionIndex]);

const filterValue = getWordAtCursorPosition(inputValue, selectionIndex);

Expand All @@ -251,6 +255,8 @@ function SearchQueryBuilderInputInternal({

const onKeyDown = useCallback(
(e: KeyboardEvent) => {
updateSelectionIndex();

// Default combobox behavior stops events from propagating outside of input
// Certain keys like ctrl+z and ctrl+a are handled in useQueryBuilderGrid()
// so we need to continue propagation for those.
Expand Down Expand Up @@ -288,7 +294,14 @@ function SearchQueryBuilderInputInternal({
}
}
},
[inputValue, item.key, state.collection, state.selectionManager, trimmedTokenValue]
[
inputValue,
item.key,
state.collection,
state.selectionManager,
trimmedTokenValue,
updateSelectionIndex,
]
);

const onPaste = useCallback(
Expand All @@ -308,8 +321,13 @@ function SearchQueryBuilderInputInternal({
[aliasToKeyMap, dispatch, resetInputValue, token]
);

const onClick = useCallback(() => {
updateSelectionIndex();
}, [updateSelectionIndex]);

return (
<SearchQueryBuilderCombobox
ref={inputRef}
items={sections}
onOptionSelected={value => {
dispatch({
Expand Down Expand Up @@ -379,6 +397,7 @@ function SearchQueryBuilderInputInternal({
}
return true;
}}
onClick={onClick}
>
{section => (
<Section title={section.title} key={section.key}>
Expand Down

0 comments on commit c7ac420

Please sign in to comment.