Merge branch 'feat/add-endpoints-groups.membersOrderedByRole-channels.membersOrderedByRole' into feat/members-virtuoso-group

Author: MartinSchoeler

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

@@ -1,5 +1,6 @@
 import { Media, Team } from '@rocket.chat/core-services';
 import type { IRoom, IUpload } from '@rocket.chat/core-typings';
+import { isPrivateRoom, isPublicRoom } from '@rocket.chat/core-typings';
 import { Messages, Rooms, Users, Uploads, Subscriptions } from '@rocket.chat/models';
 import type { Notifications } from '@rocket.chat/rest-typings';
 import {
@@ -874,7 +875,7 @@ API.v1.addRoute(
 				return API.v1.notFound('The required "roomId" or "roomName" param provided does not match any room');
 			}
 
-			if (findResult.t !== 'c' && findResult.t !== 'p') {
+			if (!isPublicRoom(findResult) && !isPrivateRoom(findResult)) {
 				return API.v1.failure('error-room-type-not-supported');
 			}
 

apps/meteor/app/lib/server/functions/syncRolePrioritiesForRoomIfRequired.ts

@@ -1,21 +1,15 @@
-import type { IRole, IRoom, IUser } from '@rocket.chat/core-typings';
-import { ROOM_ROLE_PRIORITY_MAP } from '@rocket.chat/core-typings';
+import type { IRoom, IUser } from '@rocket.chat/core-typings';
 import { Subscriptions, Users, Rooms } from '@rocket.chat/models';
 
-export const getRoomRolePriorityForRole = (role: IRole['_id']) =>
-	(ROOM_ROLE_PRIORITY_MAP as { [key: IRole['_id']]: number })[role] ?? ROOM_ROLE_PRIORITY_MAP.default;
-
-export const calculateRoomRolePriorityFromRoles = (roles: IRole['_id'][]) => {
-	return roles.reduce((acc, roleId) => Math.min(acc, getRoomRolePriorityForRole(roleId)), ROOM_ROLE_PRIORITY_MAP.default);
-};
+import { calculateRoomRolePriorityFromRoles } from '../../../../server/lib/roles/syncRoomRolePriority';
 
 const READ_BATCH_SIZE = 1000;
 
-async function assignRoomRolePrioritiesFromMap(userIdAndroomRolePrioritiesMap: Map<IUser['_id'], IUser['roomRolePriorities']>) {
+async function assignRoomRolePrioritiesFromMap(userIdAndRoomRolePrioritiesMap: Map<IUser['_id'], IUser['roomRolePriorities']>) {
 	const bulk = Users.col.initializeUnorderedBulkOp();
 
-	for await (const [userId, roomRolePriorities] of userIdAndroomRolePrioritiesMap.entries()) {
-		userIdAndroomRolePrioritiesMap.delete(userId);
+	for await (const [userId, roomRolePriorities] of userIdAndRoomRolePrioritiesMap.entries()) {
+		userIdAndRoomRolePrioritiesMap.delete(userId);
 
 		if (roomRolePriorities) {
 			const updateFields = Object.entries(roomRolePriorities).reduce(
@@ -39,7 +33,7 @@ async function assignRoomRolePrioritiesFromMap(userIdAndroomRolePrioritiesMap: M
 }
 
 export const syncRolePrioritiesForRoomIfRequired = async (rid: IRoom['_id']) => {
-	const userIdAndroomRolePrioritiesMap = new Map<IUser['_id'], IUser['roomRolePriorities']>();
+	const userIdAndRoomRolePrioritiesMap = new Map<IUser['_id'], IUser['roomRolePriorities']>();
 
 	if (await Rooms.hasCreatedRolePrioritiesForRoom(rid)) {
 		return;
@@ -62,13 +56,13 @@ export const syncRolePrioritiesForRoomIfRequired = async (rid: IRoom['_id']) =>
 		const roomId = sub.rid;
 		const priority = calculateRoomRolePriorityFromRoles(sub.roles);
 
-		const existingPriorities = userIdAndroomRolePrioritiesMap.get(userId) || {};
+		const existingPriorities = userIdAndRoomRolePrioritiesMap.get(userId) || {};
 		existingPriorities[roomId] = priority;
-		userIdAndroomRolePrioritiesMap.set(userId, existingPriorities);
+		userIdAndRoomRolePrioritiesMap.set(userId, existingPriorities);
 	}
 
 	// Flush any remaining priorities in the map
-	await assignRoomRolePrioritiesFromMap(userIdAndroomRolePrioritiesMap);
+	await assignRoomRolePrioritiesFromMap(userIdAndRoomRolePrioritiesMap);
 
 	await Rooms.markRolePrioritesCreatedForRoom(rid);
 };

apps/meteor/server/lib/findUsersOfRoomOrderedByRole.ts

@@ -39,9 +39,11 @@ export async function findUsersOfRoomOrderedByRole({
 	const sortCriteria = {
 		rolePriority: rolePrioritySort ?? 1,
 		statusConnection: -1,
-		...(usernameSort ?? {
-			...(settings.get('UI_Use_Real_Name') ? { name: 1 } : { username: 1 }),
-		}),
+		...(usernameSort
+			? { username: usernameSort }
+			: {
+					...(settings.get('UI_Use_Real_Name') ? { name: 1 } : { username: 1 }),
+				}),
 	};
 
 	const matchUserFilter = {

apps/meteor/tests/data/roles.helper.ts

@@ -0,0 +1,42 @@
+import type { Credentials } from '@rocket.chat/api-client';
+import type { IRole } from '@rocket.chat/core-typings';
+
+import { api, credentials, request } from './api-data';
+
+export const createCustomRole = async ({
+	name,
+	scope,
+	description,
+	credentials: customCredentials,
+}: Pick<IRole, 'name' | 'scope' | 'description'> & { credentials?: Credentials }) => {
+	const response = await request
+		.post(api('roles.create'))
+		.set(customCredentials || credentials)
+		.send({ name, scope, description });
+	console.log(response.body);
+	return response.body.role as IRole;
+};
+
+export const deleteCustomRole = async ({ roleId, credentials: customCredentials }: { roleId: IRole['_id']; credentials?: Credentials }) => {
+	const response = await request
+		.post(api('roles.delete'))
+		.set(customCredentials || credentials)
+		.send({ roleId });
+	return response.body.success as boolean;
+};
+
+export const assignRoleToUser = async ({
+	username,
+	roleId,
+	credentials: customCredentials,
+}: {
+	username: string;
+	roleId: string;
+	credentials?: Credentials;
+}) => {
+	const response = await request
+		.post(api('roles.addUserToRole'))
+		.set(customCredentials || credentials)
+		.send({ username, roleId });
+	return response.body.success as boolean;
+};

apps/meteor/tests/end-to-end/api/rooms.ts

@@ -2,7 +2,7 @@ import fs from 'fs';
 import path from 'path';
 
 import type { Credentials } from '@rocket.chat/api-client';
-import type { IMessage, IRoom, ITeam, IUpload, IUser, ImageAttachmentProps, SettingValue } from '@rocket.chat/core-typings';
+import type { IMessage, IRole, IRoom, ITeam, IUpload, IUser, ImageAttachmentProps, SettingValue } from '@rocket.chat/core-typings';
 import { TEAM_TYPE } from '@rocket.chat/core-typings';
 import { Random } from '@rocket.chat/random';
 import { assert, expect } from 'chai';
@@ -13,6 +13,7 @@ import { getCredentials, api, request, credentials } from '../../data/api-data';
 import { sendSimpleMessage, deleteMessage } from '../../data/chat.helper';
 import { imgURL } from '../../data/interactions';
 import { getSettingValueById, updateEEPermission, updatePermission, updateSetting } from '../../data/permissions.helper';
+import { assignRoleToUser, createCustomRole, deleteCustomRole } from '../../data/roles.helper';
 import { createRoom, deleteRoom } from '../../data/rooms.helper';
 import { createTeam, deleteTeam } from '../../data/teams.helper';
 import { password } from '../../data/user';
@@ -3637,11 +3638,14 @@ describe('[Rooms]', () => {
 	});
 
 	describe('[/rooms.membersOrderedByRole]', () => {
+		const isEnterprise = Boolean(process.env.IS_EE);
+
 		let testChannel: IRoom;
 		let ownerUser: IUser;
 		let moderatorUser: IUser;
 		let memberUser1: IUser;
 		let memberUser2: IUser;
+		let customRole: IRole;
 
 		let ownerCredentials: { 'X-Auth-Token': string; 'X-User-Id': string };
 
@@ -3655,6 +3659,12 @@ describe('[Rooms]', () => {
 
 			ownerCredentials = await login(ownerUser.username, password);
 
+			customRole = await createCustomRole({
+				name: `customRole.${Random.id()}`,
+				scope: 'Subscriptions',
+				description: 'Custom Role',
+			});
+
 			// Create a public channel
 			const roomCreationResponse = await createRoom({
 				type: 'c',
@@ -3689,6 +3699,7 @@ describe('[Rooms]', () => {
 		after(async () => {
 			await deleteRoom({ type: 'c', roomId: testChannel._id });
 			await Promise.all([ownerUser, moderatorUser, memberUser1, memberUser2].map((user) => deleteUser(user)));
+			await deleteCustomRole({ roleId: customRole._id });
 		});
 
 		it('should return a list of members ordered by owner, moderator, then members by default', async () => {
@@ -3808,6 +3819,33 @@ describe('[Rooms]', () => {
 			expect(usernames).to.deep.equal(expected);
 		});
 
+		it('should not be affected by custom roles when sorting', async () => {
+			if (!isEnterprise) {
+				return;
+			}
+			await Promise.all([
+				assignRoleToUser({ username: moderatorUser.username as string, roleId: customRole._id }),
+				assignRoleToUser({ username: memberUser2.username as string, roleId: customRole._id }),
+			]);
+
+			const response = await request
+				.get(api('rooms.membersOrderedByRole'))
+				.set(credentials)
+				.query({
+					roomId: testChannel._id,
+				})
+				.expect('Content-Type', 'application/json')
+				.expect(200);
+
+			expect(response.body).to.have.property('success', true);
+			const [first, second, third, fourth] = response.body.members;
+
+			expect(first.username).to.equal(ownerUser.username);
+			expect(second.username).to.equal(moderatorUser.username);
+			expect(third.username).to.equal(memberUser1.username);
+			expect(fourth.username).to.equal(memberUser2.username);
+		});
+
 		describe('Additional Visibility Tests', () => {
 			let outsiderUser: IUser;
 			let insideUser: IUser;