[HOLD for payment 2024-07-24] Filter out payroll and bill reports from the client

[puneetlath]

If a report has the report type type: paycheck or type: bill we should filter it out in the NewDot inbox. It shouldn't show up in the LHN even if it has unread messages or error messages. It just shouldn't ever show up there.

You won't be able to test this with real data as reports of type:paycheck isn't currently a publicly accessible feature.

Issue Owner

Current Issue Owner: @puneetlath

[melvin-bot]

Triggered auto assignment to Contributor-plus team member for initial proposal review - @sobitneupane (External)

[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 - @dubielzyk-expensify (NewFeature)

[cretadn22]

Proposal

Please re-state the problem that we are trying to solve in this issue.

Filter out payroll reports

What is the root cause of that problem?

New feature

What changes do you think we should make in order to solve the problem?

In the shouldReportBeInOptionList function, we need to include a condition to filter reports that has type: paycheck

 if (report.type === "paycheck") {
        return false;
    }

What alternative solutions did you explore? (Optional)

[ShridharGoel]

Proposal

Please re-state the problem that we are trying to solve in this issue.

Filter out payroll reports from the client.

What is the root cause of that problem?

New change.

What changes do you think we should make in order to solve the problem?

We need to update getOrderedReportIDs in SidebarUtils to include the below check after this:

if (ReportUtils.isPaycheck(report) || ReportUtils.isBill(report)) {
    return;
}

We'll add the isPaycheck method in ReportUtils:

function isPaycheck(report: OnyxEntry<Report>): boolean {
    return report?.type === 'paycheck';
}

We'll add the isBill method in ReportUtils:

function isBill(report: OnyxEntry<Report>): boolean {
    return report?.type === 'bill';
}

[nkdengineer]

Proposal

Please re-state the problem that we are trying to solve in this issue.

Filter out payroll reports from the client

What is the root cause of that problem?

This is a new feature

What changes do you think we should make in order to solve the problem?

1. Create a util to check the type of report

function isPayCheckReport(report: OnyxInputOrEntry<Report>): boolean {
    return report?.type === 'paycheck';
}

function isBillReport(report: OnyxInputOrEntry<Report>): boolean {
    return report?.type === 'bill';
}

2. To not show the report in LHN and display the not found page if we access this report via deeplink, we can update the canAccessReport function to return false if the report is paycheck report. This function is used in shouldReportBeInOptionList‎ function here to not show the report in LHN and used in the ReportScreen here to show the not found page.

if (isPayCheckReport(report) || isBillReport(report)) {
    return false;
}

App/src/libs/ReportUtils.ts

Line 5307 in c973e62

function canAccessReport(report: OnyxEntry<Report>, policies: OnyxCollection<Policy>, betas: OnyxEntry<Beta[]>): boolean {

OPTIONAL: We can also create a beta for the paycheck report or bill report as we do for the default room

App/src/libs/ReportUtils.ts

Lines 5309 to 5311 in c973e62

	if (isDefaultRoom(report) && !canSeeDefaultRoom(report, policies, betas)) {
	return false;
	}

What alternative solutions did you explore? (Optional)

NA

[puneetlath]

FYI, I updated the OP to include reports of type: bill but I think the solution should be the same.

[ShridharGoel]

Proposal

Updated to include bill check.

[nkdengineer]

Updated proposal #45104 (comment)

[rayane-djouah]

Taking over as C+ (https://expensify.slack.com/archives/C02NK2DQWUX/p1720624712448849)

[rayane-djouah]

@cretadn22's proposal looks good to me. we can address refactors on the PR stage (include reports of type: bill and create isPaycheck and isBillReport utility functions), I don't think we need a beta for this though.

🎀👀🎀 C+ reviewed

[melvin-bot]

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

[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.7-8 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• Filter out paycheck report on LHN #45186

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

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

• @rayane-djouah requires payment (Needs manual offer from BZ)
• @cretadn22 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:

• [@rayane-djouah] 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.

[puneetlath]

@cretadn22 bump. Any thoughts on this?

[cretadn22]

In your case

App/src/libs/SidebarUtils.ts

Lines 100 to 105 in c973e62

	if (hasErrorsOtherThanFailedReceipt) {
	reportsToDisplay.push({
	...report,
	hasErrorsOtherThanFailedReceipt: true,
	});
	return;

I think hasErrorsOtherThanFailedReceipt is true, the report is included in reportsToDisplay. And, we also skip ReportUtils.shouldReportBeInOptionList checking

[cretadn22]

The PR will be up soon

[melvin-bot]

Payment Summary

Upwork Job

• ROLE: @rayane-djouah paid $(AMOUNT) via Upwork (LINK)
• ROLE: @cretadn22 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]

@rayane-djouah @cretadn22 can you link me your Upwork profiles so that I can send you an offer?

[rayane-djouah]

https://www.upwork.com/freelancers/~01af33a55f4988a74b

[rayane-djouah]

• Please propose regression test steps to ensure the new feature will work correctly on production in further releases.

No regression tests are needed as we included automated tests

[puneetlath]

@rayane-djouah offer: https://www.upwork.com/nx/wm/offer/103254979

Please ping me when you've accepted.

[rayane-djouah]

@puneetlath - Accepted, Thanks!

[puneetlath]

Ok @rayane-djouah has been paid.

Just waiting on the Upwork profile for @cretadn22 now.

[cretadn22]

@puneetlath My Upwork
https://www.upwork.com/freelancers/~01af96c76db71b99d9

[puneetlath]

@cretadn22 sent you an offer here: https://www.upwork.com/nx/wm/offer/103263505

Please ping me on this issue when you've accepted.

[cretadn22]

@puneetlath I accepted your offer

[puneetlath]

Ok all paid now. Thanks everyone!