-
Notifications
You must be signed in to change notification settings - Fork 13k
chore: adds deprecation warning on livechat:setupConnection
#37218
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
Conversation
|
Looks like this PR is ready to merge! 🎉 |
🦋 Changeset detectedLatest commit: 40974a8 The changes in this PR will be included in the next version bump. This PR includes changesets to release 42 packages
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 |
WalkthroughAdds deprecation warnings for the livechat:setupConnection method in Meteor and DDP Streamer code paths and introduces a changeset patch for @rocket.chat/meteor and @rocket.chat/ddp-streamer. No public API signatures changed and runtime behavior remains unchanged beyond logging. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant C as Client
participant M as Meteor Method<br/>livechat:setupConnection
participant L as Deprecation Logger
participant D as DDP Streamer Server
C->>M: call livechat:setupConnection(params)
M->>L: log deprecation (methodDeprecationLogger)
Note right of L: Deprecation recorded
M->>D: continue existing setup/token handling
D-->>M: result (behavior unchanged)
M-->>C: response
Note over D: Also emits `console.warn` on invocation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (5 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro Disabled knowledge base sources:
📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
livechat:setupConnectionlivechat:setupConnection
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #37218 +/- ##
===========================================
+ Coverage 67.58% 67.59% +0.01%
===========================================
Files 3295 3295
Lines 112648 112648
Branches 20455 20480 +25
===========================================
+ Hits 76137 76150 +13
+ Misses 33841 33824 -17
- Partials 2670 2674 +4
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
🧹 Nitpick comments (1)
ee/apps/ddp-streamer/src/configureServer.ts (1)
142-142: Inconsistent deprecation mechanism and version format.While the method name is correct here, there are inconsistencies with the Meteor implementation:
- Version format: This uses
v8.0.0while the Meteor file uses8.0.0(without the 'v' prefix).- Deprecation mechanism: This uses
console.warnwhile the Meteor file usesmethodDeprecationLogger, which provides structured logging.Consider aligning both for consistency.
Apply this diff to align with the Meteor implementation:
- console.warn('Warning: Method livechat:setUpConnection is deprecated and will be removed on v8.0.0'); + console.warn('Warning: Method livechat:setUpConnection is deprecated and will be removed in 8.0.0');Alternatively, if structured logging is available in this context, consider using it instead of
console.warnto match the Meteor implementation.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (3)
.changeset/chilled-chicken-drop.md(1 hunks)apps/meteor/app/livechat/server/methods/setUpConnection.ts(2 hunks)ee/apps/ddp-streamer/src/configureServer.ts(1 hunks)
🔇 Additional comments (1)
apps/meteor/app/livechat/server/methods/setUpConnection.ts (1)
6-6: LGTM!The import of
methodDeprecationLoggeris appropriate for structured deprecation warnings.
Proposed changes (including videos or screenshots)
This PR adds a deprecation warning for
livechat:setupConnection.Issue(s)
CORE-1407
Steps to test or reproduce
Further comments
Summary by CodeRabbit