[Fix] Remove empty suggestion history (#5349) (#5607)

* Add search input filter * Add CHANGELOG.md * Add tests for empty suggestions * Add code comment --------- Signed-off-by: Willie Hung <[email protected]> Signed-off-by: Josh Romero <[email protected]> Signed-off-by: Anan Zhuang <[email protected]> Co-authored-by: Josh Romero <[email protected]> Co-authored-by: Anan Zhuang <[email protected]> (cherry picked from commit 808591a) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-project · Dec 14, 2023 · 05e3a5c · 05e3a5c
1 parent 953fb81
commit 05e3a5c
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 0 deletions.
diff --git a/src/plugins/data/public/ui/typeahead/suggestion_component.test.tsx b/src/plugins/data/public/ui/typeahead/suggestion_component.test.tsx
@@ -45,6 +45,14 @@ const mockSuggestion: QuerySuggestion = {
   type: QuerySuggestionTypes.Value,
 };
 
+const mockEmptySuggestion: QuerySuggestion = {
+  description: '',
+  end: 0,
+  start: 0,
+  text: '',
+  type: QuerySuggestionTypes.Value,
+};
+
 describe('SuggestionComponent', () => {
   it('Should display the suggestion and use the provided ariaId', () => {
     const component = shallow(
@@ -135,4 +143,37 @@ describe('SuggestionComponent', () => {
     component.simulate('mouseenter');
     expect(mockHandler).toHaveBeenCalledTimes(1);
   });
+
+  it('Should return null for empty suggestion text', () => {
+    const component = shallow(
+      <SuggestionComponent
+        onClick={noop}
+        onMouseEnter={noop}
+        selected={false}
+        suggestion={mockEmptySuggestion}
+        innerRef={noop}
+        ariaId={'suggestion-empty'}
+        shouldDisplayDescription={true}
+      />
+    );
+
+    expect(component.isEmptyRender()).toBeTruthy();
+  });
+
+  it('Should return null for suggestion text with only whitespace', () => {
+    const whitespaceSuggestion = { ...mockEmptySuggestion, text: '  ' };
+    const component = shallow(
+      <SuggestionComponent
+        onClick={noop}
+        onMouseEnter={noop}
+        selected={false}
+        suggestion={whitespaceSuggestion}
+        innerRef={noop}
+        ariaId={'suggestion-whitespace'}
+        shouldDisplayDescription={true}
+      />
+    );
+
+    expect(component.isEmptyRender()).toBeTruthy();
+  });
 });
diff --git a/src/plugins/data/public/ui/typeahead/suggestion_component.tsx b/src/plugins/data/public/ui/typeahead/suggestion_component.tsx
@@ -61,6 +61,13 @@ interface Props {
 }
 
 export function SuggestionComponent(props: Props) {
+  // Removing empty suggestions from the history is for maintaining a clean user experience.
+  // Empty suggestions, which typically result from inadvertent keystrokes or incomplete queries,
+  // do not provide value to the user.
+  if (!props.suggestion.text.trim()) {
+    return null;
+  }
+
   return (
     // eslint-disable-next-line jsx-a11y/click-events-have-key-events, jsx-a11y/interactive-supports-focus
     <div