RocketChat/Rocket.Chat

View on GitHub
apps/meteor/app/lib/server/functions/removeUserFromRoom.ts

Summary

Maintainability
B
4 hrs
Test Coverage
import { Apps, AppEvents } from '@rocket.chat/apps';
import { AppsEngineException } from '@rocket.chat/apps-engine/definition/exceptions';
import { Message, Team, Room } from '@rocket.chat/core-services';
import type { IUser } from '@rocket.chat/core-typings';
import { Subscriptions, Rooms } from '@rocket.chat/models';
import { Meteor } from 'meteor/meteor';

import { afterLeaveRoomCallback } from '../../../../lib/callbacks/afterLeaveRoomCallback';
import { beforeLeaveRoomCallback } from '../../../../lib/callbacks/beforeLeaveRoomCallback';
import { settings } from '../../../settings/server';
import { notifyOnRoomChangedById, notifyOnSubscriptionChanged } from '../lib/notifyListener';

export const removeUserFromRoom = async function (rid: string, user: IUser, options?: { byUser: IUser }): Promise<void> {
    const room = await Rooms.findOneById(rid);

    if (!room) {
        return;
    }

    try {
        await Apps.self?.triggerEvent(AppEvents.IPreRoomUserLeave, room, user, options?.byUser);
    } catch (error: any) {
        if (error.name === AppsEngineException.name) {
            throw new Meteor.Error('error-app-prevented', error.message);
        }

        throw error;
    }

    await Room.beforeLeave(room);

    // TODO: move before callbacks to service
    await beforeLeaveRoomCallback.run(user, room);

    const subscription = await Subscriptions.findOneByRoomIdAndUserId(rid, user._id, {
        projection: { _id: 1 },
    });

    if (subscription) {
        const removedUser = user;
        if (options?.byUser) {
            const extraData = {
                u: options.byUser,
            };

            if (room.teamMain) {
                await Message.saveSystemMessage('removed-user-from-team', rid, user.username || '', user, extraData);
            } else {
                await Message.saveSystemMessage('ru', rid, user.username || '', user, extraData);
            }
        } else if (room.teamMain) {
            await Message.saveSystemMessage('ult', rid, removedUser.username || '', removedUser);
        } else {
            await Message.saveSystemMessage('ul', rid, removedUser.username || '', removedUser);
        }
    }

    if (room.t === 'l') {
        await Message.saveSystemMessage('command', rid, 'survey', user);
    }

    const deletedSubscription = await Subscriptions.removeByRoomIdAndUserId(rid, user._id);
    if (deletedSubscription) {
        void notifyOnSubscriptionChanged(deletedSubscription, 'removed');
    }

    if (room.teamId && room.teamMain) {
        await Team.removeMember(room.teamId, user._id);
    }

    if (room.encrypted && settings.get('E2E_Enable')) {
        await Rooms.removeUsersFromE2EEQueueByRoomId(room._id, [user._id]);
    }

    // TODO: CACHE: maybe a queue?
    await afterLeaveRoomCallback.run(user, room);

    void notifyOnRoomChangedById(rid);

    await Apps.self?.triggerEvent(AppEvents.IPostRoomUserLeave, room, user, options?.byUser);
};