feat: add search history for search page (#749)

- save search history for search page
- record number limit to 10
- add search history relate function
- support both sql and lucene search
- test


https://github.com/user-attachments/assets/67bbc4ce-999d-494d-9fa4-1f085c2fbf8d




ref: hdx-1565

Author: LYHuang

.changeset/sweet-kiwis-cheer.md

@@ -0,0 +1,5 @@
+---
+"@hyperdx/app": patch
+---
+
+Add search history

packages/app/src/AutocompleteInput.tsx

@@ -1,7 +1,9 @@
 import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
 import Fuse from 'fuse.js';
 import { OverlayTrigger } from 'react-bootstrap';
-import { TextInput } from '@mantine/core';
+import { TextInput, UnstyledButton } from '@mantine/core';
+
+import { useQueryHistory } from '@/utils';
 
 import InputLanguageSwitch from './components/InputLanguageSwitch';
 import { useDebounce } from './utils';
@@ -22,6 +24,7 @@ export default function AutocompleteInput({
   language,
   showHotkey,
   onSubmit,
+  queryHistoryType,
 }: {
   inputRef: React.RefObject<HTMLInputElement>;
   value: string;
@@ -38,21 +41,46 @@ export default function AutocompleteInput({
   onLanguageChange?: (language: 'sql' | 'lucene') => void;
   language?: 'sql' | 'lucene';
   showHotkey?: boolean;
+  queryHistoryType?: string;
 }) {
   const suggestionsLimit = 10;
 
   const [isSearchInputFocused, setIsSearchInputFocused] = useState(false);
   const [isInputDropdownOpen, setIsInputDropdownOpen] = useState(false);
+  const [showSearchHistory, setShowSearchHistory] = useState(false);
 
   const [selectedAutocompleteIndex, setSelectedAutocompleteIndex] =
     useState(-1);
 
+  const [selectedQueryHistoryIndex, setSelectedQueryHistoryIndex] =
+    useState(-1);
+  // query search history
+  const [queryHistory, setQueryHistory] = useQueryHistory(queryHistoryType);
+  const queryHistoryList = useMemo(() => {
+    if (!queryHistoryType || !queryHistory) return [];
+    return queryHistory.map(q => {
+      return {
+        value: q,
+        label: q,
+      };
+    });
+  }, [queryHistory]);
+
   useEffect(() => {
     if (isSearchInputFocused) {
       setIsInputDropdownOpen(true);
     }
   }, [isSearchInputFocused]);
 
+  useEffect(() => {
+    // only show search history when: 1.no input, 2.has search type, 3.has history list
+    if (value.length === 0 && queryHistoryList.length > 0 && queryHistoryType) {
+      setShowSearchHistory(true);
+    } else {
+      setShowSearchHistory(false);
+    }
+  }, [value, queryHistoryType, queryHistoryList]);
+
   const fuse = useMemo(
     () =>
       new Fuse(autocompleteOptions ?? [], {
@@ -74,6 +102,14 @@ export default function AutocompleteInput({
     return fuse.search(lastToken).map(result => result.item);
   }, [debouncedValue, fuse, autocompleteOptions, showSuggestionsOnEmpty]);
 
+  const onSelectSearchHistory = (query: string) => {
+    setSelectedQueryHistoryIndex(-1);
+    onChange(query); // update inputText bar
+    setQueryHistory(query); // update history order
+    setIsInputDropdownOpen(false); // close dropdown since we execute search
+    onSubmit?.(); // search
+  };
+
   const onAcceptSuggestion = (suggestion: string) => {
     setSelectedAutocompleteIndex(-1);
 
@@ -154,6 +190,29 @@ export default function AutocompleteInput({
               {belowSuggestions}
             </div>
           )}
+          <div>
+            {showSearchHistory && (
+              <div className="border-top border-dark fs-8 py-2">
+                <div className="text-muted fs-8 fw-bold me-1 px-3">
+                  Search History:
+                </div>
+                {queryHistoryList.map(({ value, label }, i) => {
+                  return (
+                    <UnstyledButton
+                      className={`d-block w-100 text-start text-muted fw-normal px-3 py-2 fs-8 ${
+                        selectedQueryHistoryIndex === i ? 'bg-hdx-dark' : ''
+                      }`}
+                      key={value}
+                      onMouseOver={() => setSelectedQueryHistoryIndex(i)}
+                      onClick={() => onSelectSearchHistory(value)}
+                    >
+                      <span className="me-1 text-truncate">{label}</span>
+                    </UnstyledButton>
+                  );
+                })}
+              </div>
+            )}
+          </div>
         </div>
       )}
       popperConfig={{
@@ -179,10 +238,12 @@ export default function AutocompleteInput({
         onChange={e => onChange(e.target.value)}
         onFocus={() => {
           setSelectedAutocompleteIndex(-1);
+          setSelectedQueryHistoryIndex(-1);
           setIsSearchInputFocused(true);
         }}
         onBlur={() => {
           setSelectedAutocompleteIndex(-1);
+          setSelectedQueryHistoryIndex(-1);
           setIsSearchInputFocused(false);
         }}
         onKeyDown={e => {
@@ -213,6 +274,9 @@ export default function AutocompleteInput({
                 suggestedProperties[selectedAutocompleteIndex].value,
               );
             } else {
+              if (queryHistoryType) {
+                setQueryHistory(value);
+              }
               onSubmit?.();
             }
           }

packages/app/src/DBSearchPage.tsx

@@ -87,7 +87,7 @@ import {
   useSources,
 } from '@/source';
 import { parseTimeQuery, useNewTimeQuery } from '@/timeQuery';
-import { usePrevious } from '@/utils';
+import { QUERY_LOCAL_STORAGE, usePrevious } from '@/utils';
 
 import { SQLPreview } from './components/ChartSQLPreview';
 import { useSqlSuggestions } from './hooks/useSqlSuggestions';
@@ -1146,6 +1146,7 @@ function DBSearchPage() {
                 language="sql"
                 onSubmit={onSubmit}
                 label="WHERE"
+                queryHistoryType={QUERY_LOCAL_STORAGE.SEARCH_SQL}
                 enableHotkey
               />
             }
@@ -1159,8 +1160,10 @@ function DBSearchPage() {
                     shouldDirty: true,
                   })
                 }
+                onSubmit={onSubmit}
                 language="lucene"
                 placeholder="Search your events w/ Lucene ex. column:foo"
+                queryHistoryType={QUERY_LOCAL_STORAGE.SEARCH_LUCENE}
                 enableHotkey
               />
             }

packages/app/src/SearchInputV2.tsx

@@ -33,6 +33,7 @@ export default function SearchInputV2({
   enableHotkey,
   onSubmit,
   additionalSuggestions,
+  queryHistoryType,
   ...props
 }: {
   tableConnections?: TableConnection | TableConnection[];
@@ -44,6 +45,7 @@ export default function SearchInputV2({
   enableHotkey?: boolean;
   onSubmit?: () => void;
   additionalSuggestions?: string[];
+  queryHistoryType?: string;
 } & UseControllerProps<any>) {
   const {
     field: { onChange, value },
@@ -91,6 +93,7 @@ export default function SearchInputV2({
       showHotkey={enableHotkey}
       onLanguageChange={onLanguageChange}
       onSubmit={onSubmit}
+      queryHistoryType={queryHistoryType}
       aboveSuggestions={
         <>
           <div className="text-muted fs-8 fw-bold me-1">Searching for:</div>

packages/app/src/__tests__/utils.test.ts

@@ -8,6 +8,7 @@ import {
   formatDate,
   formatNumber,
   getMetricTableName,
+  useQueryHistory,
 } from '../utils';
 
 describe('utils', () => {
@@ -471,3 +472,67 @@ describe('useLocalStorage', () => {
     expect(localStorageMock.getItem).not.toHaveBeenCalled();
   });
 });
+
+describe('useQueryHistory', () => {
+  const mockGetItem = jest.fn();
+  const mockSetItem = jest.fn();
+  const mockRemoveItem = jest.fn();
+  const originalLocalStorage = window.localStorage;
+
+  beforeEach(() => {
+    mockGetItem.mockClear();
+    mockSetItem.mockClear();
+    mockRemoveItem.mockClear();
+    mockGetItem.mockReturnValue('["service = test3","service = test1"]');
+    Object.defineProperty(window, 'localStorage', {
+      value: {
+        getItem: (...args: string[]) => mockGetItem(...args),
+        setItem: (...args: string[]) => mockSetItem(...args),
+        removeItem: (...args: string[]) => mockRemoveItem(...args),
+      },
+    });
+  });
+
+  afterEach(() => {
+    jest.restoreAllMocks();
+    Object.defineProperty(window, 'localStorage', {
+      value: originalLocalStorage,
+      configurable: true,
+    });
+  });
+
+  it('adds new query', () => {
+    const { result } = renderHook(() => useQueryHistory('searchSQL'));
+    const setQueryHistory = result.current[1];
+    act(() => {
+      setQueryHistory('service = test2');
+    });
+
+    expect(mockSetItem).toHaveBeenCalledWith(
+      'QuerySearchHistory.searchSQL',
+      '["service = test2","service = test3","service = test1"]',
+    );
+  });
+
+  it('does not add duplicate query, but change the order to front', () => {
+    const { result } = renderHook(() => useQueryHistory('searchSQL'));
+    const setQueryHistory = result.current[1];
+    act(() => {
+      setQueryHistory('service = test1');
+    });
+
+    expect(mockSetItem).toHaveBeenCalledWith(
+      'QuerySearchHistory.searchSQL',
+      '["service = test1","service = test3"]',
+    );
+  });
+
+  it('does not add empty query', () => {
+    const { result } = renderHook(() => useQueryHistory('searchSQL'));
+    const setQueryHistory = result.current[1];
+    act(() => {
+      setQueryHistory('   '); // empty after trim
+    });
+    expect(mockSetItem).not.toBeCalled();
+  });
+});