Debug Mode - "Has RBR" is not shown for report that has RBR in LHN #50468

pac-guerreiro · 2024-10-08T19:10:15Z

Details

Fixed Issues

$#50403
PROPOSAL:

Add missing translations for Has RBR.
Add missing logic to determine reason to show a report in LHN, if a report has errors other than receipt failed receipt.
Extra: Migrate some logic from OptionsListUtils to ReportUtils to avoid dependency cycles

Tests

Enable Debug mode in troubleshoot
On home page, open a chat report from LHN that has a RBR
Click on the header of the chat you just opened, then click on Debug
On the Details tab, Has RBR is shown in Visible in LHN for report that has RBR in LHN

Offline tests

Same as tests

QA Steps

Same as tests

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 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 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
  - If any non-english text was added/modified, I verified the translation was requested/reviewed 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.js 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.
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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-10-08T19:10:20Z

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

pac-guerreiro · 2024-10-09T00:02:18Z

@DylanDylann

All that remains from my side is to add missing screenshots and three test cases for hasRBR.

I'll let you know when I'm done, which should be tomorrow 😄

src/libs/DebugUtils.ts

…-visible-in-lhn-debug-section

DylanDylann · 2024-10-10T08:49:17Z

@pac-guerreiro Kindly bump

… LHN

pac-guerreiro · 2024-10-10T15:06:56Z

@DylanDylann

Sorry for the delay, I just added the unit test cases for hasRBR.

I also added the screenshots in the meantime.

Can you give another review and let me know if I missed anything? Thanks 😄

DylanDylann · 2024-10-11T03:50:20Z

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-10-11.at.11.34.59.mov

Android: mWeb Chrome

Screen.Recording.2024-10-11.at.11.03.31.mov

iOS: Native

Screen.Recording.2024-10-11.at.11.35.35.mov

iOS: mWeb Safari

Screen.Recording.2024-10-11.at.10.59.19.mov

MacOS: Chrome / Safari

Screen.Recording.2024-10-11.at.10.50.31.mov

MacOS: Desktop

Screen.Recording.2024-10-14.at.17.04.28.mov

DylanDylann · 2024-10-11T04:39:44Z

@pac-guerreiro On the first time, I go to the transaction thread and go to Debug mode, the RBR display true but visible LHN reason display "is temporarily focused". But if we go back and open again, the reason display correctly (has IOU Violations).

Screen.Recording.2024-10-11.at.11.03.31.mov

pac-guerreiro · 2024-10-11T15:06:29Z

@DylanDylann I'm currently investigating this and I think I'm observing the same behaviour in this PR - #49962

It seems that the data that we read for displaying the Visible in LHN reason is incomplete before OpenReport API call.

I'm digging through the code to understand what data is triggering the RBR and why it differs from the data for Visible in LHN reason

DylanDylann · 2024-10-11T17:11:06Z

@pac-guerreiro Will we handle this bug here?

… message

DylanDylann · 2024-10-14T09:05:55Z

@pac-guerreiro I think we can utilize hasRBR in DebugReportPage

index 261d2db208..66779ef999 100644
--- a/src/libs/DebugUtils.ts
+++ b/src/libs/DebugUtils.ts
@@ -601,7 +601,7 @@ function validateReportActionJSON(json: string) {
 /**
  * Gets the reason for showing LHN row
  */
-function getReasonForShowingRowInLHN(report: OnyxEntry<Report>): TranslationPaths | null {
+function getReasonForShowingRowInLHN(report: OnyxEntry<Report>, hasRBR: boolean): TranslationPaths | null {
     if (!report) {
         return null;
     }
@@ -620,10 +620,7 @@ function getReasonForShowingRowInLHN(report: OnyxEntry<Report>): TranslationPath
         includeSelfDM: true,
     });
 
-    if (
-        !([CONST.REPORT_IN_LHN_REASONS.HAS_ADD_WORKSPACE_ROOM_ERRORS, CONST.REPORT_IN_LHN_REASONS.HAS_IOU_VIOLATIONS] as Array<typeof reason>).includes(reason) &&
-        SidebarUtils.shouldShowRedBrickRoad(report, reportActionsCollection?.[`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${report?.reportID}`], doesReportHaveViolations, transactionViolations)
-    ) {
+    if (!([CONST.REPORT_IN_LHN_REASONS.HAS_ADD_WORKSPACE_ROOM_ERRORS, CONST.REPORT_IN_LHN_REASONS.HAS_IOU_VIOLATIONS] as Array<typeof reason>).includes(reason) && hasRBR) {
         return `debug.reasonVisibleInLHN.hasRBR`;
     }
 
diff --git a/src/pages/Debug/Report/DebugReportPage.tsx b/src/pages/Debug/Report/DebugReportPage.tsx
index 530b4b5f4a..5dd91874bc 100644
--- a/src/pages/Debug/Report/DebugReportPage.tsx
+++ b/src/pages/Debug/Report/DebugReportPage.tsx
@@ -58,13 +58,12 @@ function DebugReportPage({
         if (!report) {
             return [];
         }
-
-        const reasonLHN = DebugUtils.getReasonForShowingRowInLHN(report);
-        const {reason: reasonGBR, reportAction: reportActionGBR} = DebugUtils.getReasonAndReportActionForGBRInLHNRow(report) ?? {};
-        const reportActionRBR = DebugUtils.getRBRReportAction(report, reportActions);
         const shouldDisplayViolations = ReportUtils.shouldDisplayTransactionThreadViolations(report, transactionViolations, parentReportAction);
         const shouldDisplayReportViolations = ReportUtils.isReportOwner(report) && ReportUtils.hasReportViolations(reportID);
         const hasRBR = SidebarUtils.shouldShowRedBrickRoad(report, reportActions, !!shouldDisplayViolations || shouldDisplayReportViolations, transactionViolations);
+        const reasonLHN = DebugUtils.getReasonForShowingRowInLHN(report, hasRBR);
+        const {reason: reasonGBR, reportAction: reportActionGBR} = DebugUtils.getReasonAndReportActionForGBRInLHNRow(report) ?? {};
+        const reportActionRBR = DebugUtils.getRBRReportAction(report, reportActions);
         const hasGBR = !hasRBR && !!reasonGBR;

pac-guerreiro · 2024-10-14T21:09:13Z

@mountiny

Waiting for your final review 😄

pac-guerreiro · 2024-10-15T18:50:10Z

Waiting on final review from @mountiny

mountiny

Sorry for late review, can you please sync main?

…-visible-in-lhn-debug-section # Conflicts: # src/libs/ReportUtils.ts

mountiny

Thanks! loooks good to me but can you please double check the implementation is same no as you moving across the files

pac-guerreiro · 2024-10-16T09:46:15Z

@mountiny

On it! I'll let you know when I'm done 😄

pac-guerreiro · 2024-10-16T14:39:52Z

@mountiny

I double checked the implementations that I migrated between files are correct!

OSBotify · 2024-10-16T14:50:06Z

✋ 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 · 2024-10-17T01:59:14Z

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

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

pac-guerreiro · 2024-10-17T12:04:02Z

@mountiny

I made a mistake while resolving merge conflicts so this issue still persists. Is it okay if I resolve it here - #50831 ?

mountiny · 2024-10-17T16:51:37Z

@pac-guerreiro if its just this issue and nothing else, then yes

pac-guerreiro · 2024-10-17T16:53:57Z

@mountiny it is, so this will get fixed in #50831.

Sorry for my mistake, I'll pay more attention next time!

mountiny · 2024-10-17T17:01:02Z

No problem, thanks. Can you link the issue to it as well

mountiny · 2024-10-17T17:01:41Z

Marked this as NoQa since it wont be passing, please add the testing steps to the other PR too

pac-guerreiro · 2024-10-17T17:02:39Z

Sure, here is the link to the issue - #50665

pac-guerreiro · 2024-10-17T18:07:57Z

@mountiny

Sorry, this PR is safe for QA! The issue only happens on #50831 because I touched it's logic and had to refactor it in order for it to work as expected.

github-actions · 2024-10-18T18:48:04Z

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.50-8 🚀

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

fix(debug mode): wrong reason for why RBR reports are visible in LHN

c0542d5

pac-guerreiro requested a review from a team as a code owner October 8, 2024 19:10

melvin-bot bot requested review from DylanDylann and removed request for a team October 8, 2024 19:10

pac-guerreiro mentioned this pull request Oct 8, 2024

Add LHN debugging to Debug Mode #48442

Merged

48 tasks

pac-guerreiro added 2 commits October 8, 2024 20:53

chore: fix test cases failing for DebugUtils

39bdf33

chore: remove unused dependency

f0dc3c1

DylanDylann reviewed Oct 9, 2024

View reviewed changes

src/libs/DebugUtils.ts Outdated Show resolved Hide resolved

Merge branch 'main' into pac-guerreiro/fix/50403-has-rbr-not-shown-in…

7d511de

…-visible-in-lhn-debug-section

pac-guerreiro added 3 commits October 10, 2024 09:51

fix(debug mode): hasGBR showing instead of hasRBR in debug details page

13807c5

fix(debug mode): not showing specific RBR reasons for report to be in…

9358bab

… LHN

chore: add test cases for hasRBR

2fd6a04

pac-guerreiro requested a review from DylanDylann October 10, 2024 15:07

pac-guerreiro added 2 commits October 11, 2024 18:33

fix(debug mode): is temporary focused reason shown instead of has RBR…

de2359f

… message

chore: fix eslint errors

6a8b6fd

pac-guerreiro added 2 commits October 14, 2024 10:34

refactor: apply suggestions

96f5935

fix: debug utils hasRBR tests

212f461

DylanDylann approved these changes Oct 14, 2024

View reviewed changes

melvin-bot bot requested a review from mountiny October 14, 2024 10:05

DylanDylann mentioned this pull request Oct 15, 2024

[HOLD for payment 2024-11-13] [$250] RBR isn't displayed when scanning failed #50799

Closed

6 tasks

mountiny assigned pac-guerreiro Oct 16, 2024

mountiny previously approved these changes Oct 16, 2024

View reviewed changes

Merge branch 'main' into pac-guerreiro/fix/50403-has-rbr-not-shown-in…

8bab8b6

…-visible-in-lhn-debug-section # Conflicts: # src/libs/ReportUtils.ts

pac-guerreiro dismissed mountiny’s stale review via 8bab8b6 October 16, 2024 09:42

mountiny approved these changes Oct 16, 2024

View reviewed changes

mountiny merged commit afe5258 into Expensify:main Oct 16, 2024
17 checks passed

github-actions bot mentioned this pull request Oct 17, 2024

Deploy Checklist: New Expensify 2024-10-17 #50969

Closed

90 tasks

mountiny changed the title ~~Debug Mode - "Has RBR" is not shown for report that has RBR in LHN~~ [NoQA] Debug Mode - "Has RBR" is not shown for report that has RBR in LHN Oct 17, 2024

mountiny changed the title ~~[NoQA] Debug Mode - "Has RBR" is not shown for report that has RBR in LHN~~ Debug Mode - "Has RBR" is not shown for report that has RBR in LHN Oct 18, 2024

melvin-bot bot mentioned this pull request Oct 18, 2024

[HOLD for payment 2024-10-25] Debug Mode - "Has RBR" is not shown for report that has RBR in LHN #50403

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Debug Mode - "Has RBR" is not shown for report that has RBR in LHN #50468

Debug Mode - "Has RBR" is not shown for report that has RBR in LHN #50468

pac-guerreiro commented Oct 8, 2024 •

edited

Loading

melvin-bot bot commented Oct 8, 2024

pac-guerreiro commented Oct 9, 2024

DylanDylann commented Oct 10, 2024

pac-guerreiro commented Oct 10, 2024

DylanDylann commented Oct 11, 2024 •

edited

Loading

DylanDylann commented Oct 11, 2024

pac-guerreiro commented Oct 11, 2024

DylanDylann commented Oct 11, 2024

DylanDylann commented Oct 14, 2024

pac-guerreiro commented Oct 14, 2024

pac-guerreiro commented Oct 15, 2024

mountiny left a comment

mountiny left a comment

pac-guerreiro commented Oct 16, 2024

pac-guerreiro commented Oct 16, 2024

OSBotify commented Oct 16, 2024

github-actions bot commented Oct 17, 2024

pac-guerreiro commented Oct 17, 2024

mountiny commented Oct 17, 2024

pac-guerreiro commented Oct 17, 2024 •

edited

Loading

mountiny commented Oct 17, 2024

mountiny commented Oct 17, 2024

pac-guerreiro commented Oct 17, 2024

pac-guerreiro commented Oct 17, 2024

github-actions bot commented Oct 18, 2024

Debug Mode - "Has RBR" is not shown for report that has RBR in LHN #50468

Debug Mode - "Has RBR" is not shown for report that has RBR in LHN #50468

Conversation

pac-guerreiro commented Oct 8, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 8, 2024

pac-guerreiro commented Oct 9, 2024

DylanDylann commented Oct 10, 2024

pac-guerreiro commented Oct 10, 2024

DylanDylann commented Oct 11, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

DylanDylann commented Oct 11, 2024

pac-guerreiro commented Oct 11, 2024

DylanDylann commented Oct 11, 2024

DylanDylann commented Oct 14, 2024

pac-guerreiro commented Oct 14, 2024

pac-guerreiro commented Oct 15, 2024

mountiny left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

pac-guerreiro commented Oct 16, 2024

pac-guerreiro commented Oct 16, 2024

OSBotify commented Oct 16, 2024

github-actions bot commented Oct 17, 2024

pac-guerreiro commented Oct 17, 2024

mountiny commented Oct 17, 2024

pac-guerreiro commented Oct 17, 2024 • edited Loading

mountiny commented Oct 17, 2024

mountiny commented Oct 17, 2024

pac-guerreiro commented Oct 17, 2024

pac-guerreiro commented Oct 17, 2024

github-actions bot commented Oct 18, 2024

pac-guerreiro commented Oct 8, 2024 •

edited

Loading

DylanDylann commented Oct 11, 2024 •

edited

Loading

pac-guerreiro commented Oct 17, 2024 •

edited

Loading