flipt 1.4.1

Flipt Server 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

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use std::collections::HashMap;

#[derive(Default, Serialize)]
pub struct BatchEvaluationRequest {
    pub requests: Vec<EvaluationRequest>,
    pub reference: Option<String>,
}

#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub struct EvaluationRequest {
    pub namespace_key: String,
    pub flag_key: String,
    pub entity_id: String,
    pub context: HashMap<String, String>,
    pub reference: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct BooleanEvaluationResponse {
    pub enabled: bool,
    pub reason: EvaluationReason,
    #[serde(default)]
    pub segment_keys: Vec<String>,
    pub request_id: String,
    pub request_duration_millis: f64,
    pub timestamp: DateTime<Utc>,
    pub flag_key: String,
}

#[derive(Debug, Clone, PartialEq, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct VariantEvaluationResponse {
    #[serde(rename = "match")]
    pub r#match: bool,
    pub segment_keys: Vec<String>,
    pub reason: EvaluationReason,
    pub variant_key: String,
    pub variant_attachment: String,
    pub request_id: String,
    pub request_duration_millis: f64,
    pub timestamp: DateTime<Utc>,
    pub flag_key: String,
}

#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ErrorEvaluationResponse {
    pub flag_key: String,
    pub namespace_key: String,
    pub reason: ErrorEvaluationReason,
}

#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct BatchEvaluationResponse {
    pub request_id: String,
    pub responses: Vec<Response>,
    pub request_duration_millis: f64,
}

#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Response {
    pub r#type: EvaluationResponseType,
    pub boolean_response: Option<BooleanEvaluationResponse>,
    pub variant_response: Option<VariantEvaluationResponse>,
    pub error_response: Option<ErrorEvaluationResponse>,
}

#[derive(Debug, Clone, PartialEq, Deserialize)]
pub enum EvaluationReason {
    #[serde(rename = "UNKNOWN_EVALUATION_REASON")]
    Unknown,
    #[serde(rename = "FLAG_DISABLED_EVALUATION_REASON")]
    FlagDisabled,
    #[serde(rename = "MATCH_EVALUATION_REASON")]
    Match,
    #[serde(rename = "DEFAULT_EVALUATION_REASON")]
    Default,
}

#[derive(Debug, Clone, PartialEq, Deserialize)]
pub enum ErrorEvaluationReason {
    #[serde(rename = "UNKNOWN_ERROR_EVALUATION_REASON")]
    Unknown,
    #[serde(rename = "NOT_FOUND_ERROR_EVALUATION_REASON")]
    NotFound,
}

#[derive(Debug, Clone, PartialEq, Deserialize)]
pub enum EvaluationResponseType {
    #[serde(rename = "VARIANT_EVALUATION_RESPONSE_TYPE")]
    Variant,
    #[serde(rename = "BOOLEAN_EVALUATION_RESPONSE_TYPE")]
    Boolean,
    #[serde(rename = "ERROR_EVALUATION_RESPONSE_TYPE")]
    Error,
}

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

    #[test]
    fn boolean_evaluation_response_default_reason() {
        let json = r#"{
            "enabled":true,
            "reason":"DEFAULT_EVALUATION_REASON",
            "requestId":"fb502132-66e5-45a1-a315-f1a91d4f4637",
            "requestDurationMillis":3.070422,
            "timestamp":"2024-05-01T10:05:06.822847492Z",
            "flagKey":"flag_boolean"
        }"#;

        let response: BooleanEvaluationResponse = serde_json::from_str(json).unwrap();

        assert!(response.enabled);
        assert_eq!(response.reason, EvaluationReason::Default);
        assert_eq!(response.request_id, "fb502132-66e5-45a1-a315-f1a91d4f4637");
        assert_eq!(response.request_duration_millis, 3.070422);
        assert_eq!(
            response.timestamp,
            "2024-05-01T10:05:06.822847492Z"
                .parse::<DateTime<Utc>>()
                .unwrap()
        );
        assert_eq!(response.flag_key, "flag_boolean");
        assert!(response.segment_keys.is_empty());
    }
}