[HOLD for payment 2023-11-21] [$500] LHN - Money Request removal offline doesn't update LHN correctly

[kbecciv]

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!

---

Action Performed:

1. Open a chat with user B
2. Request money
3. Go offline
4. Open the newly created money request report
5. Delete the request

Expected Result:

In the LHN, the chat with user B should show the last visible message

Actual Result:

In the LHN, the chat with user B shows " owes " until going back online

Workaround:

Unknown

Platforms:

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

• Android / native
• Android / Chrome
• iOS / native
• iOS / Safari
• MacOS / Chrome / Safari
• MacOS / Desktop

Version Number: 1.3.78.0
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
Notes/Photos/Videos: Any additional supporting documentation

ios.1.mov

android.1.mov

desktop.2.mov

safari.MP4

chrome.MP4

272100142-18604d4d-3bc9-4507-893a-d5d2204648e3.mp4

Recording.4879.mp4

Expensify/Expensify Issue URL:
Issue reported by: @paultsimura
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1696501720522399

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~01e4ad059b092f74b3
• Upwork Job ID: 1709994082221408256
• Last Price Increase: 2023-10-12
• Automatic offers:
• tienifr | Contributor | 27265296
• paultsimura | Reporter | 27265299

[melvin-bot]

Triggered auto assignment to @dylanexpensify (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details.

[melvin-bot]

Bug0 Triage Checklist (Main S/O)

• This "bug" occurs on a supported platform (ensure Platforms in OP are ✅)
• This bug is not a duplicate report (check E/App issues and #expensify-bugs)
  • If it is, comment with a link to the original report, close the issue and add any novel details to the original issue instead
• This bug is reproducible using the reproduction steps in the OP. S/O
  • If the reproduction steps are clear and you're unable to reproduce the bug, check with the reporter and QA first, then close the issue.
  • If the reproduction steps aren't clear and you determine the correct steps, please update the OP.
• This issue is filled out as thoroughly and clearly as possible
  • Pay special attention to the title, results, platforms where the bug occurs, and if the bug happens on staging/production.
• I have reviewed and subscribed to the linked Slack conversation to ensure Slack/Github stay in sync

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~01e4ad059b092f74b3

[melvin-bot]

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

[paultsimura]

Proposal

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

Once IOU report is deleted, the parent report's last message is not updated in LHN

What is the root cause of that problem?

When deleting a Money Request, if it's the last request in the IOU report, we optimistically update the parent report:

App/src/libs/actions/IOU.js

Lines 1567 to 1580 in 1663440

	...(shouldDeleteIOUReport
	? [
	{
	onyxMethod: Onyx.METHOD.MERGE,
	key: `${ONYXKEYS.COLLECTION.REPORT}${chatReport.reportID}`,
	value: {
	hasOutstandingIOU: false,
	iouReportID: null,
	lastMessageText: ReportActionsUtils.getLastVisibleMessage(iouReport.chatReportID, {[reportPreviewAction.reportActionID]: null}).lastMessageText,
	lastVisibleActionCreated: ReportActionsUtils.getLastVisibleAction(iouReport.chatReportID, {[reportPreviewAction.reportActionID]: null}).created,
	},
	},
	]
	: []),

We explicitly tell the ReportActionsUtils.getLastVisibleMessage to ignore the "IOU Preview" action: {[parentReportAction.reportActionID]: null}
However, this null is ignored here, the change was introduced by #26447, the null scenario was not ignored before:

App/src/libs/ReportActionsUtils.js

Lines 381 to 387 in f6efb26

	function getLastVisibleAction(reportID, actionsToMerge = {}) {
	const updatedActionsToMerge = {};
	if (actionsToMerge && Object.keys(actionsToMerge).length !== 0) {
	Object.keys(actionsToMerge).forEach(
	(actionToMergeID) => (updatedActionsToMerge[actionToMergeID] = {...allReportActions[reportID][actionToMergeID], ...actionsToMerge[actionToMergeID]}),
	);
	}

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

If the actionsToMerge contains explicit null, we should set the corresponding updatedActionsToMerge key to null instead of using the spread operator:

    if (actionsToMerge && Object.keys(actionsToMerge).length !== 0) {
        Object.keys(actionsToMerge).forEach(
-           (actionToMergeID) => (updatedActionsToMerge[actionToMergeID] = {...allReportActions[reportID][actionToMergeID], ...actionsToMerge[actionToMergeID]}),
+           (actionToMergeID) => (updatedActionsToMerge[actionToMergeID] = lodashIsNull(actionsToMerge[actionToMergeID]) ? null : {...allReportActions[reportID][actionToMergeID], ...actionsToMerge[actionToMergeID]}),
        );
    }

And also, for better code reuse, in IOU.deleteMoneyRequest we should consider passing {[reportPreviewAction.reportActionID]: updatedReportPreviewAction} (as a param to ReportActionsUtils.getLastVisibleMessage and ReportActionsUtils.getLastVisibleAction) instead of {[reportPreviewAction.reportActionID]: null}, as the updatedReportPreviewAction is already null in this scenario.

    // STEP 5: Build Onyx data
+   const optimisticChatReportActions = {[reportPreviewAction.reportActionID]: updatedReportPreviewAction};

    const optimisticData = [
        ......
        {
            onyxMethod: Onyx.METHOD.MERGE,
            key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${chatReport.reportID}`,
-           value: {
-               [reportPreviewAction.reportActionID]: updatedReportPreviewAction,
-           },
+           value: optimisticChatReportActions,
        },
        ...(shouldDeleteIOUReport
            ? [
                  {
                      onyxMethod: Onyx.METHOD.MERGE,
                      key: `${ONYXKEYS.COLLECTION.REPORT}${chatReport.reportID}`,
                      value: {
                          hasOutstandingIOU: false,
                          iouReportID: null,
-                         lastMessageText: ReportActionsUtils.getLastVisibleMessage(iouReport.chatReportID, {[reportPreviewAction.reportActionID]: null}).lastMessageText,
-                         lastVisibleActionCreated: ReportActionsUtils.getLastVisibleAction(iouReport.chatReportID, {[reportPreviewAction.reportActionID]: null}).created,
+                         lastMessageText: ReportActionsUtils.getLastVisibleMessage(iouReport.chatReportID, optimisticChatReportActions).lastMessageText,
+                         lastVisibleActionCreated: ReportActionsUtils.getLastVisibleAction(iouReport.chatReportID, optimisticChatReportActions).created,
                      },
                  },
              ]
            : []),
    ];

Result:

iou-delete-offline.mov

What alternative solutions did you explore? (Optional)

We can alternatively leave the ReportActionsUtils.getLastVisibleAction logic untouched and pass some dummy "invisible" action instead of null. Like an action with message.html: '', but that's not a preferable approach.

[tienifr]

Proposal

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

LHN - Money Request removal offline doesn't update LHN correctly

What is the root cause of that problem?

After deleting the request money action, we update the lastMessageText of parent report

App/src/libs/actions/IOU.js

Line 1575 in e078b4a

lastMessageText: ReportActionsUtils.getLastVisibleMessage(iouReport.chatReportID, {[reportPreviewAction.reportActionID]: null}).lastMessageText,

As we're passing {[reportPreviewAction.reportActionID]: null} to getLastVisibleMessage

In getLastVisibleMessage function, we merge the actionsToMerge with allReportActions[reportID]

App/src/libs/ReportActionsUtils.js

Lines 387 to 397 in e078b4a

	function getLastVisibleAction(reportID, actionsToMerge = {}) {
	const updatedActionsToMerge = {};
	if (actionsToMerge && Object.keys(actionsToMerge).length !== 0) {
	Object.keys(actionsToMerge).forEach(
	(actionToMergeID) => (updatedActionsToMerge[actionToMergeID] = {...allReportActions[reportID][actionToMergeID], ...actionsToMerge[actionToMergeID]}),
	);
	}
	const actions = Object.values({
	...allReportActions[reportID],
	...updatedActionsToMerge,
	});

but actionsToMerge[actionToMergeID] is null -> it will be ignored

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

we need to merge 2 objects to achieve the final objects, so we should do the same as onyx

implement mergeObject like what we did in onyx so we can remove the redundant code avoid the future inconsistency bug

function getLastVisibleAction(reportID, actionsToMerge = {}) {
    const actions = Object.values(mergeObject(
        allReportActions[reportID],
        actionsToMerge,
    ));

Result

Screen.Recording.2023-10-06.at.15.25.47.mov

[melvin-bot]

@burczu, @dylanexpensify Whoops! This issue is 2 days overdue. Let's get this updated quick!