feat: Add membersByHighestRole endpoints

.changeset/thick-swans-drop.md

@@ -0,0 +1,8 @@
+---
+"@rocket.chat/meteor": minor
+"@rocket.chat/core-typings": minor
+"@rocket.chat/model-typings": minor
+"@rocket.chat/rest-typings": minor
+---
+
+Added `membersByHighestRole` endpoints, which enables users to retrieve room members sorted by their room-scoped roles

apps/meteor/app/api/server/v1/channels.ts

@@ -1,5 +1,5 @@
 import { Team, Room } from '@rocket.chat/core-services';
-import type { IRoom, ISubscription, IUser, RoomType, IUpload } from '@rocket.chat/core-typings';
+import type { IRoom, ISubscription, IUser, RoomType, IUpload, UserStatus } from '@rocket.chat/core-typings';
 import { Integrations, Messages, Rooms, Subscriptions, Uploads, Users } from '@rocket.chat/models';
 import {
 	isChannelsAddAllProps,
@@ -24,6 +24,7 @@ import { Meteor } from 'meteor/meteor';
 
 import { isTruthy } from '../../../../lib/isTruthy';
 import { findUsersOfRoom } from '../../../../server/lib/findUsersOfRoom';
+import { findUsersOfRoomByHighestRole } from '../../../../server/lib/findUsersOfRoomByHighestRole';
 import { hideRoomMethod } from '../../../../server/methods/hideRoom';
 import { removeUserFromRoomMethod } from '../../../../server/methods/removeUserFromRoom';
 import { canAccessRoomAsync } from '../../../authorization/server';
@@ -1094,6 +1095,41 @@ API.v1.addRoute(
 	},
 );
 
+API.v1.addRoute(
+	'channels.membersByHighestRole',
+	{ authRequired: true },
+	{
+		async get() {
+			const findResult = await findChannelByIdOrName({
+				params: this.queryParams,
+				checkedArchived: false,
+			});
+
+			if (findResult.broadcast && !(await hasPermissionAsync(this.userId, 'view-broadcast-member-list', findResult._id))) {
+				return API.v1.unauthorized();
+			}
+
+			const { count: limit } = await getPaginationItems(this.queryParams);
+			const { sort = {} } = await this.parseJsonQuery();
+			const { status, filter } = this.queryParams;
+
+			const { members, total } = await findUsersOfRoomByHighestRole({
+				rid: findResult._id,
+				...(status && { status: { $in: status as UserStatus[] } }),
+				limit,
+				filter,
+				...(sort?.username && { sort: { username: sort.username } }),
+			});
+
+			return API.v1.success({
+				members,
+				count: members.length,
+				total,
+			});
+		},
+	},
+);
+
 API.v1.addRoute(
 	'channels.online',
 	{ authRequired: true },

apps/meteor/app/api/server/v1/groups.ts

@@ -1,11 +1,12 @@
 import { Team, isMeteorError } from '@rocket.chat/core-services';
-import type { IIntegration, IUser, IRoom, RoomType } from '@rocket.chat/core-typings';
+import type { IIntegration, IUser, IRoom, RoomType, UserStatus } from '@rocket.chat/core-typings';
 import { Integrations, Messages, Rooms, Subscriptions, Uploads, Users } from '@rocket.chat/models';
 import { check, Match } from 'meteor/check';
 import { Meteor } from 'meteor/meteor';
 import type { Filter } from 'mongodb';
 
 import { findUsersOfRoom } from '../../../../server/lib/findUsersOfRoom';
+import { findUsersOfRoomByHighestRole } from '../../../../server/lib/findUsersOfRoomByHighestRole';
 import { hideRoomMethod } from '../../../../server/methods/hideRoom';
 import { removeUserFromRoomMethod } from '../../../../server/methods/removeUserFromRoom';
 import { canAccessRoomAsync, roomAccessAttributes } from '../../../authorization/server';
@@ -747,6 +748,41 @@ API.v1.addRoute(
 	},
 );
 
+API.v1.addRoute(
+	'groups.membersByHighestRole',
+	{ authRequired: true },
+	{
+		async get() {
+			const findResult = await findPrivateGroupByIdOrName({
+				params: this.queryParams,
+				userId: this.userId,
+			});
+
+			if (findResult.broadcast && !(await hasPermissionAsync(this.userId, 'view-broadcast-member-list', findResult.rid))) {
+				return API.v1.unauthorized();
+			}
+
+			const { count: limit } = await getPaginationItems(this.queryParams);
+			const { sort = {} } = await this.parseJsonQuery();
+			const { status, filter } = this.queryParams;
+
+			const { members, total } = await findUsersOfRoomByHighestRole({
+				rid: findResult.rid,
+				...(status && { status: { $in: status as UserStatus[] } }),
+				limit,
+				filter,
+				...(sort?.username && { sort: { username: sort.username } }),
+			});
+
+			return API.v1.success({
+				members,
+				count: members.length,
+				total,
+			});
+		},
+	},
+);
+
 API.v1.addRoute(
 	'groups.messages',
 	{ authRequired: true },

apps/meteor/app/api/server/v1/im.ts

@@ -339,7 +339,7 @@ API.v1.addRoute(
 
 			const searchFields = settings.get<string>('Accounts_SearchFields').trim().split(',');
 
-			const { cursor, totalCount } = Users.findPaginatedByActiveUsersExcept(filter, [], options, searchFields, [extraQuery]);
+			const { cursor, totalCount } = Users.findPaginatedByActiveUsersExcept(filter, [], searchFields, options, [extraQuery]);
 
 			const [members, total] = await Promise.all([cursor.toArray(), totalCount]);
 

apps/meteor/server/lib/findUsersOfRoom.ts

@@ -35,7 +35,7 @@ export function findUsersOfRoom({ rid, status, skip = 0, limit = 0, filter = '',
 
 	const searchFields = settings.get<string>('Accounts_SearchFields').trim().split(',');
 
-	return Users.findPaginatedByActiveUsersExcept(filter, undefined, options, searchFields, [
+	return Users.findPaginatedByActiveUsersExcept(filter, undefined, searchFields, options, [
 		{
 			__rooms: rid,
 			...(status && { status }),

apps/meteor/server/lib/findUsersOfRoomByHighestRole.ts

@@ -0,0 +1,81 @@
+import type { IUserWithRoleInfo, IUser, IRoom, UserStatus } from '@rocket.chat/core-typings';
+import { Users, Subscriptions } from '@rocket.chat/models';
+import type { Filter, FilterOperators, FindOptions } from 'mongodb';
+
+import { settings } from '../../app/settings/server';
+
+type FindUsersParam = {
+	rid: string;
+	status?: FilterOperators<UserStatus>;
+	skip?: number;
+	limit?: number;
+	filter?: string;
+	sort?: Record<string, any>;
+};
+
+export async function findUsersOfRoomByHighestRole({
+	rid,
+	status,
+	limit = 0,
+	filter = '',
+	sort,
+}: FindUsersParam): Promise<{ members: IUserWithRoleInfo[]; total: number }> {
+	const options: FindOptions<IUser> = {
+		projection: {
+			name: 1,
+			username: 1,
+			nickname: 1,
+			status: 1,
+			avatarETag: 1,
+			_updatedAt: 1,
+			federated: 1,
+			statusConnection: 1,
+		},
+		sort: {
+			statusConnection: -1 as const,
+			...(sort || { ...(settings.get('UI_Use_Real_Name') && { name: 1 }), username: 1 }),
+		},
+		limit,
+	};
+	const extraQuery: Filter<IUser & { __rooms: IRoom['_id'][] }> = {
+		__rooms: rid,
+		...(status && { status }),
+	};
+	const searchFields = settings.get<string>('Accounts_SearchFields').trim().split(',');
+
+	// Find highest roles members (owners and moderators)
+	const result = await Subscriptions.findPaginatedActiveHighestRoleUsers(filter, rid, searchFields, options, extraQuery);
+	const {
+		members: highestRolesMembers = [],
+		totalCount: totalMembersWithRoles = { total: 0 },
+		ids = { allMembersIds: [] },
+	} = result[0] || {};
+	const { total: totalMembersWithRolesCount } = totalMembersWithRoles;
+	const { allMembersIds: highestRolesMembersIds } = ids;
+
+	if (limit <= highestRolesMembers.length) {
+		const totalMembersCount = await Users.countActiveUsersExcept(filter, highestRolesMembersIds, searchFields, [extraQuery]);
+		return { members: highestRolesMembers, total: totalMembersWithRolesCount + totalMembersCount };
+	}
+	if (options.limit) {
+		options.limit -= highestRolesMembers.length;
+	}
+
+	// Find average members
+	const { cursor, totalCount } = Users.findPaginatedByActiveUsersExcept(filter, highestRolesMembersIds, searchFields, options, [
+		extraQuery,
+	]);
+	const [members, totalMembersCount] = await Promise.all([await cursor.toArray(), totalCount]);
+	const membersWithHighestRoles = members.map(
+		(member): IUserWithRoleInfo => ({
+			...member,
+			highestRole: {
+				role: 'member',
+				level: 2,
+			},
+		}),
+	);
+
+	const allMembers = highestRolesMembers.concat(membersWithHighestRoles);
+	return { members: allMembers, total: totalMembersWithRolesCount + totalMembersCount };
+}

apps/meteor/server/methods/browseChannels.ts

@@ -225,7 +225,7 @@ const findUsers = async ({
 		  };
 
 	if (workspace === 'all') {
-		const { cursor, totalCount } = Users.findPaginatedByActiveUsersExcept<FederatedUser>(text, [], options, searchFields);
+		const { cursor, totalCount } = Users.findPaginatedByActiveUsersExcept<FederatedUser>(text, [], searchFields, options);
 		const [results, total] = await Promise.all([cursor.toArray(), totalCount]);
 		return {
 			total,

apps/meteor/server/models/raw/Subscriptions.ts

@@ -4,6 +4,7 @@ import type {
 	IRoom,
 	ISubscription,
 	IUser,
+	IUserWithRoleInfo,
 	RocketChatRecordDeleted,
 	RoomType,
 	SpotlightUser,
@@ -460,6 +461,96 @@ export class SubscriptionsRaw extends BaseRaw<ISubscription> implements ISubscri
 			.toArray();
 	}
 
+	async findPaginatedActiveHighestRoleUsers(
+		searchTerm: string,
+		rid: IRoom['_id'],
+		searchFields: string[],
+		options: FindOptions<IUser> = {},
+		extraQuery?: Filter<IUser>,
+		{ startsWith = false, endsWith = false }: { startsWith?: string | false; endsWith?: string | false } = {},
+	): Promise<{ members: IUserWithRoleInfo[]; totalCount: { total: number }; ids: { allMembersIds: string[] } }[]> {
+		const termRegex = new RegExp((startsWith ? '^' : '') + escapeRegExp(searchTerm) + (endsWith ? '$' : ''), 'i');
+		const orStatement = (searchFields || []).map((el) => ({ [el.trim()]: termRegex })) as { [x: string]: RegExp }[];
+
+		const limit =
+			options.limit !== 0
+				? [
+						{
+							$limit: options.limit,
+						},
+				  ]
+				: [];
+
+		return this.col
+			.aggregate<{ members: IUserWithRoleInfo[]; totalCount: { total: number }; ids: { allMembersIds: string[] } }>(
+				[
+					{
+						$match: {
+							rid,
+							roles: { $in: ['owner', 'moderator'] },
+						},
+					},
+					{
+						$lookup: {
+							from: 'users',
+							as: 'user',
+							let: { id: '$u._id' },
+							pipeline: [
+								{
+									$match: {
+										$expr: { $eq: ['$_id', '$$id'] },
+										username: { $exists: true },
+										active: true,
+										...(searchTerm && orStatement.length > 0 && { $or: orStatement }),
+										...extraQuery,
+									},
+								},
+								{ $project: options.projection },
+							],
+						},
+					},
+					{
+						$unwind: {
+							path: '$user',
+						},
+					},
+					{
+						$addFields: {
+							'user.highestRole': {
+								$cond: [{ $in: ['owner', '$roles'] }, { role: 'owner', level: 0 }, { role: 'moderator', level: 1 }],
+							},
+						},
+					},
+					{
+						$replaceRoot: { newRoot: '$user' },
+					},
+					{
+						$facet: {
+							members: [
+								{
+									$sort: {
+										'highestRole.level': 1,
+										...(options.sort as object),
+									},
+								},
+								...limit,
+							],
+							ids: [{ $group: { _id: null, allMembersIds: { $push: '$_id' } } }],
+							totalCount: [{ $count: 'total' }],
+						},
+					},
+					{
+						$unwind: { path: '$totalCount' },
+					},
+					{
+						$unwind: { path: '$ids' },
+					},
+				],
+				{ allowDiskUse: true },
+			)
+			.toArray();
+	}
+
 	incUnreadForRoomIdExcludingUserIds(roomId: IRoom['_id'], userIds: IUser['_id'][], inc: number): Promise<UpdateResult | Document> {
 		if (inc == null) {
 			inc = 1;