Add MessagePackMessageSerializer for binary data #51102
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
djmb
force-pushed
the
encryption-message-pack-message-serialization
branch
2 times, most recently
from
10e5e7a
to
27f683c
Compare
Serialize data to the MessagePack format, for efficient storage in binary columns. The binary encoding requires around 30% less space than the base64 encoding used by the default serializer. To prevent it being used with text columns, validate that we only try to store binary data in binary columns.
djmb
force-pushed
the
encryption-message-pack-message-serialization
branch
from
27f683c
to
16ef895
Compare
Ridhwana
pushed a commit
to Ridhwana/rails
that referenced
this pull request
Mar 7, 2024
viralpraxis
pushed a commit
to viralpraxis/rails
that referenced
this pull request
Mar 24, 2024
4 tasks
joshuay03
reviewed
Mar 25, 2024
| encryptor.encrypt(value, **encryption_options) | ||
| encryptor.encrypt(value, **encryption_options).tap do |encrypted| | ||
| if !cast_type.binary? && encrypted.encoding == Encoding::BINARY | ||
| raise Errors::Encoding, "Binary encoded data can only be stored in binary columns" |
fractaledmind
pushed a commit
to fractaledmind/rails
that referenced
this pull request
May 13, 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.
Motivation / Background
ActiveRecord::Encryption::MessageSerializercreates serialized JSON. The JSON values are Base64 encoded to ensure that the data can stored in text database columns without encoding issues.Binary columns however can store arbitrary data, so won't have the encoding issues. By using a MessagePack based serializer we can store data more efficiently without the Base64 overhead (about 33%).
Detail
Add a new serializer
ActiveRecord::Encryption::MessagePackMessageSerializerthat serializes encrypted data to the MessagePack format, for efficient storage in binary columns.To prevent it being used with text columns, validate that we only try to store binary data in binary columns.
The serializer is not autoloaded, because it relies on the optional msgpack gem.
Usage:
Checklist
Before submitting the PR make sure the following are checked:
[Fix #issue-number]