Skip to content

perf: move screen focus to LHNOptionsList to avoid re-renders#62968

Merged
mountiny merged 3 commits intoExpensify:mainfrom
callstack-internal:perf/lhn-move-screen-focus-to-parent
May 30, 2025
Merged

perf: move screen focus to LHNOptionsList to avoid re-renders#62968
mountiny merged 3 commits intoExpensify:mainfrom
callstack-internal:perf/lhn-move-screen-focus-to-parent

Conversation

@OlimpiaZurek
Copy link
Contributor

@OlimpiaZurek OlimpiaZurek commented May 28, 2025

Explanation of Change

Problem

OptionRowLHN use theuseFocusEffect hook locally inside each row component. This means that every time the screen focus changed (e.g., navigating between Inbox → Reports), all instances of OptionRowLHN triggered re-renders — even if nothing else changed.
In large lists (e.g., LHN with hundreds/thousands of rows), this caused significant performance hits and longer render durations.

Solution

Move the screen focus logic to the parent component (LHNOptionsList) and passed isScreenFocused value as a prop to each OptionRowLHN instead of using useFocusEffect within the row. Replace the custom focus hook with React Navigation’s built-in useIsFocused() in the parent for better clarity and simplicity. This avoided each row setting up its own focus listener and prevented cascading re-renders on screen transitions. This change preserves the required focus-based behavior while minimizing redundant work across many list items.

Performance gain

  • Android
  • Commit count dropped from 17 → 14, total render time down by ~29% ( from8941ms down to 6328ms -> Total Duration Difference: 2613.470 ms)
  • iOS - Commit count dropped from 25 → 22, total render time down by ~14% ( from 3297ms down to 2820ms -> Total Duration Difference: -477.069 ms)

Before:

Image

After:

Image

Fixed Issues

$ #60007
PROPOSAL:

Tests

This change is performance-related only — no functionality is expected to change. The goal is to avoid unnecessary re-renders in long LHN lists by lifting useFocusEffect `out of each row and managing focus state at the parent level.
Please check that there are no regressions in the behavior tied to screen focus

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

  • 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
    • MacOS: Desktop
  • 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 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: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

Copy link
Contributor

@kacper-mikolajczak kacper-mikolajczak left a comment

Choose a reason for hiding this comment

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

Fantastic, LGTM!! Thank you for working on this - the perf results look promising❤️

One idea that popped in my head while looking at the changes, we might as an alternative use context instead of props drilling. It would simplify the types (no need to distinguish between isOptionFocused and isScreenFocused because it stays the same).

When looking at it further, it'd be nice for ScreenWrapper to expose that functionality, but that's story for different ticket :) Thanks once again!

import {useFocusEffect} from '@react-navigation/native';
import {useCallback, useState} from 'react';

export default function useIsScreenFocusedRef() {
Copy link
Contributor

Choose a reason for hiding this comment

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

Tiny typo useIsScreenFocusedRef -> useIsScreenFocused

Copy link
Contributor

@kacper-mikolajczak kacper-mikolajczak May 29, 2025

Choose a reason for hiding this comment

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

Would it be fine for our use-case (as we are using just state) to go with useIsFocus instead and avoid custom hook altogether?

Copy link
Contributor Author

@OlimpiaZurek OlimpiaZurek May 29, 2025

Choose a reason for hiding this comment

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

Good point. Replaced custom hook with useIsFocused as it has the same behavior but simplifies the code

@OlimpiaZurek
Copy link
Contributor Author

Fantastic, LGTM!! Thank you for working on this - the perf results look promising❤️

One idea that popped in my head while looking at the changes, we might as an alternative use context instead of props drilling. It would simplify the types (no need to distinguish between isOptionFocused and isScreenFocused because it stays the same).

When looking at it further, it'd be nice for ScreenWrapper to expose that functionality, but that's story for different ticket :) Thanks once again!

@kacper-mikolajczak Thank you for the feedback ❤️ .

Agree — using context could help avoid the prop drilling and clean up the types a bit. The main reason I went with props here was to keep things a bit more explicit and avoid introducing extra renders that might come from context updates (especially in big lists like LHN).

@OlimpiaZurek OlimpiaZurek marked this pull request as ready for review May 29, 2025 11:36
@OlimpiaZurek OlimpiaZurek requested a review from a team as a code owner May 29, 2025 11:36
@melvin-bot melvin-bot bot requested review from rushatgabhane and removed request for a team May 29, 2025 11:36
@melvin-bot
Copy link

melvin-bot bot commented May 29, 2025

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

@github-actions
Copy link
Contributor

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

@github-actions
Copy link
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
Android 🤖🔄 iOS 🍎🔄
❌ FAILED ❌ ❌ FAILED ❌
The QR code can't be generated, because the Android build failed The QR code can't be generated, because the iOS build failed
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/62968/NewExpensify.dmg https://62968.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@rushatgabhane
Copy link
Member

rushatgabhane commented May 29, 2025

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
    • 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 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
WhatsApp.Video.2025-05-29.at.21.48.15.mp4
Android: mWeb Chrome
iOS: HybridApp
Screen.Recording.2025-05-30.at.13.00.31.mov
iOS: mWeb Safari
Screen.Recording.2025-05-30.at.13.06.15.mov
MacOS: Chrome / Safari
Screen.Recording.2025-05-30.at.05.10.30.mov
MacOS: Desktop

Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Really nice improvement, great job!

@mountiny mountiny merged commit bf272cb into Expensify:main May 30, 2025
20 checks passed
@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.

@github-actions
Copy link
Contributor

github-actions bot commented Jun 2, 2025

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

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

@IuliiaHerets
Copy link

@OlimpiaZurek Do we have QA steps for this?

@OlimpiaZurek
Copy link
Contributor Author

@IuliiaHerets

In this PR, we moved the focus logic to the parent to avoid unnecessary re-renders, so these QA steps are just to make sure nothing broke with focus-related behavior after the performance tweak:

Tooltip Behavior:

  1. Create a new account and start a few chats.
  2. Verify that a tooltip (e.g., “Get Started Here”) is shown on one of the reports in the LHN.

Context menu:

  1. Long-press (on mobile) or right-click (on desktop/web) a chat in the LHN.
  2. Verify that the context menu appears correctly with the expected options.

@github-actions
Copy link
Contributor

github-actions bot commented Jun 3, 2025

🚀 Deployed to staging by https://github.com/mountiny in version: 9.1.56-2 🚀

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

@IuliiaHerets
Copy link

@OlimpiaZurek Get started tooltip was removed here. Or was it revert again?
QA team sees only the tooltip about GBR and RBR on Concierge chat.

Get.mp4

@OlimpiaZurek
Copy link
Contributor Author

Based on the code, it shows one of 3 different tooltips depending on specific conditions, so it’s hard to say if the behavior was recently changed or reverted. In this PR, I didn’t touch the tooltip logic—so the only thing that needs to be checked is whether the tooltip still shows up correctly, just to make sure nothing broke as a side effect of the refactor.

@IuliiaHerets
Copy link

@OlimpiaZurek

so the only thing that needs to be checked is whether the tooltip still shows up correctly

Which tooltip do you mean?
Can you add clear steps to the QA Steps to check this correctly?

@github-actions
Copy link
Contributor

github-actions bot commented Jun 3, 2025

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

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

@roryabraham
Copy link
Contributor

confirmed that this caused a regression, so going to revert

@roryabraham
Copy link
Contributor

Maybe when we redo it we can try to add an automated UI test that covers the regression? Not sure whether gestures like long-press are testable, but if they are it seems like it would be a good test

@mountiny
Copy link
Contributor

mountiny commented Jun 4, 2025

Thanks for the revert

@github-actions
Copy link
Contributor

github-actions bot commented Jun 4, 2025

🚀 Deployed to production by https://github.com/roryabraham in version: 9.1.58-4 🚀

platform result
🖥 desktop 🖥 success ✅
🕸 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