Skip to content

Reduce re-renders of MoneyRequestReportPreview#64940

Merged
mountiny merged 10 commits intoExpensify:mainfrom
callstack-internal:fix/reduce-state-updates-in-onlayout
Jul 17, 2025
Merged

Reduce re-renders of MoneyRequestReportPreview#64940
mountiny merged 10 commits intoExpensify:mainfrom
callstack-internal:fix/reduce-state-updates-in-onlayout

Conversation

@zirgulis
Copy link
Contributor

@zirgulis zirgulis commented Jun 25, 2025

Explanation of Change

Reduce rerenders of MoneyRequestReportPreview by batching all measurements using refs and trigger a single re-render only when all required dimensions are collected.

Fixed Issues

$ #65524

Tests

  1. Pick a chat conversation with many Money Request previews.
  2. While using React profiler, navigate to that chat conversation, save profiler results.
  3. Do the same steps on main branch and compare the results.

Offline tests

QA Steps

  1. Navigate to any chat with expense reports or money request previews
  2. Observe that money request previews render smoothly without unnecessary re-renders
  3. Verify there are no visual glitches or layout shifts when the preview components mount
  4. Test scrolling through multiple money request previews in a chat - ensure smooth performance
  5. Open and close the money request details multiple times to verify consistent layout behavior

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 SCR-20250709-jsfs
Android: mWeb Chrome
iOS: Native SCR-20250709-jqrz
iOS: mWeb Safari
MacOS: Chrome / Safari SCR-20250709-jtsx
MacOS: Desktop SCR-20250709-jval sktop

@zirgulis zirgulis force-pushed the fix/reduce-state-updates-in-onlayout branch from 2a0b01c to 95b17c5 Compare June 25, 2025 16:57
@mountiny
Copy link
Contributor

mountiny commented Jul 5, 2025

@zirgulis Can you please make this ready for a review and fix the unit tests?

@mountiny
Copy link
Contributor

mountiny commented Jul 8, 2025

@zirgulis Lets please prioritize making this ready for a review, thanks!

@zirgulis zirgulis changed the title Reduce state updates in onLayout Reduce re-renders of MoneyRequestReportPreview Jul 9, 2025
@zirgulis zirgulis marked this pull request as ready for review July 9, 2025 08:23
@zirgulis zirgulis requested a review from a team as a code owner July 9, 2025 08:23
@melvin-bot melvin-bot bot requested review from hoangzinh and removed request for a team July 9, 2025 08:23
@melvin-bot
Copy link

melvin-bot bot commented Jul 9, 2025

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

@hoangzinh
Copy link
Contributor

@zirgulis Is there any way that we can measure performance to prove it has been reduced?

@zirgulis
Copy link
Contributor Author

zirgulis commented Jul 9, 2025

@hoangzinh yes the testing steps are mentioned in the Tests section in this PR's description. To compare the React profiler's results you can use https://kacper-mikolajczak.github.io/rcc/

Copy link
Contributor

Choose a reason for hiding this comment

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

One concern here is: it won't trigger recalculate reportPreviewStyles when layout is changed again (like change window size, or vertical mode -> horizontal mode)

Copy link
Contributor

Choose a reason for hiding this comment

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

But I couldn't find a regression issue related to this concern.

Screen.Recording.2025-07-10.at.09.04.16.mov

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@hoangzinh I managed to find a regression: when using the responsive window size in the browser the styles recalculation was not working properly on mobile dimensions, it was showing many smaller TransactionPreview components instead of one big TransactionPreview. I.e. the recalculation of transactionPreviewCarouselStyle was not working properly:

Screen.Recording.2025-07-10.at.18.19.45.mov

I have fixed that in my latest commit , now it correctly recalculates the TransactionPreview "box" while still reducing state updates when not resizing:

Screen.Recording.2025-07-10.at.18.20.28.mov

Copy link
Contributor

Choose a reason for hiding this comment

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

nice catch 👍

@zirgulis zirgulis requested a review from hoangzinh July 10, 2025 15:33
Copy link
Contributor

@hoangzinh hoangzinh Jul 10, 2025

Choose a reason for hiding this comment

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

I don't feel strong about this trick, tbh. It will trigger re-render 2 times in the narrow layout.

Wdyt about this?

const widthsRef = useRef({currentWidth: null, currentWrapperWidth: null});
const [widths, setWidths] = useState({currentWidth: 0, currentWrapperWidth: 0});

const updateWidths = () => {
    const {currentWidth, currentWrapperWidth} = widthsRef.current;
    if (currentWidth !== null && currentWrapperWidth !== null) {
        setWidths({currentWidth, currentWrapperWidth});
        widthRefs.current = {};
    }
};

const onCarouselLayout = (e) => {
    widthsRef.current.currentWidth = e.nativeEvent.layout.width;
    updateWidths();
};
const onWrapperLayout = (e) => {
    widthsRef.current.currentWrapperWidth = e.nativeEvent.layout.width;
    updateWidths();
};


// Then update existing reportPreviewStyles to
const reportPreviewStyles = useMemo(
    () => StyleUtils.getMoneyRequestReportPreviewStyle(shouldUseNarrowLayout, transactions.length, widths.currentWidth, widths.currentWrapperWidth),
    [StyleUtils, widths, shouldUseNarrowLayout, transactions.length],
);

Copy link
Contributor Author

Choose a reason for hiding this comment

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

can you provide the whole code? It's unclear to me how your code should work, e.g. widths state is not used anywhere

Copy link
Contributor

Choose a reason for hiding this comment

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

Updated the above code suggestion. Can you take a look again? My idea is update them in a batch

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@hoangzinh doesn't work on web:
image

on mobile currentWrapperWidth doesn't seem to be correct

image

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm, sorry, I didn't test it carefully. I just updated it. Anw, it's just my suggestion. Feel free to choose any solution that works for you first.

diff --git a/src/components/ReportActionItem/MoneyRequestReportPreview/index.tsx b/src/components/ReportActionItem/MoneyRequestReportPreview/index.tsx
index 321f4ad0a7a..8c8510508fb 100644
--- a/src/components/ReportActionItem/MoneyRequestReportPreview/index.tsx
+++ b/src/components/ReportActionItem/MoneyRequestReportPreview/index.tsx
@@ -1,4 +1,4 @@
-import React, {useCallback, useMemo, useState} from 'react';
+import React, {useCallback, useMemo, useRef, useState} from 'react';
 import type {LayoutChangeEvent, ListRenderItem} from 'react-native';
 import {usePersonalDetails} from '@components/OnyxProvider';
 import TransactionPreview from '@components/ReportActionItem/TransactionPreview';
@@ -52,12 +52,31 @@ function MoneyRequestReportPreview({
     const lastTransactionViolations = useTransactionViolations(lastTransaction?.transactionID);
     const isTrackExpenseAction = isTrackExpenseActionReportActionsUtils(action);
     const isSplitBillAction = isSplitBillActionReportActionsUtils(action);
-    const [currentWidth, setCurrentWidth] = useState<number>(0);
-    const [currentWrapperWidth, setCurrentWrapperWidth] = useState<number>(0);
+
+    const widthsRef = useRef({currentWidth: 0, currentWrapperWidth: 0});
+    const [widths, setWidths] = useState({currentWidth: 0, currentWrapperWidth: 0});
+
     const reportPreviewStyles = useMemo(
-        () => StyleUtils.getMoneyRequestReportPreviewStyle(shouldUseNarrowLayout, transactions.length, currentWidth, currentWrapperWidth),
-        [StyleUtils, currentWidth, currentWrapperWidth, shouldUseNarrowLayout, transactions.length],
+        () => StyleUtils.getMoneyRequestReportPreviewStyle(shouldUseNarrowLayout, transactions.length, widths.currentWidth, widths.currentWrapperWidth),
+        [StyleUtils, widths, shouldUseNarrowLayout, transactions.length],
     );
+
+    const updateWidths = () => {
+        const {currentWidth, currentWrapperWidth} = widthsRef.current;
+        if (currentWidth !== 0 && currentWrapperWidth !== 0) {
+            setWidths({currentWidth, currentWrapperWidth});
+        }
+    };
+    
+    const onCarouselLayout = (e) => {
+        widthsRef.current.currentWidth = e.nativeEvent.layout.width;
+        updateWidths();
+    };
+    const onWrapperLayout = (e) => {
+        widthsRef.current.currentWrapperWidth = e.nativeEvent.layout.width;
+        updateWidths();
+    };
+
     const shouldShowPayerAndReceiver = useMemo(() => {
         if (!isIOUReport(iouReport) && action.childType !== CONST.REPORT.TYPE.IOU) {
             return false;
@@ -121,13 +140,9 @@ function MoneyRequestReportPreview({
             invoiceReceiverPolicy={invoiceReceiverPolicy}
             lastTransactionViolations={lastTransactionViolations}
             renderTransactionItem={renderItem}
-            onCarouselLayout={(e: LayoutChangeEvent) => {
-                setCurrentWidth(e.nativeEvent.layout.width);
-            }}
-            onWrapperLayout={(e: LayoutChangeEvent) => {
-                setCurrentWrapperWidth(e.nativeEvent.layout.width);
-            }}
-            currentWidth={currentWidth}
+            onCarouselLayout={onCarouselLayout}
+            onWrapperLayout={onWrapperLayout}
+            currentWidth={widthsRef.current.currentWidth}
             reportPreviewStyles={reportPreviewStyles}
             shouldDisplayContextMenu={shouldDisplayContextMenu}
             isInvoice={isInvoice}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@hoangzinh please have another look I fixed your POC + added some optimizations

Copy link
Contributor

Choose a reason for hiding this comment

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

sure, @zirgulis

@zirgulis zirgulis requested a review from hoangzinh July 11, 2025 10:01
@hoangzinh
Copy link
Contributor

hoangzinh commented Jul 11, 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-11.at.23.25.32.mov
Android: mWeb Chrome
Screen.Recording.2025-07-11.at.23.05.30.android.chrome.mov
iOS: HybridApp
Screen.Recording.2025-07-11.at.23.17.35.ios.mov
iOS: mWeb Safari
Screen.Recording.2025-07-11.at.23.11.53.ios.safari.mov
MacOS: Chrome / Safari
Screen.Recording.2025-07-11.at.22.32.23.web.mov
MacOS: Desktop
Screen.Recording.2025-07-11.at.22.54.27.desktop.mov

Copy link
Contributor

@hoangzinh hoangzinh left a comment

Choose a reason for hiding this comment

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

LGTM

@melvin-bot melvin-bot bot requested a review from mountiny July 11, 2025 16:27
@zirgulis
Copy link
Contributor Author

I'm OOO for today, will address any upcoming PR comments tomorrow.

@mountiny mountiny requested a review from Guccio163 July 14, 2025 11:44
@mountiny
Copy link
Contributor

Also adding @Guccio163 for a review kindly, thanks

@Guccio163
Copy link
Contributor

Code-wise it looks okay, but I think something is still buggy, because 'iOS: mWeb Safari' in @hoangzinh 's Reviewer Checklist looks wrong on 0:09 - Carousel doesn't scroll right on the dot click; It did occur to me some time ago during the development of the Carousel when TransactionPreview width was calculated wrong or value which it operates on isn't updated properly, you should check it 🔎

@hoangzinh
Copy link
Contributor

Thank you @Guccio163. @zirgulis, can you take a look to see if that bug is caused by this PR?

@zirgulis
Copy link
Contributor Author

@hoangzinh @Guccio163 I can't reproduce that bug. What are the steps to reproduce this?

Screen.Recording.2025-07-15.at.19.32.37.mov

@hoangzinh
Copy link
Contributor

I couldn't reproduce it again, either

Screen.Recording.2025-07-16.at.04.43.05.mov

@hoangzinh
Copy link
Contributor

@Guccio163 It seems to be an intermittent bug. Anw, I don't think this PR causes that bug. Can we go ahead with this PR?

@mountiny
Copy link
Contributor

@hoangzinh maybe its repro on main too

@hoangzinh
Copy link
Contributor

I couldn't reproduce again, so I can't verify @mountiny. I think we can go ahead with the PR. If we catch this bug later with reproducible steps, we can fix it later.

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.

Thanks!

@mountiny mountiny merged commit bb4a236 into Expensify:main Jul 17, 2025
17 checks passed
@github-actions
Copy link
Contributor

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

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

@github-actions
Copy link
Contributor

🚀 Deployed to production by https://github.com/cristipaval in version: 9.1.83-5 🚀

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.

4 participants

Comments