feat(realtime): add metadata to realtime user broadcast push #1894
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
We don't have any usage at the moment for this extra metadata but we want to have this ready for the future
@supabase/auth-js
@supabase/functions-js
@supabase/postgrest-js
@supabase/realtime-js
@supabase/storage-js
@supabase/supabase-js
commit: |
![depthfirst-app[bot]](https://avatars.githubusercontent.com/in/1021002?s=60&v=4){kind=small}
filipecabaco
approved these changes
Nov 26, 2025
filipecabaco
previously approved these changes
Nov 26, 2025
filipecabaco
approved these changes
Nov 26, 2025
mandarini
approved these changes
Nov 26, 2025
grdsdev
added a commit
to supabase/supabase-swift
that referenced
this pull request
Dec 5, 2025
This implements the Realtime V2 serializer based on supabase-js PRs #1829 and #1894. Key features: - Binary payload support for user messages - Two new message types: user broadcast and user broadcast push - Optional metadata support for user broadcast push messages - Reduced JSON encoding overhead on the server side - Backward compatible with V1 (1.0.0) as default Changes: - Added RealtimeBinaryEncoder and RealtimeBinaryDecoder classes - Added RealtimeSerializer protocol for future extensibility - Updated RealtimeClientOptions to support serializer version selection - Updated RealtimeClientV2 to use binary serializer when v2.0.0 is selected - Added RealtimeBinaryPayload helper for working with binary data - Comprehensive test suite with 16 tests covering encoding/decoding scenarios References: - supabase/supabase-js#1829 - supabase/supabase-js#1894 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Draft
6 tasks
grdsdev
added a commit
to supabase/supabase-py
that referenced
this pull request
Dec 5, 2025
This implements the Realtime V2 serializer based on supabase-js PRs #1829 and #1894. Key features: - Binary payload support for user messages - Two new message types: user broadcast and user broadcast push - Optional metadata support for user broadcast push messages - Reduced JSON encoding overhead on the server side - Backward compatible with V1 (1.0.0) as default Changes: - Added Serializer class with binary encoding/decoding support - Updated types.py to add VSN constants (VSN_1_0_0, VSN_2_0_0, DEFAULT_VSN) - Updated AsyncRealtimeClient to support vsn parameter and serializer selection - Added comprehensive test suite with 16 tests covering encoding/decoding scenarios - Metadata filtering based on allowed_metadata_keys parameter References: - supabase/supabase-js#1829 - supabase/supabase-js#1894
3 tasks
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
In the future we want to be able to include some metadata using JSON to User Broadcast Push.
What changed?
Add an optional metadata to be sent as part of the User Broadcast Push. At the moment it won't send anything because we don't have any allowed metadata keys but the serializer is ready to accept those as an option.
We don't have any usage at the moment for this extra metadata but we want to have this ready for the future
Related to supabase/realtime#1629
📸 Screenshots/Examples
🔄 Breaking changes
No breaking changes because 2.0.0 has not been set as default serializer and not publicly advertised just yet.
📋 Checklist
<type>(<scope>): <description>npx nx formatto ensure consistent code formatting📝 Additional notes