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

@@ -23,6 +23,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';
@@ -1044,6 +1045,52 @@ 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 { offset: skip, count: limit } = await getPaginationItems(this.queryParams);
+			const { sort = {} } = await this.parseJsonQuery();
+			const { status, filter } = this.queryParams;
+
+			const cursor = await findUsersOfRoomByHighestRole({
+				rid: findResult._id,
+				...(status && { status: { $in: status } }),
+				skip,
+				limit,
+				filter,
+				...(sort?.username && { sort: { username: sort.username } }),
+			});
+
+			const result = await cursor.toArray();
+			if (!result?.[0]) {
+				return API.v1.failure('No user info could be found for the channel provided');
+			}
+			const {
+				members,
+				totalCount: [{ total } = { total: 0 }],
+			} = result[0];
+
+			return API.v1.success({
+				members,
+				count: members.length,
+				offset: skip,
+				total,
+			});
+		},
+	},
+);
+
 API.v1.addRoute(
 	'channels.online',
 	{ authRequired: true },

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

@@ -6,6 +6,7 @@ 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';
@@ -738,6 +739,52 @@ 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 { offset: skip, count: limit } = await getPaginationItems(this.queryParams);
+			const { sort = {} } = await this.parseJsonQuery();
+			const { status, filter } = this.queryParams;
+
+			const cursor = await findUsersOfRoomByHighestRole({
+				rid: findResult.rid,
+				...(status && { status: { $in: status } }),
+				skip,
+				limit,
+				filter,
+				...(sort?.username && { sort: { username: sort.username } }),
+			});
+
+			const result = await cursor.toArray();
+			if (!result?.[0]) {
+				return API.v1.failure('No user info could be found for the group provided');
+			}
+			const {
+				members,
+				totalCount: [{ total } = { total: 0 }],
+			} = result[0];
+
+			return API.v1.success({
+				members,
+				count: members.length,
+				offset: skip,
+				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,50 @@
+import type { IUserWithRoleInfo } from '@rocket.chat/core-typings';
+import { Users } from '@rocket.chat/models';
+import type { AggregationCursor, FilterOperators } from 'mongodb';
+
+import { settings } from '../../app/settings/server';
+
+type FindUsersParam = {
+	rid: string;
+	status?: FilterOperators<string>;
+	skip?: number;
+	limit?: number;
+	filter?: string;
+	sort?: Record<string, any>;
+};
+
+export async function findUsersOfRoomByHighestRole({
+	rid,
+	status,
+	skip = 0,
+	limit = 0,
+	filter = '',
+	sort,
+}: FindUsersParam): Promise<AggregationCursor<{ members: IUserWithRoleInfo[]; totalCount: { total: number }[] }>> {
+	const options = {
+		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 }),
+		},
+		skip,
+		limit,
+	};
+
+	const searchFields = settings.get<string>('Accounts_SearchFields').trim().split(',');
+
+	return Users.findPaginatedActiveUsersByRoomIdWithHighestRole(filter, rid, searchFields, options, [
+		{
+			...(status && { status }),
+		},
+	]);
+}

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/Users.js

@@ -264,10 +264,7 @@ export class UsersRaw extends BaseRaw {
 
 		const termRegex = new RegExp((startsWith ? '^' : '') + escapeRegExp(searchTerm) + (endsWith ? '$' : ''), 'i');
 
-		const orStmt = (searchFields || []).reduce((acc, el) => {
-			acc.push({ [el.trim()]: termRegex });
-			return acc;
-		}, []);
+		const orStmt = (searchFields || []).map((el) => ({ [el.trim()]: termRegex }));
 
 		const query = {
 			$and: [
@@ -290,38 +287,33 @@ export class UsersRaw extends BaseRaw {
 	findPaginatedByActiveUsersExcept(
 		searchTerm,
 		exceptions,
-		options,
 		searchFields,
+		options = {},
 		extraQuery = [],
 		{ startsWith = false, endsWith = false } = {},
 	) {
 		if (exceptions == null) {
 			exceptions = [];
 		}
-		if (options == null) {
-			options = {};
-		}
 		if (!Array.isArray(exceptions)) {
 			exceptions = [exceptions];
 		}
 
-		const termRegex = new RegExp((startsWith ? '^' : '') + escapeRegExp(searchTerm) + (endsWith ? '$' : ''), 'i');
+		const regexString = (startsWith ? '^' : '') + escapeRegExp(searchTerm) + (endsWith ? '$' : '');
+		const termRegex = new RegExp(regexString, 'i');
 
-		const orStmt = (searchFields || []).reduce((acc, el) => {
-			acc.push({ [el.trim()]: termRegex });
-			return acc;
-		}, []);
+		const orStmt = (searchFields || []).map((el) => ({ [el.trim()]: termRegex }));
 
 		const query = {
 			$and: [
 				{
 					active: true,
 					username: {
 						$exists: true,
-						...(exceptions.length > 0 && { $nin: exceptions }),
+						...(exceptions.length && { $nin: exceptions }),
 					},
 					// if the search term is empty, don't need to have the $or statement (because it would be an empty regex)
-					...(searchTerm && orStmt.length > 0 && { $or: orStmt }),
+					...(searchTerm && orStmt.length && { $or: orStmt }),
 				},
 				...extraQuery,
 			],
@@ -330,18 +322,121 @@ export class UsersRaw extends BaseRaw {
 		return this.findPaginated(query, options);
 	}
 
+	findPaginatedActiveUsersByRoomIdWithHighestRole(
+		searchTerm,
+		rid,
+		searchFields,
+		options = {},
+		extraQuery = [],
+		{ startsWith = false, endsWith = false } = {},
+	) {
+		const regexString = (startsWith ? '^' : '') + escapeRegExp(searchTerm) + (endsWith ? '$' : '');
+		const termRegex = new RegExp(regexString, 'i');
+
+		const orStmt = (searchFields || []).map((el) => ({ [el.trim()]: termRegex }));
+
+		const query = {
+			$and: [
+				{
+					active: true,
+					__rooms: rid,
+					username: { $exists: true },
+					// if the search term is empty, don't need to have the $or statement (because it would be an empty regex)
+					...(searchTerm && orStmt.length && { $or: orStmt }),
+				},
+				...extraQuery,
+			],
+		};
+
+		const skip =
+			options.skip !== 0
+				? [
+						{
+							$skip: options.skip,
+						},
+				  ]
+				: [];
+
+		const limit =
+			options.limit !== 0
+				? [
+						{
+							$limit: options.limit,
+						},
+				  ]
+				: [];
+
+		return this.col.aggregate(
+			[
+				{
+					$match: query,
+				},
+				{
+					$lookup: {
+						from: 'rocketchat_subscription',
+						let: { id: '$_id' },
+						as: 'sub',
+						pipeline: [
+							{
+								$match: {
+									$expr: {
+										$and: [{ $eq: ['$u._id', '$$id'] }, { $eq: ['$rid', rid] }],
+									},
+								},
+							},
+						],
+					},
+				},
+				{ $unwind: '$sub' },
+				{
+					$project: {
+						...options.projection,
+						roomRoles: { $ifNull: ['$sub.roles', []] },
+					},
+				},
+				{
+					$addFields: {
+						highestRole: {
+							$cond: [
+								{ $in: ['owner', '$roomRoles'] },
+								{ role: 'owner', level: 0 },
+								{ $cond: [{ $in: ['moderator', '$roomRoles'] }, { role: 'moderator', level: 1 }, { role: 'member', level: 2 }] },
+							],
+						},
+					},
+				},
+				{
+					$facet: {
+						members: [
+							{
+								$sort: {
+									'highestRole.level': 1,
+									...options.sort,
+								},
+							},
+							...skip,
+							...limit,
+						],
+						totalCount: [{ $group: { _id: null, total: { $sum: 1 } } }],
+					},
+				},
+			],
+			{ allowDiskUse: true },
+		);
+	}
+
 	findPaginatedByActiveLocalUsersExcept(searchTerm, exceptions, options, forcedSearchFields, localDomain) {
 		const extraQuery = [
 			{
 				$or: [{ federation: { $exists: false } }, { 'federation.origin': localDomain }],
 			},
 		];
-		return this.findPaginatedByActiveUsersExcept(searchTerm, exceptions, options, forcedSearchFields, extraQuery);
+		return this.findPaginatedByActiveUsersExcept(searchTerm, exceptions, forcedSearchFields, options, extraQuery);
 	}
 
 	findPaginatedByActiveExternalUsersExcept(searchTerm, exceptions, options, forcedSearchFields, localDomain) {
 		const extraQuery = [{ federation: { $exists: true } }, { 'federation.origin': { $ne: localDomain } }];
-		return this.findPaginatedByActiveUsersExcept(searchTerm, exceptions, options, forcedSearchFields, extraQuery);
+		return this.findPaginatedByActiveUsersExcept(searchTerm, exceptions, forcedSearchFields, options, extraQuery);
 	}
 
 	findActive(query, options = {}) {