feat: E2EE messages mentions

.changeset/late-planes-sniff.md

@@ -0,0 +1,8 @@
+---
+"@rocket.chat/meteor": patch
+"@rocket.chat/core-typings": patch
+"@rocket.chat/i18n": patch
+---
+
+Added the possibility to enable mentions in End to end encrypted channels
+

apps/meteor/app/lib/server/methods/updateMessage.ts

@@ -10,7 +10,7 @@ import { hasPermissionAsync } from '../../../authorization/server/functions/hasP
 import { settings } from '../../../settings/server';
 import { updateMessage } from '../functions/updateMessage';
 
-const allowedEditedFields = ['tshow', 'alias', 'attachments', 'avatar', 'emoji', 'msg', 'customFields'];
+const allowedEditedFields = ['tshow', 'alias', 'attachments', 'avatar', 'emoji', 'msg', 'customFields', 'e2eMentions'];
 
 export async function executeUpdateMessage(uid: IUser['_id'], message: AtLeast<IMessage, '_id' | 'rid' | 'msg'>, previewUrls?: string[]) {
 	const originalMessage = await Messages.findOneById(message._id);

apps/meteor/app/mentions/server/Mentions.ts

@@ -43,8 +43,17 @@ export class MentionsServer extends MentionsParser {
 			});
 	}
 
-	async getUsersByMentions({ msg, rid, u: sender }: Pick<IMessage, 'msg' | 'rid' | 'u'>): Promise<IMessage['mentions']> {
-		const mentions = this.getUserMentions(msg);
+	async getUsersByMentions({
+		msg,
+		rid,
+		u: sender,
+		t,
+		e2eMentions,
+	}: Pick<IMessage, 'msg' | 'rid' | 'u' | 't' | 'e2eMentions'>): Promise<IMessage['mentions']> {
+		const mentions =
+			t === 'e2e' && e2eMentions?.e2eUserMentions && e2eMentions?.e2eUserMentions.length > 0
+				? e2eMentions?.e2eUserMentions
+				: this.getUserMentions(msg);
 		const mentionsAll: { _id: string; username: string }[] = [];
 		const userMentions = [];
 
@@ -67,8 +76,11 @@ export class MentionsServer extends MentionsParser {
 		return [...mentionsAll, ...(userMentions.length ? await this.getUsers(userMentions) : [])];
 	}
 
-	async getChannelbyMentions({ msg }: Pick<IMessage, 'msg'>) {
-		const channels = this.getChannelMentions(msg);
+	async getChannelbyMentions({ msg, t, e2eMentions }: Pick<IMessage, 'msg' | 't' | 'e2eMentions'>) {
+		const channels =
+			t === 'e2e' && e2eMentions?.e2eChannelMentions && e2eMentions?.e2eChannelMentions.length > 0
+				? e2eMentions?.e2eChannelMentions
+				: this.getChannelMentions(msg);
 		return this.getChannels(channels.map((c) => c.trim().substr(1)));
 	}
 

apps/meteor/client/startup/e2e.ts

@@ -4,7 +4,8 @@ import { Tracker } from 'meteor/tracker';
 
 import { E2EEState } from '../../app/e2e/client/E2EEState';
 import { e2e } from '../../app/e2e/client/rocketchat.e2e';
-import { Subscriptions, ChatRoom } from '../../app/models/client';
+import { MentionsParser } from '../../app/mentions/lib/MentionsParser';
+import { Subscriptions, ChatRoom, Users } from '../../app/models/client';
 import { settings } from '../../app/settings/client';
 import { sdk } from '../../app/utils/client/lib/SDKClient';
 import { onClientBeforeSendMessage } from '../lib/onClientBeforeSendMessage';
@@ -146,11 +147,33 @@ Meteor.startup(() => {
 				return message;
 			}
 
+			const mentionsEnabled = settings.get<boolean>('E2E_Enabled_Mentions');
+
+			if (mentionsEnabled) {
+				const me = (message.u?._id && Users.findOne(message.u?._id, { fields: { username: 1 } })?.username) || '';
+				const pattern = settings.get('UTF8_User_Names_Validation');
+				const useRealName = settings.get('UI_Use_Real_Name');
+
+				const mentions = new MentionsParser({
+					pattern: () => pattern,
+					useRealName: () => useRealName,
+					me: () => me,
+				});
+
+				const e2eMentions: IMessage['e2eMentions'] = {
+					e2eUserMentions: mentions.getUserMentions(message.msg),
+					e2eChannelMentions: mentions.getChannelMentions(message.msg),
+				};
+
+				message.e2eMentions = e2eMentions;
+			}
+
 			// Should encrypt this message.
 			const msg = await e2eRoom.encrypt(message);
 			message.msg = msg;
 			message.t = 'e2e';
 			message.e2e = 'pending';
+
 			return message;
 		});
 

apps/meteor/server/settings/e2e.ts

@@ -27,4 +27,10 @@ export const createE2ESettings = () =>
 			public: true,
 			enableQuery: { _id: 'E2E_Enable', value: true },
 		});
+
+		await this.add('E2E_Enabled_Mentions', false, {
+			type: 'boolean',
+			public: true,
+			enableQuery: { _id: 'E2E_Enable', value: true },
+		});
 	});

apps/meteor/tests/e2e/e2e-encryption.spec.ts

@@ -132,11 +132,13 @@ test.describe.serial('e2e-encryption', () => {
 
 	test.beforeAll(async ({ api }) => {
 		expect((await api.post('/settings/E2E_Allow_Unencrypted_Messages', { value: true })).status()).toBe(200);
+		expect((await api.post('/settings/E2E_Enabled_Mentions', { value: true })).status()).toBe(200);
 	});
 
 	test.afterAll(async ({ api }) => {
 		expect((await api.post('/settings/E2E_Enable', { value: false })).status()).toBe(200);
 		expect((await api.post('/settings/E2E_Allow_Unencrypted_Messages', { value: false })).status()).toBe(200);
+		expect((await api.post('/settings/E2E_Enabled_Mentions', { value: false })).status()).toBe(200);
 	});
 
 	test('expect create a private channel encrypted and send an encrypted message', async ({ page }) => {
@@ -205,6 +207,54 @@ test.describe.serial('e2e-encryption', () => {
 		await expect(poHomeChannel.content.lastUserMessage.locator('.rcx-icon--name-key')).toBeVisible();
 	});
 
+	test('expect create a encrypted private channel and mention user', async ({ page }) => {
+		const channelName = faker.string.uuid();
+
+		await poHomeChannel.sidenav.createEncryptedChannel(channelName);
+
+		await expect(page).toHaveURL(`/group/${channelName}`);
+
+		await poHomeChannel.dismissToast();
+
+		await expect(poHomeChannel.content.encryptedRoomHeaderIcon).toBeVisible();
+
+		await poHomeChannel.content.sendMessage('hello @user1');
+
+		const userMention = await page.getByRole('button', {
+			name: 'user1',
+		});
+
+		await expect(userMention).toBeVisible();
+
+		await userMention.click();
+
+		await expect(poHomeChannel.content.userCard).toBeVisible();
+	});
+
+	test('expect create a encrypted private channel, mention a channel and navigate to it', async ({ page }) => {
+		const channelName = faker.string.uuid();
+
+		await poHomeChannel.sidenav.createEncryptedChannel(channelName);
+
+		await expect(page).toHaveURL(`/group/${channelName}`);
+
+		await poHomeChannel.dismissToast();
+
+		await expect(poHomeChannel.content.encryptedRoomHeaderIcon).toBeVisible();
+
+		await poHomeChannel.content.sendMessage('Are you in the #general channel?');
+
+		const channelMention = await page.getByRole('button', {
+			name: 'general',
+		});
+
+		await expect(channelMention).toBeVisible();
+
+		await channelMention.click();
+
+		await expect(page).toHaveURL(`/channel/general`);
+	});
+
 	test('expect placeholder text in place of encrypted message, when E2EE is not setup', async ({ page }) => {
 		const channelName = faker.string.uuid();
 
@@ -447,5 +497,4 @@ test.describe.serial('e2ee room setup', () => {
 		await expect(poHomeChannel.content.inputMessage).not.toBeVisible();
 		await expect(page.locator('.rcx-states__title')).toContainText('Check back later');
 	});
-
 });

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

@@ -82,8 +82,8 @@ export class HomeContent {
 	async sendMessage(text: string): Promise<void> {
 		await this.joinRoomIfNeeded();
 		await this.page.waitForSelector('[name="msg"]:not([disabled])');
-		await this.page.locator('[name="msg"]').type(text);
-		await this.page.keyboard.press('Enter');
+		await this.page.locator('[name="msg"]').fill(text);
+		await this.page.getByLabel('Send').click();
 	}
 
 	async dispatchSlashCommand(text: string): Promise<void> {

packages/core-typings/src/IMessage/IMessage.ts

@@ -164,6 +164,7 @@ export interface IMessage extends IRocketChatRecord {
 	tcount?: number;
 	t?: MessageTypesValues;
 	e2e?: 'pending' | 'done';
+	e2eMentions?: { e2eUserMentions?: string[]; e2eChannelMentions?: string[] };
 	otrAck?: string;
 
 	urls?: MessageUrl[];

packages/i18n/src/locales/en.i18n.json

@@ -1794,6 +1794,8 @@
   "E2E_Enabled": "E2E Enabled",
   "E2E_Enabled_Default_DirectRooms": "Enable encryption for Direct Rooms by default",
   "E2E_Enabled_Default_PrivateRooms": "Enable encryption for Private Rooms by default",
+  "E2E_Enabled_Mentions": "Mentions",
+  "E2E_Enabled_Mentions_Description": "Notify people, and highlight user, channel, and team mentions in encrypted content.",
   "E2E_Encryption_Password_Change": "Change Encryption Password",
   "E2E_Encryption_Password_Explanation": "You can now create encrypted private groups and direct messages. You may also change existing private groups or DMs to encrypted.<br/><br/>This is end-to-end encryption so the key to encode/decode your messages will not be saved on the server. For that reason you need to store your password somewhere safe. You will be required to enter it on other devices you wish to use e2e encryption on.",
   "E2E_key_reset_email": "E2E Key Reset Notification",