Adding Snappy to API server flow #171
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| #include "compression_utils.h" | ||
| #include <snappy.h> | ||
|
|
||
| using namespace dbps::external; | ||
| using namespace dbps::enum_utils; | ||
|
|
||
| namespace dbps::compression { | ||
|
|
||
| std::vector<uint8_t> Compress(const std::vector<uint8_t>& bytes, CompressionCodec::type compression) { | ||
| if (compression == CompressionCodec::UNCOMPRESSED) { | ||
| return bytes; | ||
| } | ||
|
|
||
| if (compression == CompressionCodec::SNAPPY) { | ||
| if (bytes.empty()) { | ||
| return bytes; | ||
| } | ||
| // `compressed` is a std::string because Snappy's API requires it. | ||
| // It is used as a binary buffer (not text), and immediately converted back to std::vector<uint8_t> to preserve binary semantics. | ||
| std::string compressed; | ||
| snappy::Compress(reinterpret_cast<const char*>(bytes.data()), bytes.size(), &compressed); | ||
| return std::vector<uint8_t>(compressed.begin(), compressed.end()); | ||
| } | ||
|
|
||
| // Note for future implementations: If compression fails because of invalid or corrupt input, | ||
| // then throw an InvalidInputException. | ||
| throw DBPSUnsupportedException( | ||
| "Unsupported compression codec: " + std::string(to_string(compression))); | ||
| } | ||
|
|
||
| std::vector<uint8_t> Decompress(const std::vector<uint8_t>& bytes, CompressionCodec::type compression) { | ||
| if (compression == CompressionCodec::UNCOMPRESSED) { | ||
| return bytes; | ||
| } | ||
|
|
||
| if (compression == CompressionCodec::SNAPPY) { | ||
| if (bytes.empty()) { | ||
| return bytes; | ||
| } | ||
| // `decompressed` is a std::string because Snappy's API requires it. | ||
| // It is used as a binary buffer (not text), and immediately converted back to std::vector<uint8_t> to preserve binary semantics. | ||
| std::string decompressed; | ||
|
Collaborator
There was a problem hiding this comment. wait, string? why is this? It seems odd - specially given that just below (before returning) we're convering it to a byte array.
Collaborator
Author
There was a problem hiding this comment. Ah! This is because
Collaborator
There was a problem hiding this comment. got it, makes sense - string being used as an auto-resize buffer. let's add a quick note to the code. Have we checked is there risk for side effects for using strings? (e.g. UTF-8 encoding doing something 'magic' but undesired with the bytes ?) If this is not an issue, using
Collaborator
Author
There was a problem hiding this comment. Added an inline comment for this. Also added (then removed) a unittest to Compress/Decompress special utf-8 chars. It feels still wrong to merge code with special chars, so won't merge that specific test, but it works. |
||
| bool success = snappy::Uncompress(reinterpret_cast<const char*>(bytes.data()), bytes.size(), &decompressed); | ||
| if (!success) { | ||
| throw InvalidInputException("Failed to decompress data: invalid or corrupt Snappy-compressed input"); | ||
| } | ||
| return std::vector<uint8_t>(decompressed.begin(), decompressed.end()); | ||
| } | ||
|
|
||
| // Note for future implementations: If decompression fails because of invalid or corrupt input, | ||
| // then throw an InvalidInputException. | ||
| throw DBPSUnsupportedException( | ||
| "Unsupported compression codec: " + std::string(to_string(compression))); | ||
| } | ||
|
|
||
| } // namespace dbps::compression | ||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this seems familiar :)