fix: Inbox showing GBR when there’s a report with RBR by truph01 · Pull Request #51643 · Expensify/App

truph01 · 2024-10-29T10:49:36Z

Details

Fixed Issues

$ #50927
PROPOSAL: #50927 (comment)

Tests

Make sure there is at least a report with RBR
Select a report which hasn’t a RBR indicator
Go to Troubleshoot, then click on Clear cache and restart
Verify the inbox tab has RBR

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-10-29.at.17.59.03.mov

Android: mWeb Chrome

Screen.Recording.2024-10-29.at.18.08.24.mov

iOS: Native

iOS: mWeb Safari

Screen.Recording.2024-10-29.at.18.01.03.mov

MacOS: Chrome / Safari

Screen.Recording.2024-10-29.at.17.54.29.mov

MacOS: Desktop

Screen.Recording.2024-10-29.at.17.57.01.mov

melvin-bot · 2024-10-29T11:10:30Z

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

truph01 · 2024-10-29T11:12:02Z

@mkhutornyi I encountered an error when running IOS native:

I will test and update the IOS native video when it is fixed.

mkhutornyi · 2024-10-29T20:21:23Z

@@ -62,6 +62,14 @@ const getBrickRoadForPolicy = (report: Report, altReportActions?: OnyxCollection
    const reportErrors = ReportUtils.getAllReportErrors(report, reportActions);
    const oneTransactionThreadReportID = ReportActionsUtils.getOneTransactionThreadReportID(report.reportID, reportActions);
    let doesReportContainErrors = Object.keys(reportErrors ?? {}).length !== 0 ? CONST.BRICK_ROAD_INDICATOR_STATUS.ERROR : undefined;


add line break

mkhutornyi · 2024-10-29T20:22:15Z

+    const parentReportActions = (altReportActions ?? allReportActions)?.[`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${report?.parentReportID}`];
+    const parentReportAction = parentReportActions?.[report?.parentReportActionID ?? '-1'];
+    const shouldDisplayViolations = ReportUtils.shouldDisplayTransactionThreadViolations(report, allTransactionViolations, parentReportAction);
+    const shouldDisplayReportViolations = ReportUtils.isReportOwner(report) && ReportUtils.hasReportViolations(report.reportID);
+    const hasViolations = shouldDisplayViolations || shouldDisplayReportViolations;
+    if (hasViolations) {
+        doesReportContainErrors = CONST.BRICK_ROAD_INDICATOR_STATUS.ERROR;
+    }


put this whole code inside if (!doesReportContainErrors) { }

(just for optimization)

mkhutornyi · 2024-10-29T20:29:47Z

+        doesReportContainErrors = CONST.BRICK_ROAD_INDICATOR_STATUS.ERROR;
+    }

    if (oneTransactionThreadReportID) {


Same here

Suggested change

if (oneTransactionThreadReportID) {

if (oneTransactionThreadReportID && !doesReportContainErrors)

mkhutornyi · 2024-10-31T05:07:08Z

+    const parentReportActions = (altReportActions ?? allReportActions)?.[`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${report?.parentReportID}`];
+    const parentReportAction = parentReportActions?.[report?.parentReportActionID ?? '-1'];
+    const shouldDisplayViolations = ReportUtils.shouldDisplayTransactionThreadViolations(report, allTransactionViolations, parentReportAction);
+    const shouldDisplayReportViolations = ReportUtils.isReportOwner(report) && ReportUtils.hasReportViolations(report.reportID);
+    const hasViolations = shouldDisplayViolations || shouldDisplayReportViolations;
+    if (hasViolations && !doesReportContainErrors) {
+        doesReportContainErrors = CONST.BRICK_ROAD_INDICATOR_STATUS.ERROR;
+    }


Suggested change

const parentReportActions = (altReportActions ?? allReportActions)?.[`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${report?.parentReportID}`];

const parentReportAction = parentReportActions?.[report?.parentReportActionID ?? '-1'];

const shouldDisplayViolations = ReportUtils.shouldDisplayTransactionThreadViolations(report, allTransactionViolations, parentReportAction);

const shouldDisplayReportViolations = ReportUtils.isReportOwner(report) && ReportUtils.hasReportViolations(report.reportID);

const hasViolations = shouldDisplayViolations || shouldDisplayReportViolations;

if (hasViolations && !doesReportContainErrors) {

doesReportContainErrors = CONST.BRICK_ROAD_INDICATOR_STATUS.ERROR;

}

if (!doesReportContainErrors) {

const parentReportActions = (altReportActions ?? allReportActions)?.[`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${report?.parentReportID}`];

const parentReportAction = parentReportActions?.[report?.parentReportActionID ?? '-1'];

const shouldDisplayViolations = ReportUtils.shouldDisplayTransactionThreadViolations(report, allTransactionViolations, parentReportAction);

const shouldDisplayReportViolations = ReportUtils.isReportOwner(report) && ReportUtils.hasReportViolations(report.reportID);

const hasViolations = shouldDisplayViolations || shouldDisplayReportViolations;

if (hasViolations) {

doesReportContainErrors = CONST.BRICK_ROAD_INDICATOR_STATUS.ERROR;

}

}

mkhutornyi · 2024-10-31T05:25:42Z

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

before:

after:

MacOS: Desktop

mkhutornyi · 2024-11-04T05:55:52Z

@truph01 bump #51643 (comment)

mkhutornyi

@tgolen all yours

tgolen

Can you please add a unit test that confirms the bug is fixed and won't come back?

truph01 · 2024-11-05T22:20:18Z

@tgolen I added unit test

tgolen

Thanks for adding the test! Can you please follow the conventions here for the given/when/then comment format? https://github.com/Expensify/App/blob/main/tests/README.md#documenting-tests

Also, I'm not really seeing other tests do this, but it might be nice to move the hard-coded JSON to it's own file called tests/unit/WorkspaceSettingsUtilsTest.json

tgolen · 2024-11-05T23:08:40Z

Also, if you're not used to writing those comments, here is a tip. The best comment is one that explains "why" the logic is doing what it's doing. Many times, comments merely state "what" the logic is doing, which is almost always self-evident.

tgolen · 2024-11-07T16:28:10Z

+            // When calling getBrickRoadForPolicy with a report and report actions
+            const result = getBrickRoadForPolicy(report as Report, reportActions as OnyxCollection<ReportActions>);
+
+            // Then the result should be 'error'


Why is the result error in this case? What is it about the report and report actions that produce this result?

I added 2nd test case, which will return undefined. The getBrickRoadForPolicy return error or undefined based on the transactionsViolation data.

Thanks for the second test case. I still don't think I know the answer to my question though. Can you please update this code comment to explain why it's expected to be "error" and not anything else? Again, what is it about the report and report actions that produce this result?

@truph01 bump on this one. I'm still looking for some more contextual code comments for this.

Apologies, I missed that earlier. I've updated the comment. Let's aim to get this PR merged today.

tgolen · 2024-11-08T15:59:23Z

+            // When calling getBrickRoadForPolicy with a report and report actions
+            const result = getBrickRoadForPolicy(report as Report, reportActions as OnyxCollection<ReportActions>);
+
+            // Then the result should be 'error'


Thanks for the second test case. I still don't think I know the answer to my question though. Can you please update this code comment to explain why it's expected to be "error" and not anything else? Again, what is it about the report and report actions that produce this result?

muttmuure · 2024-11-11T11:51:06Z

@truph01 are you working on these changes today?

truph01 · 2024-11-11T11:52:56Z

are you working on these changes today?

@muttmuure I resolved all the comments. In case you miss it: #51643 (comment)

truph01 · 2024-11-12T09:49:56Z

@tgolen The PR is ready for the final review

tgolen

Ah, that's perfect. Thank you!

OSBotify · 2024-11-12T17:31:33Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

mvtglobally · 2024-11-13T00:47:44Z

@tgolen @truph01 QA steps are not populated. Are we ok to use Test steps or there are any additional validations needed

github-actions · 2024-11-13T01:08:40Z

🚀 Deployed to staging by https://github.com/tgolen in version: 9.0.61-0 🚀

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

tgolen · 2024-11-13T16:26:57Z

@mvtglobally thanks for checking! It looks like running the "test steps" will work in this case, so please do those.

github-actions · 2024-11-14T00:39:58Z

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.61-3 🚀

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

fix: Inbox showing GBR when there’s a report with RBR

87f6644

truph01 marked this pull request as ready for review October 29, 2024 11:10

truph01 requested a review from a team as a code owner October 29, 2024 11:10

melvin-bot Bot requested a review from mkhutornyi October 29, 2024 11:10

melvin-bot Bot removed the request for review from a team October 29, 2024 11:10

mkhutornyi suggested changes Oct 29, 2024

View reviewed changes

truph01 added 2 commits October 31, 2024 09:15

merge main

850f5ab

fix: optimize code

6d00a65

mkhutornyi reviewed Oct 31, 2024

View reviewed changes

truph01 added 3 commits November 4, 2024 13:41

merge main

bba3e08

fix: refactor code

bbbe5aa

fix: lint

462c52f

mkhutornyi approved these changes Nov 4, 2024

View reviewed changes

tgolen requested changes Nov 4, 2024

View reviewed changes

truph01 added 6 commits November 5, 2024 17:44

merge main

c45ade8

fix: add test

f20b84f

fix: lint

a708691

fix: unit test

85d684f

fix: lint

0f9e3df

fix: lint

976c78f

tgolen requested changes Nov 5, 2024

View reviewed changes

truph01 added 2 commits November 7, 2024 09:46

fix: add comment to test and create json file

e156dca

fix: prettier

e82e777

tgolen requested changes Nov 7, 2024

View reviewed changes

truph01 added 3 commits November 8, 2024 16:28

fix: remove unused data in json

8d0da00

fix: add 2nd test case

d42e264

fix: lint

ef77bb9

tgolen requested changes Nov 8, 2024

View reviewed changes

fix: update comment

bd9c7ac

fix: add detailed comments in test

16b9d4e

tgolen approved these changes Nov 12, 2024

View reviewed changes

tgolen merged commit 1fdc8a7 into Expensify:main Nov 12, 2024

github-actions Bot mentioned this pull request Nov 13, 2024

Deploy Checklist: New Expensify 2024-11-13 #52440

Closed

41 tasks

melvin-bot Bot mentioned this pull request Nov 14, 2024

[HOLD for payment 2024-11-21] [$250] Inbox showing GBR when there’s a report with RBR #50927

Closed

8 tasks

	if (oneTransactionThreadReportID) {
	if (oneTransactionThreadReportID && !doesReportContainErrors)

Uh oh!

Conversation

truph01 commented Oct 29, 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 Oct 29, 2024

Uh oh!

truph01 commented Oct 29, 2024

Uh oh!

mkhutornyi Oct 29, 2024

Choose a reason for hiding this comment

Uh oh!

mkhutornyi Oct 29, 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!

mkhutornyi Oct 29, 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!

mkhutornyi Oct 31, 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!

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

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

mkhutornyi commented Nov 4, 2024

Uh oh!

mkhutornyi left a comment

Choose a reason for hiding this comment

Uh oh!

tgolen left a comment

Choose a reason for hiding this comment

Uh oh!

truph01 commented Nov 5, 2024

Uh oh!

tgolen left a comment • 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!

tgolen commented Nov 5, 2024

Uh oh!

tgolen Nov 7, 2024

Choose a reason for hiding this comment

Uh oh!

truph01 Nov 8, 2024

Choose a reason for hiding this comment

Uh oh!

tgolen Nov 8, 2024

Choose a reason for hiding this comment

Uh oh!

tgolen Nov 11, 2024

Choose a reason for hiding this comment

Uh oh!

truph01 Nov 12, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tgolen Nov 8, 2024

Choose a reason for hiding this comment

Uh oh!

muttmuure commented Nov 11, 2024

Uh oh!

truph01 commented Nov 11, 2024

Uh oh!

truph01 commented Nov 12, 2024

Uh oh!

tgolen left a comment

truph01 commented Oct 29, 2024 •

edited

Loading

mkhutornyi Oct 29, 2024 •

edited

Loading

mkhutornyi Oct 29, 2024 •

edited

Loading

mkhutornyi Oct 31, 2024 •

edited

Loading

mkhutornyi commented Oct 31, 2024 •

edited

Loading

tgolen left a comment •

edited

Loading