diff --git a/src/CONST/SENTRY_LABEL.ts b/src/CONST/SENTRY_LABEL.ts index 416dbe590462..134e10732332 100644 --- a/src/CONST/SENTRY_LABEL.ts +++ b/src/CONST/SENTRY_LABEL.ts @@ -514,6 +514,7 @@ const SENTRY_LABEL = { CREATE_EXPENSE: 'Search-EmptyState-CreateExpense', CREATE_REPORT: 'Search-EmptyState-CreateReport', SEND_INVOICE: 'Search-EmptyState-SendInvoice', + RESET_FILTERS: 'Search-EmptyState-ResetFilters', BOOK_TRAVEL: 'Search-EmptyState-BookTravel', }, EXPENSE_REPORT_CHECKBOX: 'Search-ExpenseReportCheckbox', diff --git a/src/components/Search/SearchPageHeader/useSearchFiltersBar.tsx b/src/components/Search/SearchPageHeader/useSearchFiltersBar.tsx index fce920c8295d..c4848fe3f976 100644 --- a/src/components/Search/SearchPageHeader/useSearchFiltersBar.tsx +++ b/src/components/Search/SearchPageHeader/useSearchFiltersBar.tsx @@ -17,10 +17,9 @@ import {shouldShowInitialCategoryFilterLoading} from '@hooks/useSearchFilterSync import useShouldReturnTripRooms from '@hooks/useShouldReturnTripRooms'; import {close} from '@libs/actions/Modal'; -import {setSearchContext} from '@libs/actions/Search'; import Navigation from '@libs/Navigation/Navigation'; import {searchKeyToSavedSearchID} from '@libs/SearchKeyUtils'; -import {buildQueryStringWithResetFilters, hasFiltersChangedFromDefault, isSearchQuerySavable, removeNegation} from '@libs/SearchQueryUtils'; +import {isSearchQuerySavable, removeNegation} from '@libs/SearchQueryUtils'; import { FILTER_VIEW_MAP, getFiltersFormWithTripRoomStatuses, @@ -46,6 +45,7 @@ import type {ReactNode} from 'react'; import React from 'react'; import DatePickerFilterPopup from './DatePickerFilterPopup'; +import useSearchFiltersReset from './useSearchFiltersReset'; type FilterItem = WithRequiredSentryLabel & { PopoverComponent: (props: PopoverComponentProps) => ReactNode; @@ -235,22 +235,14 @@ function useSearchFiltersBar(queryJSON: SearchQueryJSON): UseSearchFiltersBarRes }), ); - const resetFilters = () => { - if (!currentSearchQueryJSON) { - return; - } - - Navigation.setParams({q: buildQueryStringWithResetFilters(currentSearchQueryJSON, currentDefaultSearchQueryJSON), rawQuery: undefined}); - setSearchContext(false); - }; + const {canReset, resetFilters} = useSearchFiltersReset(); const isCategoryFilterLoading = shouldShowInitialCategoryFilterLoading(queryJSON, areCategoriesLoaded, isLoadingCategories, isOffline); - const hasDefaultQuery = !!currentDefaultSearchQueryJSON && !!currentSearchQueryJSON; return { filters, hasErrors: Object.keys(currentSearchResults?.errors ?? {}).length > 0 && !isOffline, shouldShowFiltersBarLoading: shouldShowFiltersBarLoading || isCategoryFilterLoading, - canReset: hasDefaultQuery ? hasFiltersChangedFromDefault(currentSearchQueryJSON, currentDefaultSearchQueryJSON) : filters.length > 0, + canReset, canSave: isSearchQuerySavable(currentSearchQueryJSON, currentDefaultSearchQueryJSON), resetFilters, }; diff --git a/src/components/Search/SearchPageHeader/useSearchFiltersReset.ts b/src/components/Search/SearchPageHeader/useSearchFiltersReset.ts new file mode 100644 index 000000000000..9e115a7e8387 --- /dev/null +++ b/src/components/Search/SearchPageHeader/useSearchFiltersReset.ts @@ -0,0 +1,49 @@ +/** Shares the applied-filter reset behavior between the search header and empty results. */ +import {useSearchQueryContext} from '@components/Search/SearchContext'; + +import {useCurrencyListActions} from '@hooks/useCurrencyList'; +import useLocalize from '@hooks/useLocalize'; +import useOnyx from '@hooks/useOnyx'; +import useShouldReturnTripRooms from '@hooks/useShouldReturnTripRooms'; + +import {setSearchContext} from '@libs/actions/Search'; +import Navigation from '@libs/Navigation/Navigation'; +import {buildQueryStringWithResetFilters, hasFiltersChangedFromDefault} from '@libs/SearchQueryUtils'; +import {getFiltersFormWithTripRoomStatuses, mapFiltersFormToLabelValueList, SKIPPED_SEARCH_FILTERS} from '@libs/SearchUIUtils'; + +import ONYXKEYS from '@src/ONYXKEYS'; +import type {SearchAdvancedFiltersForm} from '@src/types/form'; +import {getEmptyObject} from '@src/types/utils/EmptyObject'; + +function useSearchFiltersReset() { + const [searchAdvancedFiltersForm = getEmptyObject>()] = useOnyx(ONYXKEYS.FORMS.SEARCH_ADVANCED_FILTERS_FORM); + const {translate, localeCompare, dateFnsLocale} = useLocalize(); + const {convertToDisplayStringWithoutCurrency} = useCurrencyListActions(); + const {currentSearchQueryJSON, currentDefaultSearchQueryJSON, currentDefaultSearchQueryFilterKeys} = useSearchQueryContext(); + const shouldReturnTripRooms = useShouldReturnTripRooms(currentSearchQueryJSON?.type); + const hasDefaultQuery = !!currentDefaultSearchQueryJSON && !!currentSearchQueryJSON; + const canReset = hasDefaultQuery + ? hasFiltersChangedFromDefault(currentSearchQueryJSON, currentDefaultSearchQueryJSON) + : mapFiltersFormToLabelValueList( + shouldReturnTripRooms ? getFiltersFormWithTripRoomStatuses(searchAdvancedFiltersForm) : searchAdvancedFiltersForm, + currentDefaultSearchQueryFilterKeys, + SKIPPED_SEARCH_FILTERS, + translate, + dateFnsLocale, + localeCompare, + convertToDisplayStringWithoutCurrency, + ).length > 0; + + const resetFilters = () => { + if (!currentSearchQueryJSON) { + return; + } + + Navigation.setParams({q: buildQueryStringWithResetFilters(currentSearchQueryJSON, currentDefaultSearchQueryJSON), rawQuery: undefined}); + setSearchContext(false); + }; + + return {canReset, resetFilters}; +} + +export default useSearchFiltersReset; diff --git a/src/libs/SearchSuggestionUtils.ts b/src/libs/SearchSuggestionUtils.ts index f12c263dddd1..b2536ed906d9 100644 --- a/src/libs/SearchSuggestionUtils.ts +++ b/src/libs/SearchSuggestionUtils.ts @@ -68,6 +68,7 @@ type SearchTypeMenuItem = { emptyState?: { title: TranslationPaths; subtitle: TranslationPaths; + shouldShowResetFilters?: boolean; buttons?: Array<{ buttonText: TranslationPaths; buttonAction: () => void; diff --git a/src/libs/SearchUIUtils.ts b/src/libs/SearchUIUtils.ts index ee4f1291c99c..e7648580da7d 100644 --- a/src/libs/SearchUIUtils.ts +++ b/src/libs/SearchUIUtils.ts @@ -5347,6 +5347,7 @@ function createTypeMenuSections(params: TypeMenuSectionsParams): SearchTypeMenuS emptyState: { title: 'search.searchResults.emptyResults.title', subtitle: 'search.searchResults.emptyResults.subtitle', + shouldShowResetFilters: true, }, }); } diff --git a/src/pages/Search/EmptySearchView.tsx b/src/pages/Search/EmptySearchView.tsx index 73ae66e12e6d..bbebb85f0413 100644 --- a/src/pages/Search/EmptySearchView.tsx +++ b/src/pages/Search/EmptySearchView.tsx @@ -48,6 +48,7 @@ import React from 'react'; import {Linking, View} from 'react-native'; import Animated from 'react-native-reanimated'; +import SearchResetFiltersButton from './SearchResetFiltersButton'; import useSearchEmptyStateIllustration from './useSearchEmptyStateIllustration'; type EmptySearchViewProps = { @@ -209,6 +210,13 @@ function EmptySearchViewContent({ // Default 'Folder' illustration styles const defaultViewItemHeader = useSearchEmptyStateIllustration(); + const getEmptyResultsContent = (): EmptySearchViewItem => ({ + ...defaultViewItemHeader.folder, + title: translate('search.searchResults.emptyResults.title'), + subtitle: translate('search.searchResults.emptyResults.subtitle'), + children: , + }); + const startTestDriveAction = () => { startTestDrive(); }; @@ -240,6 +248,7 @@ function EmptySearchViewContent({ ...button, buttonText: translate(button.buttonText), })), + children: menuItem.emptyState.shouldShowResetFilters ? : undefined, }; break; } @@ -282,17 +291,9 @@ function EmptySearchViewContent({ break; case CONST.SEARCH.DATA_TYPES.EXPENSE_REPORT: if (!isFilteredWorkspaceAccessible) { - content = { - ...defaultViewItemHeader.folder, - title: translate('search.searchResults.emptyResults.title'), - subtitle: translate('search.searchResults.emptyResults.subtitle'), - }; + content = getEmptyResultsContent(); } else if (hasResults && (!queryJSON || !isDefaultExpenseReportsQuery(queryJSON) || hasExpenseReports)) { - content = { - ...defaultViewItemHeader.folder, - title: translate('search.searchResults.emptyResults.title'), - subtitle: translate('search.searchResults.emptyResults.subtitle'), - }; + content = getEmptyResultsContent(); } else if (!hasResults || !hasExpenseReports) { content = { ...defaultViewItemHeader.folder, @@ -325,17 +326,9 @@ function EmptySearchViewContent({ case CONST.SEARCH.DATA_TYPES.EXPENSE: if (!content) { if (!isFilteredWorkspaceAccessible) { - content = { - ...defaultViewItemHeader.folder, - title: translate('search.searchResults.emptyResults.title'), - subtitle: translate('search.searchResults.emptyResults.subtitle'), - }; + content = getEmptyResultsContent(); } else if (hasResults && (!queryJSON || !isDefaultExpensesQuery(queryJSON) || hasTransactions)) { - content = { - ...defaultViewItemHeader.folder, - title: translate('search.searchResults.emptyResults.title'), - subtitle: translate('search.searchResults.emptyResults.subtitle'), - }; + content = getEmptyResultsContent(); } else if (!hasResults || !hasTransactions) { content = { ...defaultViewItemHeader.expenses, @@ -406,11 +399,7 @@ function EmptySearchViewContent({ case CONST.SEARCH.DATA_TYPES.CHAT: default: if (!content) { - content = { - ...defaultViewItemHeader.folder, - title: translate('search.searchResults.emptyResults.title'), - subtitle: translate('search.searchResults.emptyResults.subtitle'), - }; + content = getEmptyResultsContent(); } break; } @@ -418,11 +407,7 @@ function EmptySearchViewContent({ // Fallback to default content if somehow not set (should never happen in practice) if (!content) { - content = { - ...defaultViewItemHeader.folder, - title: translate('search.searchResults.emptyResults.title'), - subtitle: translate('search.searchResults.emptyResults.subtitle'), - }; + content = getEmptyResultsContent(); } return ( diff --git a/src/pages/Search/SearchResetFiltersButton.tsx b/src/pages/Search/SearchResetFiltersButton.tsx new file mode 100644 index 000000000000..d5406a66f2b0 --- /dev/null +++ b/src/pages/Search/SearchResetFiltersButton.tsx @@ -0,0 +1,34 @@ +/** Lets empty search results share the filter bar's applied-query reset action. */ +import Button from '@components/Button'; +import useSearchFiltersReset from '@components/Search/SearchPageHeader/useSearchFiltersReset'; + +import useLocalize from '@hooks/useLocalize'; +import useThemeStyles from '@hooks/useThemeStyles'; + +import CONST from '@src/CONST'; + +import React from 'react'; +import {View} from 'react-native'; + +function SearchResetFiltersButton() { + const {canReset, resetFilters} = useSearchFiltersReset(); + const {translate} = useLocalize(); + const styles = useThemeStyles(); + + if (!canReset) { + return null; + } + + return ( + + + + ); +} + +export default SearchResetFiltersButton; diff --git a/tests/ui/components/EmptySearchViewTest.tsx b/tests/ui/components/EmptySearchViewTest.tsx index b240fbd32416..9dcf98ddcbc8 100644 --- a/tests/ui/components/EmptySearchViewTest.tsx +++ b/tests/ui/components/EmptySearchViewTest.tsx @@ -1,17 +1,23 @@ -import {act, render, screen} from '@testing-library/react-native'; +import {act, fireEvent, render, screen} from '@testing-library/react-native'; import {LocaleContextProvider} from '@components/LocaleContextProvider'; import OnyxListItemProvider from '@components/OnyxListItemProvider'; +import {SearchQueryContext} from '@components/Search/SearchContext'; +import type {SearchQueryJSON} from '@components/Search/types'; -import {buildQueryStringFromFilterFormValues, buildSearchQueryJSON} from '@libs/SearchQueryUtils'; +import * as SearchTypeMenuSections from '@hooks/useSearchTypeMenuSections'; + +import Navigation from '@libs/Navigation/Navigation'; +import {buildQueryStringFromFilterFormValues, buildQueryStringWithResetFilters, buildSearchQueryJSON} from '@libs/SearchQueryUtils'; import EmptySearchView from '@pages/Search/EmptySearchView'; import CONST from '@src/CONST'; import ONYXKEYS from '@src/ONYXKEYS'; +import {defaultTheme} from '@src/styles/theme'; import type {Beta, Policy} from '@src/types/onyx'; -import React from 'react'; +import React, {useContext, useMemo} from 'react'; import Onyx from 'react-native-onyx'; import {translateLocal} from '../../utils/TestHelper'; @@ -27,10 +33,17 @@ jest.mock('@components/BookTravelButton', () => { }); // Wrapper component with OnyxListItemProvider -function Wrapper({children}: {children: React.ReactNode}) { +function Wrapper({children, queryJSON, defaultQueryJSON}: {children: React.ReactNode; queryJSON?: SearchQueryJSON; defaultQueryJSON?: SearchQueryJSON}) { + const searchContext = useContext(SearchQueryContext); + const queryContext = useMemo( + () => ({...searchContext, currentSearchQueryJSON: queryJSON, currentDefaultSearchQueryJSON: defaultQueryJSON}), + [searchContext, queryJSON, defaultQueryJSON], + ); return ( - {children} + + {children} + ); } @@ -49,6 +62,7 @@ const createPolicy = (type: Policy['type'] = CONST.POLICY.TYPE.TEAM) => ({ describe('EmptySearchView', () => { afterEach(async () => { + jest.restoreAllMocks(); jest.clearAllMocks(); await act(async () => { await Onyx.clear(); @@ -60,6 +74,156 @@ describe('EmptySearchView', () => { Onyx.init({keys: ONYXKEYS}); }); + describe('reset filters', () => { + it.each([ + {shouldShowResetFilters: true, title: 'search.searchResults.emptyResults.title'}, + {shouldShowResetFilters: true, title: 'search.searchResults.emptyExpenseResults.title'}, + {shouldShowResetFilters: false, title: 'search.searchResults.emptyResults.title'}, + {shouldShowResetFilters: undefined, title: 'search.searchResults.emptyResults.title'}, + ] as const)('uses shouldShowResetFilters=$shouldShowResetFilters independently of title=$title', async ({shouldShowResetFilters, title}) => { + // Given an Insights view whose changed feed does not change its similar search hash + const defaultQueryJSON = buildSearchQueryJSON('type:expense group-by:merchant'); + const queryJSON = buildSearchQueryJSON('type:expense group-by:merchant feed:123'); + expect(queryJSON).toBeDefined(); + expect(queryJSON?.similarSearchHash).toBe(defaultQueryJSON?.similarSearchHash); + const menuSections = jest.spyOn(SearchTypeMenuSections, 'default').mockReturnValue([ + { + translationPath: 'search.tabs.insights', + menuItems: [ + { + key: CONST.SEARCH.SEARCH_KEYS.TOP_MERCHANTS, + translationPath: 'search.tabs.insights', + type: CONST.SEARCH.DATA_TYPES.EXPENSE, + icon: 'Basket', + searchQuery: defaultQueryJSON?.inputQuery ?? '', + searchQueryJSON: defaultQueryJSON, + hash: defaultQueryJSON?.hash ?? -1, + recentSearchHash: defaultQueryJSON?.recentSearchHash ?? -1, + similarSearchHash: queryJSON?.similarSearchHash ?? -1, + emptyState: { + title, + subtitle: 'search.searchResults.emptyResults.subtitle', + shouldShowResetFilters, + }, + }, + ], + }, + ]); + + // When the menu-provided empty state is rendered + render( + + + , + ); + await waitForBatchedUpdatesWithAct(); + + // Then only the explicit flag controls reset eligibility, regardless of the title + expect(screen.getByText(translateLocal(title))).toBeVisible(); + if (shouldShowResetFilters) { + expect(screen.getByText(translateLocal('search.resetFilters'))).toBeVisible(); + } else { + expect(screen.queryByText(translateLocal('search.resetFilters'))).not.toBeOnTheScreen(); + } + menuSections.mockRestore(); + }); + + it.each([CONST.SEARCH.DATA_TYPES.EXPENSE, CONST.SEARCH.DATA_TYPES.EXPENSE_REPORT, CONST.SEARCH.DATA_TYPES.CHAT, CONST.SEARCH.DATA_TYPES.INVOICE])( + 'resets filtered empty %s results to the view default', + async (type) => { + // Given a filter that differs from the current view's defaults + const queryJSON = buildSearchQueryJSON(`type:${type} merchant:zzzz`); + const defaultQueryJSON = buildSearchQueryJSON(`type:${type}`); + if (!queryJSON) { + throw new Error('Invalid test query'); + } + const setParams = jest.spyOn(Navigation, 'setParams').mockImplementation(() => {}); + + // When the filtered search has no matching results + render( + + + , + ); + await waitForBatchedUpdatesWithAct(); + + // Then the empty state offers the same reset action as the filter bar + expect(screen.getByText(translateLocal('search.searchResults.emptyResults.title'))).toBeVisible(); + expect(screen.getByRole(CONST.ROLE.BUTTON, {name: translateLocal('search.resetFilters')})).toHaveStyle({backgroundColor: defaultTheme.buttonDefaultBG}); + fireEvent.press(screen.getByText(translateLocal('search.resetFilters'))); + expect(setParams).toHaveBeenCalledWith({q: buildQueryStringWithResetFilters(queryJSON, defaultQueryJSON), rawQuery: undefined}); + setParams.mockRestore(); + }, + ); + + it('does not offer reset when the filters match the view default', async () => { + // Given a view with unchanged default filters + const queryJSON = buildSearchQueryJSON('type:chat'); + + // When that view is empty + render( + + + , + ); + await waitForBatchedUpdatesWithAct(); + + // Then there is nothing to reset + expect(screen.getByText(translateLocal('search.searchResults.emptyResults.title'))).toBeVisible(); + expect(screen.queryByText(translateLocal('search.resetFilters'))).not.toBeOnTheScreen(); + }); + + it('preserves onboarding actions even when filters can be reset', async () => { + // Given a new user with a changed filter but no expenses at all + const queryJSON = buildSearchQueryJSON('type:expense merchant:zzzz'); + const defaultQueryJSON = buildSearchQueryJSON('type:expense'); + + // When the onboarding empty state is rendered + render( + + + , + ); + await waitForBatchedUpdatesWithAct(); + + // Then it keeps the creation action without adding a reset button + expect(screen.getByText(translateLocal('iou.createExpense'))).toBeVisible(); + expect(screen.queryByText(translateLocal('search.resetFilters'))).not.toBeOnTheScreen(); + }); + }); + describe('type is Expense', () => { const dataType = CONST.SEARCH.DATA_TYPES.EXPENSE; diff --git a/tests/unit/hooks/useSearchFiltersReset.test.tsx b/tests/unit/hooks/useSearchFiltersReset.test.tsx new file mode 100644 index 000000000000..95751752a1ac --- /dev/null +++ b/tests/unit/hooks/useSearchFiltersReset.test.tsx @@ -0,0 +1,105 @@ +import {act, renderHook} from '@testing-library/react-native'; + +import {LocaleContextProvider} from '@components/LocaleContextProvider'; +import type * as SearchContext from '@components/Search/SearchContext'; +import {SearchQueryContext, useSearchQueryContext} from '@components/Search/SearchContext'; +import useSearchFiltersReset from '@components/Search/SearchPageHeader/useSearchFiltersReset'; + +import {setSearchContext} from '@libs/actions/Search'; +import Navigation from '@libs/Navigation/Navigation'; +import {buildQueryStringWithResetFilters, buildSearchQueryJSON} from '@libs/SearchQueryUtils'; + +import ONYXKEYS from '@src/ONYXKEYS'; + +import {useContext} from 'react'; +import Onyx from 'react-native-onyx'; + +import waitForBatchedUpdatesWithAct from '../../utils/waitForBatchedUpdatesWithAct'; + +jest.mock('@components/Search/SearchContext', () => ({ + ...jest.requireActual('@components/Search/SearchContext'), + useSearchQueryContext: jest.fn(), +})); +jest.mock('@libs/actions/Search'); +jest.mock('@libs/Navigation/Navigation'); + +const mockUseSearchQueryContext = jest.mocked(useSearchQueryContext); +const defaultQuery = buildSearchQueryJSON('type:expense status:all'); +const filteredQuery = buildSearchQueryJSON('type:expense status:all merchant:zzzz'); + +describe('useSearchFiltersReset', () => { + beforeAll(() => { + Onyx.init({keys: ONYXKEYS}); + }); + + beforeEach(() => { + jest.clearAllMocks(); + const {result} = renderHook(() => useContext(SearchQueryContext)); + mockUseSearchQueryContext.mockReturnValue({ + ...result.current, + currentSearchQueryJSON: filteredQuery, + currentDefaultSearchQueryJSON: defaultQuery, + }); + }); + + afterEach(async () => { + await act(async () => Onyx.clear()); + await waitForBatchedUpdatesWithAct(); + }); + + it.each([ + ['changed filters', filteredQuery, true], + ['default filters', defaultQuery, false], + ['a keyword only', buildSearchQueryJSON('type:expense status:all lunch'), false], + ] as const)('computes reset availability for %s', (_description, queryJSON, expected) => { + // Given an applied query and a view default + mockUseSearchQueryContext.mockReturnValue({...mockUseSearchQueryContext(), currentSearchQueryJSON: queryJSON}); + + // When reset availability is evaluated + const {result} = renderHook(() => useSearchFiltersReset(), {wrapper: LocaleContextProvider}); + + // Then only resettable filter changes enable the action + expect(result.current.canReset).toBe(expected); + }); + + it.each([true, false])('uses visible filters without a default query (has filter: %s)', async (hasFilter) => { + // Given an ad-hoc query with no view default + mockUseSearchQueryContext.mockReturnValue({...mockUseSearchQueryContext(), currentDefaultSearchQueryJSON: undefined}); + await act(async () => Onyx.set(ONYXKEYS.FORMS.SEARCH_ADVANCED_FILTERS_FORM, hasFilter ? {merchant: 'zzzz'} : {})); + + // When the same filter mapping used by the bar is evaluated + const {result} = renderHook(() => useSearchFiltersReset(), {wrapper: LocaleContextProvider}); + await waitForBatchedUpdatesWithAct(); + + // Then reset is available exactly when a visible filter exists + expect(result.current.canReset).toBe(hasFilter); + }); + + it('restores the default query and leaves the search context', () => { + // Given a filtered query with view-specific defaults + if (!filteredQuery) { + throw new Error('Invalid test query'); + } + const {result} = renderHook(() => useSearchFiltersReset()); + + // When filters are reset + act(() => result.current.resetFilters()); + + // Then the existing navigation reset contract is preserved + expect(Navigation.setParams).toHaveBeenCalledWith({q: buildQueryStringWithResetFilters(filteredQuery, defaultQuery), rawQuery: undefined}); + expect(setSearchContext).toHaveBeenCalledWith(false); + }); + + it('does nothing without a current query', () => { + // Given no applied query + mockUseSearchQueryContext.mockReturnValue({...mockUseSearchQueryContext(), currentSearchQueryJSON: undefined}); + const {result} = renderHook(() => useSearchFiltersReset()); + + // When reset is requested + act(() => result.current.resetFilters()); + + // Then navigation and search context remain untouched + expect(Navigation.setParams).not.toHaveBeenCalled(); + expect(setSearchContext).not.toHaveBeenCalled(); + }); +});