Skip to content

Sort top categories/merchants insights by groupTotal desc#84424

Open
MelvinBot wants to merge 4 commits intomainfrom
claude-fixTopInsightSearchSortOrder
Open

Sort top categories/merchants insights by groupTotal desc#84424
MelvinBot wants to merge 4 commits intomainfrom
claude-fixTopInsightSearchSortOrder

Conversation

@MelvinBot
Copy link
Contributor

@MelvinBot MelvinBot commented Mar 6, 2026

Explanation of Change

Previously, the default sorting for top categories and top merchants insights were incorrect. That has been fixed, and then I also changed it so that updating the view mode, for example, from bar to table, does not change the sort order. The view setting should only affect presentation, not ordering.

Fixed Issues

$ #84420

Tests

  1. Create some expenses with different amounts, merchants, and categories, all dated to last month
  2. Navigate to the Search page
  3. Click on "Top categories" in the suggested searches
  4. Switch to view:table
  5. Verify categories are sorted from highest to lowest total spend (not alphabetically)
  6. Go back and click on "Top merchants"
  7. Switch to view:table
  8. Verify merchants are sorted from highest to lowest total spend (not alphabetically)
  9. Go to the base expenses search
  10. Open the filters
  11. Set group by to category
  12. Verify the results are sorted by category ascending
  13. Set the group by to merchant
  14. Verify the results are sorted by merchant ascending
  • Verify that no errors appear in the JS console

Offline tests

N/A - This change only affects the default search query string construction. Sorting is handled server-side.

QA Steps

Same as tests

  • 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 it to be fixed)
  • 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

The changes are platform independent, so I only tested on Mac Chrome.

Android: Native

N/A - No UI changes, only default search query parameter change

Android: mWeb Chrome

N/A - No UI changes, only default search query parameter change

iOS: Native

N/A - No UI changes, only default search query parameter change

iOS: mWeb Safari

N/A - No UI changes, only default search query parameter change

MacOS: Chrome / Safari
SearchOrder2026-03-06_13-07-08.mp4

MelvinBot and others added 2 commits March 6, 2026 16:10
The default insight search queries for "Top categories" and "Top merchants"
were sorting alphabetically (by groupCategory/groupMerchant ASC) instead of
by total spend descending. This changes them to always sort by groupTotal DESC,
which is the expected behavior for "Top X" reports.

Co-authored-by: Neil Marcellini <neil-marcellini@users.noreply.github.com>
Updates the sort default tests for Top Categories and Top Merchants
to assert the corrected sort behavior (groupTotal desc).

Co-authored-by: Neil Marcellini <neil-marcellini@users.noreply.github.com>
@neil-marcellini
Copy link
Contributor

@MelvinBot please test this add add screenshots for Chrome to the PR description

@MelvinBot
Copy link
Contributor Author

I tested this PR in Chrome and updated the PR description with screenshots in the MacOS: Chrome / Safari section. Here's what was verified:

Test results — all passing:

  1. Top categories (bar view): URL correctly contains sortBy:groupTotal sortOrder:desc — no longer using alphabetical sort
  2. Top categories (table view): After switching to table view, the sortBy:groupTotal sortOrder:desc parameters are preserved
  3. Top merchants (pie view): URL correctly contains sortBy:groupTotal sortOrder:desc
  4. Top merchants (table view): After switching to table view, the sortBy:groupTotal sortOrder:desc parameters are preserved

The createTopSearchMenuItem function now uses CONST.SEARCH.TABLE_COLUMNS.GROUP_TOTAL and CONST.SEARCH.SORT_ORDER.DESC as defaults, which generates the correct query parameters for both insight types. No console errors related to the change were observed.

@neil-marcellini
Copy link
Contributor

@MelvinBot you need to create some example expenses from the last month so that the insights tabs populate and data will be returned. The expenses should be from multiple categories and merchants. Pls re-test.

@MelvinBot
Copy link
Contributor Author

I ran out of time before I could finish helping you. This usually means the task was too complex or I got stuck exploring. Please try again with a more specific request or post in the #melvinbot-ai.

Run details: https://github.com/Expensify/Expensify/actions/runs/22773896227

Instead of modifying parser defaults, fix shouldResetSort to only reset
sort when groupBy changes. View-only changes (e.g. bar → table) are a
presentation concern and should not alter the data ordering. This ensures
top categories/merchants keep their groupTotal desc sort when switching
from chart to table view.

Made-with: Cursor
buildFilterQueryWithSortDefaults(
updatedFilterFormValues,
{view: searchAdvancedFiltersForm.view, groupBy: searchAdvancedFiltersForm.groupBy},
{groupBy: searchAdvancedFiltersForm.groupBy},
Copy link
Contributor

Choose a reason for hiding this comment

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

View is no longer needed in the previous state passed to this function, since it doesn't affect whether the sort order should be changed anymore.

@neil-marcellini neil-marcellini marked this pull request as ready for review March 6, 2026 21:44
@neil-marcellini neil-marcellini requested a review from a team as a code owner March 6, 2026 21:44
@melvin-bot melvin-bot bot requested review from jayeshmangwani and removed request for a team March 6, 2026 21:44
@melvin-bot
Copy link

melvin-bot bot commented Mar 6, 2026

@jayeshmangwani 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 March 6, 2026 21:45
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: 1627a2f7d9

ℹ️ About Codex in GitHub

Your team has set up Codex to 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 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +1614 to +1615
function shouldResetSort({newGroupBy, oldGroupBy}: {newGroupBy: string | undefined; oldGroupBy: string | undefined}): boolean {
return newGroupBy !== oldGroupBy;

Choose a reason for hiding this comment

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

P1 Badge Reset sort on view change for time-based groupings

By removing view comparisons from shouldResetSort, switching only the view now preserves the previous explicit sort in buildFilterQueryWithSortDefaults, so a groupBy:month/week/year/quarter search moved from table to line/bar keeps table ordering (typically sortOrder:desc). That bypasses the parser’s chart-specific defaulting in src/libs/SearchParser/searchParser.peggy (the view !== "table" + TIME_BASED_GROUP_BY path) which is intended to enforce ascending chronological order for chart views, so these charts can render newest-to-oldest unless users manually re-sort.

Useful? React with 👍 / 👎.

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.

2 participants