test: refactor end-to-end test for inviting a user from Synapse to ensure proper member and message reflection

Author: ggazzo

apps/meteor/tests/data/rooms.helper.ts

@@ -454,6 +454,30 @@ export const acceptRoomInvite = (roomId: IRoom['_id'], config?: IRequestConfig)
 	});
 };
 
+/**
+ * Retrieves the subscriptions for the authenticated user.
+ *
+ * Fetches the complete list of subscriptions for the authenticated user, which is essential
+ * for verifying federation subscription synchronization and member synchronization.
+ *
+ * @param config - Optional request configuration for custom domains
+ * @returns Promise resolving to the subscriptions response
+ */
+
+export const getSubscriptions = (config?: IRequestConfig) => {
+	const requestInstance = config?.request || request;
+	const credentialsInstance = config?.credentials || credentials;
+
+	return new Promise<ReturnType<Endpoints['/v1/subscriptions.get']['GET']>>((resolve) => {
+		void requestInstance
+			.get(api('subscriptions.get'))
+			.set(credentialsInstance)
+			.end((_err: any, req: any) => {
+				resolve(req.body);
+			});
+	});
+};
+
 /**
  * Rejects a room invite for the authenticated user.
  *

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

@@ -9,6 +9,8 @@ import {
 	addUserToRoomSlashCommand,
 	acceptRoomInvite,
 	rejectRoomInvite,
+	getRoomMembers,
+	getSubscriptions,
 } from '../../../../../apps/meteor/tests/data/rooms.helper';
 import { type IRequestConfig, getRequestConfig, createUser, deleteUser } from '../../../../../apps/meteor/tests/data/users.helper';
 import { IS_EE } from '../../../../../apps/meteor/tests/e2e/config/constants';
@@ -1563,14 +1565,58 @@ import { SynapseClient } from '../helper/synapse-client';
 					// RC view: Admin tries to accept rc1User1's invitation
 					const response = await acceptRoomInvite(federatedChannel._id, rc1AdminRequestConfig);
 					expect(response.success).toBe(false);
-					expect(response.error).toBe('Failed to handle invite: No subscription found or user does not have permission to accept or reject this invite');
+					expect(response.error).toBe(
+						'Failed to handle invite: No subscription found or user does not have permission to accept or reject this invite',
+					);
 				});
 
 				it('It should not allow admin to reject invitation on behalf of another user', async () => {
 					// RC view: Admin tries to reject rc1User1's invitation
 					const response = await rejectRoomInvite(federatedChannel._id, rc1AdminRequestConfig);
 					expect(response.success).toBe(false);
-					expect(response.error).toBe('Failed to handle invite: No subscription found or user does not have permission to accept or reject this invite');
+					expect(response.error).toBe(
+						'Failed to handle invite: No subscription found or user does not have permission to accept or reject this invite',
+					);
+				});
+			});
+		});
+
+		describe('Inviting a RC user from Synapse', () => {
+			describe('Room that already contains previous events', () => {
+				let matrixRoomId: string;
+				let channelName: string;
+				let rid: string;
+				beforeAll(async () => {
+					channelName = `federated-channel-from-synapse-${Date.now()}`;
+					matrixRoomId = await hs1AdminApp.createRoom(channelName);
+
+					await hs1AdminApp.matrixClient.sendTextMessage(matrixRoomId, 'Message from admin');
+					await hs1AdminApp.matrixClient.invite(matrixRoomId, federationConfig.hs1.additionalUser1.matrixUserId);
+					await hs1User1App.matrixClient.joinRoom(matrixRoomId);
+					await hs1User1App.matrixClient.sendTextMessage(matrixRoomId, 'Message from user1');
+					await hs1AdminApp.matrixClient.invite(matrixRoomId, federationConfig.rc1.adminMatrixUserId);
+
+					const subscriptions = await getSubscriptions(rc1AdminRequestConfig);
+
+					const pendingInvitation = subscriptions.update.find((subscription) => subscription.status === 'INVITED');
+
+					expect(pendingInvitation).not.toBeUndefined();
+
+					rid = pendingInvitation?.rid!;
+
+					await acceptRoomInvite(rid, rc1AdminRequestConfig);
+				}, 15000);
+
+				describe('It should reflect all the members and messagens on the rocket.chat side', () => {
+					it('It should show all the three users in the members list', async () => {
+						const members = await getRoomMembers(rid, rc1AdminRequestConfig);
+						expect(members.members.length).toBe(3);
+						expect(members.members.find((member: IUser) => member.username === federationConfig.rc1.adminUser)).not.toBeNull();
+						expect(
+							members.members.find((member: IUser) => member.username === federationConfig.rc1.additionalUser1.username),
+						).not.toBeNull();
+						expect(members.members.find((member: IUser) => member.username === federationConfig.hs1.adminMatrixUserId)).not.toBeNull();
+					});
 				});
 			});
 		});

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

@@ -7,7 +7,7 @@
 import * as fs from 'fs';
 import * as path from 'path';
 
-import { createClient, type MatrixClient, KnownMembership, type Room, type RoomMember } from 'matrix-js-sdk';
+import { createClient, type MatrixClient, KnownMembership, type Room, type RoomMember, Visibility } from 'matrix-js-sdk';
 
 /**
  * Creates a promise that resolves after the specified delay.
@@ -30,7 +30,7 @@ export function wait(ms: number): Promise<void> {
  * invitation handling with built-in retry logic for eventual consistency.
  */
 export class SynapseClient {
-	private matrixClient: MatrixClient | null = null;
+	private _matrixClient: MatrixClient | null = null;
 
 	private url: string;
 
@@ -51,6 +51,13 @@ export class SynapseClient {
 		this.password = password;
 	}
 
+	get matrixClient(): MatrixClient {
+		if (!this._matrixClient) {
+			throw new Error('Matrix client is not initialized');
+		}
+		return this._matrixClient;
+	}
+
 	/**
 	 * Initializes the Matrix client connection.
 	 *
@@ -63,7 +70,7 @@ export class SynapseClient {
 	async initialize(): Promise<void> {
 		const client = await this.createClient(this.username, this.password, this.url);
 		await client.startClient();
-		this.matrixClient = client;
+		this._matrixClient = client;
 	}
 
 	/**
@@ -132,6 +139,26 @@ export class SynapseClient {
 		throw new Error(`No room found with name ${roomName}`);
 	}
 
+	async createRoom(roomName: string, visibility: Visibility = Visibility.Private): Promise<string> {
+		if (!this.matrixClient) {
+			throw new Error('Matrix client is not initialized');
+		}
+
+		const room = await this.matrixClient.createRoom({
+			name: roomName,
+			visibility,
+		});
+
+		return room.room_id;
+	}
+
+	async inviteUserToRoom(roomId: string, userId: string): Promise<void> {
+		if (!this.matrixClient) {
+			throw new Error('Matrix client is not initialized');
+		}
+		await this.matrixClient.invite(userId, roomId);
+	}
+
 	/**
 	 * Finds a room by name and membership status.
 	 *
@@ -664,7 +691,7 @@ export class SynapseClient {
 			await this.matrixClient.clearStores?.();
 			this.matrixClient.removeAllListeners();
 			await this.matrixClient.logout(true);
-			this.matrixClient = null;
+			this._matrixClient = null;
 		}
 	}
 }