[HOLD for payment 2024-11-20] [$250] Search filters - Category list shows default categories when no workspace is created

[lanitochka17]

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!

---

Version Number: 9.0.47-1
Reproducible in staging?: Y
Reproducible in production?: Y
If this was caught during regression testing, add the test name, ID and link from TestRail: N/A
Email or phone of affected tester (no customers): applausetester+pso@applause.expensifail.com
Issue reported by: Applause - Internal Team

Action Performed:

1. Go to staging.new.expensify.com
2. Log in with a new account (no workspace)
3. Go to Search
4. Click Filters
5. Click Categories

Expected Result:

Category list should be empty because no workspace is created

Actual Result:

Category list shows default categories when no workspace is created

Workaround:

Unknown

Platforms:

Which of our officially supported platforms is this issue occurring on?

• Android: Native
• Android: mWeb Chrome
• iOS: Native
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

Add any screenshot/video evidence

Bug6630371_1728540215030.20241010_140142.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~021844424503641996992
• Upwork Job ID: 1844424503641996992
• Last Price Increase: 2024-10-31

Issue Owner

Current Issue Owner: @garrettmknight

[melvin-bot]

Triggered auto assignment to @garrettmknight (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details. Please add this bug to a GH project, as outlined in the SO.

[lanitochka17]

@garrettmknight FYI I haven't added the External label as I wasn't 100% sure about this issue. Please take a look and add the label if you agree it's a bug and can be handled by external contributors

[lanitochka17]

We think that this bug might be related to #wave-control

[NJ-2020]

Edited by proposal-police: This proposal was edited at 2024-10-16 06:05:34 UTC.

Proposal

Please re-state the problem that we are trying to solve in this issue.

Search filters - Category list shows default categories when no workspace is created

What is the root cause of that problem?

Right here we don't filter out the personal policy for allPolicyIDCategories

App/src/pages/Search/SearchAdvancedFiltersPage/SearchFiltersCategoryPage.tsx

Lines 22 to 32 in 8f5ba1e

	const [allPolicyIDCategories] = useOnyx(ONYXKEYS.COLLECTION.POLICY_CATEGORIES);
	const singlePolicyCategories = allPolicyIDCategories?.[`${ONYXKEYS.COLLECTION.POLICY_CATEGORIES}${policyID}`];
	const categoryItems = useMemo(() => {
	if (!singlePolicyCategories) {
	const uniqueCategoryNames = new Set<string>();
	Object.values(allPolicyIDCategories ?? {}).map((policyCategories) => Object.values(policyCategories ?? {}).forEach((category) => uniqueCategoryNames.add(category.name)));
	return Array.from(uniqueCategoryNames).map((categoryName) => ({name: categoryName, value: categoryName}));
	}
	return Object.values(singlePolicyCategories ?? {}).map((category) => ({name: category.name, value: category.name}));
	}, [allPolicyIDCategories, singlePolicyCategories]);

And inside AdvancedSearchFilters.tsx we don't hide the categories, tags, and taxes if the list is empty

What changes do you think we should make in order to solve the problem?

We can create 2 new hooks inside PolicyUtils to get the lists of tags and categories, for taxes we already have right here:

App/src/pages/Search/AdvancedSearchFilters.tsx

Line 262 in ce23fb5

const taxRates = getAllTaxRates();

and we will hide the categories, tags and taxes inside AdvancedSearchFilters page if the list is empty

function getAllTags(): Record<string, string> {
    const tags: Record<string, string> = {};
    Object.values(allTags ?? {})?.forEach((policy) => {
        if (!policy?.Tag.tags) {
            return;
        }
        Object.entries(policy?.Tag.tags).forEach(([tagKey, tag]) => {
            if (!tags[tag.name]) {
                tags[tag.name] = tagKey;
                return;
            }
        });
    });
    return tags;
}

function getAllCategories() {
    const uniqueCategoryNames = new Set<string>();
    const personalPolicyID = getPersonalPolicy()?.id;
    Object.entries(allCategories ?? {})?.forEach(([policyKey, policyCategories]) => {
        if (isEmptyObject(policyCategories) || policyKey === `${ONYXKEYS.COLLECTION.POLICY_CATEGORIES}${personalPolicyID}`) {
            return;
        }
        Object.values(policyCategories ?? {}).forEach((category) => uniqueCategoryNames.add(category.name));
    });
    return Array.from(uniqueCategoryNames).map((categoryName) => ({name: categoryName, value: categoryName}));
}

Then inside AdvancedSearchFilters

const tags = getAllTags();
const categories = getAllCategories();

...
else if (key === CONST.SEARCH.SYNTAX_FILTER_KEYS.CATEGORY) {
    if (isEmptyObject(categories)) {
        return undefined;
    }
    filterTitle = baseFilterConfig[key].getTitle(searchAdvancedFilters, key, translate);
} else if (key === CONST.SEARCH.SYNTAX_FILTER_KEYS.TAG) {
    if (isEmptyObject(tags)) {
        return undefined;
    }
    filterTitle = baseFilterConfig[key].getTitle(searchAdvancedFilters, key, translate);
}  else if (key === CONST.SEARCH.SYNTAX_FILTER_KEYS.TAX_RATE) {
    if (isEmptyObject(taxRates)) {
        return undefined;
    }
    filterTitle = baseFilterConfig[key].getTitle(searchAdvancedFilters, taxRates);
}

For cards we already hide right here if the lists are empty

App/src/pages/Search/AdvancedSearchFilters.tsx

Line 261 in ce23fb5

const [cardList = {}] = useOnyx(ONYXKEYS.CARD_LIST);

App/src/pages/Search/AdvancedSearchFilters.tsx

Lines 317 to 321 in ce23fb5

	} else if (key === CONST.SEARCH.SYNTAX_FILTER_KEYS.CARD_ID) {
	if (Object.keys(cardList).length === 0) {
	return undefined;
	}
	filterTitle = baseFilterConfig[key].getTitle(searchAdvancedFilters, cardList);

But i think for cards we should update the if condition from above code to:

if (isEmptyObject(cardList)) {
    return undefined;
}

And Inside the SearchFiltersCategoryPage we can use the new hook we just created getAllCategories if the current policy categories is empty which also will filter out the personal policy
And we should update from this:

App/src/pages/Search/SearchAdvancedFiltersPage/SearchFiltersCategoryPage.tsx

Lines 31 to 41 in ce23fb5

	const categoryItems = useMemo(() => {
	const items = [{name: translate('search.noCategory'), value: CONST.SEARCH.EMPTY_VALUE as string}];
	if (!singlePolicyCategories) {
	const uniqueCategoryNames = new Set<string>();
	Object.values(allPolicyIDCategories ?? {}).map((policyCategories) => Object.values(policyCategories ?? {}).forEach((category) => uniqueCategoryNames.add(category.name)));
	items.push(...Array.from(uniqueCategoryNames).map((categoryName) => ({name: categoryName, value: categoryName})));
	} else {
	items.push(...Object.values(singlePolicyCategories ?? {}).map((category) => ({name: category.name, value: category.name})));
	}
	return items;
	}, [allPolicyIDCategories, singlePolicyCategories, translate]);

to

const categoryItems = useMemo(() => {
    if (!singlePolicyCategories) {
        return PolicyUtils.getAllCategories();
    }
    return Object.values(singlePolicyCategories ?? {}).map((category) => ({name: category.name, value: category.name}));
}, [singlePolicyCategories]);

Here's the test branch

Result

What alternative solutions did you explore? (Optional)

[truph01]

Edited by proposal-police: This proposal was edited at 2024-10-11 23:28:14 UTC.

Proposal

Please re-state the problem that we are trying to solve in this issue.

Category list shows default categories when no workspace is created

What is the root cause of that problem?

• In the logic to get the categories from policies:

App/src/pages/Search/SearchAdvancedFiltersPage/SearchFiltersCategoryPage.tsx

Line 28 in 8f5ba1e

Object.values(allPolicyIDCategories ?? {}).map((policyCategories) => Object.values(policyCategories ?? {}).forEach((category) => uniqueCategoryNames.add(category.name)));

we don't filter out the personal policy, which also has categories.

What changes do you think we should make in order to solve the problem?

• In this, we should check if the policy is personal policy, if so, don't get categories from it:

            const personalPolicyID = PolicyUtils.getPersonalPolicy()?.id;
            const allPolicyIDCategoriesWithoutPersonalPolicy = Object.keys(allPolicyIDCategories).map((key)=>{
                if(key === `policyCategories_${personalPolicyID}`){
                    return {}
                }
                return allPolicyIDCategories?.[key]
            })
          
            allPolicyIDCategoriesWithoutPersonalPolicy.map((policyCategories) => Object.values(policyCategories ?? {}).forEach((category) => uniqueCategoryNames.add(category.name)));

What alternative solutions did you explore? (Optional)

• Beside the main solution, if we want to hide the category option in AdvancedSearchFilters if there is no category option, we can:

1. Create a util hook to get the categories, tags, cards, ... data:

const useFilterOption = () => {
    const [searchAdvancedFiltersForm] = useOnyx(ONYXKEYS.FORMS.SEARCH_ADVANCED_FILTERS_FORM);
    const selectedCategoriesItems = searchAdvancedFiltersForm?.category?.map((category) => ({name: category, value: category}));
    const policyID = searchAdvancedFiltersForm?.policyID ?? '-1';
    const [allPolicyIDCategories] = useOnyx(ONYXKEYS.COLLECTION.POLICY_CATEGORIES);
    const singlePolicyCategories = allPolicyIDCategories?.[`${ONYXKEYS.COLLECTION.POLICY_CATEGORIES}${policyID}`];

    const categories = useMemo(() => {
        if (!singlePolicyCategories) {
            const uniqueCategoryNames = new Set<string>();
            Object.values(allPolicyIDCategories ?? {}).map((policyCategories) => Object.values(policyCategories ?? {}).forEach((category) => uniqueCategoryNames.add(category.name)));
            return Array.from(uniqueCategoryNames).map((categoryName) => ({name: categoryName, value: categoryName}));
        }
        return Object.values(singlePolicyCategories ?? {}).map((category) => ({name: category.name, value: category.name}));
    }, [allPolicyIDCategories, singlePolicyCategories]);

    const [allPoliciesTagsLists] = useOnyx(ONYXKEYS.COLLECTION.POLICY_TAGS);
    const singlePolicyTagsList: PolicyTagLists | undefined = allPoliciesTagsLists?.[`${ONYXKEYS.COLLECTION.POLICY_TAGS}${policyID}`];

    const tags = useMemo(() => {
        if (!singlePolicyTagsList) {
            const uniqueTagNames = new Set<string>();
            const tagListsUnpacked = Object.values(allPoliciesTagsLists ?? {}).filter((item) => !!item) as PolicyTagLists[];
            tagListsUnpacked
                .map((policyTagLists) => {
                    return getTagNamesFromTagsLists(policyTagLists);
                })
                .flat()
                .forEach((tag) => uniqueTagNames.add(tag));
            return Array.from(uniqueTagNames).map((tagName) => ({name: tagName, value: tagName}));
        }
        return getTagNamesFromTagsLists(singlePolicyTagsList).map((name) => ({name, value: name}));
    }, [allPoliciesTagsLists, singlePolicyTagsList]);

    const [cards] = useOnyx(ONYXKEYS.CARD_LIST);
    return {categories, tags, cards};
};

2. In AdvancedSearchFilters use:

    const {cards, categories, tags} = useFilterOption();

then for the key category, tag, or card, check if its options length is greater than 0, if not, return undefined in:

App/src/pages/Search/AdvancedSearchFilters.tsx

Line 268 in 8f5ba1e

const filters = typeFiltersKeys[currentType].map((key) => {

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~021844424503641996992

[melvin-bot]

Triggered auto assignment to Contributor-plus team member for initial proposal review - @fedirjh (External)