perf: improve shouldDisplayViolationsRBRInLHN #56639

TMisiukiewicz · 2025-02-11T07:37:16Z

Explanation of Change

Refactoring the code to use more performant way of determining whether report should have RBR displayed or not.

Fixed Issues

$ #56730
PROPOSAL: #56730 (comment)

Tests

Make sure account you are logged into does not have RBR in the inbox
Start new chat
Create expense and upload an image that is not a proper receipt
Wait until it is processed
Verify RBR is displayed in the LHN next to the report and in the bottom tabs together with Inbox item

Verify that no errors appear in the JS console

Offline tests

QA Steps

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

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

android-web.mov

iOS: Native

iOS: mWeb Safari

ios-web.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

…DisplayViolationsRBRInLHN

melvin-bot · 2025-02-12T11:11:39Z

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

ZhenjaHorbach · 2025-02-12T11:14:08Z

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 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: Native

Uploading android.mov…

Android: mWeb Chrome

Screenrecorder-2025-02-13-09-28-23-837.mp4

iOS: Native

ios.mov

iOS: mWeb Safari

ios-web.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

ZhenjaHorbach · 2025-02-12T11:18:02Z

tests/unit/SidebarUtilsTest.ts

+                ...MOCK_REPORTS,
+                ...MOCK_TRANSACTION_VIOLATIONS,
+                [`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${MOCK_REPORT.reportID}` as const]: MOCK_REPORT_ACTIONS,


Actually interesting why our tests broke after refactoring the code and we need to update tests after that 🤔

yeah I had to spend some time to figure it out 🙈 The Onyx callback responsible for creating a map of reports by policy ID is using a value based on session, so when it was trying to access it, it was still undefined because it was declared in multiSet after reports

Oh
Got it !
Thanks for the explanation !

ZhenjaHorbach · 2025-02-12T14:22:50Z

Strange
But when I get an error I don't have any updates in LHN

But I know what the issue is
If we don't create a chat beforehand, we'll have this issue
And since we have the same issue in the last main
Then never mind 😅

2025-02-12.15.09.35.mov

ZhenjaHorbach · 2025-02-12T17:17:12Z

@TMisiukiewicz
Actually could you retest android mobile, please ?
Because in order to update a expense status I need to reopen a chat page
I repeated it 3 times and every time I have the same issue
I just want to make sure I'm the only one with this issue 😅

2025-02-12.17.31.47.mov

TMisiukiewicz · 2025-02-13T07:54:46Z

@ZhenjaHorbach hmm no such issue on my side 🤔

…DisplayViolationsRBRInLHN

ZhenjaHorbach · 2025-02-13T08:32:41Z

@ZhenjaHorbach hmm no such issue on my side 🤔

Thanks for checking !

And yeah
Retested on a real device
And everything works !

There may be problems with my emulator 😅

ZhenjaHorbach · 2025-02-13T08:33:06Z

LGTM !

ZhenjaHorbach · 2025-02-14T09:45:22Z

@mjasikowski
I think we can merge this PR 😅

mjasikowski · 2025-02-14T09:55:33Z

@ZhenjaHorbach sorry, I thought I pressed the merge button yesterday 😄

OSBotify · 2025-02-14T10:05:27Z

✋ 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 · 2025-02-17T09:24:16Z

🚀 Deployed to staging by https://github.com/mjasikowski in version: 9.0.99-0 🚀

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

github-actions · 2025-02-18T06:16:19Z

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.99-2 🚀

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

TMisiukiewicz added 9 commits February 7, 2025 15:06

avoid loop for each report

564e6ce

Merge branch 'main' into perf/improve-shouldDisplayViolationsRBRInLHN

b948f01

fix types

778bb18

update comment

442bda8

Merge remote-tracking branch 'upstream/main' into perf/improve-should…

d4b9e6c

…DisplayViolationsRBRInLHN

Merge remote-tracking branch 'upstream/main' into perf/improve-should…

3b16787

…DisplayViolationsRBRInLHN

fix linter

9dc145e

fix sidebar utils

13818ac

fix WorkspaceSettingsUtilsTest

f73f5e7

TMisiukiewicz marked this pull request as ready for review February 12, 2025 11:11

TMisiukiewicz requested a review from a team as a code owner February 12, 2025 11:11

melvin-bot bot requested review from ZhenjaHorbach and removed request for a team February 12, 2025 11:11

ZhenjaHorbach reviewed Feb 12, 2025

View reviewed changes

Merge remote-tracking branch 'upstream/main' into perf/improve-should…

368cd01

…DisplayViolationsRBRInLHN

ZhenjaHorbach approved these changes Feb 13, 2025

View reviewed changes

melvin-bot bot requested a review from mjasikowski February 13, 2025 08:32

mjasikowski approved these changes Feb 13, 2025

View reviewed changes

mjasikowski merged commit 9c91706 into Expensify:main Feb 14, 2025
17 checks passed

github-actions bot mentioned this pull request Feb 17, 2025

Deploy Checklist: New Expensify 2025-02-17 #56922

Closed

46 tasks

DylanDylann mentioned this pull request Feb 17, 2025

[$250] RBR shown on the LHN for a violation on the expense but no RBR on the expense or report preview #56512

Closed

8 tasks

melvin-bot bot mentioned this pull request Feb 18, 2025

[Due for payment 2025-02-25] [$250] Improve performance of the function responsible for displaying RBR in LHN and bottom tabs #56730

Closed

perf: improve shouldDisplayViolationsRBRInLHN #56639

perf: improve shouldDisplayViolationsRBRInLHN #56639

Uh oh!

Conversation

TMisiukiewicz commented Feb 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Feb 12, 2025

Uh oh!

ZhenjaHorbach commented Feb 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

ZhenjaHorbach Feb 12, 2025

Choose a reason for hiding this comment

Uh oh!

TMisiukiewicz Feb 12, 2025 • 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!

ZhenjaHorbach Feb 12, 2025

Choose a reason for hiding this comment

Uh oh!

ZhenjaHorbach commented Feb 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ZhenjaHorbach commented Feb 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TMisiukiewicz commented Feb 13, 2025

Uh oh!

ZhenjaHorbach commented Feb 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ZhenjaHorbach commented Feb 13, 2025

Uh oh!

ZhenjaHorbach commented Feb 14, 2025

Uh oh!

Uh oh!

mjasikowski commented Feb 14, 2025

Uh oh!

OSBotify commented Feb 14, 2025

Uh oh!

github-actions bot commented Feb 17, 2025

Uh oh!

github-actions bot commented Feb 18, 2025

Uh oh!

Uh oh!

TMisiukiewicz commented Feb 11, 2025 •

edited

Loading

ZhenjaHorbach commented Feb 12, 2025 •

edited

Loading

TMisiukiewicz Feb 12, 2025 •

edited

Loading

ZhenjaHorbach commented Feb 12, 2025 •

edited

Loading

ZhenjaHorbach commented Feb 12, 2025 •

edited

Loading

ZhenjaHorbach commented Feb 13, 2025 •

edited

Loading