Skip to content

Reports page and TransactionItemRow performance improvements[part 1]#65421

Merged
mountiny merged 15 commits intoExpensify:mainfrom
software-mansion-labs:@szymczak/performance-improvements
Jul 9, 2025
Merged

Reports page and TransactionItemRow performance improvements[part 1]#65421
mountiny merged 15 commits intoExpensify:mainfrom
software-mansion-labs:@szymczak/performance-improvements

Conversation

@SzymczakJ
Copy link
Contributor

@SzymczakJ SzymczakJ commented Jul 3, 2025

Explanation of Change

This PR refactors Search related components SearchContext, SearchList, SearchPage etc. to stop redundant rerenders that cascade all the way down to search list items.
Key points of the refactor:

  1. I refactored how Onyx MOBILE_SELECTION_MODE value works, it used to be a object with single prop {isEnabled: boolean} which was causing redundant value updates in Onyx when setting this onyx key to the same value(cause of new object creation)
  2. I refactored useMobileSelectionMode hook to not run turnOffMobileSelectionMode when selectionMode is already off, this saves rerenders all over the app as this hook is widely used.
  3. On SearchPage: I refactored lastNonEmptySearchResults to be stored in useRef instead of useState to avoid extra rerender every time new search data comes from the BE.
  4. In SearchContext:
    • I fixed setCurrentSearchHash function to not make SearchContext rerender(which rerenders everything) when we set hash to the same hash.
    • I fixed clearSelectedTransactions function to not make SearchContext rerender, when selected transactions are already cleared.
  5. In Search/index: stoped running setSelectedTransactions in case, when there are no selectedTransactions.
  6. ... plus some minor optimizations.

Fixed Issues

$ #63672
PROPOSAL:

Tests

  1. Go to Reports page:
  2. Test selection mode on Reports > Expenses page
  • test if selecting one expense /multiple expenses works
  • test if deselecting one expense /multiple expenses works
  • test if using selection options like hold etc. works
  1. Test selection mode on Reports > Expense Reports page
  • test if selecting one report /multiple reports works
  • test if deselecting one report /multiple reports works
  • test if using selection options like hold etc. works
  1. Test switching between Reports page tabs: Expenses <-> Expense Reports, make sure that if the page was already loaded it doesn't show loading state
  2. Test switching between Reports page tabs: Chats <-> Expenses, make sure that if the page was already loaded it doesn't show loading state
  3. Reset cache -> go to reports page and make sure selection mode is off

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
Screen.Recording.2025-07-07.at.12.09.45.mov
Android: mWeb Chrome
Screen.Recording.2025-07-07.at.12.14.54.mov
iOS: Native
Screen.Recording.2025-07-07.at.10.32.47.mov
iOS: mWeb Safari
Screen.Recording.2025-07-07.at.12.01.02.mov
MacOS: Chrome / Safari
Screen.Recording.2025-07-07.at.12.19.43.mov
MacOS: Desktop

Copy link
Contributor

@Kicu Kicu left a comment

Choose a reason for hiding this comment

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

Very good changes 👍 I left a bunch of comments but none are super important.
Good job!


const turnOnMobileSelectionMode = () => {
Onyx.merge(ONYXKEYS.MOBILE_SELECTION_MODE, {isEnabled: true});
Onyx.merge(ONYXKEYS.MOBILE_SELECTION_MODE, true);
Copy link
Contributor

Choose a reason for hiding this comment

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

great 🚀

},
[],
);

Copy link
Contributor

Choose a reason for hiding this comment

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

amazing 👏
Can you tell me in short what part of code is responsible for disabling selection mode now in these cases?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

  1. For the first useEffect:
    this useEffect and this one from Search/index are doing the same thing, so these effects were redundant.
  2. For the second one: now when everything uses useMobileSelctionMode we don't need it to clear it after leaving because it is cleared on entering a screen that uses useMobileSelctionMode.

const selectedTransactionsKeys = Object.keys(selectedTransactions ?? {});

if (shouldUseNarrowLayout && selectionMode?.isEnabled && headerButtonsOptions.length > 0) {
if (shouldUseNarrowLayout && !!selectionMode && headerButtonsOptions.length > 0) {
Copy link
Contributor

Choose a reason for hiding this comment

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

same case - selection mode is used via useOnyx and not via useSelectionMode. Why?

},
},
});
[],
Copy link
Contributor

Choose a reason for hiding this comment

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

the change with useAnimatedScrollHandler is that you are now passing [] as a dependency list, right?
Does that mean we will do less re-renders now because in the past we'd do more?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Previously useAnimatedScrollHandler would recreate in every rerender causing additional overhead. Passing empty dependency array stops that.

@SzymczakJ SzymczakJ marked this pull request as ready for review July 7, 2025 10:36
@SzymczakJ SzymczakJ requested a review from a team as a code owner July 7, 2025 10:36
@melvin-bot melvin-bot bot requested review from suneox and removed request for a team July 7, 2025 10:36
@melvin-bot
Copy link

melvin-bot bot commented Jul 7, 2025

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

Copy link
Contributor

@suneox suneox left a comment

Choose a reason for hiding this comment

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

Overall, the change set looks good. There are just a few points that need clarification and improvement. I’m currently stuck with the iOS build but will resolve it soon to complete the checklist.

type SearchFiltersBarProps = {
queryJSON: SearchQueryJSON;
headerButtonsOptions: Array<DropdownOption<SearchHeaderOptionValue>>;
isMobileSelectionModeEnabled: boolean;
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB: I'm not sure if we need to introduce this prop, since all the places using this component already pass the value from the useMobileSelectionMode 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.

Each useMobileSelectionMode is adding additional overhead with useOnyx, useRef and the useEfffect which it calls.
Since the performance is our number one concern and it's so easy to pass isMobileSelectionModeEnabled as it is in the SearchFiltersBar parent I think we should keep it that way.

onSearchRouterFocus?: () => void;
headerButtonsOptions: Array<DropdownOption<SearchHeaderOptionValue>>;
handleSearch: (value: string) => void;
isMobileSelectionModeEnabled: boolean;
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB: same above all the places using this component already pass the value from the useMobileSelectionMode hook so i think we don't need to introduce this props

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The same answear as above ☝️

handleActionButtonPress(currentSearchHash, transactionItem, () => onSelectRow(item), shouldUseNarrowLayout && !!canSelectMultiple);
}}
onButtonPress={handleActionButtonPress}
onCheckboxPress={() => onCheckboxPress?.(item)}
Copy link
Contributor

@suneox suneox Jul 8, 2025

Choose a reason for hiding this comment

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

If this component has a re-render issue, I think we should wrap all calback functions with useCallback, rather than just wrapping onButtonPress

@suneox
Copy link
Contributor

suneox commented Jul 9, 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
Screen.Recording.2025-07-09.at.16.39.55.mp4
Android: mWeb Chrome
Screen.Recording.2025-07-09.at.16.36.02.mp4
iOS: HybridApp
Screen.Recording.2025-07-09.at.16.27.48.mp4
iOS: mWeb Safari
Screen.Recording.2025-07-09.at.16.32.49.mp4
MacOS: Chrome / Safari
Screen.Recording.2025-07-09.at.16.18.51.mp4
MacOS: Desktop
Screen.Recording.2025-07-09.at.16.30.48.mp4

Copy link
Contributor

@suneox suneox left a comment

Choose a reason for hiding this comment

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

The current change doesn't break existing functionality, so i think we can proceed with this PR. Based on my test data, I've only seen a slight improvement. Looking forward to the next investigation around flattening the view hierarchy it may bring even more improvements!

@melvin-bot melvin-bot bot requested a review from mountiny July 9, 2025 10:49
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.

Lets get this one out, thanks!

[ONYXKEYS.REVIEW_DUPLICATES]: OnyxTypes.ReviewDuplicates;
[ONYXKEYS.ADD_NEW_COMPANY_CARD]: OnyxTypes.AddNewCompanyCardFeed;
[ONYXKEYS.ASSIGN_CARD]: OnyxTypes.AssignCard;
[ONYXKEYS.MOBILE_SELECTION_MODE]: OnyxTypes.MobileSelectionMode;
Copy link
Contributor

Choose a reason for hiding this comment

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

Did you remove this type as its not used anymore?

const baseKey = isChat
? `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${(item as ReportActionListItemType).reportActionID}`
: `${ONYXKEYS.COLLECTION.TRANSACTION}${(item as TransactionListItemType).transactionID}`;
// Check if the base key matches the newSearchResultKey (TransactionListItemType)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
// Check if the base key matches the newSearchResultKey (TransactionListItemType)
// Check if the base key matches the newSearchResultKey (TransactionListItemType)

: `${ONYXKEYS.COLLECTION.TRANSACTION}${(item as TransactionListItemType).transactionID}`;
// Check if the base key matches the newSearchResultKey (TransactionListItemType)
const isBaseKeyMatch = baseKey === newSearchResultKey;
// Check if any transaction within the transactions array (TransactionGroupListItemType) matches the newSearchResultKey
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
// Check if any transaction within the transactions array (TransactionGroupListItemType) matches the newSearchResultKey
// Check if any transaction within the transactions array (TransactionGroupListItemType) matches the newSearchResultKey

const transactionKey = `${ONYXKEYS.COLLECTION.TRANSACTION}${transaction.transactionID}`;
return transactionKey === newSearchResultKey;
});
// Determine if either the base key or any transaction key matches
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
// Determine if either the base key or any transaction key matches
// Determine if either the base key or any transaction key matches

@mountiny mountiny merged commit 8956422 into Expensify:main Jul 9, 2025
20 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Jul 9, 2025

✋ 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

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

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

@github-actions
Copy link
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 9.1.79-11 🚀

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

Comment on lines -159 to -161
} else if (selectedItemsLength === 0 && selectionMode?.isEnabled && !wasSelectionOnRef.current) {
turnOffMobileSelectionMode();
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Coming from the #66027 checklist: we’ve removed this logic, so in case the user navigates back using the Android back button, we need to call turnOffMobileSelectionMode

});
}
if (isEmptyObject(newTransactionList)) {
return;
Copy link
Contributor

Choose a reason for hiding this comment

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

This early return causes an issue where the selected transactions are not cleared when we previously have selected transactions, but then all selected items are removed from the list.

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.

6 participants