rvoip-core-traits 0.3.2

Pure-data trait + type surface for the rvoip ecosystem. Holds ID newtypes and Identity data types so consumer crates (auth-core, vcon, harness, adapters) can depend on the type surface without pulling in rvoip-core's implementation. Carved out to break the rvoip-core → rvoip-vcon → rvoip-auth-core → rvoip-core dependency cycle (GAP_PLAN V2.A).
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
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

//! Strongly-typed identifiers — the canonical home post-V2.A.
//!
//! Each ID is a newtype around a UUID-shaped string so cross-crate
//! consumers can pattern-match on the kind without confusing a
//! `SessionId` with a `ConnectionId`. `rvoip-core` re-exports this
//! whole module so `use rvoip_core::ids::ConnectionId` keeps working.

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

macro_rules! id_type {
    ($name:ident, $prefix:expr) => {
        #[derive(Clone, Eq, Hash, PartialEq, Ord, PartialOrd, Serialize, Deserialize)]
        pub struct $name(pub String);

        impl $name {
            pub fn new() -> Self {
                Self(format!("{}_{}", $prefix, Uuid::new_v4().simple()))
            }

            pub fn from_string(s: impl Into<String>) -> Self {
                Self(s.into())
            }

            pub fn as_str(&self) -> &str {
                &self.0
            }
        }

        impl fmt::Display for $name {
            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                f.write_str(&self.0)
            }
        }

        impl fmt::Debug for $name {
            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                // IDs are correlation material. Keep their functional Display
                // and wire forms intact, but make accidental structured-log
                // capture metadata-only.
                f.write_str(concat!(stringify!($name), "([redacted])"))
            }
        }

        impl Default for $name {
            fn default() -> Self {
                Self::new()
            }
        }
    };
}

id_type!(ConversationId, "conv");
id_type!(SessionId, "sess");
id_type!(ConnectionId, "conn");
id_type!(StreamId, "strm");
id_type!(MessageId, "msg");
id_type!(ParticipantId, "part");
id_type!(IdentityId, "id");
id_type!(DeviceId, "dev");
id_type!(BridgeId, "brdg");
id_type!(MediaRouteId, "route");
id_type!(TenantId, "tnt");
id_type!(RecordingId, "rec");
id_type!(ListenerId, "lstn");
id_type!(AttachmentId, "att");
id_type!(AiAttachmentId, "ai");
id_type!(PlaybackId, "play");
id_type!(TranscriptionId, "trn");
id_type!(TransferAttemptId, "xfer");

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

    #[test]
    fn identifier_debug_never_discloses_correlation_values() {
        const CANARY: &str = "id-diagnostic-canary\r\nAuthorization: exposed";
        let ids = [
            format!("{:?}", ConversationId::from_string(CANARY)),
            format!("{:?}", SessionId::from_string(CANARY)),
            format!("{:?}", ConnectionId::from_string(CANARY)),
            format!("{:?}", StreamId::from_string(CANARY)),
            format!("{:?}", MessageId::from_string(CANARY)),
            format!("{:?}", TenantId::from_string(CANARY)),
            format!("{:?}", TransferAttemptId::from_string(CANARY)),
        ];
        for debug in ids {
            assert!(!debug.contains(CANARY));
            assert!(debug.contains("[redacted]"));
        }
        assert_eq!(SessionId::from_string(CANARY).to_string(), CANARY);
    }
}