Skip to content

Reports - Expense created while on "Reports", gets highlighted again when opened.#89525

Merged
mountiny merged 6 commits into
Expensify:mainfrom
software-mansion-labs:borys3kk-fix-only-first-expense-is-highlighted
May 13, 2026
Merged

Reports - Expense created while on "Reports", gets highlighted again when opened.#89525
mountiny merged 6 commits into
Expensify:mainfrom
software-mansion-labs:borys3kk-fix-only-first-expense-is-highlighted

Conversation

@borys3kk
Copy link
Copy Markdown
Contributor

@borys3kk borys3kk commented May 4, 2026

Explanation of Change

  1. In useSearchHighlightAndScroll — replaced the timer-based reset of transactionIDsToHighlight (which lost a race with the newSearchResultKeys reset and never fired) with a synchronous Onyx merge inside the detect effect. Stops every prior expense from re-animating on each new add.
  2. In Search/index.tsxuseFocusEffect now skips the skeleton-during-transition defer when the highlight hook already queued rows. Otherwise FlashList stays empty for ~1s while the RHP dismiss transition runs, the new row never mounts inside the 300ms highlight window, and the animation never fires for expenses created outside Search.

Fixed Issues

$ #81474
PROPOSAL:

Tests

  1. Sign in with an account that has at least one workspace and existing expenses.
  2. Navigate to the Spend tab (Search) so the Expenses list is visible.
  3. Click the global Create button (FAB) → Create expense → Submit a manual expense and return to Spend.
  4. Verify that the newly created expense row briefly flashes with the yellow highlight animation (exactly once).
  5. Without leaving the Spend tab, click the FAB again → Create expense → Submit a second manual expense.
  6. Verify that only the second expense flashes with the highlight animation. The first expense must not re-animate.
  7. Repeat the FAB → Create expense → Submit flow a third time.
  8. Verify that only the third expense flashes; neither the first nor the second re-animate.
  1. While on the Spend tab with Expense selected, submit a new expense via the FAB and let the highlight finish animating.
  2. Switch the Search type to Reports (or any other Search sub-tab), then back to Expenses.
  3. Verify that no rows flash on return — the highlight state was cleaned up when the Search type changed.
  • Verify that no errors appear in the JS console

Offline tests

  1. Go offline (DevTools → Network → Offline, or disable Wi-Fi).
  2. On the Spend tab, click the FAB → Create expense → Submit.
  3. Verify that the expense appears optimistically in the list and the highlight animation plays for the new row.
  4. Submit a second expense while still offline.
  5. Verify that only the second expense's row flashes.
  6. Go back online and verify the optimistic rows are reconciled with the server response and that no rows flash again on reconciliation.

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 an issue for 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

Android: Native
Screen.Recording.2026-05-05.at.12.23.20.mov
Android: mWeb Chrome
Screen.Recording.2026-05-05.at.12.26.25.mov
iOS: Native
Screen.Recording.2026-05-05.at.12.11.42.mov
iOS: mWeb Safari
Screen.Recording.2026-05-05.at.12.13.17.mov
MacOS: Chrome / Safari
Screen.Recording.2026-05-04.at.12.39.12.mov

@borys3kk borys3kk changed the title fix only first expense being highlighted Reports - Expense created while on "Reports", gets highlighted again when opened. May 4, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented May 5, 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/useSearchHighlightAndScroll.ts 82.44% <100.00%> (-0.65%) ⬇️
src/components/Search/index.tsx 0.85% <0.00%> (-0.01%) ⬇️
... and 10 files with indirect coverage changes

Comment on lines +241 to +245
// Clear consumed manual highlight flags synchronously so subsequent detect runs
// don't re-highlight the same IDs. A previous timer-based reset effect lost a race
// with the reset of `newSearchResultKeys` (its cleanup kept canceling the timer
// before it could fire), leaving flags stuck at `true` and causing every later add
// to re-animate every prior expense.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

imo this comment is a little too verbose and I don't love documenting a previous approach that isn't here now. same in tests/unit/useSearchHighlightAndScrollTest.ts -> the new comment is unnecessary

@borys3kk borys3kk marked this pull request as ready for review May 5, 2026 12:57
@borys3kk borys3kk requested review from a team as code owners May 5, 2026 12:57
@melvin-bot melvin-bot Bot requested review from heyjennahay and truph01 and removed request for a team May 5, 2026 12:57
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 5, 2026

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

@borys3kk
Copy link
Copy Markdown
Contributor Author

borys3kk commented May 7, 2026

hello @truph01, how's the review coming along?

@mountiny
Copy link
Copy Markdown
Contributor

mountiny commented May 8, 2026

@truph01 can you prioritize this pr please?

@truph01
Copy link
Copy Markdown
Contributor

truph01 commented May 9, 2026

@mountiny @borys3kk I need to prioritize other tasks this week.

I can review it today.

@mountiny
Copy link
Copy Markdown
Contributor

@truph01 sorry it is not clear to me if you are available to review this 😂

@truph01
Copy link
Copy Markdown
Contributor

truph01 commented May 11, 2026

@truph01 sorry it is not clear to me if you are available to review this 😂

@mountiny I've started reviewing it since yesterday. I'm currently testing a few edge cases to help catch any regressions.

@mountiny
Copy link
Copy Markdown
Contributor

Thank you

@truph01
Copy link
Copy Markdown
Contributor

truph01 commented May 11, 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 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-05-12.at.10.25.16.mov
Android: mWeb Chrome
output.mp4
iOS: HybridApp
output.mp4
iOS: mWeb Safari
Screen.Recording.2026-05-12.at.10.15.12.mov
MacOS: Chrome / Safari
output.mp4

Comment thread src/components/Search/index.tsx Outdated
// Used to skip the deferral that would otherwise hide the freshly-added row from
// FlashList during the RHP dismiss transition, which would prevent the highlight
// animation from ever firing on it.
const newSearchResultKeysRef = useRef(newSearchResultKeys);
Copy link
Copy Markdown
Contributor

@truph01 truph01 May 12, 2026

Choose a reason for hiding this comment

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

We can consider returning a hasQueuedHighlights flag directly from the useSearchHighlightAndScroll hook instead of making the consumer mirror state into its own ref:

// In useSearchHighlightAndScroll
return { newSearchResultKeys, handleSelectionListScroll, newTransactions, hasQueuedHighlights: newSearchResultKeys !== null && newSearchResultKeys.size > 0 };

Then use a ref for that boolean in Search/index.tsx — it would be cleaner and keep the highlight logic encapsulated.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

yeah, seems valid, implemented

@truph01
Copy link
Copy Markdown
Contributor

truph01 commented May 12, 2026

@borys3kk PR looks good, I just have one minor comment.

@borys3kk
Copy link
Copy Markdown
Contributor Author

@borys3kk PR looks good, I just have one minor comment.

looking into it now

@borys3kk
Copy link
Copy Markdown
Contributor Author

@truph01 this pr should be good to go assuming that merging main fixed the performance tests

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Fixes the “new expense row highlights again after being opened” behavior on the Reports/Spend (Search) experience by ensuring highlight state is consumed deterministically and by avoiding a focus-time deferral that can prevent the highlighted row from mounting in time.

Changes:

  • useSearchHighlightAndScroll: clears consumed manual highlight flags synchronously during the “detect new items” effect (removing the prior timer-based reset that could lose races).
  • Search/index.tsx: adds hasQueuedHighlights from the hook and uses a ref to let the post-create useFocusEffect skip the skeleton/deferral when a highlight is queued.
  • Unit test: removes the timer wait now that the highlight-flag reset is no longer timer-based.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
tests/unit/useSearchHighlightAndScrollTest.ts Updates the manual-highlight test to no longer wait for a timer-based reset.
src/hooks/useSearchHighlightAndScroll.ts Consumes/clears manual highlight flags inline when detected; exposes hasQueuedHighlights.
src/components/Search/index.tsx Skips focus-time skeleton deferral when highlights are queued to ensure the row mounts in time.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@mountiny mountiny merged commit 1465400 into Expensify:main May 13, 2026
43 checks passed
@github-actions
Copy link
Copy Markdown
Contributor

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

@OSBotify
Copy link
Copy Markdown
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
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 9.3.74-0 🚀

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

Bundle Size Analysis (Sentry):

@MelvinBot
Copy link
Copy Markdown
Contributor

No help site changes are required for this PR.

This is an internal bug fix for the expense highlight animation on the Search/Spend tab — it corrects a race condition so only the newly created expense row flashes instead of re-animating all previous rows. The changes are limited to hook logic (useSearchHighlightAndScroll.ts), a component guard (Search/index.tsx), and a test update. There are no new features, renamed settings, changed labels, or user-facing workflow changes that would require documentation updates.

@OSBotify
Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/Beamanator in version: 9.3.74-7 🚀

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

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.

7 participants