Add RBR reason to LHN debugging by pac-guerreiro · Pull Request #50831 · Expensify/App

pac-guerreiro · 2024-10-15T19:39:55Z

Details

Fixed Issues

Tests

Enable Debug Mode in Troubleshoot
Open a report with RBR from LHN
Click on the chat header
Click on Debug
Confirm that Has RBR is shown in Visible in LHN
Confirm that RBR section displays the correct reason for why the report has a RBR

If you don't have a report with RBR in LHN, then just create an expense and remove a required property (e.g. category) in order to trigger a missing violation.

Offline tests

Same as above

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

pac-guerreiro · 2024-10-15T19:41:26Z

Todo:

Add RBR reason test cases in DebugUtilsTest.ts
Add screenshots
Add QA testing steps

…o-lhn-debugging # Conflicts: # src/libs/DebugUtils.ts # src/libs/SidebarUtils.ts # src/pages/Debug/Report/DebugReportPage.tsx # tests/unit/DebugUtilsTest.ts

pac-guerreiro · 2024-10-16T22:46:23Z

Today's update:

Add RBR reason test cases in DebugUtilsTest.ts

Todo:

Fix unit test for when there are transaction thread violations
Add screenshots
Add QA testing steps

…o-lhn-debugging

melvin-bot · 2024-10-17T15:00:21Z

@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-17T15:00:52Z

The PR is now ready for review! 😄

Go ahead @DylanDylann

pac-guerreiro · 2024-10-17T16:51:30Z

I just requested confirmation for the translations in expensify-open-source

…o-lhn-debugging # Conflicts: # tests/unit/DebugUtilsTest.ts

…o-lhn-debugging

src/languages/en.ts

DylanDylann · 2024-10-18T08:12:08Z

Discover an error log on Android and IOS app when going to debug report page

Screen.Recording.2024-10-18.at.15.10.41.mov

It is caused by using 2 scrollView on DebugReportPage

…o-lhn-debugging

pac-guerreiro · 2024-10-18T10:00:02Z

@DylanDylann I applied your suggestions to the translations and I fixed the VirtualizedLists issue 😄

DylanDylann · 2024-10-18T10:44:24Z

@pac-guerreiro Please ping me when you update Jest UTs

pac-guerreiro · 2024-10-18T10:58:33Z

@DylanDylann I just fixed the unit tests that were failing 😄

DylanDylann · 2024-10-18T11:23:47Z

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-18.at.15.08.39.mov

Android: mWeb Chrome

Screen.Recording.2024-10-18.at.15.03.59.mov

iOS: Native

Screen.Recording.2024-10-18.at.15.06.04.mov

iOS: mWeb Safari

Screen.Recording.2024-10-18.at.15.04.34.mov

MacOS: Chrome / Safari

Screen.Recording.2024-10-18.at.15.05.22.mov

MacOS: Desktop

Screen.Recording.2024-10-18.at.15.02.42.mov

DylanDylann · 2024-10-18T11:25:52Z

src/pages/Debug/Report/DebugReportActions.tsx

-            style={styles.mt5}
-            contentContainerStyle={styles.pb5}
-        >
+        <View style={[styles.mv5, styles.flex1]}>


NAB: But we have a point on the checklist

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

Here, we use Flatlist instead of ScrollView. But I think It still make sense

@DylanDylann Thanks for pointing this out! I just applied added ScrollView again and disabled scroll on the FlatList and the problem is gone 😄

Let me know if you like this solution!

puneetlath

Looks good to me. Thanks for adding the tests. Just one question about the TODO comment.

puneetlath · 2024-10-18T14:38:30Z

tests/unit/DebugUtilsTest.ts

+                    ) ?? {};
+                expect(reportAction).toBeUndefined();
+            });
+            // TODO: remove '.failing' once the implementation is fixed


What does this mean?

@puneetlath Sorry, I missed this while resolving a merge conflict with main 😅 I just reverted this change so it matches what we currently have on main!

…o-lhn-debugging

pac-guerreiro · 2024-10-19T01:01:54Z

All feedback from @puneetlath @DylanDylann were applied 😄

I also applied the changes requested by @Gonals to the spanish translations, thank you 🙌

(Sorry for the late update but I had to travel between places)

DylanDylann

@puneetlath All yours

puneetlath · 2024-10-21T14:27:55Z

Approved, but there are conflicts @pac-guerreiro

…o-lhn-debugging # Conflicts: # src/languages/en.ts # src/languages/es.ts

pac-guerreiro · 2024-10-21T15:50:56Z

@puneetlath conflicts resolved 😄

OSBotify · 2024-10-21T16:35:30Z

✋ 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-22T04:48:33Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 9.0.52-0 🚀

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

github-actions · 2024-10-23T16:26:00Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.52-5 🚀

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

feat(debug mode): add RBR reason to LHN debugging

6819a11

pac-guerreiro changed the title ~~Add RBR reason to LHN debugging~~ [WIP] Add RBR reason to LHN debugging Oct 15, 2024

pac-guerreiro added 2 commits October 16, 2024 20:36

Merge branch 'main' into pac-guerreiro/feature/50665-add-rbr-reason-t…

69181c7

…o-lhn-debugging # Conflicts: # src/libs/DebugUtils.ts # src/libs/SidebarUtils.ts # src/pages/Debug/Report/DebugReportPage.tsx # tests/unit/DebugUtilsTest.ts

chore(debug mode): add RBR reason unit tests

fd8cdec

pac-guerreiro added 2 commits October 17, 2024 12:49

fix(debug mode): RBR reason unit test for transaction thread violations

e9d9106

Merge branch 'main' into pac-guerreiro/feature/50665-add-rbr-reason-t…

3e3adfe

…o-lhn-debugging

This was referenced Oct 17, 2024

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

Merged

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

Closed

pac-guerreiro added 2 commits October 17, 2024 13:05

fix(debug mode): hasRBR not showing in visible in LHN

d47ed26

chore: fix eslint issues

03579b9

pac-guerreiro marked this pull request as ready for review October 17, 2024 15:00

pac-guerreiro requested a review from a team as a code owner October 17, 2024 15:00

melvin-bot bot requested review from DylanDylann and removed request for a team October 17, 2024 15:00

pac-guerreiro changed the title ~~[WIP] Add RBR reason to LHN debugging~~ Add RBR reason to LHN debugging Oct 17, 2024

mountiny assigned pac-guerreiro Oct 17, 2024

pac-guerreiro added 2 commits October 17, 2024 19:00

Merge branch 'main' into pac-guerreiro/feature/50665-add-rbr-reason-t…

5a7f97f

…o-lhn-debugging # Conflicts: # tests/unit/DebugUtilsTest.ts

Merge branch 'main' into pac-guerreiro/feature/50665-add-rbr-reason-t…

77be888

…o-lhn-debugging

DylanDylann reviewed Oct 18, 2024

View reviewed changes

src/languages/en.ts Outdated Show resolved Hide resolved

pac-guerreiro added 3 commits October 18, 2024 09:36

chore(debug mode): update translation for has errors

1066c8d

fix: VirtualizedLists should never be nested inside plain ScrollViews

7d137ab

Merge branch 'main' into pac-guerreiro/feature/50665-add-rbr-reason-t…

6934949

…o-lhn-debugging

DylanDylann approved these changes Oct 18, 2024

View reviewed changes

melvin-bot bot requested a review from puneetlath October 18, 2024 11:25

puneetlath reviewed Oct 18, 2024

View reviewed changes

pac-guerreiro added 3 commits October 19, 2024 01:45

Merge branch 'main' into pac-guerreiro/feature/50665-add-rbr-reason-t…

2d3aaee

…o-lhn-debugging

chore: revert merge conflict resolution

2462c82

refactor: apply suggestion

99e4d9d

fix(debug mode): spanish translation for violation related errors

eba07b6

DylanDylann approved these changes Oct 21, 2024

View reviewed changes

melvin-bot bot requested a review from puneetlath October 21, 2024 03:46

puneetlath previously approved these changes Oct 21, 2024

View reviewed changes

Merge branch 'main' into pac-guerreiro/feature/50665-add-rbr-reason-t…

d740283

…o-lhn-debugging # Conflicts: # src/languages/en.ts # src/languages/es.ts

pac-guerreiro dismissed puneetlath’s stale review via d740283 October 21, 2024 15:50

puneetlath previously approved these changes Oct 21, 2024

View reviewed changes

chore: fix eslint issues

22019b3

pac-guerreiro dismissed puneetlath’s stale review via 22019b3 October 21, 2024 15:52

pac-guerreiro requested a review from puneetlath October 21, 2024 16:09

puneetlath approved these changes Oct 21, 2024

View reviewed changes

puneetlath merged commit 23ea36a into Expensify:main Oct 21, 2024

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

Deploy Checklist: New Expensify 2024-10-22 #51219

Closed

74 tasks

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

[HOLD for payment 2024-10-30] Add RBR reason to LHN debugging #50665

Closed

DylanDylann mentioned this pull request Oct 29, 2024

[HOLD for payment 2024-10-24] [HOLD for payment 2024-10-16] Add LHN debugging to Debug Mode #46992

Closed

arosiclair mentioned this pull request Dec 31, 2024

[HOLD for payment 2025-01-22] [$250] LHN - RBR is missing from the report when it fails to export to QBO #53924

Closed

8 tasks

Conversation

pac-guerreiro commented Oct 15, 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!

pac-guerreiro commented Oct 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pac-guerreiro commented Oct 16, 2024

Uh oh!

melvin-bot bot commented Oct 17, 2024

Uh oh!

pac-guerreiro commented Oct 17, 2024

Uh oh!

pac-guerreiro commented Oct 17, 2024

Uh oh!

Uh oh!

DylanDylann commented Oct 18, 2024

Uh oh!

pac-guerreiro commented Oct 18, 2024

Uh oh!

DylanDylann commented Oct 18, 2024

Uh oh!

pac-guerreiro commented Oct 18, 2024

Uh oh!

DylanDylann commented Oct 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

DylanDylann Oct 18, 2024

Choose a reason for hiding this comment

Uh oh!

pac-guerreiro Oct 19, 2024

Choose a reason for hiding this comment

Uh oh!

puneetlath left a comment

Choose a reason for hiding this comment

Uh oh!

puneetlath Oct 18, 2024

Choose a reason for hiding this comment

Uh oh!

pac-guerreiro Oct 19, 2024

Choose a reason for hiding this comment

Uh oh!

pac-guerreiro commented Oct 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DylanDylann left a comment

Choose a reason for hiding this comment

Uh oh!

puneetlath commented Oct 21, 2024

Uh oh!

pac-guerreiro commented Oct 21, 2024

Uh oh!

OSBotify commented Oct 21, 2024

Uh oh!

github-actions bot commented Oct 22, 2024

Uh oh!

github-actions bot commented Oct 23, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

pac-guerreiro commented Oct 15, 2024 •

edited

Loading

pac-guerreiro commented Oct 15, 2024 •

edited

Loading

DylanDylann commented Oct 18, 2024 •

edited

Loading

pac-guerreiro commented Oct 19, 2024 •

edited

Loading