RSDK-9180: Change TabularDataBySQL/MQL return type to raw BSON in Flutter SDK #286
Conversation
This file contains 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
purplenicole730
approved these changes
Oct 31, 2024
|
Is this considered a breaking change? |
Yes! we talked off-line about this but yes since the dates/times will be given back as native Date objects and not strings this is a breaking change. I posted in eng-breaking-changes |
stuqdog
approved these changes
Nov 1, 2024
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.
For context: The return type of the TabularDataBySQL/MQL proto has changed to return both a list of structs, the existing return type, and also a list of bytearrays that represent BSON.
Added a required dependency to bson to use the BSON library for dart
BSON provides a
BsonCodec.deserialize()andBsonCodec.serialize()function for converting lists of byte sequences into lists of dart objects.Testing:
Updated the
datatesting input to includeDateTimeobjects, as the Flutter SDK will receive date fields in this format. I added a check to ensure thatDateTimeinputs are returned as native FlutterDateTimeobjectsI ensured that date fields are returned as native dart DateTime objects instead of strings by running tabularDataByMQL against real tabular data on viam-dev and printed the decoded data and their types. As you can see below the date and time elements are of type "DateTime":
