feat: add endpoint rooms.membersOrderedByRole

[abhinavkrin]

Proposed changes (including videos or screenshots)

Adds groups.membersOrderedByRole and channels.membersOrderedByRole endpoints to retrieve members of groups and channels sorted according to their respective role in the room.
This will help in grouping of users according to their roles in the room like below.

The endpoint works similar as groups.members and channels.members, but accepts an optional rolesOrder[] param which can be used for defining roles order while sorting. The index of the role will signify its priority. By default, owner > moderator > rest of members.

The endpoint works similar as groups.members and channels.members, but sorts the members according to their role in the room. Owners > moderators > all other members. This can be reversed using sort={"rolePriority":-1}.

The changes introduces an additional field roomRolePriorities to user collection. It will store the roomId and rolePriority score mapping which will be helpful in bringing down the sort time when there are a large number of users in a room.

This PR also adds a migration to assign the roomRolePriority to already existing room members
I have adopted a soft migration approach, as we only include migrations during breaking changes. In the endpoint, we first check whether the role priorities for the room have already been created. If not, we proceed to create them. For subsequent calls, this process is skipped.

I conducted performance testing using a room with 30,000 owners and moderators and a total of 100,000 members. The first call took approximately ~1 second, while subsequent calls were as fast as the channels.members endpoint. In most practical cases, where room sizes are smaller, the response time is significantly shorter.

A sample request

curl --location 'http://localhost:3000/api/v1/rooms.membersOrderedByRole?roomName=general' \
--header 'X-Auth-Token: aeqK4p8Z8a-FQy8HiI0MIO3zcg4aHZX2vy6AHSpdvoi' \
--header 'X-User-Id: u29m4aQNjZujdE4r5' \
--data ''

Issue(s)

Steps to test or reproduce

Further comments

CORE-846

[dionisio-bot]

Looks like this PR is ready to merge! 🎉
If you have any trouble, please check the PR guidelines

[changeset-bot]

🦋 Changeset detected

Latest commit: dbe0674

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 37 packages

Name	Type
@rocket.chat/i18n	Minor
@rocket.chat/meteor	Minor
@rocket.chat/rest-typings	Minor
@rocket.chat/mock-providers	Patch
@rocket.chat/ui-contexts	Major
@rocket.chat/web-ui-registration	Major
@rocket.chat/api-client	Patch
@rocket.chat/core-services	Patch
@rocket.chat/ddp-client	Patch
@rocket.chat/models	Patch
@rocket.chat/account-service	Patch
@rocket.chat/authorization-service	Patch
@rocket.chat/ddp-streamer	Patch
@rocket.chat/stream-hub-service	Patch
@rocket.chat/omnichannel-services	Patch
@rocket.chat/presence	Patch
rocketchat-services	Patch
@rocket.chat/fuselage-ui-kit	Major
@rocket.chat/ui-client	Major
@rocket.chat/ui-voip	Major
@rocket.chat/uikit-playground	Patch
@rocket.chat/gazzodown	Major
@rocket.chat/livechat	Patch
@rocket.chat/ui-avatar	Major
@rocket.chat/ui-video-conf	Major
@rocket.chat/omnichannel-transcript	Patch
@rocket.chat/presence-service	Patch
@rocket.chat/queue-worker	Patch
@rocket.chat/network-broker	Patch
@rocket.chat/cron	Patch
@rocket.chat/instance-status	Patch
@rocket.chat/core-typings	Minor
@rocket.chat/apps	Patch
@rocket.chat/freeswitch	Patch
@rocket.chat/model-typings	Patch
@rocket.chat/license	Patch
@rocket.chat/pdf-worker	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[github-actions]

PR Preview Action v1.6.0
🚀 View preview at https://RocketChat.github.io/Rocket.Chat/pr-preview/pr-34153/
Built to branch gh-pages at 2025-01-17 20:20 UTC. Preview will be ready when the GitHub Pages deployment is complete.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.18%. Comparing base (3c237b2) to head (dbe0674).
Report is 1 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #34153      +/-   ##
===========================================
- Coverage    59.18%   59.18%   -0.01%     
===========================================
  Files         2819     2819              
  Lines        67717    67716       -1     
  Branches     15080    15080              
===========================================
- Hits         40077    40076       -1     
  Misses       24818    24818              
  Partials      2822     2822              

Flag	Coverage Δ
unit	75.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

[MarcosSpessatto]

I think we could create a rooms.membersOrderedByRole instead of creating one for each room type.

Also, we need to create some mock data to test the aggregation part and its performance.
@ricardogarim can you help us with that.

[MarcosSpessatto]

It looks good to me, we just need to do some perf tests with some fake data to ensure the query perf

[MartinSchoeler]

Hey, it seems that the total property is missing from the endpoint result

(Old Members Endpoint)

(New Members Endpoint)