[HOLD for payment 2024-08-09] [$250] ‘New messages’ banner shows up every time for the sender when sending a message to a chat report

[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.81-8
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: @youssef-lr
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1718058418632669

Action Performed:

1. Go to a chat report (user B) with lots of messages as user A
2. Send a message from user A to user B

Expected Result:

New message banner should not appear for the sender (user A)

Actual Result:

‘New messages’ banner shows up every time sending a new message in a chat, the message is coming from user A

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

RPReplay_Final1718058334.MP4

TKUV5746.MP4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~01e44bca9dc779dfff
• Upwork Job ID: 1803494636295070981
• Last Price Increase: 2024-06-26
• Automatic offers:
• shubham1206agra | Reviewer | 102953243
• bernhardoj | Contributor | 102953244

Issue Owner

Current Issue Owner: @alexpensify

[melvin-bot]

Triggered auto assignment to @alexpensify (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.

[bernhardoj]

Proposal

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

New message floating banner shows every time adding a new message.

What is the root cause of that problem?

One of the condition that will show the new message floating banner is canScrollToNewerComments. In our case, when sending a new message, hasNewestReportAction becomes false, so canScrollToNewerComments becomes true.

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

Line 679 in 95c8202

const canScrollToNewerComments = !isLoadingInitialReportActions && !hasNewestReportAction && sortedReportActions.length > 25 && !isLastPendingActionIsDelete;

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

Lines 682 to 683 in 95c8202

	<FloatingMessageCounter
	isActive={(isFloatingMessageCounterVisible && !!currentUnreadMarker) || canScrollToNewerComments}

hasNewestReportAction checks whether we have the newest report action or not.

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

Line 215 in 95c8202

const hasNewestReportAction = sortedVisibleReportActions[0]?.created === report.lastVisibleActionCreated;

When we send a new message, we optimistically update both report and report actions.

App/src/libs/actions/Report.ts

Lines 511 to 522 in 95c8202

	const optimisticData: OnyxUpdate[] = [
	{
	onyxMethod: Onyx.METHOD.MERGE,
	key: `${ONYXKEYS.COLLECTION.REPORT}${reportID}`,
	value: optimisticReport,
	},
	{
	onyxMethod: Onyx.METHOD.MERGE,
	key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${reportID}`,
	value: optimisticReportActions as ReportActions,
	},
	];

However, the component received the report optimistic update first which makes hasNewestReportAction becomes false. Later, when the component receive the report actions optimistic update, hasNewestReportAction becomes true again. Both report and report actions are received from ReportScreen.

It's because for report onyx, we use useOnyx,

App/src/pages/home/ReportScreen.tsx

Line 151 in 95c8202

const [reportOnyx, reportResult] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${getReportID(route)}`, {allowStaleData: true});

and for report actions, we use withOnyx,

App/src/pages/home/ReportScreen.tsx

Lines 760 to 764 in 95c8202

	sortedAllReportActions: {
	key: ({route}) => `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${getReportID(route)}`,
	canEvict: false,
	selector: (allReportActions: OnyxEntry<OnyxTypes.ReportActions>) => ReportActionsUtils.getSortedReportActionsForDisplay(allReportActions, true),
	},

so their state update are not batched together.

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

Convert report actions from withOnyx to useOnyx.

const [sortedAllReportActions] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${getReportID(route)}`, {canEvict: false,
        selector: (allReportActions: OnyxEntry<OnyxTypes.ReportActions>) => ReportActionsUtils.getSortedReportActionsForDisplay(allReportActions, true)})

Based on @youssef-lr comment, we can convert the other withOnyx to useOnyx too.

const isSidebarLoaded = useOnyx(ONYXKEYS.IS_SIDEBAR_LOADED);
const reportNameValuePairs = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${getReportID(route)}`, {allowStaleData: true});
const reportMetadata = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_METADATA}${getReportID(route)}`, {initialValue: {
    isLoadingInitialReportActions: true,
    isLoadingOlderReportActions: false,
    hasLoadingOlderReportActionsError: false,
    isLoadingNewerReportActions: false,
    hasLoadingNewerReportActionsError: false,
}});
const policies = useOnyx(ONYXKEYS.COLLECTION.POLICY, {allowStaleData: true});
const betas = useBetas();

[alexpensify]

I'll test this one tomorrow.

[melvin-bot]

@alexpensify Uh oh! This issue is overdue by 2 days. Don't forget to update your issues!

[alexpensify]

No update yet

[alexpensify]

@youssef-lr - I followed up in the Slack thread since I'm unable to replicate the experience:

[alexpensify]

I was able to replicate the experience if you overload a chat with a ton of activity. Also, I think the issue might be the response trying to catch up. I'm going to mark this as external, but I think @youssef-lr should be involved in the review.

2024-06-18_22-14-17.mp4

[melvin-bot]

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

[melvin-bot]

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

[alexpensify]

@shubham1206agra can you please review if the proposal here will fix the issue? Thanks!

[alexpensify]

@shubham1206agra any update regarding the proposal here? Thanks!

[shubham1206agra]

@bernhardoj Can you create a test branch? So we can test this.

[bernhardoj]

@shubham1206agra here is the test branch

[youssef-lr]

Maybe we can convert all withOnyx to useOnyx, but withOnyx has shouldDelayUpdate set to true for ReportScreen which isn't present in useOnyx, so not sure.

@bernhardoj withOnyx is now deprecated, we can safely use useOnyx here

[alexpensify]

@bernhardoj - can you please update your proposal based on the feedback here? Thanks!

[bernhardoj]

Updated my proposal

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

• Fix "New messages" banner shows up every time sending a message in a chat #44724

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

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

• @bernhardoj requires payment automatic offer (Contributor)
• @shubham1206agra requires payment automatic offer (Reviewer)

[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:

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

[alexpensify]

Noted the payment date is tomorrow

[shubham1206agra]

@alexpensify The PR was reverted and #45711 is waiting on @youssef-lr.

[alexpensify]

@shubham1206agra, thank you for that update! I've updated the GH. We will continue with the payment process after this second PR goes into production and then clears the regression period.

[alexpensify]

Weekly Update: Waiting on #45711

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

• Fix "New messages" banner shows up every time sending a message in a chat #44724
• #2 - Fix new message shows every time add new message #45711

If no regressions arise, payment will be issued on 2024-08-09. 🎊

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

• @bernhardoj requires payment automatic offer (Contributor)
• @shubham1206agra requires payment automatic offer (Reviewer)

[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:

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

[alexpensify]

I was OOO on Friday and will work on the payment process tomorrow.

[alexpensify]

Payouts due: 2024-08-09

• Contributor: $250 @bernhardoj - handled via Chat
• Contributor+: $250 @shubham1206agra - please accept the invite in Upwork

Upwork job is here.

[shubham1206agra]

@alexpensify Accepted offer

[bernhardoj]

Requested in ND.

[alexpensify]

I've completed the payment process in Upwork - #43486 (comment)

Closing for now since the remaining payment will be handled via Chat.

[JmillsExpensify]

$250 approved for @bernhardoj