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

[puneetlath]

We are adding a debug mode to the App here: #45481

What I would really love from the Debug Mode is something that tells me why a given report is in the LHN. So if I'm seeing a report in the LHN, why is it there? And similarly if it has an RBR/GBR, what is causing that to be there?
This might be more useful in Focus Mode than in Most Recent, but I think it would help with a lot of the recent issues we've been troubleshooting.

cc @pac-guerreiro

Issue Owner

Current Issue Owner: @puneetlath

[melvin-bot]

Current assignee @puneetlath is eligible for the NewFeature assigner, not assigning anyone new.

[melvin-bot]

⚠️ It looks like this issue is labelled as a New Feature but not tied to any GitHub Project. Keep in mind that all new features should be tied to GitHub Projects in order to properly track external CAP software time ⚠️

[melvin-bot]

Triggered auto assignment to Design team member for new feature review - @shawnborton (NewFeature)

[pac-guerreiro]

Hi! I’m Pedro Guerreiro from Callstack - expert contributor group. I’d like to work on this task!

[puneetlath]

Still waiting for the first PR to get merged.

[DylanDylann]

yeah, I will try to complete check list today

[puneetlath]

Still waiting for the first PR to get merged.

[puneetlath]

Still waiting for the first PR to get merged.

[puneetlath]

Still waiting for the first PR to get merged.

[blimpich]

@puneetlath can you respond to this comment on the PR?

[fabioh8010]

Update: PR is being reviewed by C+, should be completed before next week.

[blimpich]

Assigning @DylanDylann since they are reviewing the PR

[pac-guerreiro]

@puneetlath @DylanDylann

Here is the PR that adds the debug option to LHN context menu - #50519 😄

[DylanDylann]

@pac-guerreiro Currently, we don't display the reason why RBR is displayed. But let's see logic to display RBR on LHN

App/src/libs/SidebarUtils.ts

Lines 237 to 255 in 12e41b1

	function shouldShowRedBrickRoad(report: Report, reportActions: OnyxEntry<ReportActions>, hasViolations: boolean, transactionViolations?: OnyxCollection<TransactionViolation[]>) {
	const hasErrors = Object.keys(OptionsListUtils.getAllReportErrors(report, reportActions)).length !== 0;
	const oneTransactionThreadReportID = ReportActionsUtils.getOneTransactionThreadReportID(report.reportID, ReportActionsUtils.getAllReportActions(report.reportID));
	if (oneTransactionThreadReportID) {
	const oneTransactionThreadReport = ReportUtils.getReport(oneTransactionThreadReportID);
	if (
	ReportUtils.shouldDisplayTransactionThreadViolations(
	oneTransactionThreadReport,
	transactionViolations,
	ReportActionsUtils.getAllReportActions(report.reportID)[oneTransactionThreadReport?.parentReportActionID ?? '-1'],
	)
	) {
	return true;
	}
	}
	return hasErrors || hasViolations;

We have three cases where the RBR is displayed on LHN

• shouldDisplayTransactionThreadViolations return true
• hasErrors (errors come from report or reportActions. Usually, this will be returned from BE)
• hasViolations

We need to design three reason messages for each case

[puneetlath]

Yes, let's add that. I think it would be very helpful for diagnosing why RBRs are showing.

[pac-guerreiro]

@puneetlath can you create a new issue for me to implement this? 😄

[puneetlath]

Yep. Here you go: #50665

[pac-guerreiro]

Thanks @puneetlath, that was fast 😄

[melvin-bot]

Payment Summary

Upwork Job

• Contributor: @pac-guerreiro is from an agency-contributor and not due payment
• ROLE: @DylanDylann paid $(AMOUNT) via Upwork (LINK)

BugZero Checklist (@puneetlath)

• I have verified the correct assignees and roles are listed above and updated the neccesary manual offers
• I have verified that there are no duplicate or incorrect contracts on Upwork for this job (https://www.upwork.com/ab/applicants//hired)
• I have paid out the Upwork contracts or cancelled the ones that are incorrect
• I have verified the payment summary above is correct

[puneetlath]

@DylanDylann are we all done here?

[melvin-bot]

Reviewing label has been removed, please complete the "BugZero Checklist".

[melvin-bot]

The solution for this issue has been 🚀 deployed to production 🚀 in version 9.0.49-2 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• Add debug option to LHN context menu #50519

If no regressions arise, payment will be issued on 2024-10-24. 🎊

For reference, here are some details about the assignees on this issue:

• @pac-guerreiro does not require payment (Contractor)
• @DylanDylann requires payment (Needs manual offer from BZ)

[melvin-bot]

BugZero Checklist: The PR adding this new feature has been merged! The following checklist (instructions) will need to be completed before the issue can be closed:

• [@DylanDylann] Please propose regression test steps to ensure the new feature will work correctly on production in further releases.
• [@puneetlath] Link the GH issue for creating/updating the regression test once above steps have been agreed upon.

[DylanDylann]

@puneetlath Do we require the regression test on debug feature issues?

[puneetlath]

Yes please. We rely on these features quite a bit, so it'd be good to have some regression testing to make sure we don't break them accidentally. Otherwise we won't realize they are broken until we need them to help us debug something.

[DylanDylann]

BugZero Checklist: The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed:

[@DylanDylann] The PR that introduced the bug has been identified. Link to the PR: NA
[@DylanDylann] The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. Link to comment: NA
[@DylanDylann] A discussion in #expensify-bugs has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion: NA
[@DylanDylann] Determine if we should create a regression test for this bug. Yes
[@DylanDylann] If we decide to create a regression test for the bug, please propose the regression test steps to ensure the same bug will not reach production again.

Regression Test Proposal

0. Enable the Debug feature
1. On the home page, open a chat report from LHN
2. Click on the header of the chat you just opened, then click on Debug
3. On the Details tab, confirm that "Visible in LHN" provides the correct reason for the report to be shown on LHN
4. Confirm that "GBR" shows the correct reason, if the report has GBR in LHN
5. Confirm that "RBR" shows the correct reason, if the report has RBR in LHN

Do we agree 👍 or 👎

[melvin-bot]

Payment Summary

Upwork Job

• Contributor: @pac-guerreiro is from an agency-contributor and not due payment
• ROLE: @DylanDylann paid $(AMOUNT) via Upwork (LINK)

BugZero Checklist (@puneetlath)

• I have verified the correct assignees and roles are listed above and updated the neccesary manual offers
• I have verified that there are no duplicate or incorrect contracts on Upwork for this job (https://www.upwork.com/ab/applicants//hired)
• I have paid out the Upwork contracts or cancelled the ones that are incorrect
• I have verified the payment summary above is correct

[puneetlath]

@DylanDylann were there multiple PRs for this one?