launchdarkly-server-sdk 3.2.0

LaunchDarkly Server-Side SDK
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
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

use serde::Deserialize;

#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub(super) enum IntentCode {
    None,
    XferFull,
    XferChanges,
    #[serde(other)]
    Unknown,
}

#[derive(Debug, Deserialize)]
pub(super) struct ServerIntent {
    pub(super) payloads: Vec<ServerIntentPayload>,
}

#[derive(Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub(super) struct ServerIntentPayload {
    pub(super) id: String,
    pub(super) target: u64,
    pub(super) intent_code: IntentCode,
    pub(super) reason: String,
}

#[derive(Debug, Deserialize)]
pub(super) struct PutObject {
    pub(super) version: u64,
    pub(super) kind: String,
    pub(super) key: String,
    pub(super) object: serde_json::Value,
}

#[derive(Debug, Deserialize)]
pub(super) struct DeleteObject {
    pub(super) version: u64,
    pub(super) kind: String,
    pub(super) key: String,
}

#[derive(Debug, Deserialize)]
pub(super) struct PayloadTransferred {
    pub(super) state: String,
}

#[derive(Debug, Deserialize)]
pub(super) struct Goodbye {
    pub(super) reason: Option<String>,
    #[serde(rename = "protocolFallbackTTL")]
    pub(super) protocol_fallback_ttl: Option<u64>,
}

#[derive(Debug, Deserialize)]
pub(super) struct FDv2Error {
    pub(super) id: Option<String>,
    pub(super) reason: String,
}

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

    #[test]
    fn intent_code_parses_known_and_unknown() {
        assert_eq!(
            serde_json::from_value::<IntentCode>(json!("none")).unwrap(),
            IntentCode::None,
        );
        assert_eq!(
            serde_json::from_value::<IntentCode>(json!("xfer-full")).unwrap(),
            IntentCode::XferFull,
        );
        assert_eq!(
            serde_json::from_value::<IntentCode>(json!("xfer-changes")).unwrap(),
            IntentCode::XferChanges,
        );
        assert_eq!(
            serde_json::from_value::<IntentCode>(json!("brand-new-code")).unwrap(),
            IntentCode::Unknown,
        );
    }

    #[test]
    fn server_intent_parses() {
        let payload = json!({
            "payloads": [{
                "id": "abc",
                "target": 5,
                "intentCode": "xfer-full",
                "reason": "payload-missing"
            }]
        });
        let intent: ServerIntent = serde_json::from_value(payload).unwrap();
        assert_eq!(intent.payloads.len(), 1);
        let p = &intent.payloads[0];
        assert_eq!(p.id, "abc");
        assert_eq!(p.target, 5);
        assert_eq!(p.intent_code, IntentCode::XferFull);
        assert_eq!(p.reason, "payload-missing");
    }

    #[test]
    fn put_object_keeps_object_as_json_value() {
        let payload = json!({
            "version": 42,
            "kind": "flag",
            "key": "my-flag",
            "object": {"on": true, "variations": [false, true]}
        });
        let put: PutObject = serde_json::from_value(payload).unwrap();
        assert_eq!(put.version, 42);
        assert_eq!(put.kind, "flag");
        assert_eq!(put.key, "my-flag");
        assert_eq!(put.object["on"], json!(true));
    }

    #[test]
    fn goodbye_handles_optional_fields() {
        let bare: Goodbye = serde_json::from_value(json!({})).unwrap();
        assert!(bare.reason.is_none());
        assert!(bare.protocol_fallback_ttl.is_none());

        let full: Goodbye =
            serde_json::from_value(json!({"reason": "rotation", "protocolFallbackTTL": 30}))
                .unwrap();
        assert_eq!(full.reason.as_deref(), Some("rotation"));
        assert_eq!(full.protocol_fallback_ttl, Some(30));
    }

    #[test]
    fn fdv2_error_handles_optional_id() {
        let with_id: FDv2Error =
            serde_json::from_value(json!({"id": "payload-1", "reason": "bad"})).unwrap();
        assert_eq!(with_id.id.as_deref(), Some("payload-1"));
        assert_eq!(with_id.reason, "bad");

        let no_id: FDv2Error = serde_json::from_value(json!({"reason": "other"})).unwrap();
        assert!(no_id.id.is_none());
        assert_eq!(no_id.reason, "other");
    }
}