[HOLD for payment 2023-07-06] [$1000] First message remains heighlighted on thread

[kavimuru]

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

---

Action Performed:

1. go to any chat
2. send any message
3. click on reply in thread option
4. go to thread and send any message
5. go to previous chat
6. click on same message and select reply in thread option

Expected Result:

first message should not be highlighted

Actual Result:

first message highlights

Workaround:

Can the user still use Expensify without this being fixed? Have you informed them of the workaround?

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.19-6
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

IMG_0409.mov

az_recorder_20230529_172540.1.mp4

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

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~01459c624ea436728a
• Upwork Job ID: 1663582287105273856
• Last Price Increase: 2023-06-20

[melvin-bot]

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

[bernhardoj]

Proposal

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

First message in thread is highlighted if we use Reply In Thread from (right-click) context menu.

What is the root cause of that problem?

One of the reason the message is highlighted is when a context menu is active. Each message compare its action ID with the active action ID.

App/src/pages/home/report/ContextMenu/PopoverReportActionContextMenu.js

Lines 111 to 113 in f007829

	isActiveReportAction(actionID) {
	return Boolean(actionID) && this.state.reportAction.reportActionID === actionID;
	}

The active action ID will be cleared once we close the context menu.

App/src/pages/home/report/ContextMenu/PopoverReportActionContextMenu.js

Lines 198 to 202 in f007829

	runAndResetOnPopoverHide() {
	this.setState({reportID: '0', reportAction: {}}, () => {
	this.onPopoverHide = this.runAndResetCallback(this.onPopoverHide);
	this.onPopoverHideActionCallback = this.runAndResetCallback(this.onPopoverHideActionCallback);
	});

One thing to keep in mind is that the thread first message action ID is the same as the thread parent action ID.
(thread parent action)

(thread first message action)

The problem is, when we click Reply in thread, it will navigate us to the thread report before hiding the context menu.

Screen.Recording.2023-05-30.at.17.03.11.mov

Notice the context menu is late to hide.

This is because we are delaying the hiding (first param of hideContextMenu)

App/src/pages/home/report/ContextMenu/ContextMenuActions.js

Lines 119 to 122 in f007829

	Report.navigateToAndOpenChildReport(lodashGet(reportAction, 'childReportID', '0'), reportAction, reportID);
	if (closePopover) {
	hideContextMenu(true, ReportActionComposeFocusManager.focus);
	}

So, when we already navigated to the thread report, the first message mounted and think that the context menu is still active (well, technically it's but we should immediately close it before navigate to the thread report)

App/src/pages/home/report/ReportActionItem.js

Lines 108 to 109 in f007829

	function ReportActionItem(props) {
	const [isContextMenuActive, setIsContextMenuActive] = useState(ReportActionContextMenu.isActiveReportAction(props.action.reportActionID));

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

1. We shouldn't delay to close/hide the context
2. If we are going to close/hide the context menu, i.e. closePopover is true, we should do the navigation after the hide completes.

Here is how it looks after both changes above:

if (closePopover) {
    hideContextMenu(false, () => {
        Report.navigateToAndOpenChildReport(lodashGet(reportAction, 'childReportID', '0'), reportAction, reportID);
        ReportActionComposeFocusManager.focus();
    });
} else {
    Report.navigateToAndOpenChildReport(lodashGet(reportAction, 'childReportID', '0'), reportAction, reportID);
}

What alternative solutions did you explore? (Optional)

Add reportID check in isActiveReportAction.

return Boolean(actionID) && Boolean(reportID) && this.state.reportID === reportID && this.state.reportAction.reportActionID === actionID;

This works well, but I think we should still apply the main solution above and this one just as an additional improvement.

[melvin-bot]

Looks like something related to react-navigation may have been mentioned in this issue discussion.

As a reminder, please make sure that all proposals are not workarounds and that any and all attempt to fix the issue holistically have been made before proceeding with a solution. Proposals to change our DeprecatedCustomActions.js files should not be accepted.

Feel free to drop a note in #expensify-open-source with any questions.

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~01459c624ea436728a

[melvin-bot]

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

[melvin-bot]

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

[melvin-bot]

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

[melvin-bot]

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

[puneetlath]

@parasharrajat thoughts on the proposal?

[parasharrajat]

Reviewing.

[melvin-bot]

📣 It's been a week! Do we have any satisfactory proposals yet? Do we need to adjust the bounty for this issue? 💸

[melvin-bot]

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

[puneetlath]

@parasharrajat thoughts on the proposals?

[parasharrajat]

Missed replying here. Thanks @bernhardoj for the proposal. So removing the delay will fix this issue. But why is the delay there? What will happen when we remove this?

[bernhardoj]

I believe the delay is used when we want to show some icon/text changes in the context menu before closing it, e.g. copy to clipboard, mark as unread.

Screen.Recording.2023-06-08.at.11.49.05.mov

[parasharrajat]

Thanks. There were two questions asked.

What will happen when we remove this?

What about this?

[bernhardoj]

The context menu will immediately close. The example we can see is in edit/delete message, flag message.

App/src/pages/home/report/ContextMenu/ReportActionContextMenu.js

Lines 47 to 68 in b8d4576

	function hideContextMenu(shouldDelay, onHideCallback = () => {}) {
	if (!contextMenuRef.current) {
	return;
	}
	if (!shouldDelay) {
	contextMenuRef.current.hideContextMenu(onHideCallback);
	return;
	}
	// Save the active instanceID for which hide action was called.
	// If menu is being closed with a delay, check that whether the same instance exists or a new was created.
	// If instance is not same, cancel the hide action
	const instanceID = contextMenuRef.current.instanceID;
	setTimeout(() => {
	if (contextMenuRef.current.instanceID !== instanceID) {
	return;
	}
	contextMenuRef.current.hideContextMenu(onHideCallback);
	}, 800);
	}

[parasharrajat]

The context menu will immediately close.

That is obvious. So we will lose the ability to show the confirmation status of an action(e.g. for Copy to Clipboard). That will become another problem.

[bernhardoj]

PR is ready for review.

cc: @parasharrajat

[melvin-bot]

🎯 ⚡️ Woah @parasharrajat / @bernhardoj, great job pushing this forwards! ⚡️

The pull request got merged within 3 working days of assignment, so this job is eligible for a 50% #urgency bonus 🎉

• when @bernhardoj got assigned: 2023-06-23 16:47:54 Z
• when the PR got merged: 2023-06-27 14:34:44 UTC

On to the next one 🚀

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

• Fix thread parent message stays highlighted #21479

If no regressions arise, payment will be issued on 2023-07-06. 🎊

After the hold period is over and BZ checklist items are completed, please complete any of the applicable payments for this issue, and check them off once done.

• External issue reporter @gadhiyamanan
• Contributor that fixed the issue @bernhardoj
• Contributor+ that helped on the issue and/or PR @parasharrajat

As a reminder, here are the bonuses/penalties that should be applied for any External issue:

• Merged PR within 3 business days of assignment - 50% bonus
• Merged PR more than 9 business days after assignment - 50% penalty

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

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

[puneetlath]

@gadhiyamanan @bernhardoj sent you both contracts.

@parasharrajat I assume you'll request payment via Expensify? And also, friendly reminder about the checklist 😄

[puneetlath]

@parasharrajat friendly reminder so that we can pay this out tomorrow!

[parasharrajat]

[@parasharrajat] The PR that introduced the bug has been identified. Link to the PR: I am not sure how to tag the real Root cause of PR. The solution was to remove the delay from the context menu hide but this delay was added before the threads were in the app so the root cause PR will be the one that added the threads. They should have removed the delay. #18522

[@parasharrajat] 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: https://github.com/Expensify/App/pull/18522/files#r1253404741

[@parasharrajat] 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: Not needed. This kind of bug can be found with testing.

[@parasharrajat] Determine if we should create a regression test for this bug. Yes

[@parasharrajat] 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 Steps

1. Open any chat
2. Send a message
3. Long press/right-click the message to open a context menu
4. Press Reply in the thread in the context menu.
5. Verify the thread parent message is not highlighted

Do you agree 👍 or 👎 ?

[puneetlath]

Thanks @parasharrajat.

You'll be requesting payment via NewDot, is that right?

@gadhiyamanan bump on accepting the Upwork offer.

[puneetlath]

@gadhiyamanan and @bernhardoj have been paid. Just waiting for confirmation from @parasharrajat on whether they've requested payment in NewDot.

[parasharrajat]

I haven't requested it yet. Please wait a few more days. It takes about 5 days to credit so the waiting time is long. Good thing on putting this weekly. Thanks for the bump @puneetlath .

[parasharrajat]

Requested payment on newDot 1500.

[anmurali]

Approved 1500 based on #19776 (comment)

[puneetlath]

Great! Closing out.