Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 34 additions & 3 deletions src/components/Search/SearchPageHeader/SearchFiltersBar.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import React, {useCallback, useMemo, useRef} from 'react';
import type {ReactNode} from 'react';
import {View} from 'react-native';
// eslint-disable-next-line no-restricted-imports
import type {ScrollView as RNScrollView} from 'react-native';
Expand All @@ -19,6 +20,7 @@ import {useSearchContext} from '@components/Search/SearchContext';
import type {SearchDateValues} from '@components/Search/SearchDatePresetFilterBase';
import type {SearchDateFilterKeys, SearchGroupBy, SearchQueryJSON, SingularSearchStatus} from '@components/Search/types';
import SearchFiltersSkeleton from '@components/Skeletons/SearchFiltersSkeleton';
import useAdvancedSearchFilters from '@hooks/useAdvancedSearchFilters';
import useLocalize from '@hooks/useLocalize';
import useNetwork from '@hooks/useNetwork';
import useOnyx from '@hooks/useOnyx';
Expand All @@ -45,11 +47,19 @@ import type {TranslationPaths} from '@src/languages/types';
import ONYXKEYS from '@src/ONYXKEYS';
import ROUTES from '@src/ROUTES';
import type {SearchAdvancedFiltersForm} from '@src/types/form';
import FILTER_KEYS from '@src/types/form/SearchAdvancedFiltersForm';
import FILTER_KEYS, {DATE_FILTER_KEYS} from '@src/types/form/SearchAdvancedFiltersForm';
import type {SearchAdvancedFiltersKey} from '@src/types/form/SearchAdvancedFiltersForm';
import type {CurrencyList, Policy} from '@src/types/onyx';
import {getEmptyObject} from '@src/types/utils/EmptyObject';
import type {SearchHeaderOptionValue} from './SearchPageHeader';

type FilterItem = {
label: string;
PopoverComponent: (props: PopoverComponentProps) => ReactNode;
value: string | string[] | null;
filterKey: SearchAdvancedFiltersKey;
};

type SearchFiltersBarProps = {
queryJSON: SearchQueryJSON;
headerButtonsOptions: Array<DropdownOption<SearchHeaderOptionValue>>;
Expand Down Expand Up @@ -410,11 +420,13 @@ function SearchFiltersBar({queryJSON, headerButtonsOptions, isMobileSelectionMod
[filterFormValues.from, updateFilterForm],
);

const {typeFiltersKeys} = useAdvancedSearchFilters();

/**
* Builds the list of all filter chips to be displayed in the
* filter bar
*/
const filters = useMemo(() => {
const filters = useMemo<FilterItem[]>(() => {
const fromValue = filterFormValues.from?.map((accountID) => personalDetails?.[accountID]?.displayName ?? accountID) ?? [];

const shouldDisplayGroupByFilter = groupBy?.value === CONST.SEARCH.GROUP_BY.FROM || groupBy?.value === CONST.SEARCH.GROUP_BY.CARD;
Expand Down Expand Up @@ -548,6 +560,25 @@ function SearchFiltersBar({queryJSON, headerButtonsOptions, isMobileSelectionMod
hasMultipleOutputCurrency,
]);

const hiddenSelectedFilters = useMemo(() => {
const advancedSearchFiltersKeys = typeFiltersKeys.flat();
const exposedFiltersKeys = filters.flatMap((filter) => {
const dateFilterKey = DATE_FILTER_KEYS.find((key) => filter.filterKey.startsWith(key));

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amount filters should also have been included here. Fixed in #73468.

if (dateFilterKey) {
return dateFilterKey;
}
return filter.filterKey;
});
const hiddenFilters = advancedSearchFiltersKeys.filter((key) => !exposedFiltersKeys.includes(key as SearchAdvancedFiltersKey));
return hiddenFilters.filter((key) => {
const dateFilterKey = DATE_FILTER_KEYS.find((dateKey) => key === dateKey);
if (dateFilterKey) {
return filterFormValues[`${dateFilterKey}On`] ?? filterFormValues[`${dateFilterKey}After`] ?? filterFormValues[`${dateFilterKey}Before`];
}
return filterFormValues[key as SearchAdvancedFiltersKey];
});
}, [filterFormValues, filters, typeFiltersKeys]);

if (hasErrors) {
return null;
}
Expand Down Expand Up @@ -610,7 +641,7 @@ function SearchFiltersBar({queryJSON, headerButtonsOptions, isMobileSelectionMod
link
small
shouldUseDefaultHover={false}
text={translate('search.filtersHeader')}
text={translate('search.filtersHeader') + (hiddenSelectedFilters.length > 0 ? ` (${hiddenSelectedFilters.length})` : '')}
iconFill={theme.link}
iconHoverFill={theme.linkHover}
icon={Expensicons.Filter}
Expand Down
251 changes: 251 additions & 0 deletions src/hooks/useAdvancedSearchFilters.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,251 @@
import {useMemo} from 'react';
import type {OnyxCollection} from 'react-native-onyx';
import {mergeCardListWithWorkspaceFeeds} from '@libs/CardUtils';
import {getAllTaxRates, getTagNamesFromTagsLists, isPolicyFeatureEnabled} from '@libs/PolicyUtils';
import {getAllPolicyValues} from '@libs/SearchQueryUtils';
import CONST from '@src/CONST';
import ONYXKEYS from '@src/ONYXKEYS';
import type {SearchAdvancedFiltersForm} from '@src/types/form';
import type {Policy, PolicyCategories, PolicyTagLists} from '@src/types/onyx';
import type {PolicyFeatureName} from '@src/types/onyx/Policy';
import {getEmptyObject, isEmptyObject} from '@src/types/utils/EmptyObject';
import useLocalize from './useLocalize';
import useOnyx from './useOnyx';
import useWorkspaceList from './useWorkspaceList';

/**
* typeFiltersKeys is stored as an object keyed by the different search types.
* Each value is then an array of arrays where each inner array is a separate section in the UI.
*/
const typeFiltersKeys = {
[CONST.SEARCH.DATA_TYPES.EXPENSE]: [
[
CONST.SEARCH.SYNTAX_FILTER_KEYS.TYPE,
CONST.SEARCH.SYNTAX_FILTER_KEYS.FROM,
CONST.SEARCH.SYNTAX_FILTER_KEYS.TO,
CONST.SEARCH.SYNTAX_FILTER_KEYS.KEYWORD,
CONST.SEARCH.SYNTAX_FILTER_KEYS.STATUS,
CONST.SEARCH.SYNTAX_FILTER_KEYS.POLICY_ID,
CONST.SEARCH.SYNTAX_ROOT_KEYS.GROUP_BY,
],
[
CONST.SEARCH.SYNTAX_FILTER_KEYS.EXPENSE_TYPE,
CONST.SEARCH.SYNTAX_FILTER_KEYS.MERCHANT,
CONST.SEARCH.SYNTAX_FILTER_KEYS.DATE,
CONST.SEARCH.SYNTAX_FILTER_KEYS.AMOUNT,
CONST.SEARCH.SYNTAX_FILTER_KEYS.CURRENCY,
CONST.SEARCH.SYNTAX_FILTER_KEYS.CATEGORY,
CONST.SEARCH.SYNTAX_FILTER_KEYS.TAG,
CONST.SEARCH.SYNTAX_FILTER_KEYS.DESCRIPTION,
CONST.SEARCH.SYNTAX_FILTER_KEYS.CARD_ID,
CONST.SEARCH.SYNTAX_FILTER_KEYS.POSTED,
CONST.SEARCH.SYNTAX_FILTER_KEYS.TAX_RATE,
CONST.SEARCH.SYNTAX_FILTER_KEYS.REIMBURSABLE,
CONST.SEARCH.SYNTAX_FILTER_KEYS.BILLABLE,
],
[
CONST.SEARCH.SYNTAX_FILTER_KEYS.REPORT_ID,
CONST.SEARCH.SYNTAX_FILTER_KEYS.SUBMITTED,
CONST.SEARCH.SYNTAX_FILTER_KEYS.APPROVED,
CONST.SEARCH.SYNTAX_FILTER_KEYS.PAID,
CONST.SEARCH.SYNTAX_FILTER_KEYS.EXPORTED,
CONST.SEARCH.SYNTAX_FILTER_KEYS.WITHDRAWAL_TYPE,
CONST.SEARCH.SYNTAX_FILTER_KEYS.WITHDRAWN,
],
],
[CONST.SEARCH.DATA_TYPES.INVOICE]: [
[
CONST.SEARCH.SYNTAX_FILTER_KEYS.TYPE,
CONST.SEARCH.SYNTAX_FILTER_KEYS.FROM,
CONST.SEARCH.SYNTAX_FILTER_KEYS.TO,
CONST.SEARCH.SYNTAX_FILTER_KEYS.KEYWORD,
CONST.SEARCH.SYNTAX_FILTER_KEYS.STATUS,
CONST.SEARCH.SYNTAX_FILTER_KEYS.POLICY_ID,
],
[
CONST.SEARCH.SYNTAX_FILTER_KEYS.MERCHANT,
CONST.SEARCH.SYNTAX_FILTER_KEYS.DATE,
CONST.SEARCH.SYNTAX_FILTER_KEYS.AMOUNT,
CONST.SEARCH.SYNTAX_FILTER_KEYS.CURRENCY,
CONST.SEARCH.SYNTAX_FILTER_KEYS.CATEGORY,
CONST.SEARCH.SYNTAX_FILTER_KEYS.TAG,
CONST.SEARCH.SYNTAX_FILTER_KEYS.DESCRIPTION,
CONST.SEARCH.SYNTAX_FILTER_KEYS.CARD_ID,
CONST.SEARCH.SYNTAX_FILTER_KEYS.POSTED,
CONST.SEARCH.SYNTAX_FILTER_KEYS.TAX_RATE,
],
[
CONST.SEARCH.SYNTAX_FILTER_KEYS.REPORT_ID,
CONST.SEARCH.SYNTAX_FILTER_KEYS.SUBMITTED,
CONST.SEARCH.SYNTAX_FILTER_KEYS.APPROVED,
CONST.SEARCH.SYNTAX_FILTER_KEYS.PAID,
CONST.SEARCH.SYNTAX_FILTER_KEYS.EXPORTED,
CONST.SEARCH.SYNTAX_FILTER_KEYS.WITHDRAWAL_TYPE,
CONST.SEARCH.SYNTAX_FILTER_KEYS.WITHDRAWN,
],
],
[CONST.SEARCH.DATA_TYPES.TRIP]: [
[
CONST.SEARCH.SYNTAX_FILTER_KEYS.TYPE,
CONST.SEARCH.SYNTAX_FILTER_KEYS.FROM,
CONST.SEARCH.SYNTAX_FILTER_KEYS.TO,
CONST.SEARCH.SYNTAX_FILTER_KEYS.KEYWORD,
CONST.SEARCH.SYNTAX_FILTER_KEYS.STATUS,
CONST.SEARCH.SYNTAX_FILTER_KEYS.POLICY_ID,
CONST.SEARCH.SYNTAX_ROOT_KEYS.GROUP_BY,
],
[
CONST.SEARCH.SYNTAX_FILTER_KEYS.MERCHANT,
CONST.SEARCH.SYNTAX_FILTER_KEYS.DATE,
CONST.SEARCH.SYNTAX_FILTER_KEYS.AMOUNT,
CONST.SEARCH.SYNTAX_FILTER_KEYS.CURRENCY,
CONST.SEARCH.SYNTAX_FILTER_KEYS.CATEGORY,
CONST.SEARCH.SYNTAX_FILTER_KEYS.TAG,
CONST.SEARCH.SYNTAX_FILTER_KEYS.DESCRIPTION,
CONST.SEARCH.SYNTAX_FILTER_KEYS.CARD_ID,
CONST.SEARCH.SYNTAX_FILTER_KEYS.POSTED,
CONST.SEARCH.SYNTAX_FILTER_KEYS.TAX_RATE,
],
[
CONST.SEARCH.SYNTAX_FILTER_KEYS.REPORT_ID,
CONST.SEARCH.SYNTAX_FILTER_KEYS.SUBMITTED,
CONST.SEARCH.SYNTAX_FILTER_KEYS.APPROVED,
CONST.SEARCH.SYNTAX_FILTER_KEYS.PAID,
CONST.SEARCH.SYNTAX_FILTER_KEYS.EXPORTED,
],
],
[CONST.SEARCH.DATA_TYPES.CHAT]: [
[
CONST.SEARCH.SYNTAX_FILTER_KEYS.TYPE,
CONST.SEARCH.SYNTAX_FILTER_KEYS.FROM,
CONST.SEARCH.SYNTAX_FILTER_KEYS.TO,
CONST.SEARCH.SYNTAX_FILTER_KEYS.IN,
CONST.SEARCH.SYNTAX_FILTER_KEYS.KEYWORD,
CONST.SEARCH.SYNTAX_FILTER_KEYS.STATUS,
CONST.SEARCH.SYNTAX_FILTER_KEYS.POLICY_ID,
CONST.SEARCH.SYNTAX_FILTER_KEYS.DATE,
],
],
[CONST.SEARCH.DATA_TYPES.TASK]: [
[
CONST.SEARCH.SYNTAX_FILTER_KEYS.TYPE,
CONST.SEARCH.SYNTAX_FILTER_KEYS.TITLE,
CONST.SEARCH.SYNTAX_FILTER_KEYS.DESCRIPTION,
CONST.SEARCH.SYNTAX_FILTER_KEYS.IN,
CONST.SEARCH.SYNTAX_FILTER_KEYS.FROM,
CONST.SEARCH.SYNTAX_FILTER_KEYS.ASSIGNEE,
CONST.SEARCH.SYNTAX_FILTER_KEYS.STATUS,
CONST.SEARCH.SYNTAX_FILTER_KEYS.DATE,
],
],
};

function shouldDisplayFilter(numberOfFilters: number, isFeatureEnabled: boolean, singlePolicyCondition = false): boolean {
return (numberOfFilters !== 0 || singlePolicyCondition) && isFeatureEnabled;
}

function isFeatureEnabledInPolicies(policies: OnyxCollection<Policy>, featureName: PolicyFeatureName) {
if (isEmptyObject(policies)) {
return false;
}
return Object.values(policies).some((policy) => isPolicyFeatureEnabled(policy, featureName));
}

function useAdvancedSearchFilters() {
const {localeCompare} = useLocalize();
const [searchAdvancedFilters = getEmptyObject<SearchAdvancedFiltersForm>()] = useOnyx(ONYXKEYS.FORMS.SEARCH_ADVANCED_FILTERS_FORM, {canBeMissing: true});
const policyID = searchAdvancedFilters.policyID;
const groupBy = searchAdvancedFilters.groupBy;
const [userCardList] = useOnyx(ONYXKEYS.CARD_LIST, {canBeMissing: false});
const [workspaceCardFeeds] = useOnyx(ONYXKEYS.COLLECTION.WORKSPACE_CARDS_LIST, {canBeMissing: false});
const allCards = useMemo(() => mergeCardListWithWorkspaceFeeds(workspaceCardFeeds ?? CONST.EMPTY_OBJECT, userCardList, true), [userCardList, workspaceCardFeeds]);
const taxRates = getAllTaxRates();

const [policies = getEmptyObject<NonNullable<OnyxCollection<Policy>>>()] = useOnyx(ONYXKEYS.COLLECTION.POLICY, {canBeMissing: false});
const [allPolicyCategories = getEmptyObject<NonNullable<OnyxCollection<PolicyCategories>>>()] = useOnyx(ONYXKEYS.COLLECTION.POLICY_CATEGORIES, {
canBeMissing: false,
selector: (policyCategories) =>
Object.fromEntries(
Object.entries(policyCategories ?? {}).filter(([, categories]) => {
const availableCategories = Object.values(categories ?? {}).filter((category) => category.pendingAction !== CONST.RED_BRICK_ROAD_PENDING_ACTION.DELETE);
return availableCategories.length > 0;
}),
),
});
const selectedPolicyCategories = getAllPolicyValues(policyID, ONYXKEYS.COLLECTION.POLICY_CATEGORIES, allPolicyCategories);
const [allPolicyTagLists = getEmptyObject<NonNullable<OnyxCollection<PolicyTagLists>>>()] = useOnyx(ONYXKEYS.COLLECTION.POLICY_TAGS, {canBeMissing: false});
const selectedPolicyTagLists = getAllPolicyValues(policyID, ONYXKEYS.COLLECTION.POLICY_TAGS, allPolicyTagLists);
const tagListsUnpacked = Object.values(allPolicyTagLists ?? {})
.filter((item): item is NonNullable<PolicyTagLists> => !!item)
.map(getTagNamesFromTagsLists)
.flat();

const [currentUserLogin] = useOnyx(ONYXKEYS.SESSION, {canBeMissing: false, selector: (session) => session?.email});

const {sections: workspaces} = useWorkspaceList({
policies,
currentUserLogin,
shouldShowPendingDeletePolicy: false,
selectedPolicyIDs: undefined,
searchTerm: '',
localeCompare,
});

// When looking if a user has any categories to display, we want to ignore the policies that are of type PERSONAL
const nonPersonalPolicyCategoryIds = Object.values(policies)
.filter((policy): policy is NonNullable<Policy> => !!(policy && policy.type !== CONST.POLICY.TYPE.PERSONAL))
.map((policy) => `${ONYXKEYS.COLLECTION.POLICY_CATEGORIES}${policy.id}`);
const nonPersonalPolicyCategoryCount = Object.keys(allPolicyCategories).filter((policyCategoryId) => nonPersonalPolicyCategoryIds.includes(policyCategoryId)).length;

const areCategoriesEnabled = isFeatureEnabledInPolicies(policies, CONST.POLICY.MORE_FEATURES.ARE_CATEGORIES_ENABLED);
const areTagsEnabled = isFeatureEnabledInPolicies(policies, CONST.POLICY.MORE_FEATURES.ARE_TAGS_ENABLED);
const areCardsEnabled =
isFeatureEnabledInPolicies(policies, CONST.POLICY.MORE_FEATURES.ARE_COMPANY_CARDS_ENABLED) ||
isFeatureEnabledInPolicies(policies, CONST.POLICY.MORE_FEATURES.ARE_EXPENSIFY_CARDS_ENABLED);
const areTaxEnabled = isFeatureEnabledInPolicies(policies, CONST.POLICY.MORE_FEATURES.ARE_TAXES_ENABLED);
const shouldDisplayCategoryFilter = shouldDisplayFilter(nonPersonalPolicyCategoryCount, areCategoriesEnabled, !!selectedPolicyCategories);
const shouldDisplayTagFilter = shouldDisplayFilter(tagListsUnpacked.length, areTagsEnabled, !!selectedPolicyTagLists);
const shouldDisplayCardFilter = shouldDisplayFilter(Object.keys(allCards).length, areCardsEnabled);
const shouldDisplayTaxFilter = shouldDisplayFilter(Object.keys(taxRates).length, areTaxEnabled);
const shouldDisplayWorkspaceFilter = workspaces.some((section) => section.data.length !== 0);
const shouldDisplayGroupByFilter = groupBy === CONST.SEARCH.GROUP_BY.FROM || groupBy === CONST.SEARCH.GROUP_BY.CARD;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coming from #75481, we remove shouldDisplayGroupByFilter so the Group filter is always displayed in the RHP, even when it is not included in the search keyword.


let currentType = searchAdvancedFilters?.type ?? CONST.SEARCH.DATA_TYPES.EXPENSE;

if (!Object.keys(typeFiltersKeys).includes(currentType)) {
currentType = CONST.SEARCH.DATA_TYPES.EXPENSE;
}

return {
currentType,
typeFiltersKeys: typeFiltersKeys[currentType]
.map((section) =>
section
.map((key) => {
if (key === CONST.SEARCH.SYNTAX_FILTER_KEYS.CATEGORY && !shouldDisplayCategoryFilter) {
return;
}
if (key === CONST.SEARCH.SYNTAX_FILTER_KEYS.TAG && !shouldDisplayTagFilter) {
return;
}
if ((key === CONST.SEARCH.SYNTAX_FILTER_KEYS.CARD_ID || CONST.SEARCH.SYNTAX_FILTER_KEYS.POSTED) && !shouldDisplayCardFilter) {
return;
}
if (key === CONST.SEARCH.SYNTAX_FILTER_KEYS.TAX_RATE && !shouldDisplayTaxFilter) {
return;
}
if (key === CONST.SEARCH.SYNTAX_FILTER_KEYS.POLICY_ID && !shouldDisplayWorkspaceFilter) {
return;
}
if (key === CONST.SEARCH.SYNTAX_ROOT_KEYS.GROUP_BY && !shouldDisplayGroupByFilter) {
return;
}
return key;
})
.filter((filter): filter is NonNullable<typeof filter> => !!filter),
)
.filter((section) => !!section.length),
};
}

export default useAdvancedSearchFilters;
Loading