Skip to content

use derived values for report-specific transaction violations#67154

Merged
mountiny merged 10 commits intoExpensify:mainfrom
callstack-internal:perf/report-transactions-derived-value-all-instances
Aug 12, 2025
Merged

use derived values for report-specific transaction violations#67154
mountiny merged 10 commits intoExpensify:mainfrom
callstack-internal:perf/report-transactions-derived-value-all-instances

Conversation

@zirgulis
Copy link
Contributor

@zirgulis zirgulis commented Jul 25, 2025

Explanation of Change

This PR optimizes performance by replacing direct Onyx collection queries for transaction violations with the existing useTransactionsAndViolationsForReport derived value hook in two components:

  1. MoneyReportHeader: Previously fetched all transaction violations and manually filtered them for the specific report. Now uses the hook's violations directly, eliminating unnecessary data fetching and filtering logic.

  2. DebugReportPage: Previously fetched all transaction violations for debugging purposes. Now uses report-specific violations since it has access to a specific reportID.

The changes maintain identical user-facing behavior while improving performance by leveraging the existing derived value system that was introduced in PR #65247.

Fixed Issues

$ #67166

Tests

  1. Navigate to various money request reports and verify they load correctly
  2. Open the MoneyReportHeader and verify all transaction data displays properly (amounts, violations, status indicators)
  3. Navigate to a money request report with transaction violations and verify the violations are displayed correctly
  4. Open the Debug > Report page for various reports and verify transaction violations are shown accurately
  5. Test report actions like approving, submitting, and exporting to ensure no regressions
  6. Navigate through the LHN and verify all reports display correctly with proper violation indicators
  7. Create new expense reports and verify they appear correctly in both the report view and LHN
  8. Verify that no errors appear in the JS console

Offline tests

  1. Go offline and navigate to previously loaded money request reports - verify cached transaction data displays correctly
  2. While offline, navigate between different reports and verify transactions and violations show properly from cached data
  3. Go back online and verify data syncs correctly without duplications or missing information

QA Steps

Same as above

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-25.at.16.28.11.mov
Android: mWeb Chrome
iOS: Native
Screen.Recording.2025-07-25.at.16.23.16.mov
iOS: mWeb Safari
MacOS: Chrome / Safari
Screen.Recording.2025-07-25.at.16.34.55.mov
MacOS: Desktop

@zirgulis zirgulis force-pushed the perf/report-transactions-derived-value-all-instances branch 4 times, most recently from 992fb13 to 64c6b33 Compare July 25, 2025 12:43
@zirgulis zirgulis force-pushed the perf/report-transactions-derived-value-all-instances branch from 64c6b33 to 558409d Compare July 25, 2025 12:46
@zirgulis zirgulis marked this pull request as ready for review July 25, 2025 13:42
@zirgulis zirgulis requested a review from a team as a code owner July 25, 2025 13:42
@melvin-bot melvin-bot bot requested review from truph01 and removed request for a team July 25, 2025 13:42
@melvin-bot
Copy link

melvin-bot bot commented Jul 25, 2025

@truph01 Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@truph01
Copy link
Contributor

truph01 commented Jul 28, 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-08-12.at.03.52.30.mov
Android: mWeb Chrome
Screen.Recording.2025-08-12.at.03.44.40.mov
iOS: HybridApp
Screen.Recording.2025-08-12.at.03.47.44.mov
iOS: mWeb Safari
Screen.Recording.2025-08-12.at.03.45.33.mov
MacOS: Chrome / Safari
Screen.Recording.2025-08-12.at.03.38.30.mov
MacOS: Desktop
Screen.Recording.2025-08-12.at.03.47.00.mov

const {transactions: reportTransactions, violations} = useTransactionsAndViolationsForReport(moneyRequestReport?.reportID);

const transactions = useMemo(() => {
return reportTransactionsSelector(reportTransactions, moneyRequestReport?.reportID);
Copy link
Contributor

Choose a reason for hiding this comment

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

Why do we need to use the reportTransactionsSelector here? It seems redundant, since reportTransactions from useTransactionsAndViolationsForReport is already filtered to include only the transactions relevant to the report.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@truph01 yeah in this case we don't need additional filtering, we already have the correct values. However we need to get the array version of it, I added the necessary changes, please have another look

const [reportActions] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${reportID}`, {canBeMissing: true});
const [transactions] = useOnyx(ONYXKEYS.COLLECTION.TRANSACTION, {canBeMissing: true});
const [transactionViolations] = useOnyx(ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS, {canBeMissing: true});
const {violations: transactionViolations} = useTransactionsAndViolationsForReport(reportID);
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's consider the case where the report is a policy expense chat that contains a few transactions with violations:

The transactionViolations object is used here:

const shouldDisplayViolations = shouldDisplayViolationsRBRInLHN(report, transactionViolations);

  • Before our change: shouldDisplayViolations returns true because transactionViolations includes data for all transactions, regardless of report ID.
  • After our change: shouldDisplayViolations returns false because transactionViolations is now scoped and becomes an empty object for this report.

We should ensure that the value of shouldDisplayViolations remains unchanged before and after the change. If it does change, it may indicate a regression.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree, reverted this change

@truph01
Copy link
Contributor

truph01 commented Jul 28, 2025

@zirgulis could you merge main and check my two comments above?

@zirgulis
Copy link
Contributor Author

@truph01 yes will do that on Friday since I'm currently OOO. Will ping you.

@mountiny
Copy link
Contributor

mountiny commented Aug 2, 2025

@zirgulis is this ready for another review and testing?

@zirgulis
Copy link
Contributor Author

zirgulis commented Aug 2, 2025

@zirgulis is this ready for another review and testing?

@mountiny yes it's ready to be reviewed again cc @truph01

@zirgulis zirgulis requested a review from truph01 August 2, 2025 10:08
const [allReports] = useOnyx(ONYXKEYS.COLLECTION.REPORT, {canBeMissing: false});
const [policies] = useOnyx(ONYXKEYS.COLLECTION.POLICY, {canBeMissing: true});
const [transactions] = useOnyx(ONYXKEYS.COLLECTION.TRANSACTION, {canBeMissing: true});
const {transactions} = useTransactionsAndViolationsForReport(report.reportID);
Copy link
Contributor

Choose a reason for hiding this comment

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

@zirgulis If the report is a self DM, the transactions object will be {}. As a result, the transaction at this line:

const transaction = transactionID ? transactions?.[`${ONYXKEYS.COLLECTION.TRANSACTION}${transactionID}`] : undefined;

will be undefined when the action is a track expense. This is a regression, because on the latest main branch, the transaction data is not undefined in the same scenario.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@truph01 fixed here a6e8698

@zirgulis zirgulis requested a review from truph01 August 6, 2025 10:28
@mountiny
Copy link
Contributor

mountiny commented Aug 6, 2025

@truph01 ready again

@truph01
Copy link
Contributor

truph01 commented Aug 7, 2025

@zirgulis The selfDM case mentioned here is just an example illustrating a potential regression we might encounter. Could you help double-check for any other similar cases besides selfDM to ensure there’s no missing transaction data?

@zirgulis
Copy link
Contributor Author

zirgulis commented Aug 7, 2025

for any other similar cases besides selfDM to ensure there’s no missing transaction data?

@truph01 can you specify which cases?

@mountiny
Copy link
Contributor

mountiny commented Aug 7, 2025

@truph01 for your interest, please leave full testing and reviews on PRs https://expensify.slack.com/archives/C02NK2DQWUX/p1752590021746689

@truph01
Copy link
Contributor

truph01 commented Aug 7, 2025

@truph01 can you specify which cases?

@zirgulis Here are the reproduction steps to demonstrate the issue:

  1. Create a group chat with multiple members.
  2. Open that group chat and create a split expense.
  3. Compare the transaction data at the following line:
    const transaction = transactionID ? transactions?.[`${ONYXKEYS.COLLECTION.TRANSACTION}${transactionID}`] : undefined;

Behavior differences:

  • In the latest main branch, the transaction data is correctly associated with the IOU action.
  • In this PR, the transaction data is undefined for the same action.

What I’m pointing out is that there may be additional edge cases—similar to the selfDM example—that we're not accounting for yet. We should only apply:

const {transactions} = useTransactionsAndViolationsForReport(report.reportID);

if we're confident that it correctly handles all possible cases. Otherwise, I recommend sticking with the current approach of subscribing to all transaction data. The key priority is ensuring the logic is reliable before we focus on performance improvements.

@zirgulis
Copy link
Contributor Author

@truph01 I had chat with @TMisiukiewicz regarding the derived values and we agreed that covering all the edge cases for ReportActionsList.tsx will increase the complexity of reportTransactionsAndViolations.ts by a lot but will not guarantee if we won't have any regressions. I reverted the change here 7cb8973

…to perf/report-transactions-derived-value-all-instances
@truph01
Copy link
Contributor

truph01 commented Aug 11, 2025

Thanks @zirgulis! Could you address the failed just unit tests?

@zirgulis
Copy link
Contributor Author

@truph01 CI checks are 🟢

@truph01
Copy link
Contributor

truph01 commented Aug 11, 2025

I will finish checklist soon

@melvin-bot melvin-bot bot requested a review from mountiny August 11, 2025 20:53
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 e5bd70e into Expensify:main Aug 12, 2025
21 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

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

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

@github-actions
Copy link
Contributor

🚀 Deployed to production by https://github.com/marcaaron in version: 9.1.94-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.

4 participants