Skip to content

Fix/79139 - Add sticky filters to the reports page#80247

Merged
JS00001 merged 13 commits intoExpensify:mainfrom
dmkt9:fix/79139
Feb 10, 2026
Merged

Fix/79139 - Add sticky filters to the reports page#80247
JS00001 merged 13 commits intoExpensify:mainfrom
dmkt9:fix/79139

Conversation

@dmkt9
Copy link
Contributor

@dmkt9 dmkt9 commented Jan 22, 2026

Explanation of Change

This PR helps:

  • The Expenses, Reports, and Chats items in the Search type menu bar within the "Explore" section will be highlighted even when we change the values of the filters.
  • When navigating between these three items, the valid filter values for each search type will still be preserved. For example:
    • User clicks Reports > Reports
    • User filters by date, and user, while on the reports page
    • User clicks Expenses and gets taken to the expenses view
    • The expenses page is also filtered now by date, and user
    • User navigates back to the Reports Page
    • The filters on the reports page should be the same as before: date & user

Fixed Issues

$ #79139
PROPOSAL: #79139 (comment)

Tests

Same as QA Steps

  • Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

  1. Open the Expensify app.
  2. Navigate to Reports > Expenses page.
  3. Change some filter values.
  4. Verify that "Expenses" in the Search type menu bar is still focused.
  5. With the changed filter values, navigate to the Expense Report/Chat type by clicking the "Reports/Chats" item in the Search type menu bar.
  6. Verify that the valid filter values for the Expense Report/Chat type remain the same as in the previous type.
  7. Repeat steps 2 to 6 starting from any item in the Explore section.
  • 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
android.native.mp4
Android: mWeb Chrome
android.mweb.mp4
iOS: Native
ios.native.mp4
iOS: mWeb Safari
ios.mweb.mp4
MacOS: Chrome / Safari
mac.safari.mp4

@dmkt9 dmkt9 requested review from a team as code owners January 22, 2026 16:18
@melvin-bot melvin-bot bot requested review from a team, JmillsExpensify and hungvu193 and removed request for a team January 22, 2026 16:18
@melvin-bot
Copy link

melvin-bot bot commented Jan 22, 2026

@hungvu193 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 JS00001 and removed request for a team January 22, 2026 16:18
@melvin-bot
Copy link

melvin-bot bot commented Jan 22, 2026

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

@codecov
Copy link

codecov bot commented Jan 22, 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/hooks/useSearchTypeMenuSections.ts 100.00% <100.00%> (ø)
src/hooks/useSearchTypeMenu.tsx 67.53% <42.85%> (-1.81%) ⬇️
src/pages/Search/SearchTypeMenu.tsx 0.00% <0.00%> (ø)
src/hooks/useStickySearchFilters.ts 29.62% <29.62%> (ø)
src/libs/SearchUIUtils.ts 59.51% <21.87%> (-0.67%) ⬇️
... and 10 files with indirect coverage changes

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: 5a73135ed4

ℹ️ 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".

@dmkt9
Copy link
Contributor Author

dmkt9 commented Jan 22, 2026

Hi @hungvu193 @JS00001, the PR has met the basic requirements, but I have a couple of questions:

  1. Should we reset the filters when the user clicks the same item that is already highlighted? For example, if we are on the Expenses item > we change some filters > the user clicks the Expenses item again, should it revert to the initial values of the Expenses item?

  2. When navigating from one item to another, some filters may not be valid for the target type and will be removed. When navigating back to the previous item, should the filter values that were removed earlier be restored? For example, the Chat type does not have a status filter, so if we apply a status filter in the Expense type and then navigate to the Chat type and back to the Expense type, the status filter has been removed.

Apart from these two minor details, if any other changes are needed, please feel free to let me know.

@JS00001
Copy link
Contributor

JS00001 commented Jan 22, 2026

Should we reset the filters when the user clicks the same item that is already highlighted? For example, if we are on the Expenses item > we change some filters > the user clicks the Expenses item again, should it revert to the initial values of the Expenses item?

No, lets not worry about that for now

When navigating from one item to another, some filters may not be valid for the target type and will be removed. When navigating back to the previous item, should the filter values that were removed earlier be restored? For example, the Chat type does not have a status filter, so if we apply a status filter in the Expense type and then navigate to the Chat type and back to the Expense type, the status filter has been removed.

I think that we should persist all filters, and when filters aren't valid, we just wont apply them

@dmkt9
Copy link
Contributor Author

dmkt9 commented Jan 22, 2026

I think that we should persist all filters, and when filters aren't valid, we just wont apply them

Thanks for confirming. I'll make some changes based on this and let you know when it's ready.

@hungvu193
Copy link
Contributor

Any updates here @dmkt9? It's been a while 😄

const policiesList = Object.values(allPolicies ?? {}).filter((policy): policy is NonNullable<typeof policy> => policy !== null && policy !== undefined);

return policiesList.some((policy) => policy.employeeList !== undefined && policy.exporter !== undefined);
return policiesList.some((policy) => policy.id !== undefined && policy.employeeList !== undefined && policy.exporter !== undefined);
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this check necessary? I think when a policy has employeeList and exporter it must have policyID?

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. It is necessary because in quite a few cases, when I place a log here, both employeeList and exporter are not undefined before id !== undefined. This leads to the Todos items not being rendered yet, while the items in the explore section are already rendered from the very beginning. As a result, when we open the Reports page for the first time, it may cause the wrong focused item to be recognized.

(allSearchAdvancedFilters.current[key] as unknown) = searchAdvancedFiltersForm[key] ?? undefined;
}
allSearchAdvancedFilters.current = {...allSearchAdvancedFilters.current, type: searchAdvancedFiltersForm.type};
prevSearchAdvancedFiltersFormsByType.current[searchAdvancedFiltersForm.type] = searchAdvancedFiltersForm;
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you think that we can use usePrevious for prevSearchAdvancedFiltersFormsByType so we can reuse existing hook?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Initially, I also intended to use usePrevious, but I encountered some issues during implementation such as:

  • prevSearchAdvancedFiltersFormsByType needs to preserve its data, but using usePrevious inside our hook would cause prevSearchAdvancedFiltersFormsByType to reset if the component gets remounted. This is most noticeable on mobile devices because the menu is displayed through a popover modal.
  • Storing all previous values is more convenient for us to access. If we use usePrevious, we would need to split them into separate variables for each type, which increases complexity.

@JS00001
Copy link
Contributor

JS00001 commented Jan 30, 2026

conflicts

@hungvu193
Copy link
Contributor

hungvu193 commented Feb 1, 2026

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • 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 there are no new alerts related to the canBeMissing param for useOnyx
  • 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: HybridApp
Screen.Recording.2026-02-01.at.16.03.32.mov
Android: mWeb Chrome
Screen.Recording.2026-02-01.at.15.59.51.mov
iOS: HybridApp
Screen.Recording.2026-02-01.at.15.46.23.mov
iOS: mWeb Safari
Screen.Recording.2026-02-01.at.15.38.44.mov
MacOS: Chrome / Safari
Screen.Recording.2026-02-01.at.15.33.05.mov

@melvin-bot melvin-bot bot requested a review from JS00001 February 1, 2026 09:01
JmillsExpensify
JmillsExpensify previously approved these changes Feb 2, 2026
Copy link
Contributor

@JmillsExpensify JmillsExpensify left a comment

Choose a reason for hiding this comment

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

Big fan of this product change.

@JS00001
Copy link
Contributor

JS00001 commented Feb 3, 2026

@dmkt9 could we remove this loading skeleton for the filters, since we're using the same filters? I think it'd feel much better (and more intuitive) if we keep the filters visible.

Screen.Recording.2026-02-03.at.9.30.10.AM.mov

// We want to use ref here only because the value from this hook is just a derived value,
// and we don’t need to rerender when the hook’s value changes.
// eslint-disable-next-line react-hooks/refs
return shouldUpdate && isEmptyObject(allSearchAdvancedFilters.current) ? searchAdvancedFiltersForm : allSearchAdvancedFilters.current;
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you explain this hook a bit more?

It seems to violate some of our react best practices. Why isnt this just a derived value? Why are we using a var outside of the hook?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Because I noticed that the value of allSearchAdvancedFilters.current will actually only change when searchAdvancedFiltersForm changes through useOnyx. Since changes in searchAdvancedFiltersForm already trigger a re-render, I think using a ref for allSearchAdvancedFilters.current would be more efficient.

Using a variable makes sense because all the values we need to store are kept in a single variable, and this variable should preserve its value as much as possible. If we keep it inside the hook, it will be continuously reset on mobile. As for using context, we could implement it, but it adds a bit more complexity while providing equivalent effectiveness.

Copy link
Contributor

Choose a reason for hiding this comment

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

but if it already triggers a re-render, then if this is a value derived from searchAdvancedFiltersForm, then it would also update in the same re-render, so this wouldn't affect the # of re-renders

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, you’re right. I used useMemo instead of useEffect to ensure it always updates within the same frame

// We want to use ref here only because the value from this hook is just a derived value,
// and we don’t need to rerender when the hook’s value changes.
// eslint-disable-next-line react-hooks/refs
return shouldUpdate && isEmptyObject(allSearchAdvancedFilters.current) ? searchAdvancedFiltersForm : allSearchAdvancedFilters.current;
Copy link
Contributor

Choose a reason for hiding this comment

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

but if it already triggers a re-render, then if this is a value derived from searchAdvancedFiltersForm, then it would also update in the same re-render, so this wouldn't affect the # of re-renders

@JS00001
Copy link
Contributor

JS00001 commented Feb 9, 2026

@dmkt9 conflicts

@dmkt9
Copy link
Contributor Author

dmkt9 commented Feb 10, 2026

Thanks. It's ready for review again.

@JS00001 JS00001 merged commit 2f80b29 into Expensify:main Feb 10, 2026
29 checks passed
@github-actions
Copy link
Contributor

🚧 @JS00001 has triggered a test Expensify/App build. You can view the workflow run here.

@OSBotify
Copy link
Contributor

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/JS00001 in version: 9.3.17-0 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/lakchote in version: 9.3.17-9 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 failure ❌

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