client_report.rs

use relay_common::{DataCategory, UnixTimestamp};
use serde::{Deserialize, Serialize};

#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
pub struct DiscardedEvent {
    pub reason: String,
    pub category: DataCategory,
    pub quantity: u32,
}

#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
pub struct ClientReport {
    /// The timestamp of when the report was created.
    pub timestamp: Option<UnixTimestamp>,
    /// Counters for events discarded by the client.
    pub discarded_events: Vec<DiscardedEvent>,
    /// Counters for events rate limited by a relay configured to emit outcomes as client reports
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub _server_rate_limited_events: Vec<DiscardedEvent>,
    /// Counters for events filtered by a relay configured to emit outcomes as client reports
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub _server_filtered_events: Vec<DiscardedEvent>,
    /// Counters for events filtered by a sampling rule,
    /// by a relay configured to emit outcomes as client reports
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub _server_filtered_sampling_events: Vec<DiscardedEvent>,
}

impl ClientReport {
    /// Parses a client report update from JSON.
    pub fn parse(payload: &[u8]) -> Result<Self, serde_json::Error> {
        serde_json::from_slice(payload)
    }

    /// Serializes a client report update back into JSON.
    pub fn serialize(&self) -> Result<Vec<u8>, serde_json::Error> {
        serde_json::to_vec(self)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_client_report_roundtrip() {
        let json = r#"{
  "timestamp": "2020-02-07T15:17:00Z",
  "discarded_events": [
    {"reason": "foo_reason", "category": "error", "quantity": 42},
    {"reason": "foo_reason", "category": "transaction", "quantity": 23}
  ],
  "_server_rate_limited_events" : [
      {"reason": "bar_reason", "category": "session", "quantity": 456}
  ]
}"#;

        let output = r#"{
  "timestamp": 1581088620,
  "discarded_events": [
    {
      "reason": "foo_reason",
      "category": "error",
      "quantity": 42
    },
    {
      "reason": "foo_reason",
      "category": "transaction",
      "quantity": 23
    }
  ],
  "_server_rate_limited_events": [
    {
      "reason": "bar_reason",
      "category": "session",
      "quantity": 456
    }
  ]
}"#;

        let update = ClientReport {
            timestamp: Some("2020-02-07T15:17:00Z".parse().unwrap()),
            discarded_events: vec![
                DiscardedEvent {
                    reason: "foo_reason".into(),
                    category: DataCategory::Error,
                    quantity: 42,
                },
                DiscardedEvent {
                    reason: "foo_reason".into(),
                    category: DataCategory::Transaction,
                    quantity: 23,
                },
            ],
            _server_rate_limited_events: vec![DiscardedEvent {
                reason: "bar_reason".into(),
                category: DataCategory::Session,
                quantity: 456,
            }],

            ..Default::default()
        };

        let parsed = ClientReport::parse(json.as_bytes()).unwrap();
        assert_eq_dbg!(update, parsed);
        assert_eq_str!(output, serde_json::to_string_pretty(&update).unwrap());
    }
}