fix(realtime): add explicit REST API broadcast method #818
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit ports the feature from supabase-js PR #1749 which adds an explicit `postSend()` method for sending broadcast messages via REST API, addressing the issue where users may unknowingly use REST fallback when WebSocket is not connected. Changes: - Add `postSend()` method to RealtimeChannelV2 for explicit REST delivery - Add deprecation warning to `broadcast()` when falling back to REST - Add comprehensive test coverage for the new method - Support custom timeout parameter for REST requests - Include proper error handling and status code validation The `postSend()` method always uses the REST API endpoint regardless of WebSocket connection state, making it clear to developers when they are using REST vs WebSocket delivery. Ref: supabase/supabase-js#1749 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Rename the explicit REST API broadcast method from postSend to httpSend to better align with naming conventions. Changes: - Rename postSend() to httpSend() in RealtimeChannelV2 - Update all test names from testPostSend to testHttpSend - Update deprecation warning to reference httpSend() - Update error messages to reference httpSend() All tests continue to pass. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Pull Request Test Coverage Report for Build 18382895627Details
💛 - Coveralls |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🔍 Description
This PR ports the feature from supabase-js#1749 which adds an explicit REST API method for sending broadcast messages.
What changed?
httpSend()method toRealtimeChannelV2for explicit REST deliverybroadcast()when falling back to RESTWhy was this change needed?
The current
broadcast()method automatically falls back to REST API when the WebSocket is not connected, which can be confusing for users who may not realize they're using REST instead of WebSocket. This change:httpSend()methodbroadcast()falls back to REST🔄 Changes
httpSend(event:message:timeout:)- Explicitly uses REST API regardless of WebSocket statebroadcast()now logs a warning when falling back to REST✅ Testing
Added comprehensive tests covering:
All tests pass successfully.
📋 Checklist
📚 References
🤖 Generated with Claude Code