chore: Remove Omnichannel tech debt - 1 #35799

KevLehman · 2025-04-14T16:31:31Z

Proposed changes (including videos or screenshots)

Issue(s)

https://rocketchat.atlassian.net/browse/CTZ-47

Steps to test or reproduce

Further comments

This pull request focuses on addressing various TODOs and refactoring efforts within the Omnichannel component of the Rocket.Chat project. Key changes include:

Refactoring and Optimization:
- Refactored the GET and DELETE endpoints for livechat users to streamline user fetching and removal processes.
- Updated visitor deletion logic to include a token parameter.
- Improved QueueManager class for better department online status checking and model imports.
- Enhanced livechat department management with new helper functions and centralized logic into hooks.
- Improved livechat guest management functions for cleaner data updates and optimized database queries.
- Refactored hooks to handle department status changes and notify listeners.
- Simplified offline email sending logic and guest alias addition in messages.
- Updated livechat user management functions for consistency and improved typing.
Interface and Model Enhancements:
- Added new method signatures to the ILivechatDepartmentModel and ILivechatRoomsModel interfaces for enhanced flexibility and type safety.
- Introduced a new method to the ILivechatVisitorsModel interface for updating visitor departments.
- Refined the IUsersModel interface by removing deprecated methods and adding new role-related functionality.
Performance Improvements:
- Replaced sequential await calls with Promise.all for concurrent execution in department fallback logic.
- Modified room retrieval logic in the sendTranscript function for potential performance gains.
Code Organization and Maintainability:
- Introduced changes to improve code organization, maintainability, and type safety across various components.
- Identified potential issues in visitor validation and user ID usage in specific functions.

Overall, this pull request aims to enhance the functionality, performance, and maintainability of the Omnichannel component by addressing existing TODOs and implementing significant refactoring efforts.

This pull request focuses on addressing various TODOs and refactoring tasks within the Omnichannel component of the Rocket.Chat project. Key changes include:

API and Logic Enhancements:
- Refactored the API route handling for livechat users to improve logic for fetching and deleting users by type.
- Modified visitor deletion logic to include the token parameter, enhancing the robustness of the process.
Code Refactoring and Optimization:
- Improved import statements in QueueManager.ts and refactored department management functions for better maintainability and performance.
- Enhanced type safety and refactored functions in guests.ts, messages.ts, and sendTranscript.ts for improved readability and efficiency.
- Updated error handling and user role management in omni-users.ts.
Concurrency and Efficiency Improvements:
- Utilized Promise.all for concurrent operations in beforeRoutingChat.ts and guests.ts, optimizing asynchronous processes.
Model and Interface Updates:
- Added new methods to various models, including ILivechatDepartmentModel, ILivechatRoomsModel, ILivechatVisitorsModel, and IUsersModel, to enhance query capabilities and refine role-based queries.
- Removed redundant methods and improved type safety in model interfaces.
Miscellaneous:
- Added a TODO comment for future AJV validation implementation in the department agents route.

These changes aim to improve code maintainability, performance, and functionality within the Omnichannel component.

This pull request, titled "chore: Fix some TODOs from Omnichannel - 1," targets the develop branch from the chore/todo branch in the RocketChat/Rocket.Chat repository. The changes focus on refactoring and improving various aspects of the Omnichannel feature set.

Key updates include:

API and Logic Enhancements:
- Refactored the API route for livechat users to enhance the logic for fetching and deleting users by type.
- Updated visitor deletion logic to include the token parameter, improving robustness.
- Simplified department assignment logic for guests by removing redundant database calls.
Code Refactoring and Optimization:
- Refactored several livechat server library functions for better readability, performance, and type safety.
- Improved error handling by replacing 'Meteor.Error' with 'Error' and updated user role management.
- Modified import statements and refactored functions to streamline processes and improve efficiency.
Interface and Model Updates:
- Added new methods to interfaces and models to enhance department and user query capabilities.
- Introduced options parameters to certain methods for improved flexibility and type safety.
- Removed unused methods and refined user role management functionality.
Miscellaneous Improvements:
- Introduced new functions for handling live chat department archiving and unarchiving.
- Refactored the sendOfflineMessage function to use the Mailer.send method directly.
- Added TODO comments for future improvements, such as using AJV validation in permissionsRequired sections.

These changes collectively aim to enhance the functionality, efficiency, and maintainability of the Omnichannel features within the Rocket.Chat application.

dionisio-bot · 2025-04-14T16:31:35Z

Looks like this PR is not ready to merge, because of the following issues:

This PR is targeting the wrong base branch. It should target 7.7.0, but it targets 7.6.0

Please fix the issues and try again

If you have any trouble, please check the PR guidelines

github-actions · 2025-04-14T16:40:40Z

PR Preview Action v1.6.1
🚀 View preview at https://RocketChat.github.io/Rocket.Chat/pr-preview/pr-35799/
Built to branch `gh-pages` at 2025-04-23 20:51 UTC. Preview will be ready when the GitHub Pages deployment is complete.

changeset-bot · 2025-04-14T16:56:59Z

⚠️ No Changeset found

Latest commit: bfe5f82

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

codecov · 2025-04-14T17:10:57Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.19%. Comparing base (6429534) to head (bfe5f82).
Report is 1 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #35799      +/-   ##
===========================================
+ Coverage    61.17%   61.19%   +0.01%     
===========================================
  Files         3005     3153     +148     
  Lines        71387    74358    +2971     
  Branches     16342    16610     +268     
===========================================
+ Hits         43670    45500    +1830     
- Misses       24748    25808    +1060     
- Partials      2969     3050      +81

Flag	Coverage Δ
e2e	`57.87% <ø> (-0.01%)`	⬇️
unit	`75.00% <100.00%> (-0.01%)`	⬇️

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

kody-ai · 2025-04-14T18:17:30Z

Code Review Completed! 🔥

The code review was successfully completed based on your current configurations.

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

apps/meteor/app/livechat/imports/server/rest/departments.ts

apps/meteor/app/livechat/server/api/v1/visitor.ts

apps/meteor/app/livechat/server/lib/omni-users.ts

apps/meteor/app/livechat/imports/server/rest/departments.ts

apps/meteor/app/livechat/server/api/v1/visitor.ts

apps/meteor/ee/app/livechat-enterprise/server/hooks/beforeRoutingChat.ts

packages/models/src/models/LivechatDepartment.ts

kody-ai · 2025-04-14T18:50:41Z

Code Review Completed! 🔥

The code review was successfully completed based on your current configurations.

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

apps/meteor/ee/app/livechat-enterprise/server/hooks/beforeRoutingChat.ts

packages/models/src/models/LivechatVisitors.ts

packages/model-typings/src/models/IUsersModel.ts

apps/meteor/ee/app/livechat-enterprise/server/hooks/beforeRoutingChat.ts

packages/models/src/models/LivechatDepartment.ts

kody-ai · 2025-04-14T19:10:46Z

Kody Review Complete

Great news! 🎉
No issues were found that match your current review configurations.

Keep up the excellent work! 🚀

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

kody-ai · 2025-04-14T19:31:56Z

Kody Review Complete

Great news! 🎉
No issues were found that match your current review configurations.

Keep up the excellent work! 🚀

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

kody-ai · 2025-04-14T20:37:17Z

Kody Review Complete

Great news! 🎉
No issues were found that match your current review configurations.

Keep up the excellent work! 🚀

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

apps/meteor/app/livechat/imports/server/rest/departments.ts

apps/meteor/app/livechat/server/lib/departmentsLib.ts

apps/meteor/app/livechat/server/lib/guests.ts

apps/meteor/app/livechat/server/lib/hooks.ts

apps/meteor/app/livechat/server/lib/messages.ts

apps/meteor/app/livechat/server/lib/omni-users.ts

apps/meteor/app/livechat/server/lib/sendTranscript.ts

KevLehman added 5 commits April 14, 2025 08:39

todo-1

82520b5

optimize a bit getRequiredDep

5daf86f

projections

f5b7c9a

fixes

6124922

optimize findonline

8f84075

improve

b680a77

fix test

11e4e77

KevLehman added 3 commits April 14, 2025 11:38

fix test

eb9812b

improve

bf2416d

remove meteor.error usage

7f2211b

test

d235135