feat: Allow Envelopes to contain raw binary data #549
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
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #549 +/- ##
==========================================
- Coverage 70.87% 70.68% -0.20%
==========================================
Files 66 66
Lines 6624 6649 +25
==========================================
+ Hits 4695 4700 +5
- Misses 1929 1949 +20 |
Swatinem
reviewed
Feb 7, 2023
| @@ -188,6 +213,11 @@ impl Envelope { | |||
| where | |||
| I: Into<EnvelopeItem>, | |||
| { | |||
| let Items::EnvelopeItems(ref mut items) = self.items else { | |||
| eprintln!("WARNING: This envelope contains raw items. Adding an item is not supported."); | |||
There was a problem hiding this comment.
oh, we don’t have sentry_debug here. :-(
| /// The resulting Envelope's `items` will just be a binary blob. | ||
| pub fn from_path_raw<P: AsRef<Path>>(path: P) -> Result<Self, EnvelopeError> { | ||
| let mut bytes = std::fs::read(path).map_err(|_| EnvelopeError::UnexpectedEof)?; | ||
| let (header, offset) = Self::parse_header(&bytes)?; |
There was a problem hiding this comment.
I would have to check what native is doing, but I believe it does not even parse the header. The header can potentially contain more than just the event id, so its best to keep that opaque as well.
There was a problem hiding this comment.
So should I just manually parse the event id?
There was a problem hiding this comment.
do we need it? its optional anyway
There was a problem hiding this comment.
Fair point. So should we just shove the whole file contents into the items in the raw case?
Swatinem
approved these changes
Feb 7, 2023
loewenheim
added a commit
that referenced
this pull request
Feb 7, 2023
loewenheim
added a commit
that referenced
this pull request
Feb 7, 2023
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.
This turns the type of
Envelope::itemsinto an enum that may be a vector ofEnvelopeItems(the status quo) or a blob of binary data. In the latter case, operations on items become no-ops because nothing can be done if there's no structure to the items.It also adds a function
from_path_rawthat reads an Envelope from disk without attempting to parse any items. The motivation for this is getsentry/sentry-cli#1458.