fix(realtime_client): make ref field optional in Message class #1284
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
Make the ref field nullable (String?) and optional in the Message constructor to match JavaScript SDK behavior. This allows null refs in scenarios like heartbeats and aligns with the JavaScript SDK implementation. - Changed ref from String to String? - Made ref optional in constructor - Updated toJson() to conditionally include ref only when not null - Added comprehensive tests for null ref scenarios Closes SDK-531
Pull Request Test Coverage Report for Build 20148486612Details
💛 - Coveralls |
Vinzent03
approved these changes
Dec 11, 2025
grdsdev
deleted the
guilherme/sdk-531-flutter-verify-optional-refs-handling-in-message
branch
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 makes the
reffield optional in theMessageclass to match the JavaScript SDK behavior. Thereffield is now nullable (String?) and optional in the constructor, allowing null refs in scenarios like heartbeats.Context
The JavaScript SDK recently fixed an issue with message serialization in the Realtime library to properly handle null/undefined
refandjoin_reffields when encoding messages (PR #1862).Changes
reffield fromStringtoString?(nullable)refparameter optional in theMessageconstructortoJson()method to conditionally includerefonly when not null (consistent withjoinRefhandling)Testing
refcontinues to workBreaking Changes
This is a minor breaking change since
refwas previously required. However:refwill continue to workrefwill benefit from this changeRelated