refactor: Roles out of DB Watcher

[ricardogarim]

As per the updates mentioned in PROJ-7 SCA-4 and ADR #74, this pull request focuses on relocating Roles entity out of DB Watcher service.

Quick context to public readers

In essence, this modification empowers RocketChat's app to directly call listeners through the api.broadcast global function, eliminating the reliance on MongoDB Change Stream data propagation

Why is this beneficial? It provides better control over notifying users by enabling more precise use-case management. Unlike Change Streams, which notify every action on Mongo's documents and sometimes might result in unnecessary duplicate notifications. Moreover, it contributes to the future removal of the DB Watcher deployment, thereby optimizing resource utilization.

Proposed changes

Key changes include:

• Conditionally incorporating the Roles entity import within DB watchers on application startup based on the dbWatchersDisabled flag.
• Enabling support for roles.update and roles.create routes to directly trigger the watch.roles listener event, subject to the dbWatchersDisabled flag (please check above section of updated use cases).

Updated use cases.

Use Case	Route/Trigger	Notes
insertRole	POST api/v1/roles.create
updateRole	POST api/v1/roles.update
deleteRole	POST api/v1/roles.delete

I didn't find references to Meteor's method deleteRoom (apps/meteor/app/authorization/server/methods/deleteRole.ts) so I didn't add listener call there.

Steps to test or reproduce

1. Start RocketChat's application with the DISABLE_DB_WATCHERS flag set to true.
2. Perform a POST request to the endpoints api/v1/roles.create, api/v1/roles.update, or api/v1/roles.delete.
3. Observe the websocket events received. Each event should be of eventName roles, containing all changed fields as well as the updated role identification data.

Further comments

While further exploration might reveal additional use cases regarding DB operations and Roles entity interaction, it's important to note that certain events, such as startup events in RocketChat Enterprise Edition or server setup initiation, are not appropriate for notification via the Listener service. Therefore, they should not be linked to trigger an event through api.broadcast calls.

To maintain consistency and avoid potential regressions, event names and signatures have been kept unchanged on both the client and app sides. This decision streamlines efforts and mitigates the risk of unintended consequences. Additionally, considering time constraints and the absence of tests for this core server component, this direction was chosen as the most pragmatic approach.

Roles model WBS. Used to guide changes discovery.

🔄 Work in progress
✅ Done
➖ Not applicable

Function	Status
findByUpdatedDate	➖
addUserRoles	✅
isUserInRoles	✅
removeUserRoles	✅
findOneByIdOrName	➖
findOneByIdOrName	➖
findOneByIdOrName	➖
findOneByIdOrName	➖
findOneByName	➖
findInIds	➖
findInIdsOrNames	➖
findAllExceptIds	➖
findByScope	➖
updateById	✅
findUsersInRole	➖
findUsersInRole	➖
findUsersInRole	➖
findUsersInRole	➖
findCustomRoles	➖
createWithRandomId	✅
canAddUserToRole	➖

[changeset-bot]

⚠️ No Changeset found

Latest commit: 301e77e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

[dionisio-bot]

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.55%. Comparing base (5d1cb28) to head (301e77e).

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #32280      +/-   ##
===========================================
+ Coverage    55.52%   55.55%   +0.02%     
===========================================
  Files         2401     2404       +3     
  Lines        52860    52892      +32     
  Branches     10856    10862       +6     
===========================================
+ Hits         29352    29385      +33     
+ Misses       20907    20905       -2     
- Partials      2601     2602       +1     

Flag	Coverage Δ
e2e	54.84% <ø> (+0.06%)	⬆️
unit	73.49% <ø> (ø)

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