Skip to content

feat/80393: FE - Add "Top merchants" suggested search with group by filter#80425

Closed
btkcodedev wants to merge 19 commits intoExpensify:mainfrom
btkcodedev:btkcodedev/80393TopMerchants
Closed

feat/80393: FE - Add "Top merchants" suggested search with group by filter#80425
btkcodedev wants to merge 19 commits intoExpensify:mainfrom
btkcodedev:btkcodedev/80393TopMerchants

Conversation

@btkcodedev
Copy link
Contributor

Explanation of Change

We need to add the ability to Group By Merchant from Reports > Expenses (group-by:merchant) and add a "Top Merchants" suggested search to all accounts with a workspace. This feature should follow the same pattern as "Top Spenders" and other group-by options (from, card, withdrawal-id) to maintain consistency across the application.

Fixed Issues

$ #80393
PROPOSAL: #80393 (comment)

Tests

  1. Go to test branch
  2. Go to Reports > Expenses
  3. Verify - "Top Merchants" is added to the suggested search on left side
  4. Verify group-by: merchant field is present for all the workplace users
  5. Verify no errors are present
  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

  1. Go to test branch
  2. Go to Reports > Expenses
  3. Verify - "Top Merchants" is added to the suggested search on left side
  4. Verify group-by: merchant field is present for all the workplace users
  5. Verify no errors are present
  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I verified there are no new alerts related to the canBeMissing param for useOnyx
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
1000000334.mp4
Android: mWeb Chrome
screen-20260124-205403.mp4
iOS: Native
Screen.Recording.2026-01-24.at.7.50.11.PM.mov
iOS: mWeb Safari
Screen.Recording.2026-01-24.at.9.01.20.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2026-01-24.at.7.06.12.PM.mov

@btkcodedev btkcodedev requested review from a team as code owners January 24, 2026 15:33
@melvin-bot melvin-bot bot requested review from joekaufmanexpensify and shubham1206agra and removed request for joekaufmanexpensify January 24, 2026 15:33
@melvin-bot
Copy link

melvin-bot bot commented Jan 24, 2026

Hey, I noticed you changed src/languages/en.ts in a PR from a fork. For security reasons, translations are not generated automatically for PRs from forks.

If you want to automatically generate translations for other locales, an Expensify employee will have to:

  1. Look at the code and make sure there are no malicious changes.
  2. Run the Generate static translations GitHub workflow. If you have write access and the K2 extension, you can simply click: [this button]

Alternatively, if you are an external contributor, you can run the translation script locally with your own OpenAI API key. To learn more, try running:

npx ts-node ./scripts/generateTranslations.ts --help

Typically, you'd want to translate only what you changed by running npx ts-node ./scripts/generateTranslations.ts --compare-ref main

@melvin-bot melvin-bot bot requested review from a team and removed request for a team January 24, 2026 15:33
@melvin-bot
Copy link

melvin-bot bot commented Jan 24, 2026

@shubham1206agra Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@melvin-bot melvin-bot bot requested review from JmillsExpensify and removed request for a team January 24, 2026 15:33
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 182be118c2

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment on lines +638 to +642
searchQuery: buildQueryStringFromFilterFormValues(
{
type: CONST.SEARCH.DATA_TYPES.EXPENSE,
groupBy: CONST.SEARCH.GROUP_BY.MERCHANT,
dateOn: CONST.SEARCH.DATE_PRESETS.LAST_MONTH,

Choose a reason for hiding this comment

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

P1 Badge Add merchant grouping handling in section builders

The new Top Merchants suggestion sets groupBy: MERCHANT here, but getSections() / getSortedSections() only handle FROM/CARD/WITHDRAWAL_ID. For groupBy=merchant the switch falls through to getTransactionsSections, while getListItem() still picks TransactionGroupListItem because groupBy is truthy, so each item lacks transactions and groupItem.transactions becomes undefined at render time. That means opening the Top merchants suggestion or using group-by:merchant will either show ungrouped results with grouped columns or crash the grouped list item. Add a merchant grouping path (and sorting) similar to the existing group-by cases.

Useful? React with 👍 / 👎.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Resolved

@codecov
Copy link

codecov bot commented Jan 24, 2026

Codecov Report

❌ Looks like you've decreased code coverage for some files. Please write tests to increase, or at least maintain, the existing level of code coverage. See our documentation here for how to interpret this table.

Files with missing lines Coverage Δ
src/CONST/index.ts 83.76% <ø> (ø)
...stWithSections/Search/TransactionGroupListItem.tsx 78.50% <100.00%> (+6.80%) ⬆️
...ListWithSections/Search/MerchantListItemHeader.tsx 96.00% <96.00%> (ø)
...ts/SelectionListWithSections/SearchTableHeader.tsx 6.34% <0.00%> (-0.44%) ⬇️
src/pages/Search/SearchColumnsPage.tsx 0.00% <0.00%> (ø)
src/libs/SearchUIUtils.ts 63.51% <46.15%> (+3.82%) ⬆️
... and 104 files with indirect coverage changes

@btkcodedev
Copy link
Contributor Author

btkcodedev commented Jan 24, 2026

Feature tested and verified after resolving automated comments:

Screen.Recording.2026-01-24.at.11.14.10.PM.mov

Copy link
Contributor

Choose a reason for hiding this comment

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

@btkcodedev Please update tests inside tests/unit/Search/SearchUIUtilsTest

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

Copy link
Contributor

Choose a reason for hiding this comment

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

@btkcodedev Please fix the tests here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

Copy link
Contributor

Choose a reason for hiding this comment

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

@btkcodedev It's still not fixed. Please look at other files for correct tests.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep, fixed now. I'll update again after the GH action run
Screenshot 2026-01-25 at 1 05 09 PM

Copy link
Contributor Author

Choose a reason for hiding this comment

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

GH actions passed. Reviewer checklist pending

Copy link
Contributor

Choose a reason for hiding this comment

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

@btkcodedev Again, this is not correct. Please see similar files for correct tests. You cannot suppress all ESLint errors without comments on why. And the reason must be valid too.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Corrected that, but still has ESLint suppressions for unavoidable any types in Jest mocks

unapprovedCard: 'Tarjeta no aprobada',
reconciliation: 'Conciliación',
topSpenders: 'Mayores gastadores',
topMerchants: 'Principales comerciantes',
Copy link
Contributor

Choose a reason for hiding this comment

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

@btkcodedev Please confirm the translations

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, i've used claude for it, all translations looks good and professional

Copy link
Contributor

Choose a reason for hiding this comment

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

Read the contributor doc and checklist for how to confirm translation.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I verified any copy/text shown in the product is localized by adding it to src/languages/* files

Copy link
Contributor

Choose a reason for hiding this comment

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

Read

If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Posted - link
Awaiting approval

Copy link
Contributor

Choose a reason for hiding this comment

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

@shubham1206agra shouldn't the generateTranslations script be run on this PR. Only Spanish needs internal approval?

Copy link
Contributor

Choose a reason for hiding this comment

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

@trjExpensify, it should have triggered. Not sure how to do this manually.

Comment on lines +964 to +978
// Trigger searches for all groups to load their transactions (only for merchant grouping)
if (validGroupBy === CONST.SEARCH.GROUP_BY.MERCHANT) {
for (const item of filteredData as TransactionGroupListItemType[]) {
if (!item.transactionsQueryJSON || isExpenseReportType) {
continue;
}
handleSearch({
queryJSON: item.transactionsQueryJSON,
searchKey: undefined,
offset: 0,
shouldCalculateTotals: false,
isLoading: false,
});
}
}
Copy link
Contributor

Choose a reason for hiding this comment

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

@btkcodedev Why do we need this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

"Select All" must first load all expenses. Otherwise, it selects only the currently expanded merchant expenses.

Copy link
Contributor

Choose a reason for hiding this comment

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

@btkcodedev This bug is present for Top Spenders too. So, can you please report it so it can be handled separately? Also, remove this workaround.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure

@mountiny
Copy link
Contributor

@codex review

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ce85b06f25

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment on lines +727 to +729
const isAuditor = policy.role === CONST.POLICY.ROLE.AUDITOR;
const isEligibleForTopSpendersSuggestion = isPaidPolicy && (isAdmin || isAuditor || isApprover);
const isEligibleForTopMerchantsSuggestion = isPaidPolicy && (isAdmin || isAuditor || isApprover);

Choose a reason for hiding this comment

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

P2 Badge Broaden Top merchants suggestion visibility

The new visibility gate for Top merchants is isPaidPolicy && (isAdmin || isAuditor || isApprover), which means regular workspace members (e.g., submitters) will never see the suggested search even though they belong to a workspace and can use group-by merchant. This hides the feature for a large portion of workspace users and contradicts the “all accounts with a workspace” intent. Consider removing the role check or aligning it with the actual availability expectations so non-admin members still get the suggestion.

Useful? React with 👍 / 👎.

Copy link
Contributor

Choose a reason for hiding this comment

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

That is expected I believe

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The issue suggested following the same pattern as Top Spenders, so Top Merchants was also allowed within the same scope.

Frontend Release 2: Add "Top Merchants" suggested search
Follow the same pattern as "Top Spenders" and "Top Categories"

Copy link
Contributor

Choose a reason for hiding this comment

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

The doc is expecting all workspace members for Top Merchants, same as Top Categories:

Add a Top Merchants suggested search to all accounts with a workspace

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done. Scope changed to all workspace members

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Partial review; we need the limit filter first.

key: CONST.SEARCH.SEARCH_KEYS.TOP_MERCHANTS,
translationPath: 'search.topMerchants',
type: CONST.SEARCH.DATA_TYPES.EXPENSE,
icon: Expensicons.Receipt,
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB: We should have a basket icon here.

Image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There seems to be no basket icon in @assets.
~/src/components/Icon

import Bank from '@assets/images/bank.svg';
import Bell from '@assets/images/bell.svg';
import Bill from '@assets/images/bill.svg';
import boltSlash from '@assets/images/bolt-slash.svg';
import Bolt from '@assets/images/bolt.svg';
import Bookmark from '@assets/images/bookmark.svg';
import Bug from '@assets/images/bug.svg';
import Building from '@assets/images/building.svg';
import Buildings from '@assets/images/buildings.svg';

Closest fit is a building icon, or we can keep the current receipt icon.

},
{
sortBy: CONST.SEARCH.TABLE_COLUMNS.GROUP_TOTAL,
sortOrder: CONST.SEARCH.SORT_ORDER.DESC,
Copy link
Contributor

Choose a reason for hiding this comment

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

We need to add a limit:10 here somewhere.

@neil-marcellini neil-marcellini changed the title feat/80393: FE - Add "Top merchants" suggested search with group by filter [HOLD 80262] feat/80393: FE - Add "Top merchants" suggested search with group by filter Jan 26, 2026
@neil-marcellini
Copy link
Contributor

HOLDing until this is merged

@puneetlath puneetlath changed the title [HOLD 80262] feat/80393: FE - Add "Top merchants" suggested search with group by filter feat/80393: FE - Add "Top merchants" suggested search with group by filter Jan 27, 2026
@neil-marcellini
Copy link
Contributor

neil-marcellini commented Jan 27, 2026

Hi @btkcodedev we are going to have @TaduJR take this over because he recently worked on a related PR and has agreed to work in our timezone.

We will work with you to come to an agreement on compensation for your work so far.

@btkcodedev
Copy link
Contributor Author

As you say @neil-marcellini
It's almost finished, all that left was just clearing your comments.

@btkcodedev
Copy link
Contributor Author

btkcodedev commented Jan 29, 2026

@neil-marcellini The PR for this feature is merged - #80672
May I go ahead and close this PR?
Also, I would appreciate it if a courtesy payment could be provided. 🙇

@shubham1206agra
Copy link
Contributor

@btkcodedev Please close this PR. And please request this in main issue.

@btkcodedev btkcodedev closed this Jan 29, 2026
@btkcodedev btkcodedev deleted the btkcodedev/80393TopMerchants branch March 13, 2026 07:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants