fix: Mark as unread not working

.changeset/hot-balloons-travel.md

@@ -0,0 +1,5 @@
+---
+"@rocket.chat/meteor": patch
+---
+
+Fixed issue where when you marked a room as read and you were part of it, sometimes it would mark it as read right after

apps/meteor/client/sidebar/RoomList/SideBarItemTemplateWithData.tsx

@@ -205,7 +205,7 @@ function SideBarItemTemplateWithData({
 						threadUnread={threadUnread}
 						rid={rid}
 						unread={!!unread}
-						roomOpen={false}
+						roomOpen={selected}
 						type={type}
 						cl={cl}
 						name={title}

apps/meteor/client/sidebar/RoomMenu.tsx

@@ -1,6 +1,6 @@
 import type { RoomType } from '@rocket.chat/core-typings';
 import { Option, Menu } from '@rocket.chat/fuselage';
-import { useMutableCallback } from '@rocket.chat/fuselage-hooks';
+import { useEffectEvent, useMutableCallback } from '@rocket.chat/fuselage-hooks';
 import type { TranslationKey, Fields } from '@rocket.chat/ui-contexts';
 import {
 	useRouter,
@@ -13,6 +13,7 @@ import {
 	useTranslation,
 	useEndpoint,
 } from '@rocket.chat/ui-contexts';
+import { useQueryClient } from '@tanstack/react-query';
 import type { ReactElement } from 'react';
 import React, { memo, useMemo } from 'react';
 
@@ -100,6 +101,8 @@ const RoomMenu = ({
 	const isOmnichannelRoom = type === 'l';
 	const prioritiesMenu = useOmnichannelPrioritiesMenu(rid);
 
+	const queryClient = useQueryClient();
+
 	const canLeave = ((): boolean => {
 		if (type === 'c' && !canLeaveChannel) {
 			return false;
@@ -171,19 +174,24 @@ const RoomMenu = ({
 		);
 	});
 
-	const handleToggleRead = useMutableCallback(async () => {
+	const handleToggleRead = useEffectEvent(async () => {
 		try {
+			queryClient.invalidateQueries(['sidebar/search/spotlight']);
+
 			if (isUnread) {
 				await readMessages({ rid, readThreads: true });
 				return;
 			}
-			await unreadMessages(undefined, rid);
+
 			if (subscription == null) {
 				return;
 			}
+
 			LegacyRoomManager.close(subscription.t + subscription.name);
 
 			router.navigate('/home');
+
+			await unreadMessages(undefined, rid);
 		} catch (error) {
 			dispatchToastMessage({ type: 'error', message: error });
 		}

apps/meteor/client/sidebarv2/RoomList/SideBarItemTemplateWithData.tsx

@@ -205,7 +205,7 @@ const SideBarItemTemplateWithData = ({
 						threadUnread={threadUnread}
 						rid={rid}
 						unread={!!unread}
-						roomOpen={false}
+						roomOpen={selected}
 						type={type}
 						cl={cl}
 						name={title}

apps/meteor/client/sidebarv2/RoomMenu.tsx

@@ -13,6 +13,7 @@ import {
 	useTranslation,
 	useEndpoint,
 } from '@rocket.chat/ui-contexts';
+import { useQueryClient } from '@tanstack/react-query';
 import type { ReactElement } from 'react';
 import React, { memo, useMemo } from 'react';
 
@@ -100,6 +101,8 @@ const RoomMenu = ({
 	const isOmnichannelRoom = type === 'l';
 	const prioritiesMenu = useOmnichannelPrioritiesMenu(rid);
 
+	const queryClient = useQueryClient();
+
 	const canLeave = ((): boolean => {
 		if (type === 'c' && !canLeaveChannel) {
 			return false;
@@ -173,17 +176,22 @@ const RoomMenu = ({
 
 	const handleToggleRead = useEffectEvent(async () => {
 		try {
+			queryClient.invalidateQueries(['sidebar/search/spotlight']);
+
 			if (isUnread) {
 				await readMessages({ rid, readThreads: true });
 				return;
 			}
-			await unreadMessages(undefined, rid);
+
 			if (subscription == null) {
 				return;
 			}
+
 			LegacyRoomManager.close(subscription.t + subscription.name);
 
 			router.navigate('/home');
+
+			await unreadMessages(undefined, rid);
 		} catch (error) {
 			dispatchToastMessage({ type: 'error', message: error });
 		}

apps/meteor/tests/e2e/mark-unread.spec.ts

@@ -0,0 +1,72 @@
+import { createAuxContext } from './fixtures/createAuxContext';
+import { Users } from './fixtures/userStates';
+import { HomeChannel } from './page-objects';
+import { createTargetChannel } from './utils';
+import { test, expect } from './utils/test';
+
+test.use({ storageState: Users.admin.state });
+
+test.describe('Mark Unread - Sidebar Action', () => {
+	let poHomeChannel: HomeChannel;
+	let targetChannel: string;
+
+	test.beforeEach(async ({ page, api }) => {
+		poHomeChannel = new HomeChannel(page);
+		await page.emulateMedia({ reducedMotion: 'reduce' });
+
+		targetChannel = await createTargetChannel(api, { members: ['user2'] });
+
+		await page.goto('/home');
+	});
+
+	test.afterEach(async ({ api }) => {
+		await api.post('/channels.delete', { roomName: targetChannel });
+	});
+
+	test('should not mark empty room as unread', async () => {
+		const sidebarItem = poHomeChannel.sidenav.getSidebarItemByName(targetChannel);
+		await poHomeChannel.sidenav.selectMarkAsUnread(targetChannel);
+		await expect(poHomeChannel.sidenav.getChannelBadge(sidebarItem)).not.toBeVisible();
+	});
+
+	test('should mark a populated room as unread', async () => {
+		await poHomeChannel.sidenav.openChat(targetChannel);
+		await poHomeChannel.content.sendMessage('this is a message for reply');
+		const sidebarItem = poHomeChannel.sidenav.getSidebarItemByName(targetChannel);
+		await poHomeChannel.sidenav.selectMarkAsUnread(targetChannel);
+		await expect(poHomeChannel.sidenav.getChannelBadge(sidebarItem)).toBeVisible();
+	});
+
+	test('should mark a populated room as unread - search', async () => {
+		await poHomeChannel.sidenav.openChat(targetChannel);
+		await poHomeChannel.content.sendMessage('this is a message for reply');
+		await poHomeChannel.sidenav.selectMarkAsUnread(targetChannel);
+		await poHomeChannel.sidenav.searchChat(targetChannel);
+		await expect(poHomeChannel.sidenav.getSearchChannelBadge(targetChannel)).toBeVisible();
+	});
+
+	test.describe('Mark Unread - Message Action', () => {
+		let poHomeChannelUser2: HomeChannel;
+
+		test.beforeEach(async ({ browser }) => {
+			const { page: user2Page } = await createAuxContext(browser, Users.user2);
+			poHomeChannelUser2 = new HomeChannel(user2Page);
+
+			await poHomeChannelUser2.sidenav.openChat(targetChannel);
+			await poHomeChannelUser2.content.sendMessage('this is a message for reply');
+		});
+
+		test('should mark a populated room as unread', async () => {
+			await poHomeChannel.sidenav.openChat(targetChannel);
+
+			await poHomeChannel.content.openLastMessageMenu();
+			await poHomeChannel.markUnread.click();
+			const sidebarItem = poHomeChannel.sidenav.getSidebarItemByName(targetChannel);
+			await expect(poHomeChannel.sidenav.getChannelBadge(sidebarItem)).toBeVisible();
+		});
+
+		test.afterEach(async () => {
+			await poHomeChannelUser2.page.close();
+		});
+	});
+});

apps/meteor/tests/e2e/page-objects/fragments/home-sidenav.ts

@@ -72,6 +72,13 @@ export class HomeSidenav {
 		return this.page.locator(`[data-qa="sidebar-item"][aria-label="${name}"]`);
 	}
 
+	async selectMarkAsUnread(name: string) {
+		const sidebarItem = this.getSidebarItemByName(name);
+		await sidebarItem.focus();
+		await sidebarItem.locator('.rcx-sidebar-item__menu').click();
+		await this.page.getByRole('option', { name: 'Mark Unread' }).click();
+	}
+
 	async selectPriority(name: string, priority: string) {
 		const sidebarItem = this.getSidebarItemByName(name);
 		await sidebarItem.focus();
@@ -123,6 +130,12 @@ export class HomeSidenav {
 		await this.waitForChannel();
 	}
 
+	async searchChat(name: string): Promise<void> {
+		await this.page.locator('role=navigation >> role=button[name=Search]').click();
+		await this.page.locator('role=search >> role=searchbox').fill(name);
+		await expect(this.page.locator(`[data-qa="sidebar-item"][aria-label="${name}"]`).first()).toBeVisible();
+	}
+
 	async waitForChannel(): Promise<void> {
 		await this.page.locator('role=main').waitFor();
 		await this.page.locator('role=main >> role=heading[level=1]').waitFor();
@@ -170,4 +183,12 @@ export class HomeSidenav {
 		await this.checkboxEncryption.click();
 		await this.btnCreate.click();
 	}
+
+	getChannelBadge(sidebarItem: Locator): Locator {
+		return sidebarItem.locator('.rcx-badge');
+	}
+
+	getSearchChannelBadge(name: string): Locator {
+		return this.page.locator(`[data-qa="sidebar-item"][aria-label="${name}"]`).first().locator('.rcx-badge');
+	}
 }

apps/meteor/tests/e2e/page-objects/home-channel.ts

@@ -59,4 +59,8 @@ export class HomeChannel {
 	get roomHeaderToolbar(): Locator {
 		return this.page.locator('[role=toolbar][aria-label="Primary Room actions"]');
 	}
+
+	get markUnread(): Locator {
+		return this.page.locator('role=menuitem[name="Mark Unread"]');
+	}
 }