Skip to content

feat: Allow Envelopes to contain raw binary data #549

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Feb 7, 2023
Merged

feat: Allow Envelopes to contain raw binary data #549

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ec043e4
feat: Allow Envelopes to contain raw binary data
loewenheim Feb 6, 2023
d602dfa
simplify EnvelopeItemIter
loewenheim Feb 7, 2023
c604bc2
Restructure to_writer
loewenheim Feb 7, 2023
e06aa64
Do no parsing at all in from_path_raw
loewenheim Feb 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
166 changes: 111 additions & 55 deletions sentry-types/src/protocol/envelope.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,14 +152,39 @@ impl From<SampleProfile> for EnvelopeItem {
/// An Iterator over the items of an Envelope.
#[derive(Clone)]
pub struct EnvelopeItemIter<'s> {
inner: std::slice::Iter<'s, EnvelopeItem>,
inner: Option<std::slice::Iter<'s, EnvelopeItem>>,
}

impl<'s> Iterator for EnvelopeItemIter<'s> {
type Item = &'s EnvelopeItem;

fn next(&mut self) -> Option<Self::Item> {
self.inner.next()
self.inner.as_mut()?.next()
}
}

/// The items contained in an [`Envelope`].
///
/// This may be a vector of [`EnvelopeItem`]s (the standard case)
/// or a binary blob.
#[derive(Debug, Clone, PartialEq)]
enum Items {
EnvelopeItems(Vec<EnvelopeItem>),
Raw(Vec<u8>),
}

impl Default for Items {
fn default() -> Self {
Self::EnvelopeItems(Default::default())
}
}

impl Items {
fn is_empty(&self) -> bool {
match self {
Items::EnvelopeItems(items) => items.is_empty(),
Items::Raw(bytes) => bytes.is_empty(),
}
}
}

Expand All @@ -174,7 +199,7 @@ impl<'s> Iterator for EnvelopeItemIter<'s> {
#[derive(Clone, Default, Debug, PartialEq)]
pub struct Envelope {
event_id: Option<Uuid>,
items: Vec<EnvelopeItem>,
items: Items,
}

impl Envelope {
Expand All @@ -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.");
Copy link
Member

Choose a reason for hiding this comment

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

oh, we don’t have sentry_debug here. :-(

return;
};

let item = item.into();
if self.event_id.is_none() {
if let EnvelopeItem::Event(ref event) = item {
Expand All @@ -196,14 +226,17 @@ impl Envelope {
self.event_id = Some(transaction.event_id);
}
}
self.items.push(item);
items.push(item);
}

/// Create an [`Iterator`] over all the [`EnvelopeItem`]s.
pub fn items(&self) -> EnvelopeItemIter {
EnvelopeItemIter {
inner: self.items.iter(),
}
let inner = match &self.items {
Items::EnvelopeItems(items) => Some(items.iter()),
Items::Raw(_) => None,
};

EnvelopeItemIter { inner }
}

/// Returns the Envelopes Uuid, if any.
Expand All @@ -215,13 +248,14 @@ impl Envelope {
///
/// [`Event`]: struct.Event.html
pub fn event(&self) -> Option<&Event<'static>> {
self.items
.iter()
.filter_map(|item| match item {
EnvelopeItem::Event(event) => Some(event),
_ => None,
})
.next()
let Items::EnvelopeItems(ref items) = self.items else {
return None;
};

items.iter().find_map(|item| match item {
EnvelopeItem::Event(event) => Some(event),
_ => None,
})
}

/// Filters the Envelope's [`EnvelopeItem`]s based on a predicate,
Expand All @@ -236,8 +270,12 @@ impl Envelope {
where
P: FnMut(&EnvelopeItem) -> bool,
{
let Items::EnvelopeItems(items) = self.items else {
return None;
};

let mut filtered = Envelope::new();
for item in self.items {
for item in items {
if predicate(&item) {
filtered.add_item(item);
}
Expand All @@ -246,9 +284,9 @@ impl Envelope {
// filter again, removing attachments which do not make any sense without
// an event/transaction
if filtered.uuid().is_none() {
filtered
.items
.retain(|item| !matches!(item, EnvelopeItem::Attachment(..)))
if let Items::EnvelopeItems(ref mut items) = filtered.items {
items.retain(|item| !matches!(item, EnvelopeItem::Attachment(..)))
}
}

if filtered.items.is_empty() {
Expand All @@ -265,53 +303,59 @@ impl Envelope {
where
W: Write,
{
let mut item_buf = Vec::new();

// write the headers:
let event_id = self.uuid();
match event_id {
Some(uuid) => writeln!(writer, r#"{{"event_id":"{uuid}"}}"#)?,
_ => writeln!(writer, "{{}}")?,
}

// write each item:
for item in &self.items {
// we write them to a temporary buffer first, since we need their length
match item {
EnvelopeItem::Event(event) => serde_json::to_writer(&mut item_buf, event)?,
EnvelopeItem::SessionUpdate(session) => {
serde_json::to_writer(&mut item_buf, session)?
}
EnvelopeItem::SessionAggregates(aggregates) => {
serde_json::to_writer(&mut item_buf, aggregates)?
}
EnvelopeItem::Transaction(transaction) => {
serde_json::to_writer(&mut item_buf, transaction)?
}
EnvelopeItem::Attachment(attachment) => {
attachment.to_writer(&mut writer)?;
match &self.items {
Items::Raw(bytes) => writer.write_all(bytes)?,
Items::EnvelopeItems(items) => {
let mut item_buf = Vec::new();
// write each item:
for item in items {
// we write them to a temporary buffer first, since we need their length
match item {
EnvelopeItem::Event(event) => serde_json::to_writer(&mut item_buf, event)?,
EnvelopeItem::SessionUpdate(session) => {
serde_json::to_writer(&mut item_buf, session)?
}
EnvelopeItem::SessionAggregates(aggregates) => {
serde_json::to_writer(&mut item_buf, aggregates)?
}
EnvelopeItem::Transaction(transaction) => {
serde_json::to_writer(&mut item_buf, transaction)?
}
EnvelopeItem::Attachment(attachment) => {
attachment.to_writer(&mut writer)?;
writeln!(writer)?;
continue;
}
EnvelopeItem::Profile(profile) => {
serde_json::to_writer(&mut item_buf, profile)?
}
}
let item_type = match item {
EnvelopeItem::Event(_) => "event",
EnvelopeItem::SessionUpdate(_) => "session",
EnvelopeItem::SessionAggregates(_) => "sessions",
EnvelopeItem::Transaction(_) => "transaction",
EnvelopeItem::Attachment(_) => unreachable!(),
EnvelopeItem::Profile(_) => "profile",
};
writeln!(
writer,
r#"{{"type":"{}","length":{}}}"#,
item_type,
item_buf.len()
)?;
writer.write_all(&item_buf)?;
writeln!(writer)?;
continue;
item_buf.clear();
}
EnvelopeItem::Profile(profile) => serde_json::to_writer(&mut item_buf, profile)?,
}
let item_type = match item {
EnvelopeItem::Event(_) => "event",
EnvelopeItem::SessionUpdate(_) => "session",
EnvelopeItem::SessionAggregates(_) => "sessions",
EnvelopeItem::Transaction(_) => "transaction",
EnvelopeItem::Attachment(_) => unreachable!(),
EnvelopeItem::Profile(_) => "profile",
};
writeln!(
writer,
r#"{{"type":"{}","length":{}}}"#,
item_type,
item_buf.len()
)?;
writer.write_all(&item_buf)?;
writeln!(writer)?;
item_buf.clear();
}

Ok(())
Expand Down Expand Up @@ -340,6 +384,18 @@ impl Envelope {
Envelope::from_slice(&bytes)
}

/// Creates a new Envelope from path without attempting to parse any items.
///
/// 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)?;
Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So should I just manually parse the event id?

Copy link
Member

Choose a reason for hiding this comment

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

do we need it? its optional anyway

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fair point. So should we just shove the whole file contents into the items in the raw case?

Copy link
Member

Choose a reason for hiding this comment

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

Yes, I would say so.

Ok(Self {
event_id: header.event_id,
items: Items::Raw(bytes.drain(offset..).collect()),
})
}

fn parse_header(slice: &[u8]) -> Result<(EnvelopeHeader, usize), EnvelopeError> {
let mut stream = serde_json::Deserializer::from_slice(slice).into_iter();

Expand Down