refactor: PbxEvents out of DB Watcher

[ricardogarim]

As per the updates mentioned in PROJ-7 SCA-4 and ADR #74, this pull request focuses on relocating PbxEvent 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 PbxEvent entity import within DB watchers on application startup based on the dbWatchersDisabled flag.
• Enabling support for the following use cases to directly trigger watch.pbxevents listener event, subject to the dbWatchersDisabled flag.

Updated use cases.

Use Case	Route/Trigger	Notes
manageDialEvents
storePbxEvent

Steps to test or reproduce

1. Start RocketChat's application with the DISABLE_DB_WATCHERS flag set to true.
2. Start or end a VOIP call to pass through the events. As an agent, you should be able to observe the status and details of the call seamlessly, without any discernible difference from when it's within the DB watcher version.

Further comments

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.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 939dbc6

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

Attention: Patch coverage is 12.50000% with 7 lines in your changes are missing coverage. Please review.

Project coverage is 55.56%. Comparing base (2671a21) to head (939dbc6).

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #32372      +/-   ##
===========================================
+ Coverage    55.55%   55.56%   +0.01%     
===========================================
  Files         2397     2401       +4     
  Lines        52789    52845      +56     
  Branches     10851    10861      +10     
===========================================
+ Hits         29325    29362      +37     
- Misses       20865    20882      +17     
- Partials      2599     2601       +2     

Flag	Coverage Δ
e2e	54.87% <ø> (+0.02%)	⬆️
unit	73.37% <12.50%> (-0.03%)	⬇️

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