perf: reduce getAllReportTransactions usage in ReportPreview by TMisiukiewicz · Pull Request #46500 · Expensify/App

TMisiukiewicz · 2024-07-30T13:23:55Z

Details

Each time getAllReportTransactions is called, it's doing filtering on all transactions to get only those matching the report ID. Instead of calling this function on multiple levels in ReportPreview, let's get report transactions on top-level and use newly created utils to avoid filtering this list.

In total, there were 12 function calls running getAllReportTransactions. It was reduced to call it only once. In an example profile trace from Jason function was running for more than 500ms in total, I think with this change we can reduce it to around 100ms.

Fixed Issues

$ #45528
PROPOSAL:

Tests

Send multiple money requests to someone
Open money report preview
Verify all money requests are visible

Verify that no errors appear in the JS console

Offline tests

QA Steps

Send multiple money requests to someone
Open money report preview
Verify all money requests are visible

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-07-30T13:57:55Z

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

ishpaul777 · 2024-07-30T16:09:02Z

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 tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- 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 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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.js 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.
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: Native

Screen.Recording.2024-07-31.at.6.04.16.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-07-31.at.6.06.37.PM.mov

iOS: Native

Screen.Recording.2024-07-31.at.5.49.37.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-07-31.at.5.55.33.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-07-31.at.5.45.13.PM.mov

MacOS: Desktop

Screen.Recording.2024-07-31.at.6.28.18.PM.mov

ishpaul777

Looks good so far, just few Comments..

ishpaul777 · 2024-07-30T16:35:11Z

        setPaymentType(type);
        setRequestType(CONST.IOU.REPORT_ACTION_TYPE.PAY);
-        if (ReportUtils.hasHeldExpenses(moneyRequestReport.reportID)) {
+        if (TransactionUtils.isAnyTransactionOnHold(allTransactions)) {


can we create a variable for TransactionUtils.isAnyTransactionOnHold(allTransactions) i see its being used few times in this file..

ishpaul777 · 2024-07-30T16:40:07Z

-            areAllRequestsBeingSmartScanned: ReportUtils.areAllRequestsBeingSmartScanned(iouReportID, action),
-            hasOnlyTransactionsWithPendingRoutes: ReportUtils.hasOnlyTransactionsWithPendingRoutes(iouReportID),
-            hasNonReimbursableTransactions: ReportUtils.hasNonReimbursableTransactions(iouReportID),
+            hasMissingSmartscanFields: TransactionUtils.hasAnyTransactionMissingFields(allTransactions),


Suggested change

hasMissingSmartscanFields: TransactionUtils.hasAnyTransactionMissingFields(allTransactions),

hasMissingSmartscanFields: TransactionUtils.hasAnyTransactionMissingSmartscanFields(allTransactions),

Yeah let's keep it specific to smart scan fields vs any missing field.

ishpaul777 · 2024-07-30T16:44:00Z

    const {hasMissingSmartscanFields, areAllRequestsBeingSmartScanned, hasOnlyTransactionsWithPendingRoutes, hasNonReimbursableTransactions} = useMemo(
        () => ({
-            hasMissingSmartscanFields: ReportUtils.hasMissingSmartscanFields(iouReportID),
-            areAllRequestsBeingSmartScanned: ReportUtils.areAllRequestsBeingSmartScanned(iouReportID, action),


areAllRequestsBeingSmartScannedin ReportUtils is unused now, can we remove it please

ishpaul777 · 2024-07-30T16:46:00Z

        () => ({
-            hasMissingSmartscanFields: ReportUtils.hasMissingSmartscanFields(iouReportID),
-            areAllRequestsBeingSmartScanned: ReportUtils.areAllRequestsBeingSmartScanned(iouReportID, action),
-            hasOnlyTransactionsWithPendingRoutes: ReportUtils.hasOnlyTransactionsWithPendingRoutes(iouReportID),


same comment as above ^ for hasOnlyTransactionsWithPendingRoutes

ishpaul777 · 2024-07-30T16:57:33Z

+    const transactionIDs = allTransactions.map((t) => t.transactionID);
    const allHavePendingRTERViolation = TransactionUtils.allHavePendingRTERViolation(transactionIDs);
    // allTransactions in TransactionUtils might have stale data
    const hasOnlyHeldExpenses = ReportUtils.hasOnlyHeldExpenses(moneyRequestReport.reportID, transactions);


can we use TransactionUtils.areAllExpensesOnHold here also ?

ishpaul777 · 2024-07-30T17:10:38Z

Not sure if this is relevant for TransactionUtils.getAllReportTransactions but i just saw this file which restricts usage for methods that look up and return Onyx data in components.

App/tests/actions/EnforceActionExportRestrictions.ts

Lines 7 to 10 in d2fdb27

    
           // There are some methods that are OK to use inside an action file, but should not be exported. These are typically methods that look up and return Onyx data. 
        
           // The correct pattern to use is that every file will use it's own withOnyx or Onyx.connect() to access the Onyx data it needs. This prevents data from becoming stale 
        
           // and prevents side-effects that you may not be aware of. It also allows each file to access Onyx data in the most performant way. More context can be found in 
        
           // https://github.com/Expensify/App/issues/27262

cc @TMisiukiewicz

neil-marcellini · 2024-07-30T19:52:31Z

Not sure if this is relevant for TransactionUtils.getAllReportTransactions but i just saw this file which restricts usage for methods that look up and return Onyx data in components.

App/tests/actions/EnforceActionExportRestrictions.ts

Lines 7 to 10 in d2fdb27

// There are some methods that are OK to use inside an action file, but should not be exported. These are typically methods that look up and return Onyx data.

// The correct pattern to use is that every file will use it's own withOnyx or Onyx.connect() to access the Onyx data it needs. This prevents data from becoming stale

// and prevents side-effects that you may not be aware of. It also allows each file to access Onyx data in the most performant way. More context can be found in

// https://github.com/Expensify/App/issues/27262

cc @TMisiukiewicz

Yep, I think we should pursue that approach, using useOnyx with the selector option to subscribe to the exact data that's needed. Since we were already using utils here though, let's not block on this change. Please create a follow up PR to move to useOnyx and tag us for a review.

edit: Maybe this is irrelevant if we can move the access of all report transactions into a util file only.

neil-marcellini

Thanks for this work and performance improvement. Overall I think it's a good idea. I would like to see us consolidate things even further so that the report utils have a mapping of reportIDs to all their transactions, and that can be the single points where we access them.

neil-marcellini · 2024-07-30T19:56:44Z

-            areAllRequestsBeingSmartScanned: ReportUtils.areAllRequestsBeingSmartScanned(iouReportID, action),
-            hasOnlyTransactionsWithPendingRoutes: ReportUtils.hasOnlyTransactionsWithPendingRoutes(iouReportID),
-            hasNonReimbursableTransactions: ReportUtils.hasNonReimbursableTransactions(iouReportID),
+            hasMissingSmartscanFields: TransactionUtils.hasAnyTransactionMissingFields(allTransactions),


Yeah let's keep it specific to smart scan fields vs any missing field.

neil-marcellini · 2024-07-30T20:06:06Z

I think we should keep one util function for each separate idea. Now we're adding multiple ways to do the same thing by having these transaction utils that mirror the report utils.

Instead, could we please require that all the report utils operating on allReportTransactions take them in as a parameter? Actually, now that I think about that, can't we have ReportUtils create a mapping of reportIDs to their transactions as part of the Onyx connection to all transactions, then each util can easily lookup all transactions for a report?

…eportTransactions-usage

TMisiukiewicz · 2024-07-31T11:16:00Z

@ishpaul777 @neil-marcellini thanks for your comments! I already pushed latest changes to the branch

Thanks for this work and performance improvement. Overall I think it's a good idea. I would like to see us consolidate things even further so that the report utils have a mapping of reportIDs to all their transactions, and that can be the single points where we access them.

Thanks for bringing the idea of mapping @neil-marcellini, it helped me reduce the diff a lot 🎉

Yep, I think we should pursue that approach, using useOnyx with the selector option to subscribe to the exact data that's needed. Since we were already using utils here though, let's not block on this change. Please create a follow up PR to move to useOnyx and tag us for a review.

edit: Maybe this is irrelevant if we can move the access of all report transactions into a util file only.

I'll create a follow up PR with this change later this week 👍

neil-marcellini

Very nice, looks really clean now. Thanks so much! Since we still have some components using the getAllTransactions util, the follow up moving to useOnyx will be a good idea.

neil-marcellini · 2024-07-31T18:27:16Z

 });

 let allTransactions: OnyxCollection<Transaction> = {};
+let reportsTransactions: Record<string, Transaction[]> = {};


NAB: Maybe rename to reportIDsToTransactions?

OSBotify · 2024-07-31T19:33:42Z

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.0.15-0 🚀

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

OSBotify · 2024-08-02T02:22:01Z

🚀 Deployed to production by https://github.com/roryabraham in version: 9.0.15-9 🚀

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

parasharrajat · 2024-08-27T21:04:10Z

    const [isHoldMenuVisible, setIsHoldMenuVisible] = useState(false);
    const [paymentType, setPaymentType] = useState<PaymentMethodType>();
    const [requestType, setRequestType] = useState<ActionHandledType>();
+    const allTransactions = useMemo(() => TransactionUtils.getAllReportTransactions(moneyRequestReport?.reportID), [moneyRequestReport?.reportID]);


This prevents the header from being refreshed when transactions for the report change causing #47084

TMisiukiewicz added 3 commits July 30, 2024 13:14

reduce usage of getAllReportTransactions in ReportPreview

020fe1b

update ReportPreview to operate on a single instance of transactions

52fcb34

memoize report transactions

a8ab569

TMisiukiewicz marked this pull request as ready for review July 30, 2024 13:57

TMisiukiewicz requested a review from a team as a code owner July 30, 2024 13:57

melvin-bot Bot requested review from mkhutornyi and removed request for a team July 30, 2024 13:57

neil-marcellini self-requested a review July 30, 2024 15:53

muttmuure requested review from ishpaul777 and removed request for mkhutornyi July 30, 2024 16:01

ishpaul777 reviewed Jul 30, 2024

View reviewed changes

neil-marcellini requested changes Jul 30, 2024

View reviewed changes

TMisiukiewicz added 6 commits July 31, 2024 09:06

Merge remote-tracking branch 'upstream/main' into perf/reduce-getAllR…

c719638

…eportTransactions-usage

code review updates

b89c139

get transactions from Onyx in MoneyReportView

7d0d08b

code update

4264fb4

use reports transactions mapping & reduce diff

e8df1c9

reduce diff

2714eec

TMisiukiewicz force-pushed the perf/reduce-getAllReportTransactions-usage branch from 95312c2 to 2714eec Compare July 31, 2024 10:57

fix tests

6a22933

ishpaul777 approved these changes Jul 31, 2024

View reviewed changes

melvin-bot Bot requested a review from neil-marcellini July 31, 2024 13:00

neil-marcellini approved these changes Jul 31, 2024

View reviewed changes

neil-marcellini merged commit 3191bc0 into Expensify:main Jul 31, 2024

ishpaul777 mentioned this pull request Jul 31, 2024

[HOLD for payment 2024-08-14] [HOLD for payment 2024-08-09] Optimize frontend performance in most recent mode #45528

Closed

github-actions Bot mentioned this pull request Jul 31, 2024

Deploy Checklist: New Expensify 2024-07-31 #46607

Closed

adhorodyski deleted the perf/reduce-getAllReportTransactions-usage branch August 1, 2024 08:02

grgia mentioned this pull request Aug 1, 2024

[HOLD for payment 2024-08-13] [HOLD for payment 2024-08-09] [$250] Expense- The number of Expense Request is not updated in the Report Conversation preview #46647

Closed

6 tasks

ishpaul777 mentioned this pull request Aug 1, 2024

Deploy Blocker Fix - Update Expense Preview #46681

Merged

50 tasks

parasharrajat reviewed Aug 27, 2024

View reviewed changes

parasharrajat mentioned this pull request Aug 27, 2024

[payment due 8-27][$250] Expense - Mark as cash button only appears in combined report after refreshing the page #47084

Closed

6 tasks

	hasMissingSmartscanFields: TransactionUtils.hasAnyTransactionMissingFields(allTransactions),
	hasMissingSmartscanFields: TransactionUtils.hasAnyTransactionMissingSmartscanFields(allTransactions),

Uh oh!

Conversation

TMisiukiewicz commented Jul 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Jul 30, 2024

Uh oh!

ishpaul777 commented Jul 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

ishpaul777 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ishpaul777 Jul 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ishpaul777 commented Jul 30, 2024

Uh oh!

neil-marcellini commented Jul 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TMisiukiewicz commented Jul 31, 2024

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Jul 31, 2024

Uh oh!

OSBotify commented Aug 2, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

TMisiukiewicz commented Jul 30, 2024 •

edited

Loading

ishpaul777 commented Jul 30, 2024 •

edited

Loading

ishpaul777 Jul 30, 2024 •

edited

Loading

neil-marcellini commented Jul 30, 2024 •

edited

Loading