test(federation): create DM tests (#37777)

Co-authored-by: Guilherme Gazzo <guilherme@gazzo.xyz>

Author: sampaiodiego

ee/packages/federation-matrix/jest.config.federation.ts

@@ -49,7 +49,7 @@ export default {
 							mode: 'testops',
 							testops: {
 								api: { token: process.env.QASE_TESTOPS_JEST_API_TOKEN },
-								project: 'RC',
+								project: process.env.QASE_PROJECT || 'RC',
 								run: {
 									title: qaseRunTitle(),
 									complete: true,

ee/packages/federation-matrix/tests/end-to-end/dms.spec.ts

@@ -0,0 +1,335 @@
+import type { ISubscription, IUser } from '@rocket.chat/core-typings';
+import type { MatrixEvent, Room, RoomEmittedEvents } from 'matrix-js-sdk';
+import { RoomStateEvent } from 'matrix-js-sdk';
+
+import { api } from '../../../../../apps/meteor/tests/data/api-data';
+import { acceptRoomInvite, getSubscriptions } from '../../../../../apps/meteor/tests/data/rooms.helper';
+import { getRequestConfig, createUser, deleteUser } from '../../../../../apps/meteor/tests/data/users.helper';
+import type { TestUser, IRequestConfig } from '../../../../../apps/meteor/tests/data/users.helper';
+import { IS_EE } from '../../../../../apps/meteor/tests/e2e/config/constants';
+import { federationConfig } from '../helper/config';
+import { SynapseClient } from '../helper/synapse-client';
+
+const waitForRoomEvent = async (room: Room, eventType: RoomEmittedEvents, validateEvent: (event: MatrixEvent) => void, timeoutMs = 5000) =>
+	Promise.race([
+		new Promise<void>((resolve, reject) => {
+			room.once(eventType, async (event: MatrixEvent) => {
+				try {
+					await validateEvent(event);
+					resolve();
+				} catch (error) {
+					reject(error);
+				}
+			});
+		}),
+		new Promise((_, reject) => setTimeout(() => reject(new Error('Timeout waiting for event')), timeoutMs)),
+	]);
+
+(IS_EE ? describe : describe.skip)('Federation DMs', () => {
+	let rc1AdminRequestConfig: IRequestConfig;
+	// let rc1User1RequestConfig: IRequestConfig;
+	let hs1AdminApp: SynapseClient;
+	// let hs1User1App: SynapseClient;
+
+	beforeAll(async () => {
+		// Create admin request config for RC1
+		rc1AdminRequestConfig = await getRequestConfig(
+			federationConfig.rc1.url,
+			federationConfig.rc1.adminUser,
+			federationConfig.rc1.adminPassword,
+		);
+
+		// Create user1 in RC1 using federation config values
+		await createUser(
+			{
+				username: federationConfig.rc1.additionalUser1.username,
+				password: federationConfig.rc1.additionalUser1.password,
+				email: `${federationConfig.rc1.additionalUser1.username}@rocket.chat`,
+				name: federationConfig.rc1.additionalUser1.username,
+			},
+			rc1AdminRequestConfig,
+		);
+
+		// Create admin Synapse client for HS1
+		hs1AdminApp = new SynapseClient(federationConfig.hs1.url, federationConfig.hs1.adminUser, federationConfig.hs1.adminPassword);
+		await hs1AdminApp.initialize();
+	});
+
+	afterAll(async () => {
+		if (hs1AdminApp) {
+			await hs1AdminApp.close();
+		}
+		// if (hs1User1App) {
+		// 	await hs1User1App.close();
+		// }
+	});
+
+	describe('1:1 Direct Messages', () => {
+		let rcUser: TestUser<IUser>;
+		let rcUserConfig: IRequestConfig;
+		let hs1Room: Room | null;
+		let invitedRoomId: string;
+
+		const userDm = `dm-federation-user-${Date.now()}`;
+		const userDmId = `@${userDm}:${federationConfig.rc1.domain}`;
+
+		beforeAll(async () => {
+			// create both RC and Synapse users
+			rcUser = await createUser(
+				{
+					username: userDm,
+					password: 'random',
+					email: `${userDm}}@rocket.chat`,
+					name: `DM Federation User ${Date.now()}`,
+				},
+				rc1AdminRequestConfig,
+			);
+
+			rcUserConfig = await getRequestConfig(federationConfig.rc1.url, rcUser.username, 'random');
+		});
+
+		afterAll(async () => {
+			// delete both RC and Synapse users
+			await deleteUser(rcUser, {}, rc1AdminRequestConfig);
+		});
+
+		describe('Synapse as the resident server', () => {
+			describe('Room list name validations', () => {
+				it('should create a DM and invite user from rc', async () => {
+					hs1Room = await hs1AdminApp.createDM([userDmId]);
+
+					expect(hs1Room).toHaveProperty('roomId');
+
+					const subs = await getSubscriptions(rcUserConfig);
+
+					const pendingInvitation = subs.update.find(
+						(subscription) =>
+							subscription.status === 'INVITED' &&
+							subscription.fname?.includes(`@${federationConfig.hs1.adminUser}:${federationConfig.hs1.domain}`),
+					);
+
+					expect(pendingInvitation).toHaveProperty('rid');
+
+					const membersBefore = await hs1Room!.getMembers();
+
+					expect(membersBefore.length).toBe(2);
+
+					const invitedMember = membersBefore.find((member) => member.userId === userDmId);
+
+					expect(invitedMember).toHaveProperty('membership', 'invite');
+
+					invitedRoomId = pendingInvitation!.rid;
+
+					const waitForRoomEventPromise = waitForRoomEvent(hs1Room!, RoomStateEvent.Members, ({ event }) => {
+						expect(event).toHaveProperty('content.membership', 'join');
+						expect(event).toHaveProperty('state_key', userDmId);
+					});
+
+					const response = await acceptRoomInvite(invitedRoomId, rcUserConfig);
+					expect(response.success).toBe(true);
+
+					await waitForRoomEventPromise;
+				});
+				it.todo('should display the fname properly');
+				it.todo('should display the fname properly after the user from Synapse leaves the DM');
+			});
+
+			describe('Permission validations', () => {
+				it('should leave the DM from Rocket.Chat', async () => {
+					const subs = await getSubscriptions(rcUserConfig);
+
+					const dmSubscription = subs.update.find(
+						(subscription) =>
+							subscription.t === 'd' && subscription.fname?.includes(`@${federationConfig.hs1.adminUser}:${federationConfig.hs1.domain}`),
+					);
+
+					expect(dmSubscription).toHaveProperty('rid');
+
+					const response = await rcUserConfig.request
+						.post(api('rooms.leave'))
+						.set(rcUserConfig.credentials)
+						.send({
+							roomId: invitedRoomId,
+						})
+						.expect(200);
+
+					expect(response.body).toHaveProperty('success', true);
+
+					await waitForRoomEvent(hs1Room!, RoomStateEvent.Members, ({ event }) => {
+						expect(event).toHaveProperty('content.membership', 'leave');
+						expect(event).toHaveProperty('state_key', userDmId);
+					});
+				});
+			});
+
+			it.todo('should reflect the revoke invitation in the RC user subscriptions');
+		});
+
+		describe('Rocket.Chat as the resident server', () => {
+			it.todo('should create a DM and invite user from synapse');
+			// const createResponse = await createDirectMessage({
+			// 	usernames: [federationConfig.hs1.adminMatrixUserId],
+			// 	config: rc1AdminRequestConfig,
+			// });
+
+			// expect(createResponse.status).toBe(200);
+			// expect(createResponse.body).toHaveProperty('success', true);
+			// // createResponse.body.room._rid;
+
+			// const sub = await getSubscriptions(rc1AdminRequestConfig).then((subs) =>
+			// 	subs.update.find((subscription) => subscription.rid === createResponse.body.room._rid),
+			// );
+			// expect(sub).toHaveProperty('rid', createResponse.body.room._rid);
+
+			// expect(sub).toHaveProperty('fname', federationConfig.hs1.adminMatrixUserId);
+
+			it.todo('should display the fname properly after reject the invitation');
+			it.todo('should display the fname properly after accept the invitation');
+			it.todo('should allow the user to leave the DM if it is not the only member');
+			it.todo('should not allow to leave if the user is the only member');
+		});
+	});
+
+	describe('Multiple user DMs', () => {
+		describe('Synapse as the resident server', () => {
+			let rcUser1: TestUser<IUser>;
+			// let rcUser2: TestUser<IUser>;
+
+			let rcUserConfig1: IRequestConfig;
+			// let rcUserConfig2: IRequestConfig;
+
+			let hs1Room: Room | null;
+
+			let pendingInvitation1: ISubscription | undefined;
+			// let pendingInvitation2: any;
+
+			let invitedRoomId1: string;
+			// let invitedRoomId2: string;
+
+			const userDm1 = `dm-federation-user1-${Date.now()}`;
+			const userDmId1 = `@${userDm1}:${federationConfig.rc1.domain}`;
+
+			const userDm2 = `dm-federation-user2-${Date.now()}`;
+			const userDmId2 = `@${userDm2}:${federationConfig.rc1.domain}`;
+
+			beforeAll(async () => {
+				// create both RC and Synapse users
+				rcUser1 = await createUser(
+					{
+						username: userDm1,
+						password: 'random',
+						email: `${userDm1}}@rocket.chat`,
+						name: `DM Federation User ${Date.now()}`,
+					},
+					rc1AdminRequestConfig,
+				);
+
+				rcUserConfig1 = await getRequestConfig(federationConfig.rc1.url, rcUser1.username, 'random');
+
+				await createUser(
+					{
+						username: userDm2,
+						password: 'random',
+						email: `${userDm2}}@rocket.chat`,
+						name: `DM Federation User ${Date.now()}`,
+					},
+					rc1AdminRequestConfig,
+				);
+
+				// rcUserConfig2 = await getRequestConfig(federationConfig.rc1.url, rcUser2.username, 'random');
+			});
+
+			afterAll(async () => {
+				// delete both RC and Synapse users
+				// await Promise.all([deleteUser(rcUser1, {}, rc1AdminRequestConfig), deleteUser(rcUser2, {}, rc1AdminRequestConfig)]);
+			});
+
+			describe('Room list name validations', () => {
+				it('should create a group DM with multiple RC users', async () => {
+					hs1Room = await hs1AdminApp.createDM([userDmId1, userDmId2]);
+
+					expect(hs1Room).toHaveProperty('roomId');
+
+					const subs1 = await getSubscriptions(rcUserConfig1);
+
+					pendingInvitation1 = subs1.update.find(
+						(subscription) =>
+							subscription.status === 'INVITED' &&
+							subscription.fname?.includes(`@${federationConfig.hs1.adminUser}:${federationConfig.hs1.domain}`),
+					);
+
+					expect(pendingInvitation1).toHaveProperty('rid');
+
+					const membersBefore = await hs1Room!.getMembers();
+
+					expect(membersBefore.length).toBe(3);
+
+					const invitedMember = membersBefore.find((member) => member.userId === userDmId1);
+
+					expect(invitedMember).toHaveProperty('membership', 'invite');
+
+					invitedRoomId1 = pendingInvitation1!.rid;
+				});
+
+				it('should display the name of the inviter on RC', async () => {
+					expect(pendingInvitation1).toHaveProperty('fname', federationConfig.hs1.adminMatrixUserId);
+				});
+
+				it.failing('should display the name of all users on RC after the invited user accepts the invitation', async () => {
+					const waitForRoomEventPromise1 = waitForRoomEvent(hs1Room!, RoomStateEvent.Members, ({ event }) => {
+						expect(event).toHaveProperty('content.membership', 'join');
+						expect(event).toHaveProperty('state_key', userDmId1);
+					});
+
+					const response = await acceptRoomInvite(invitedRoomId1, rcUserConfig1);
+					expect(response.success).toBe(true);
+
+					await waitForRoomEventPromise1;
+
+					const subs1After = await getSubscriptions(rcUserConfig1);
+
+					const joinedSubscription1 = subs1After.update.find((subscription) => subscription.rid === invitedRoomId1);
+
+					expect(joinedSubscription1).toHaveProperty('fname', `${federationConfig.hs1.adminMatrixUserId}, ${userDm1}, ${userDm2}`);
+				});
+				it.todo('should update the display the name if the inviter from Synapse leaves the group DM');
+			});
+			describe('Permission validations', () => {
+				it.todo('should allow a user to add another user to the group DM');
+				it.todo('should allow a user to leave the group DM');
+			});
+			describe('Turning a 1:1 DM into a group DM', () => {
+				it.todo('should show the invite to the third user');
+				it.todo('should update the room name to reflect the three users after the third user accepts the invitation');
+			});
+		});
+		describe('Rocket.Chat as the resident server', () => {
+			describe('Room list name validations', () => {
+				it.todo('should display the fname containing the two invited users for the inviter');
+				it.todo("should display only the inviter's username for the invited user");
+				it.todo('should update the fname when a user leaves the DM');
+				it.todo('should update the fname when a user is added to the DM');
+			});
+			describe('Permission validations', () => {
+				it.todo('should add a user to the DM');
+				it.todo('should add another user by another user than the initial inviter');
+			});
+			describe('Duplicated rooms', () => {
+				describe('When the third user leaves a DM', () => {
+					describe('When there is an existing non-federated DM with the same users', () => {
+						it.todo('should have two DMs with same users');
+						it.todo('should return the non-federated room when trying to create a new DM with same users');
+					});
+					describe('When there is only federated DMs', () => {
+						it.todo('should have two DMs with same users');
+						it.todo('should return the oldest room when trying to create a new DM with same users');
+					});
+				});
+			});
+			describe('Turning a 1:1 DM into a group DM', () => {
+				it.todo('should show the invite to the third user');
+				it.todo('should update the room name to reflect the three users after the third user accepts the invitation');
+			});
+		});
+	});
+});

ee/packages/federation-matrix/tests/helper/synapse-client.ts

@@ -152,6 +152,19 @@ export class SynapseClient {
 		return room.room_id;
 	}
 
+	async createDM(userIds: string[]) {
+		if (!this.matrixClient) {
+			throw new Error('Matrix client is not initialized');
+		}
+
+		const dmRoom = await this.matrixClient.createRoom({
+			is_direct: true,
+			invite: userIds,
+		});
+
+		return this.matrixClient.getRoom(dmRoom.room_id);
+	}
+
 	async inviteUserToRoom(roomId: string, userId: string): Promise<void> {
 		if (!this.matrixClient) {
 			throw new Error('Matrix client is not initialized');