Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: LivechatPriority out of DB Watcher #32362

Merged
merged 7 commits into from May 16, 2024

Conversation

ricardogarim
Copy link
Contributor

@ricardogarim ricardogarim commented May 2, 2024

As per the updates mentioned in PROJ-7 SCA-4 and ADR #74, this pull request focuses on relocating LivechatPriority 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 LivechatPriority entity import within DB watchers on application startup based on the dbWatchersDisabled flag.
  • Enabling support for the following use cases to directly trigger watch.priorities listener event, subject to the dbWatchersDisabled flag.
  • Changed resetPriorities method response to comply with same name use case needs (POST route to livechat/priorities.reset). I found appropriate to update raw method since there is just one calling origin.

Also, found some createDefaultPriorities actions but didn't refactored it since it is a startup event.

Updated use cases.
Use Case Route/Trigger Notes
updatePriority Route PUT livechat/priorities/:priorityId
resetPriorities Route POST livechat/priorities.reset

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 above given endpoints available on updated use cases.
  3. Observe websocket received events. Related events should be of eventName: omnichannel.priority-changed, containing all changed fields as well as the updated priority identification data.

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.

LivechatPriority model WBS. Used to guide changes discovery.
🔄 Work in progress
✅ Done
➖ Not applicable

Function Status
findOneByIdOrName
findOneNameUsingRegex
canResetPriorities
resetPriorities
updatePriority

Copy link
Contributor

dionisio-bot bot commented May 2, 2024

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

Copy link

changeset-bot bot commented May 2, 2024

⚠️ No Changeset found

Latest commit: 6a5ac3b

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

Copy link

codecov bot commented May 2, 2024

Codecov Report

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

Project coverage is 55.76%. Comparing base (3ed5bda) to head (6a5ac3b).

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop   #32362      +/-   ##
===========================================
+ Coverage    55.75%   55.76%   +0.01%     
===========================================
  Files         2413     2413              
  Lines        53180    53186       +6     
  Branches     10932    10934       +2     
===========================================
+ Hits         29649    29659      +10     
- Misses       20908    20909       +1     
+ Partials      2623     2618       -5     
Flag Coverage Δ
e2e 55.05% <ø> (+<0.01%) ⬆️
unit 72.84% <0.00%> (+0.04%) ⬆️

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

@ricardogarim ricardogarim force-pushed the refactor/livechat-priority-out-of-db-watcher branch from 83a02e4 to e6e7cbc Compare May 15, 2024 16:42
@ricardogarim ricardogarim marked this pull request as ready for review May 15, 2024 17:21
@ricardogarim ricardogarim requested review from a team as code owners May 15, 2024 17:21
sampaiodiego
sampaiodiego previously approved these changes May 16, 2024
@sampaiodiego sampaiodiego added this to the 6.9 milestone May 16, 2024
@sampaiodiego sampaiodiego added the stat: QA assured Means it has been tested and approved by a company insider label May 16, 2024
@dionisio-bot dionisio-bot bot added the stat: ready to merge PR tested and approved waiting for merge label May 16, 2024
@kodiakhq kodiakhq bot merged commit fb6d9eb into develop May 16, 2024
48 checks passed
@kodiakhq kodiakhq bot deleted the refactor/livechat-priority-out-of-db-watcher branch May 16, 2024 15:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stat: QA assured Means it has been tested and approved by a company insider stat: ready to merge PR tested and approved waiting for merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants