Add grouping by reports functionality in search components #56850

ishpaul777 · 2025-02-13T19:39:14Z

Explanation of Change

Made the following changes to the default filters on the Reports page:

Stop using group-by:report on the “Expenses” default filter. Meaning, if you click “Draft” or "Outstanding" for example, that’s just a list of expenses that are on draft reports. Instead of grouped by Report as they are today.

Screen.Recording.2025-02-14.at.6.04.11.PM.mov

Introduce a “Expense Reports” default to the Reports page LHN which is grouped by report across statuses, including All.

Screen.Recording.2025-02-14.at.6.04.35.PM.mov

Fixed Issues

$ #56785
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Precondition

Many expenses submitted to a workspace around 10-20.
workspace has enabled the workflows like delayed submissions, have approval
Have 3-4 expense pending for submisision
Have 3-4 expense pending for approval
Have 3-4 expense approved pending for payment
Have 3-4 expense paid

Steps:

go to Reports bottom tab, change Status from tabs of the expenses, verify none of expenses are not grouped together by report
Click on Expense reports, click on Expense reports in "bottom Tab", verify expenses are grouped together by reports.

Offline tests

QA Steps

Verify that no errors appear in the JS console

same as test steps

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2025-02-19.at.4.31.27.AM.mov

Android: mWeb Chrome

Screen.Recording.2025-02-19.at.6.16.03.PM.mov

iOS: Native

Screen.Recording.2025-02-19.at.4.33.06.AM.mov

iOS: mWeb Safari

Screen.Recording.2025-02-19.at.4.50.21.AM.mov

Screen.Recording.2025-02-19.at.4.48.57.AM.mov

MacOS: Chrome / Safari

Screen.Recording.2025-02-14.at.6.02.04.PM.mov

MacOS: Desktop

Screen.Recording.2025-02-19.at.6.56.13.PM.mov

…ndition

…able

melvin-bot · 2025-02-14T12:45:57Z

@allroundexperts 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]

ishpaul777 · 2025-02-14T12:47:18Z

Open for initial review from C+, i will do checklist once we are 🟢 codewise

@allroundexperts

… icon

shawnborton · 2025-02-14T18:30:55Z

Since this will likely get merged before the top query bar changes, maybe we can go ahead and add a temporary illustration to the top header? cc @Expensify/design

I'm thinking one of these?

Can you try both and show us how they look?

Reports.zip

ishpaul777 · 2025-02-14T19:27:12Z

Report	Report with Receipt

@shawnborton

dannymcclain · 2025-02-14T19:57:01Z

Report with Receipt gets my vote!

… expense reports

shawnborton · 2025-02-14T21:03:51Z

Nice, I can get down with that one!

ishpaul777 · 2025-02-17T17:15:25Z

friendly bump @allroundexperts

luacmartins

Minor comment to update the variable name

luacmartins · 2025-02-18T18:43:42Z

src/CONST.ts

@@ -6165,6 +6165,9 @@ const CONST = {
            ASC: 'asc',
            DESC: 'desc',
        },
+        GROUPED_BY: {


Suggested change

GROUPED_BY: {

GROUP_BY: {

src/components/Search/SearchPageHeader.tsx

ZhenjaHorbach · 2025-02-18T19:14:39Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible 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 checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (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
- 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 verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
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
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
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 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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

andoid-web.mov

iOS: Native

ios.mov

iOS: mWeb Safari

ios-web.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

ZhenjaHorbach · 2025-02-18T19:25:27Z

@ishpaul777
Could you please fill out the checklist? 😅

ZhenjaHorbach · 2025-02-18T19:28:40Z

Looks like a bug
When we navigate from Expenses to Expense Reports we reset selected items
But when from Expense Reports to Expenses we don't

2025-02-18.20.27.02.mov

ZhenjaHorbach · 2025-02-18T19:50:45Z

Similar issue
Slightly different behavior when downloading all reports between Expenses and Expense Reports

2025-02-18.20.49.16.mov

ZhenjaHorbach · 2025-02-18T20:10:23Z

But overall the changes look good !

… for consistency

ishpaul777 · 2025-02-18T22:16:36Z

Looks like a bug When we navigate from Expenses to Expense Reports we reset selected items But when from Expense Reports to Expenses we don't

2025-02-18.20.27.02.mov

this is fixed

Similar issue Slightly different behavior when downloading all reports between Expenses and Expense Reports

2025-02-18.20.49.16.mov

still looking into this one

…omponents

shawnborton · 2025-02-19T02:27:13Z

Looks like we have lots of conflicts that need to be resolved.

ZhenjaHorbach · 2025-02-19T11:40:10Z

@ishpaul777
We still have eslint issues 😅

ZhenjaHorbach · 2025-02-19T13:37:18Z

Just rechecked
Now looks like everything is good !
LGTM !

puneetlath

Code looks good to me. Is there any test we could/should add?

puneetlath · 2025-02-19T15:18:58Z

@ZhenjaHorbach the reviewer checklist check also seems to be failing. Any idea why?

puneetlath · 2025-02-19T15:19:48Z

Actually, I removed Sibtain's comment and it's passing now.

ZhenjaHorbach · 2025-02-19T15:20:28Z

@ZhenjaHorbach the reviewer checklist check also seems to be failing. Any idea why?

I think because my checklist was a second 😅

OSBotify · 2025-02-19T17:13:33Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

github-actions · 2025-02-20T03:07:23Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 9.1.2-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	success ✅
🍎🔄 iOS HybridApp 🍎🔄	success ✅

Kicu · 2025-02-20T14:54:07Z

@ishpaul777 this PR introduced a bug, check here: #57157 (comment)
(I believe some useEffect is unnecessarily triggering turnOnMobileSelectionMode but I did not dig any deeper).

ishpaul777 · 2025-02-20T14:55:41Z

i am raising a PR i found the fix

PR here https://github.com/Expensify/App/pull/57186/files

github-actions · 2025-02-20T22:00:37Z

🚀 Deployed to production by https://github.com/francoisl in version: 9.1.2-1 🚀

platform	result
🤖 android 🤖	true ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	failure ❌
🍎🔄 iOS HybridApp 🍎🔄	failure ❌

ishpaul777 added 6 commits February 14, 2025 01:04

Add grouping by reports functionality in search components

69be62a

fix toggle all option and mobile search

e56f48d

Refactor search grouping logic to use constant for report grouping co…

758fd2b

…ndition

prettier

2a9c744

Simplify search route query construction by removing unnecessary vari…

2d09ff0

…able

Add support for grouping by reports in search components

218667e

ishpaul777 marked this pull request as ready for review February 14, 2025 12:45

ishpaul777 requested a review from a team as a code owner February 14, 2025 12:45

melvin-bot bot requested review from allroundexperts and removed request for a team February 14, 2025 12:45

Update document SVG and change icon in SearchTypeMenu to use Document…

eb7cff7

… icon

ishpaul777 requested a review from a team as a code owner February 14, 2025 18:18

Add ReportReceipt icon and update search header to use it for grouped…

846440a

… expense reports

Merge branch 'Expensify:main' into feat/56785

3fcff8e

luacmartins reviewed Feb 18, 2025

View reviewed changes

puneetlath requested a review from ZhenjaHorbach February 18, 2025 19:59

refactor: rename 'shouldBeGroupedByReports' to 'shouldGroupByReports'…

bcd073c

… for consistency

ishpaul777 added 3 commits February 19, 2025 03:49

code format

fa5f3cd

fix: remove unnecessary dependency from useEffect in Search component

44f572f

fix: add debug logs and update condition for expense type in Search c…

65e9acc

…omponents

ishpaul777 added 6 commits February 19, 2025 15:18

Merge branch 'main' into feat/56785

fb09b20

Add expense reports option to search menu

3fc443f

Fix translation key for expense reports in search menu

af1252e

Fix translation path for expense reports in search menu

2efd990

fix option highlight

818f18f

fix eslint

a12286f

fix eslint

ef50e6d

ZhenjaHorbach approved these changes Feb 19, 2025

View reviewed changes

melvin-bot bot requested a review from puneetlath February 19, 2025 13:37

ZhenjaHorbach mentioned this pull request Feb 19, 2025

[Due for payment 2025-02-27] [$500] Update default Reports page filters #56785

Open

puneetlath approved these changes Feb 19, 2025

View reviewed changes

Expensify deleted a comment from allroundexperts Feb 19, 2025

puneetlath merged commit 0274a6f into Expensify:main Feb 19, 2025
16 of 18 checks passed

github-actions bot mentioned this pull request Feb 20, 2025

Deploy Checklist: New Expensify 2025-02-20 #57146

Closed

30 tasks

MariaHCD mentioned this pull request Feb 20, 2025

[Due for payment 2025-02-28] Web - Reports - Expense reports are not sorted correctly #57156

Closed

8 tasks

NikkiWines mentioned this pull request Feb 20, 2025

[Due for payment 2025-02-28] [Due for payment 2025-02-27] mWeb - Invoices - The back button doesn't correspond in the invoice tab on the search page #57157

Open

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add grouping by reports functionality in search components #56850

Add grouping by reports functionality in search components #56850

ishpaul777 commented Feb 13, 2025 •

edited

Loading

melvin-bot bot commented Feb 14, 2025

ishpaul777 commented Feb 14, 2025

shawnborton commented Feb 14, 2025

ishpaul777 commented Feb 14, 2025 •

edited

Loading

dannymcclain commented Feb 14, 2025

shawnborton commented Feb 14, 2025

ishpaul777 commented Feb 17, 2025

luacmartins left a comment

luacmartins Feb 18, 2025

ishpaul777 Feb 18, 2025

ZhenjaHorbach commented Feb 18, 2025 •

edited

Loading

ZhenjaHorbach commented Feb 18, 2025

ZhenjaHorbach commented Feb 18, 2025 •

edited

Loading

ZhenjaHorbach commented Feb 18, 2025

ZhenjaHorbach commented Feb 18, 2025

ishpaul777 commented Feb 18, 2025

shawnborton commented Feb 19, 2025

ZhenjaHorbach commented Feb 19, 2025

ZhenjaHorbach commented Feb 19, 2025 •

edited

Loading

puneetlath left a comment

puneetlath commented Feb 19, 2025

puneetlath commented Feb 19, 2025

ZhenjaHorbach commented Feb 19, 2025

OSBotify commented Feb 19, 2025

github-actions bot commented Feb 20, 2025

Kicu commented Feb 20, 2025 •

edited

Loading

ishpaul777 commented Feb 20, 2025 •

edited

Loading

github-actions bot commented Feb 20, 2025

Add grouping by reports functionality in search components #56850

Add grouping by reports functionality in search components #56850

Conversation

ishpaul777 commented Feb 13, 2025 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 14, 2025

ishpaul777 commented Feb 14, 2025

shawnborton commented Feb 14, 2025

ishpaul777 commented Feb 14, 2025 • edited Loading

dannymcclain commented Feb 14, 2025

shawnborton commented Feb 14, 2025

ishpaul777 commented Feb 17, 2025

luacmartins left a comment

Choose a reason for hiding this comment

luacmartins Feb 18, 2025

Choose a reason for hiding this comment

ishpaul777 Feb 18, 2025

Choose a reason for hiding this comment

ZhenjaHorbach commented Feb 18, 2025 • edited Loading

Reviewer Checklist

Screenshots/Videos

ZhenjaHorbach commented Feb 18, 2025

ZhenjaHorbach commented Feb 18, 2025 • edited Loading

ZhenjaHorbach commented Feb 18, 2025

ZhenjaHorbach commented Feb 18, 2025

ishpaul777 commented Feb 18, 2025

shawnborton commented Feb 19, 2025

ZhenjaHorbach commented Feb 19, 2025

ZhenjaHorbach commented Feb 19, 2025 • edited Loading

puneetlath left a comment

Choose a reason for hiding this comment

puneetlath commented Feb 19, 2025

puneetlath commented Feb 19, 2025

ZhenjaHorbach commented Feb 19, 2025

OSBotify commented Feb 19, 2025

github-actions bot commented Feb 20, 2025

Kicu commented Feb 20, 2025 • edited Loading

ishpaul777 commented Feb 20, 2025 • edited Loading

github-actions bot commented Feb 20, 2025

ishpaul777 commented Feb 13, 2025 •

edited

Loading

ishpaul777 commented Feb 14, 2025 •

edited

Loading

ZhenjaHorbach commented Feb 18, 2025 •

edited

Loading

ZhenjaHorbach commented Feb 18, 2025 •

edited

Loading

ZhenjaHorbach commented Feb 19, 2025 •

edited

Loading

Kicu commented Feb 20, 2025 •

edited

Loading

ishpaul777 commented Feb 20, 2025 •

edited

Loading