[HOLD for payment 2024-07-10] [$250] "Expense" is showing as a "new comment" when opening the one expense report for the first time

[m-natarajan]

If you haven’t already, check out our contributing guidelines for onboarding and email [email protected] to request to join our Slack channel!

---

Version Number: 1.4.74-4
Reproducible in staging?: y
Reproducible in production?: y
If this was caught during regression testing, add the test name, ID and link from TestRail:
Email or phone of affected tester (no customers):
Logs: https://stackoverflow.com/c/expensify/questions/4856
Expensify/Expensify Issue URL:
Issue reported by: @puneetlath
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1716320170918369

Action Performed:

1. Submit a expense report with one expense as an employee
2. Sign in as a approver of the expense report (shouldn't be signed in before so that you don't have the expense report or transaction thread locally)
3. Throttle network connection to slow 3G, so that OpenReport takes a little bit to return
4. Click on the expense report to view the details

Expected Result:

Should not see a green New line like a comment

Actual Result:

"Expense" is showing as a "new comment" with greenline

Workaround:

unknown

Platforms:

Which of our officially supported platforms is this issue occurring on?

• Android: Native
• Android: mWeb Chrome
• iOS: Native
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

Add any screenshot/video evidence

Recording.102.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~011a3e7a662efa0b69
• Upwork Job ID: 1794039154450477056
• Last Price Increase: 2024-06-07
• Automatic offers:
• nkdengineer | Contributor | 102691860

Issue Owner

Current Issue Owner: @zanyrenney / @zanyrenney

[melvin-bot]

Triggered auto assignment to @zanyrenney (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details. Please add this bug to a GH project, as outlined in the SO.

[nkdengineer]

Proposal

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

"Expense" is showing as a "new comment" with greenline

What is the root cause of that problem?

Before OpenReport API of the expenseReport is called, transaction thread report actions is empty

App/src/pages/home/report/ReportActionsView.tsx

Lines 152 to 153 in aa9bbcf

	() => ReportActionsUtils.getCombinedReportActions(allReportActions, transactionThreadReportActions),
	[allReportActions, transactionThreadReportActions],

and then we return all report actions of the expense report which contains the IOU action here

App/src/libs/ReportActionsUtils.ts

Lines 313 to 315 in aa9bbcf

	if (isEmptyObject(transactionThreadReportActions)) {
	return reportActions;
	}

So this action is displayed as a action in combine report

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

1. I see that the logic to calculate reportActionsToDisplay is added in this PR Display total and money request in offline #36657. As this comment, the aim of this to generate created action for money request report if it doesn't exist so I think we should use allReportActions which are all report actions of current report to calculate reportActionsToDisplay firstly and then we will use this to get the combine report actions here. So we should move this block here to before this block and use allReportActions instead of reportActions

App/src/pages/home/report/ReportActionsView.tsx

Lines 480 to 485 in aa9bbcf

	// When we are offline before opening an IOU/Expense report,
	// the total of the report and sometimes the expense aren't displayed because these actions aren't returned until `OpenReport` API is complete.
	// We generate a fake created action here if it doesn't exist to display the total whenever possible because the total just depends on report data
	// and we also generate an expense action if the number of expenses in reportActions is less than the total number of expenses
	// to display at least one expense action to match the total data.
	const reportActionsToDisplay = useMemo(() => {

2. We should add an extra param in getCombinedReportActions like isCombineReport and then we only return reportActions if transactionThreadReportActions is empty and the report isn't a combine report

if (isEmptyObject(transactionThreadReportActions) && !isCombineReport) {
    return reportActions;
}

App/src/libs/ReportActionsUtils.ts

Lines 313 to 315 in aa9bbcf

	if (isEmptyObject(transactionThreadReportActions)) {
	return reportActions;
	}

3. Pass !!transactionThreadReportID as isCombineReport param into getCombinedReportActions function

const combinedReportActions = useMemo(
    () => ReportActionsUtils.getCombinedReportActions(reportActionsToDisplay, transactionThreadReportActions, !!transactionThreadReportID),
    [reportActionsToDisplay, transactionThreadReportActions, transactionThreadReportID],
);

App/src/pages/home/report/ReportActionsView.tsx

Lines 152 to 153 in aa9bbcf

	() => ReportActionsUtils.getCombinedReportActions(allReportActions, transactionThreadReportActions),
	[allReportActions, transactionThreadReportActions],

4. Finally, pass sortedReportActions={reportActions} here instead of reportActionsToDisplay

App/src/pages/home/report/ReportActionsView.tsx

Line 554 in aa9bbcf

sortedReportActions={reportActionsToDisplay}

What alternative solutions did you explore? (Optional)

NA

[zanyrenney]

Adding the external label - looks like NK engineer already has a proposal.

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~011a3e7a662efa0b69

[melvin-bot]

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

[zanyrenney]

hey there @mollfpr - please can you review the proposal from @nkdengineer above! thanks!

[melvin-bot]

Triggered auto assignment to @zanyrenney (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details. Please add this bug to a GH project, as outlined in the SO.

[melvin-bot]

Triggered auto assignment to @lschurr (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details. Please add this bug to a GH project, as outlined in the SO.

[zanyrenney]

Hey there! I am going OOO until the 9th of June. Please can you handle this and I will take it back once I return? Thanks!

[melvin-bot]

@mollfpr, @lschurr, @zanyrenney Whoops! This issue is 2 days overdue. Let's get this updated quick!

[lschurr]

Bump on this @mollfpr - Can you review the proposal?

[mollfpr]

Looking now!

[melvin-bot]

📣 @nkdengineer 🎉 An offer has been automatically sent to your Upwork account for the Contributor role 🎉 Thanks for contributing to the Expensify app!

Offer link
Upwork job
Please accept the offer and leave a comment on the Github issue letting us know when we can expect a PR to be ready for review 🧑‍💻
Keep in mind: Code of Conduct | Contributing 📖

[nkdengineer]

@mollfpr this PR is ready for preview

[melvin-bot]

⚠️ Looks like this issue was linked to a Deploy Blocker here

If you are the assigned CME please investigate whether the linked PR caused a regression and leave a comment with the results.

If a regression has occurred and you are the assigned CM follow the instructions here.

If this regression could have been avoided please consider also proposing a recommendation to the PR checklist so that we can avoid it in the future.

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

• fix: a 'new comment' when opening the one expense report for the first time #43531

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

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

• @mollfpr requires payment through NewDot Manual Requests
• @nkdengineer requires payment automatic offer (Contributor)

[melvin-bot]

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:

• [@mollfpr] The PR that introduced the bug has been identified. Link to the PR:
• [@mollfpr] 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:
• [@mollfpr] 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:
• [@mollfpr] Determine if we should create a regression test for this bug.
• [@mollfpr] 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.
• [@lschurr / @zanyrenney] Link the GH issue for creating/updating the regression test once above steps have been agreed upon:

[zanyrenney]

payment summary

@mollfpr requires payment through NewDot Manual Requests - owed $250 once comment above is complete.
@nkdengineer requires payment automatic offer (Contributor) - paid $250 on upwork.

[zanyrenney]

@srikarparsi please can you do me a favour and once this checklist is complete, close out the issue?

I am OOO until Tuesday 16th so don't want to keep this open during my OOO if all the steps are complete.

I have also DM'd @mollfpr

[mollfpr]

Sorry for the delay 🙏

[@mollfpr] The PR that introduced the bug has been identified. Link to the PR:
[@mollfpr] 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:

No specific PR causing the bug.

[@mollfpr] 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:

The regression step should be enough.

[@mollfpr] Determine if we should create a regression test for this bug.
[@mollfpr] 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.

1. Submit an expense report with one expense as an employee
2. Sign in as an approver of the expense report (shouldn't be signed in before so that you don't have the expense report or transaction thread locally)
3. Throttle network connection to slow 3G, so that OpenReport takes a little bit to return
4. Click on the expense report to view the details
5. Verify that no green New line like a comment
6. 👍 or 👎

[JmillsExpensify]

$250 approved for @mollfpr

[srikarparsi]

The regression steps look good to me. @zanyrenney once you're back from OOO and you have some time, do you know who's in charge of adding the regression test to TestRail?

[zanyrenney]

Yep, i can add them!

[zanyrenney]

Added, closing! #45595