Add encoding/decoding for Fauna Bytes #260
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
cleve-fauna
reviewed
May 6, 2024
freels
reviewed
May 10, 2024
freels
approved these changes
May 10, 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.
Ticket(s): FE-4855
Problem
Fauna supports a Bytes type which is transmitted as a base-64-encoded string
https://docs.fauna.com/fauna/current/reference/fql_reference/types#bytes
We also had a type issue where JS Date could not be used as a query argument, so I added Date to arg type as well as a test.
Solution
Add encoding and decoding of the Bytes type
Result
ArrayBuffers andUint8Array(as well as Node'sBuffersince that extendsUint8Array) classes are encoded to Fauna Bytes. Attempting to encode any other TypedArray results in an error.Fauna Bytes are decoded into
Uint8Array, which can be used to create the desired type.See tests for examples.
Out of scope
N/A
Testing
Added unit and integration tests.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.