feat(types): add accessors for envelope headers

Author: lcian

sentry-types/src/protocol/envelope.rs

@@ -42,7 +42,7 @@ pub enum EnvelopeError {
 
 /// The supported [Sentry Envelope Headers](https://develop.sentry.dev/sdk/data-model/envelopes/#headers).
 #[derive(Clone, Default, Debug, Serialize, Deserialize, PartialEq)]
-struct EnvelopeHeaders {
+pub struct EnvelopeHeaders {
     #[serde(default, skip_serializing_if = "Option::is_none")]
     event_id: Option<Uuid>,
     #[serde(default, skip_serializing_if = "Option::is_none")]
@@ -59,6 +59,64 @@ struct EnvelopeHeaders {
     trace: Option<DynamicSamplingContext>,
 }
 
+impl EnvelopeHeaders {
+    /// Creates empty Envelope headers.
+    pub fn new() -> EnvelopeHeaders {
+        Default::default()
+    }
+
+    /// Returns the Event ID.
+    pub fn event_id(&self) -> Option<&Uuid> {
+        self.event_id.as_ref()
+    }
+
+    /// Sets the Event ID.
+    pub fn set_event_id(&mut self, event_id: Option<Uuid>) {
+        self.event_id = event_id;
+    }
+
+    /// Returns the DSN.
+    pub fn dsn(&self) -> Option<&Dsn> {
+        self.dsn.as_ref()
+    }
+
+    /// Sets the DSN.
+    pub fn set_dsn(&mut self, dsn: Option<Dsn>) {
+        self.dsn = dsn;
+    }
+
+    /// Returns the SDK information.
+    pub fn sdk(&self) -> Option<&ClientSdkInfo> {
+        self.sdk.as_ref()
+    }
+
+    /// Sets the SDK information.
+    pub fn set_sdk(&mut self, sdk: Option<ClientSdkInfo>) {
+        self.sdk = sdk;
+    }
+
+    /// Returns the time this envelope was sent at.
+    pub fn sent_at(&self) -> Option<&SystemTime> {
+        self.sent_at.as_ref()
+    }
+
+    /// Sets the time this envelope was sent at.
+    /// This timestamp should be generated as close as possible to the transmision of the event.
+    pub fn set_sent_at(&mut self, sent_at: Option<SystemTime>) {
+        self.sent_at = sent_at;
+    }
+
+    /// Returns the Dynamic Sampling Context.
+    pub fn trace(&self) -> Option<&DynamicSamplingContext> {
+        self.trace.as_ref()
+    }
+
+    /// Sets the Dynamic Sampling Context.
+    pub fn set_trace(&mut self, trace: Option<DynamicSamplingContext>) {
+        self.trace = trace;
+    }
+}
+
 /// An Envelope Item Type.
 #[derive(Clone, Debug, Eq, PartialEq, Deserialize)]
 #[non_exhaustive]
@@ -334,6 +392,16 @@ impl Envelope {
         EnvelopeItemIter { inner }
     }
 
+    /// Returns the Envelope headers.
+    pub fn headers(&self) -> &EnvelopeHeaders {
+        &self.headers
+    }
+
+    /// Sets the Envelope headers.
+    pub fn set_headers(&mut self, headers: EnvelopeHeaders) {
+        self.headers = headers
+    }
+
     /// Returns the Envelopes Uuid, if any.
     pub fn uuid(&self) -> Option<&Uuid> {
         self.headers.event_id.as_ref()

sentry-types/src/protocol/v7.rs

@@ -2339,7 +2339,7 @@ impl<'de> Deserialize<'de> for LogAttribute {
 
 /// An ID that identifies an organization in the Sentry backend.
 #[derive(Clone, Copy, Debug, Serialize, Deserialize, PartialEq)]
-struct OrganizationId(u64);
+pub struct OrganizationId(u64);
 
 impl From<u64> for OrganizationId {
     fn from(value: u64) -> Self {
@@ -2363,7 +2363,7 @@ impl std::fmt::Display for OrganizationId {
 
 /// A random number generated at the start of a trace by the head of trace SDK.
 #[derive(Clone, Copy, Debug, Serialize, Deserialize, PartialEq)]
-struct SampleRand(f64);
+pub struct SampleRand(f64);
 
 impl From<f64> for SampleRand {
     fn from(value: f64) -> Self {
@@ -2392,8 +2392,8 @@ impl std::fmt::Display for SampleRand {
 /// This feature allows users to specify target sample rates for each project via the frontend instead of requiring an application redeployment.
 /// The backend needs additional information from the SDK to support these features, contained in
 /// the Dynamic Sampling Context.
-#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
-pub(crate) struct DynamicSamplingContext {
+#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq)]
+pub struct DynamicSamplingContext {
     // Strictly required fields
     // Still typed as optional, as when deserializing an envelope created by an older SDK they might still be missing
     #[serde(default, skip_serializing_if = "Option::is_none")]
@@ -2432,3 +2432,101 @@ pub(crate) struct DynamicSamplingContext {
     )]
     org_id: Option<OrganizationId>,
 }
+
+impl DynamicSamplingContext {
+    /// Creates an empty Dynamic Sampling Context.
+    pub fn new() -> Self {
+        Default::default()
+    }
+
+    /// Gets the trace ID.
+    pub fn trace_id(&self) -> Option<&TraceId> {
+        self.trace_id.as_ref()
+    }
+
+    /// Sets the trace ID.
+    pub fn set_trace_id(&mut self, trace_id: Option<TraceId>) {
+        self.trace_id = trace_id;
+    }
+
+    /// Gets the DSN public key.
+    pub fn public_key(&self) -> Option<&String> {
+        self.public_key.as_ref()
+    }
+
+    /// Sets the DSN public key.
+    pub fn set_public_key(&mut self, public_key: Option<String>) {
+        self.public_key = public_key;
+    }
+
+    /// Gets the sample rate.
+    pub fn sample_rate(&self) -> Option<&f32> {
+        self.sample_rate.as_ref()
+    }
+
+    /// Sets the sample rate.
+    pub fn set_sample_rate(&mut self, sample_rate: Option<f32>) {
+        self.sample_rate = sample_rate;
+    }
+
+    /// Gets the sample random value generated by the head of trace SDK.
+    pub fn sample_rand(&self) -> Option<&SampleRand> {
+        self.sample_rand.as_ref()
+    }
+
+    /// Sets the sample random value generated by the head of trace SDK.
+    pub fn set_sample_rand(&mut self, sample_rand: Option<SampleRand>) {
+        self.sample_rand = sample_rand;
+    }
+
+    /// Gets the sampled flag, true if and only if the trace was sampled. This is set by the head
+    /// of trace SDK.
+    pub fn sampled(&self) -> Option<&bool> {
+        self.sampled.as_ref()
+    }
+
+    /// Sets the sampled flag.
+    pub fn set_sampled(&mut self, sampled: Option<bool>) {
+        self.sampled = sampled;
+    }
+
+    /// Gets the release.
+    pub fn release(&self) -> Option<&String> {
+        self.release.as_ref()
+    }
+
+    /// Sets the release.
+    pub fn set_release(&mut self, release: Option<String>) {
+        self.release = release;
+    }
+
+    /// Gets the environment.
+    pub fn environment(&self) -> Option<&String> {
+        self.environment.as_ref()
+    }
+
+    /// Sets the environment.
+    pub fn set_environment(&mut self, environment: Option<String>) {
+        self.environment = environment;
+    }
+
+    /// Gets the transaction.
+    pub fn transaction(&self) -> Option<&String> {
+        self.transaction.as_ref()
+    }
+
+    /// Sets the transaction.
+    pub fn set_transaction(&mut self, transaction: Option<String>) {
+        self.transaction = transaction;
+    }
+
+    /// Gets the organization ID.
+    pub fn org_id(&self) -> Option<&OrganizationId> {
+        self.org_id.as_ref()
+    }
+
+    /// Sets the organization ID.
+    pub fn set_org_id(&mut self, org_id: Option<OrganizationId>) {
+        self.org_id = org_id;
+    }
+}