fix: federated presence is never sent

.changeset/federated-presence-never-sent.md

@@ -0,0 +1,5 @@
+---
+'@rocket.chat/federation-matrix': patch
+---
+
+Fixes federated user presence never being sent to remote workspaces

ee/packages/federation-matrix/src/FederationMatrix.ts

@@ -103,12 +103,10 @@ export class FederationMatrix extends ServiceClass implements IFederationMatrixS
 				if (!user.username || !user.status || user.username.includes(':')) {
 					return;
 				}
-				const localUser = await Users.findOneByUsername(user.username, { projection: { _id: 1, federated: 1, federation: 1 } });
-				if (!localUser) {
-					return;
-				}
-
-				if (!isUserNativeFederated(localUser)) {
+				const localUser = await Users.findOneByUsername(user.username, {
+					projection: { _id: 1, username: 1, federated: 1, federation: 1 },
+				});
+				if (!localUser?.username) {
 					return;
 				}
 
@@ -121,10 +119,12 @@ export class FederationMatrix extends ServiceClass implements IFederationMatrixS
 					[UserStatus.BUSY]: 'unavailable',
 					[UserStatus.DISABLED]: 'offline',
 				};
+				const userMui = isUserNativeFederated(localUser) ? localUser.federation.mui : `@${localUser.username}:${this.serverName}`;
+
 				void federationSDK.sendPresenceUpdateToRooms(
 					[
 						{
-							user_id: localUser.federation.mui,
+							user_id: userMui,
 							presence: statusMap[user.status] || 'offline',
 						},
 					],

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

@@ -0,0 +1,161 @@
+import type { IRoomNativeFederated } from '@rocket.chat/core-typings';
+import { UserStatus } from '@rocket.chat/core-typings';
+import { Visibility } from 'matrix-js-sdk';
+
+import { api } from '../../../../../apps/meteor/tests/data/api-data';
+import { acceptRoomInvite } from '../../../../../apps/meteor/tests/data/rooms.helper';
+import { type IRequestConfig, createUser, getRequestConfig, getUserByUsername } from '../../../../../apps/meteor/tests/data/users.helper';
+import { IS_EE } from '../../../../../apps/meteor/tests/e2e/config/constants';
+import { retry } from '../../../../../apps/meteor/tests/end-to-end/api/helpers/retry';
+import { federationConfig } from '../helper/config';
+import { DDPListener } from '../helper/ddp-listener';
+import { SynapseClient } from '../helper/synapse-client';
+
+const localUser = federationConfig.rc1.additionalUser1;
+const remoteUser = federationConfig.hs1.additionalUser1;
+
+const PRESENCE_SETTING = 'Federation_Service_EDU_Process_Presence';
+
+(IS_EE ? describe : describe.skip)('Federation presence', () => {
+	let rc1AdminRequestConfig: IRequestConfig;
+	let rc1UserRequestConfig: IRequestConfig;
+	let hs1UserApp: SynapseClient;
+	let federatedRoomId: string;
+
+	const setPresenceSetting = async (value: boolean) => {
+		await rc1AdminRequestConfig.request
+			.post(api(`settings/${PRESENCE_SETTING}`))
+			.set(rc1AdminRequestConfig.credentials)
+			.send({ value })
+			.expect(200);
+	};
+
+	const expectRemotePresence = async (expected: string) =>
+		retry(
+			`waiting for ${remoteUser.username} to see ${localUser.matrixUserId} as ${expected}`,
+			async () => {
+				const status = await hs1UserApp.matrixClient.getPresence(localUser.matrixUserId);
+
+				expect(status.presence).toBe(expected);
+			},
+			{ retries: 10, delayMs: 2000 },
+		);
+
+	beforeAll(async () => {
+		rc1AdminRequestConfig = await getRequestConfig(
+			federationConfig.rc1.url,
+			federationConfig.rc1.adminUser,
+			federationConfig.rc1.adminPassword,
+		);
+
+		const existingLocalUser = await getUserByUsername(localUser.username, rc1AdminRequestConfig);
+		if (!existingLocalUser?._id) {
+			await createUser(
+				{
+					username: localUser.username,
+					password: localUser.password,
+					email: `${localUser.username}@rocket.chat`,
+					name: localUser.username,
+				},
+				rc1AdminRequestConfig,
+			);
+		}
+
+		rc1UserRequestConfig = await getRequestConfig(federationConfig.rc1.url, localUser.username, localUser.password);
+
+		await setPresenceSetting(true);
+
+		hs1UserApp = new SynapseClient(federationConfig.hs1.url, remoteUser.username, remoteUser.password);
+		await hs1UserApp.initialize();
+
+		const channelName = `fed-presence-${Date.now()}`;
+		const synapseRoomId = await hs1UserApp.createRoom(channelName, Visibility.Private);
+		await hs1UserApp.inviteUserToRoom(synapseRoomId, localUser.matrixUserId);
+
+		await retry(
+			'waiting for the federated room to reach RC',
+			async () => {
+				const response = await rc1UserRequestConfig.request.get(api('rooms.get')).set(rc1UserRequestConfig.credentials).expect(200);
+
+				const rcRoom = response.body.update.find(
+					(room: IRoomNativeFederated) => room.federation?.mrid === synapseRoomId,
+				) as IRoomNativeFederated | null;
+
+				expect(rcRoom).toBeTruthy();
+				federatedRoomId = rcRoom!._id;
+			},
+			{ retries: 10, delayMs: 2000 },
+		);
+
+		const accepted = await acceptRoomInvite(federatedRoomId, rc1UserRequestConfig);
+		expect(accepted).toHaveProperty('success', true);
+	}, 120000);
+
+	afterAll(async () => {
+		if (rc1AdminRequestConfig) {
+			await setPresenceSetting(false);
+		}
+		await hs1UserApp?.close();
+	});
+
+	const setLocalStatus = async (status: UserStatus) => {
+		const response = await rc1UserRequestConfig.request
+			.post(api('users.setStatus'))
+			.set(rc1UserRequestConfig.credentials)
+			.send({ status, message: '' })
+			.expect(200);
+
+		expect(response.body).toHaveProperty('success', true);
+	};
+
+	it('should share a federated room with the remote user', async () => {
+		const response = await rc1UserRequestConfig.request
+			.get(api('subscriptions.getOne'))
+			.set(rc1UserRequestConfig.credentials)
+			.query({ roomId: federatedRoomId })
+			.expect(200);
+
+		expect(response.body.subscription).toBeTruthy();
+	});
+
+	it('should reach the remote server when the local user goes online', async () => {
+		await setLocalStatus(UserStatus.ONLINE);
+
+		await expectRemotePresence('online');
+	}, 60000);
+
+	describe('with a connected client', () => {
+		let ddp: DDPListener;
+
+		beforeAll(async () => {
+			ddp = new DDPListener(federationConfig.rc1.url, rc1UserRequestConfig);
+			await ddp.connect();
+		}, 60000);
+
+		afterAll(() => {
+			ddp?.disconnect();
+		});
+
+		// away and busy both collapse to the Matrix `unavailable` state
+		it('should reach the remote server when the local user goes away', async () => {
+			await setLocalStatus(UserStatus.AWAY);
+
+			await expectRemotePresence('unavailable');
+		}, 60000);
+
+		it('should reach the remote server when the local user goes busy', async () => {
+			await setLocalStatus(UserStatus.ONLINE);
+			await expectRemotePresence('online');
+
+			await setLocalStatus(UserStatus.BUSY);
+
+			await expectRemotePresence('unavailable');
+		}, 60000);
+
+		it('should reach the remote server when the local user comes back online', async () => {
+			await setLocalStatus(UserStatus.ONLINE);
+
+			await expectRemotePresence('online');
+		}, 60000);
+	});
+});