detritus-protocol 0.2.0

Wire protocol types for Detritus telemetry and crash ingestion
Documentation 
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

//! Source identity for observability payloads.

use serde::{Deserialize, Serialize};
use uuid::Uuid;

/// Identifies the game build and installation that produced a payload.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SourceId {
    /// Project or product identifier.
    pub project: String,
    /// Runtime platform, such as `linux`, `windows`, or `android`.
    pub platform: String,
    /// User-facing application version.
    pub version: String,
    /// Stable installation identifier.
    pub install_id: Uuid,
}

impl SourceId {
    /// Returns `<project>/<platform>/<version>/<install_id>`.
    ///
    /// This canonical form is used in storage paths and rate-limit keys.
    #[must_use]
    pub fn canonical(&self) -> String {
        format!(
            "{}/{}/{}/{}",
            self.project, self.platform, self.version, self.install_id
        )
    }
}

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

    #[test]
    #[cfg_attr(coverage_nightly, coverage(off))]
    fn canonical_joins_fields_with_slashes() {
        // The canonical form is a storage-path and rate-limit-key contract, so
        // pin its exact shape.
        let source = SourceId {
            project: "detritus".to_owned(),
            platform: "linux".to_owned(),
            version: "1.2.3".to_owned(),
            install_id: Uuid::nil(),
        };
        assert_eq!(
            source.canonical(),
            "detritus/linux/1.2.3/00000000-0000-0000-0000-000000000000"
        );
    }
}