Make lz4 module optional
#246
Merged
Conversation
This file contains hidden or 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
Signed-off-by: Levko Kravets <levko.ne@gmail.com>
kravets-levko
requested review from
andrefurlan-db,
arikfr,
benc-db,
jackyhu-db,
rcypher-databricks,
superdupershant and
yunbodeng-db
as code owners
kravets-levko
temporarily deployed
to
azure-prod
GitHub Actions
Inactive
Signed-off-by: Levko Kravets <levko.ne@gmail.com>
kravets-levko
temporarily deployed
to
azure-prod
GitHub Actions
Inactive
kravets-levko
temporarily deployed
to
azure-prod
GitHub Actions
Inactive
benc-db
requested changes
Apr 19, 2024
Contributor
benc-db
left a comment
benc-db
left a comment
There was a problem hiding this comment.
Looks good, but for long term maintainability, would like LZ4 to be renamed to something a little more obvious of what it is used for (per my comment)
benc-db
approved these changes
Apr 19, 2024
kravets-levko
temporarily deployed
to
azure-prod
GitHub Actions
Inactive
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.
Fixes #245
lz4module is partially built from C sources during installation. This process requires some build tools available on user's machine. While on Linux machines it's typically available, it may not be true for others. Unfortunately, we cannot replacelz4by other library because it's the only LZ4 implementation for Node that supports LZ4 frame API.Proposed solution is to make
lz4dependency optional. With this change, package manager won't fail iflz4cannot be installed, but we should be ready thatlz4dependency may be missing. When it's not available, we completely disable LZ4 support in the library - don't sentcanDecompressLZ4Resultto Thrift server, and add guards everywherelz4is used.