firestore: marshal values as []byte, not string #4160
Merged
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
awly
requested review from
fspmarshall,
klizhentas,
russjones and
webvictim
as code owners
|
Looks like the linter is failing. |
Firestore marshaler requires all string data to be valid UTF-8. Our values are sometimes binary (like QR codes for OTP signup), which would fail to marhal. On reads, try using both new and old formats to support existing data. Added tests for this fallback and for writing binary data into all backends.
awly
force-pushed
the
andrew/firestore-binary-data
branch
from
98433c7
to
4105887
Compare
|
Fixed linter failures |
fspmarshall
approved these changes
Aug 10, 2020
lib/backend/firestore/firestorebk.go
Outdated
| @@ -110,13 +110,63 @@ type FirestoreBackend struct { | |||
| } | |||
|
|
|||
| type record struct { | |||
| Key string `firestore:"key,omitempty"` | |||
There was a problem hiding this comment.
Should Key be changed to []byte as well while we're here? I don't think we enforce UTF-8 on keys either.
There was a problem hiding this comment.
Good point. In practice it seems to always be UTF-8, but it's not enforced anywhere.
Changed and added test coverage for other backends.
Same as values, `backend.Item` passes keys as `[]byte` and has no guarantees about the encoding. GetRange queries need extra care because of this type mismatch too: `where` clauses are type-sensitive.
awly
force-pushed
the
andrew/firestore-binary-data
branch
from
bfe8eb9
to
6a212f1
Compare
This was referenced Aug 11, 2020
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.
Firestore marshaler requires all string data to be valid UTF-8. Our
values are sometimes binary (like QR codes for OTP signup), which would
fail to marhal.
On reads, try using both new and old formats to support existing data.
Added tests for this fallback and for writing binary data into all
backends.
Tested with firestore, including upgrade from an existing teleport cluster.
Fixes #4145