1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
//!  Extract and inject [W3C TraceContext](https://w3c.github.io/trace-context/) headers.
//!
//! ## Examples
//! ```
//! let mut headers = http::HeaderMap::new();
//! headers.insert(
//!     "traceparent",
//!     "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01".parse().unwrap()
//! );
//! 
//! let context = trace_context::TraceContext::extract(&headers).unwrap();
//! 
//! assert_eq!(context.trace_id(), u128::from_str_radix("0af7651916cd43dd8448eb211c80319c", 16).unwrap());
//! assert_eq!(context.parent_id(), u64::from_str_radix("00f067aa0ba902b7", 16).ok());
//! assert_eq!(context.sampled(), true);
//! ```

#![deny(unsafe_code)]

use rand::Rng;
use std::fmt;

/// A TraceContext object
#[derive(Debug)]
pub struct TraceContext {
    id: u64,
    version: u8,
    trace_id: u128,
    parent_id: Option<u64>,
    flags: u8,
}

impl TraceContext {
    /// Create and return TraceContext object based on `traceparent` HTTP header.
    ///
    /// ## Examples
    /// ```
    /// let mut headers = http::HeaderMap::new();
    /// headers.insert("traceparent", "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01".parse().unwrap());
    /// 
    /// let context = trace_context::TraceContext::extract(&headers).unwrap();
    /// 
    /// assert_eq!(context.trace_id(), u128::from_str_radix("0af7651916cd43dd8448eb211c80319c", 16).unwrap());
    /// assert_eq!(context.parent_id(), u64::from_str_radix("00f067aa0ba902b7",
    /// 16).ok());
    /// assert_eq!(context.sampled(), true);
    /// ```
    pub fn extract(headers: &http::HeaderMap) -> Result<Self, std::num::ParseIntError> {
        let mut rng = rand::thread_rng();

        let traceparent = match headers.get("traceparent") {
            Some(header) => header.to_str().unwrap(),
            None => return Ok(Self::new_root()),
        };

        let parts: Vec<&str> = traceparent.split('-').collect();

        Ok(Self {
            id: rng.gen(),
            version: u8::from_str_radix(parts[0], 16)?,
            trace_id: u128::from_str_radix(parts[1], 16)?,
            parent_id: Some(u64::from_str_radix(parts[2], 16)?),
            flags: u8::from_str_radix(parts[3], 16)?
        })
    }

    pub fn new_root() -> Self {
        let mut rng = rand::thread_rng();

        Self {
            id: rng.gen(),
            version: 0,
            trace_id: rng.gen(),
            parent_id: None,
            flags: 1
        }
    }

    /// Add the traceparent header to the http headers
    ///
    /// ## Examples
    /// ```
    /// let mut input_headers = http::HeaderMap::new();
    /// input_headers.insert("traceparent", "00-00000000000000000000000000000001-0000000000000002-01".parse().unwrap());
    ///
    /// let parent = trace_context::TraceContext::extract(&input_headers).unwrap();
    ///
    /// let mut output_headers = http::HeaderMap::new();
    /// parent.inject(&mut output_headers);
    ///
    /// let child = trace_context::TraceContext::extract(&output_headers).unwrap();
    ///
    /// assert_eq!(child.version(), parent.version());
    /// assert_eq!(child.trace_id(), parent.trace_id());
    /// assert_eq!(child.parent_id(), Some(parent.id()));
    /// assert_eq!(child.flags(), parent.flags());
    /// ```
    pub fn inject(&self, headers: &mut http::HeaderMap) {
        headers.insert("traceparent", format!("{}", self).parse().unwrap());
    }

    pub fn child(&self) -> Self {
        let mut rng = rand::thread_rng();

        Self {
            id: rng.gen(),
            version: self.version,
            trace_id: self.trace_id,
            parent_id: Some(self.id),
            flags: self.flags,
        }
    }

    pub fn id(&self) -> u64 {
        self.id
    }

    pub fn version(&self) -> u8 {
        self.version
    }

    pub fn trace_id(&self) -> u128 {
        self.trace_id
    }

    pub fn parent_id(&self) -> Option<u64> {
        self.parent_id
    }

    pub fn flags(&self) -> u8 {
        self.flags
    }

    /// Returns true if the trace is sampled
    ///
    /// ## Examples
    /// ```
    /// let mut headers = http::HeaderMap::new();
    /// headers.insert("traceparent", "00-00000000000000000000000000000001-0000000000000002-01".parse().unwrap());
    /// let context = trace_context::TraceContext::extract(&headers).unwrap();
    /// assert_eq!(context.sampled(), true);
    /// ```
    pub fn sampled(&self) -> bool {
        (self.flags & 0b00000001) == 1
    }

    /// Change sampled flag
    ///
    /// ## Examples
    /// ```
    /// let mut context = trace_context::TraceContext::new_root();
    /// assert_eq!(context.sampled(), true);
    /// context.set_sampled(false);
    /// assert_eq!(context.sampled(), false);
    /// ```
    pub fn set_sampled(&mut self, sampled: bool) {
        let x = sampled as u8;
        self.flags ^= (x ^ self.flags) & (1 << 0);
    }
}

impl fmt::Display for TraceContext {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(
            f,
            "{:02x}-{:032}-{:016x}-{:02x}",
            self.version, self.trace_id, self.id, self.flags
        )
    }
}

#[cfg(test)]
mod test {
    mod extract {
        #[test]
        fn default() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
            let mut headers = http::HeaderMap::new();
            headers.insert("traceparent", "00-01-deadbeef-00".parse()?);
            let context = crate::TraceContext::extract(&headers)?;
            assert_eq!(context.version(), 0);
            assert_eq!(context.trace_id(), 1);
            assert_eq!(context.parent_id().unwrap(), 3735928559);
            assert_eq!(context.flags(), 0);
            assert_eq!(context.sampled(), false);
            Ok(())
        }

        #[test]
        fn no_header() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
            let headers = http::HeaderMap::new();
            let context = crate::TraceContext::extract(&headers)?;
            assert_eq!(context.version(), 0);
            assert_eq!(context.parent_id(), None);
            assert_eq!(context.flags(), 1);
            assert_eq!(context.sampled(), true);
            Ok(())
        }

        #[test]
        fn not_sampled() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
            let mut headers = http::HeaderMap::new();
            headers.insert("traceparent", "00-01-02-00".parse().unwrap());
            let context = crate::TraceContext::extract(&headers)?;
            assert_eq!(context.sampled(), false);
            Ok(())
        }

        #[test]
        fn sampled() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
            let mut headers = http::HeaderMap::new();
            headers.insert("traceparent", "00-01-02-01".parse().unwrap());
            let context = crate::TraceContext::extract(&headers)?;
            assert_eq!(context.sampled(), true);
            Ok(())
        }
    }
}