Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce compressor option to ActiveRecord::Encryption::Encryptor #51735

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

heka1024
Copy link
Contributor

@heka1024 heka1024 commented May 4, 2024

Motivation / Background

There are more performant algorithms than zlib, like zstd or snappy. So I made it possible to configure the compressor to take advantage of these more performant algorithms.

Detail

Make compressor as argument which default value is zlib.

Additional information

Checklist

Before submitting the PR make sure the following are checked:

  • This Pull Request is related to one change. Unrelated changes should be opened in separate PRs.
  • Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
  • Tests are added or updated if you fix a bug or add a feature.
  • CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.

Discussion

What do you thinks about make compressor as property of ActiveRecord::Encryption ?

Copy link
Member

@flavorjones flavorjones left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The naming of the custom compressor's methods seems inconsistent to me. Would you consider using Encryptor's convention and name them compress/uncompress instead of ZLib's deflate/inflate?

I also think this PR should update the Rails Guides page on encryption, guides/source/active_record_encryption.md to explain how to implement a custom compressor.

@rails-bot rails-bot bot added the docs label May 7, 2024
@heka1024 heka1024 force-pushed the encryption-compressor branch 2 times, most recently from 883a321 to 3231918 Compare May 7, 2024 08:58
@heka1024
Copy link
Contributor Author

heka1024 commented May 7, 2024

Hi, @flavorjones ! I changed signature of compressor (compress/uncompress) and make compressor configurable. And add some document about compression. Could you review it? I'd really appreciate it if you could provide feedback!

activerecord/CHANGELOG.md Outdated Show resolved Hide resolved
activerecord/CHANGELOG.md Outdated Show resolved Hide resolved
@heka1024 heka1024 force-pushed the encryption-compressor branch 5 times, most recently from a34e1dd to d2de562 Compare May 14, 2024 05:50
@zzak
Copy link
Member

zzak commented May 19, 2024

CI failures seem unrelated, you might want to rebase just to be sure as I think most of those have been fixed

@heka1024 heka1024 force-pushed the encryption-compressor branch 3 times, most recently from 3a52769 to 5664b8c Compare May 19, 2024 06:35
@heka1024
Copy link
Contributor Author

CI failures seem unrelated, you might want to rebase just to be sure as I think most of those have been fixed

@zzak I just rebased it, and it looks like all CI failures are fixed now. 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants