add error handling to xmpp slash command

Author: sampaiodiego

apps/meteor/ee/server/startup/federation.ts

@@ -8,6 +8,7 @@ import { Users } from '@rocket.chat/models';
 
 import { settings } from '../../../app/settings/server';
 import { slashCommands } from '../../../app/utils/server/slashCommand';
+import { i18n } from '../../../server/lib/i18n';
 import { StreamerCentral } from '../../../server/modules/streamer/streamer.module';
 import { registerFederationRoutes } from '../api/federation';
 
@@ -96,14 +97,36 @@ export const startFederationService = async (): Promise<void> => {
 
 	slashCommands.add({
 		command: 'xmpp',
-		callback: async ({ params, message: _message, userId }: SlashCommandCallbackParams<'xmpp'>): Promise<void> => {
+		callback: async ({ params, message, userId }: SlashCommandCallbackParams<'xmpp'>): Promise<void> => {
+			// the helper advertises `#channel`, so accept the leading # and strip it before joining
+			const channel = params.trim().replace(/^#/, '');
+			if (!channel) {
+				void api.broadcast('notify.ephemeralMessage', userId, message.rid, {
+					msg: i18n.t('Federation_XMPP_Join_Channel_Required', {
+						lng: settings.get('Language') || 'en',
+					}),
+				});
+				return;
+			}
+
 			const user = await Users.findOneById(userId);
 			if (!user) {
 				logger.error({ msg: 'User not found for joining xmpp room', userId });
 				return;
 			}
 
-			await FederationMatrixService.joinXMPPChatRoom(params.trim(), user);
+			const joined = await FederationMatrixService.joinXMPPChatRoom(channel, user);
+
+			const lng = settings.get<string>('Language') || 'en';
+			if (joined) {
+				void api.broadcast('notify.ephemeralMessage', userId, message.rid, {
+					msg: `${i18n.t('Federation_XMPP_Join_Channel_Success', { lng })}`,
+				});
+			} else {
+				void api.broadcast('notify.ephemeralMessage', userId, message.rid, {
+					msg: `${i18n.t('Federation_XMPP_Join_Channel_Failed', { lng })}`,
+				});
+			}
 		},
 		options: {
 			description: 'Join xmpp rooms',

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

@@ -1038,20 +1038,21 @@ export class FederationMatrix extends ServiceClass implements IFederationMatrixS
 		);
 	}
 
-	async joinXMPPChatRoom(roomAlias: string, user: IUser): Promise<void> {
+	async joinXMPPChatRoom(roomAlias: string, user: IUser): Promise<boolean> {
 		try {
 			if (isUserNativeFederated(user)) {
 				throw new Error('Federated users cannot join XMPP chat rooms');
 			}
 
-			const result = await federationSDK.joinXMPPChatRoom(roomAlias, userIdSchema.parse(`@${user.username}:${this.serverName}`));
-
-			console.log(result);
+			await federationSDK.joinXMPPChatRoom(roomAlias, userIdSchema.parse(`@${user.username}:${this.serverName}`));
 
 			this.logger.info({ msg: 'User joined XMPP chat room successfully', username: user.username, roomAlias });
+
+			return true;
 		} catch (err) {
-			this.logger.error({ msg: 'Failed to join XMPP chat room', err });
-			throw err;
+			this.logger.error({ msg: 'Failed to join XMPP chat room', err, username: user.username, roomAlias });
+
+			return false;
 		}
 	}
 

packages/core-services/src/types/IFederationMatrixService.ts

@@ -34,6 +34,6 @@ export interface IFederationMatrixService {
 	canUserAccessFederation(user: IUser): Promise<boolean>;
 	notifyRoomRead(params: { room: IRoomNativeFederated; userId: string; threadId?: string }): Promise<void>;
 	updateUserName(user: IUser): Promise<void>;
-	joinXMPPChatRoom(roomAlias: string, user: IUser): Promise<void>;
+	joinXMPPChatRoom(roomAlias: string, user: IUser): Promise<boolean>;
 	saveFederationMessage(event: { event: PduForType<'m.room.message'>; event_id: EventID }): Promise<void>;
 }

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

@@ -2310,6 +2310,9 @@
   "Federation_Service_Allow_List_Description": "Restrict federation to the given allow list of domains.",
   "Federation_Service_Validate_User_Domain": "Users email restrictions",
   "Federation_Service_Validate_User_Domain_Description": "Restrict access to verified email addresses that match your Federated Domain.",
+  "Federation_XMPP_Join_Channel_Required": "Please provide a channel to join. Usage: `/xmpp #channel`",
+  "Federation_XMPP_Join_Channel_Success": "You joined the XMPP channel.",
+  "Federation_XMPP_Join_Channel_Failed": "Could not join the XMPP channel. Please try again later.",
   "Field": "Field",
   "Field_removed": "Field removed",
   "Field_required": "Field required",