[HOLD for payment 2024-01-17] Unsubscribe icon shows up after leaving your own thread

[srikarparsi]

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

---

Version Number: 1.3.93-0
Reproducible in staging?: Y
Reproducible in production?: N
If this was caught during regression testing, add the test name, ID and link from TestRail:
Email or phone of affected tester (no customers): N/A
Logs: https://stackoverflow.com/c/expensify/questions/4856
Issue reported by: @srikarparsi and Applause
Slack conversation: N/A

Issue found when executing PR #27994

Action Performed:

Break down in numbered steps

1. Comment on a report
2. Reply to the comment
3. Go into the thread, and then click leave thread
4. Return to the parent report.
5. The unsubscribe icon will show up even if the report is no longer shared.

Expected Result:

Describe what you think should've happened

The subscribe icon should show up

Actual Result:

Describe what actually happened

The unsubscribe icon shows up instead

Workaround:

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

Yes

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

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2023-10-27.at.4.49.30.PM.mov

MacOS: Desktop

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~017a3500c3ff4829ca
• Upwork Job ID: 1719512812572073984
• Last Price Increase: 2023-11-01

[paultsimura]

Proposal

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

The "Unsubscribe" context menu action is visible even after the thread was left.

What is the root cause of that problem?

The issue is that on leaving the thread, here:

App/src/pages/home/HeaderView.js

Lines 130 to 136 in fb0899f

	} else if (props.report.notificationPreference.length) {
	threeDotMenuItems.push({
	icon: Expensicons.ChatBubbles,
	text: props.translate('common.leaveThread'),
	onSelected: Session.checkIfActionIsAllowed(() => Report.leaveRoom(props.report.reportID)),
	});
	}

We call this action:

App/src/libs/actions/Report.js

Lines 2011 to 2078 in a59d56f

	/**
	* Leave a report by setting the state to submitted and closed
	*
	* @param {String} reportID
	* @param {Boolean} isWorkspaceMemberLeavingWorkspaceRoom
	*/
	function leaveRoom(reportID, isWorkspaceMemberLeavingWorkspaceRoom = false) {
	const report = lodashGet(allReports, [reportID], {});
	const reportKeys = _.keys(report);
	// Pusher's leavingStatus should be sent earlier.
	// Place the broadcast before calling the LeaveRoom API to prevent a race condition
	// between Onyx report being null and Pusher's leavingStatus becoming true.
	broadcastUserIsLeavingRoom(reportID);
	// If a workspace member is leaving a workspace room, they don't actually lose the room from Onyx.
	// Instead, their notification preference just gets set to "hidden".
	const optimisticData = [
	isWorkspaceMemberLeavingWorkspaceRoom
	? {
	onyxMethod: Onyx.METHOD.MERGE,
	key: `${ONYXKEYS.COLLECTION.REPORT}${reportID}`,
	value: {
	notificationPreference: CONST.REPORT.NOTIFICATION_PREFERENCE.HIDDEN,
	},
	}
	: {
	onyxMethod: Onyx.METHOD.SET,
	key: `${ONYXKEYS.COLLECTION.REPORT}${reportID}`,
	value: {
	stateNum: CONST.REPORT.STATE_NUM.SUBMITTED,
	statusNum: CONST.REPORT.STATUS.CLOSED,
	},
	},
	];
	const successData = [
	{
	onyxMethod: Onyx.METHOD.MERGE,
	key: `${ONYXKEYS.COLLECTION.REPORT}${reportID}`,
	value: isWorkspaceMemberLeavingWorkspaceRoom ? {notificationPreference: CONST.REPORT.NOTIFICATION_PREFERENCE.HIDDEN} : _.object(reportKeys, Array(reportKeys.length).fill(null)),
	},
	];
	API.write(
	'LeaveRoom',
	{
	reportID,
	},
	{
	optimisticData,
	successData,
	failureData: [
	{
	onyxMethod: Onyx.METHOD.MERGE,
	key: `${ONYXKEYS.COLLECTION.REPORT}${reportID}`,
	value: report,
	},
	],
	},
	);
	if (isWorkspaceMemberLeavingWorkspaceRoom) {
	const participantAccountIDs = PersonalDetailsUtils.getAccountIDsByLogins([CONST.EMAIL.CONCIERGE]);
	const chat = ReportUtils.getChatByParticipants(participantAccountIDs);
	Navigation.navigate(ROUTES.REPORT_WITH_ID.getRoute(chat.reportID));
	}
	}

But it doesn't update the childReportNotificationPreference of the parent reportAction.

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

First, we should update the BE behavior on the LeaveRoom API call: it should set the parentReportAction.childReportNotificationPreference: "hidden" if the left report was a thread.

Second, he should add an optimistic Onyx merge operation to reflect this change for an appropriate offline behavior:

    if (report.parentReportID && report.parentReportActionID) {
        const parentReportAction = ReportActionsUtils.getParentReportAction(report);

        optimisticData.push({
            onyxMethod: Onyx.METHOD.MERGE,
            key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${report.parentReportID}`,
            value: {[parentReportAction.reportActionID]: {childReportNotificationPreference: CONST.REPORT.NOTIFICATION_PREFERENCE.HIDDEN}},
        });
        failureData.push({
            onyxMethod: Onyx.METHOD.MERGE,
            key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${report.parentReportID}`,
            value: {[parentReportAction.reportActionID]: {childReportNotificationPreference: report.notificationPreference}},
        });
    }

We do similar on the "Unsubscribe" action here:

App/src/libs/actions/Report.js

Lines 1387 to 1398 in a59d56f

	if (parentReportID && parentReportActionID) {
	optimisticData.push({
	onyxMethod: Onyx.METHOD.MERGE,
	key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${parentReportID}`,
	value: {[parentReportActionID]: {childReportNotificationPreference: newValue}},
	});
	failureData.push({
	onyxMethod: Onyx.METHOD.MERGE,
	key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${parentReportID}`,
	value: {[parentReportActionID]: {childReportNotificationPreference: previousValue}},
	});
	}

What alternative solutions did you explore? (Optional)

Instead of fixing the BE, we could just call Report.updateNotificationPreference together with Report.leaveRoom, but this will result in sending 2 API calls on 1 operation, which breaks the 1:1:1 convention.

[DylanDylann]

Proposal

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

Unsubscribe icon shows up after leaving your own thread

What is the root cause of that problem?

When clicking the subcribe or unsubcribe button on the ContextMenu modal. We will call toggleSubscribeToChildReport function to update Notification Preference

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

Line 215 in e99c297

Report.toggleSubscribeToChildReport(lodashGet(reportAction, 'childReportID', '0'), reportAction, reportID, childReportNotificationPreference);

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

Line 181 in e99c297

Report.toggleSubscribeToChildReport(lodashGet(reportAction, 'childReportID', '0'), reportAction, reportID, childReportNotificationPreference);

When leaving the thread, we don't call toggleSubscribeToChildReport to unsubscribe this thread

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

When leaving the thread, we should call toggleSubscribeToChildReport to unsubscribe this thread like we did here

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

Lines 206 to 215 in e99c297

	onPress: (closePopover, {reportAction, reportID}) => {
	let childReportNotificationPreference = lodashGet(reportAction, 'childReportNotificationPreference', '');
	if (!childReportNotificationPreference) {
	const isActionCreator = ReportUtils.isActionCreator(reportAction);
	childReportNotificationPreference = isActionCreator ? CONST.REPORT.NOTIFICATION_PREFERENCE.ALWAYS : CONST.REPORT.NOTIFICATION_PREFERENCE.HIDDEN;
	}
	if (closePopover) {
	hideContextMenu(false, () => {
	ReportActionComposeFocusManager.focus();
	Report.toggleSubscribeToChildReport(lodashGet(reportAction, 'childReportID', '0'), reportAction, reportID, childReportNotificationPreference);

We also consider calling toggleSubscribeToChildReport to true when the user clicks the thread again after leaving the thread

Optional: While investigating this issue I see a problem. Let's see the below image

The unsubscribe button displayed on context menu modal even It is single message not thread (there are no child message). The RC is

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

Line 197 in e99c297

const subscribed = childReportNotificationPreference !== 'hidden';

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

Line 204 in e99c297

return subscribed && (isCommentAction || isReportPreviewAction || isIOUAction);

we are using this condition to display unsubcribe button

Solution: I suggest we add a condition to make sure it is a thread (Ex: childVisibleActionCount > 0). If It is true, we display unsubcribe or subcribe button

What alternative solutions did you explore? (Optional)

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

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