feat: EvalDetail support variation-index

Author: SSebo

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 edition = "2021"
 name = "feature-probe-server-sdk"
-version = "1.0.4"
+version = "1.0.5"
 license = "Apache-2.0"
 authors = ["maintain@featureprobe.com"]
 description = "FeatureProbe Server Side SDK for Rust"
@@ -43,8 +43,8 @@ thiserror = "1.0"
 tracing = "0.1"
 url = "2"
 
-feature-probe-event-std = { optional = true, version = "1.0.3", package="feature-probe-event" }
-feature-probe-event-tokio = { optional = true, version = "1.0.3", features=["use_tokio"], default-features=false, package="feature-probe-event" }
+feature-probe-event-std = { optional = true, version = "1.0.4", package="feature-probe-event" }
+feature-probe-event-tokio = { optional = true, version = "1.0.4", features=["use_tokio"], default-features=false, package="feature-probe-event" }
 
 reqwest = { optional = true, version = "0.11", default-features = false, features = ["rustls-tls", "json"] }
 tokio = {optional = true, version = "1", features = ["full"]}
@@ -59,5 +59,5 @@ criterion = "0.3"
 rusty-hook = "^0.11.2"
 tokio = { version = "1", features = ["full"] }
 tracing-subscriber = "0.3"
-feature-probe-server = "1.0.3"
+feature-probe-server = "1.0.4"
 

Cargo.toml

@@ -18,8 +18,14 @@ pub enum Serve {
     Split(Distribution),
 }
 
+#[derive(Serialize, Deserialize, Debug)]
+pub struct Variation {
+    pub value: Value,
+    pub index: usize,
+}
+
 impl Serve {
-    pub fn select_variation(&self, eval_param: &EvalParams) -> Result<Value, FPError> {
+    pub fn select_variation(&self, eval_param: &EvalParams) -> Result<Variation, FPError> {
         let variations = eval_param.variations;
         let index = match self {
             Serve::Select(i) => *i,
@@ -33,9 +39,17 @@ impl Serve {
                 variations.len()
             ))),
             None => Err(FPError::EvalError),
-            Some(v) => Ok(v.clone()),
+            Some(v) => Ok(Variation {
+                value: v.clone(),
+                index,
+            }),
         }
     }
+
+    pub fn select_variation_value(&self, eval_param: &EvalParams) -> Result<Value, FPError> {
+        let v = self.select_variation(eval_param)?;
+        Ok(v.value)
+    }
 }
 
 #[derive(Serialize, Deserialize, Debug, PartialEq)]
@@ -119,6 +133,7 @@ pub struct EvalParams<'a> {
 pub struct EvalDetail<T> {
     pub value: Option<T>,
     pub rule_index: Option<usize>,
+    pub variation_index: Option<usize>,
     pub version: Option<u64>,
     pub reason: String,
 }
@@ -151,16 +166,16 @@ impl Toggle {
         };
 
         if !self.enabled {
-            return self.disabled_serve.select_variation(&eval_param);
+            return self.disabled_serve.select_variation_value(&eval_param);
         }
 
         for rule in &self.rules {
-            if let Some(value) = rule.serve_variation(&eval_param)? {
-                return Ok(value);
+            if let Some(v) = rule.serve_variation(&eval_param)? {
+                return Ok(v.value);
             }
         }
 
-        self.default_serve.select_variation(&eval_param)
+        self.default_serve.select_variation_value(&eval_param)
     }
 
     pub fn eval_detail(
@@ -176,8 +191,10 @@ impl Toggle {
             variations: &self.variations,
         };
         if !self.enabled {
+            let v = self.disabled_serve.select_variation(&eval_param).ok();
             return EvalDetail {
-                value: self.disabled_serve.select_variation(&eval_param).ok(),
+                variation_index: v.as_ref().map(|v| v.index),
+                value: v.map(|v| v.value),
                 version: Some(self.version),
                 reason: "disabled".to_owned(),
                 ..Default::default()
@@ -188,7 +205,8 @@ impl Toggle {
                 Ok(opt_value) => {
                     if let Some(v) = opt_value {
                         return EvalDetail {
-                            value: Some(v),
+                            value: Some(v.value),
+                            variation_index: Some(v.index),
                             rule_index: Some(i),
                             version: Some(self.version),
                             reason: format!("rule {}", i),
@@ -209,7 +227,8 @@ impl Toggle {
 
         match self.default_serve.select_variation(&eval_param) {
             Ok(v) => EvalDetail {
-                value: Some(v),
+                value: Some(v.value),
+                variation_index: Some(v.index),
                 version: Some(self.version),
                 reason: "default.".to_owned(),
                 ..Default::default()
@@ -269,7 +288,7 @@ struct Rule {
 }
 
 impl Rule {
-    pub fn serve_variation(&self, eval_param: &EvalParams) -> Result<Option<Value>, FPError> {
+    pub fn serve_variation(&self, eval_param: &EvalParams) -> Result<Option<Variation>, FPError> {
         let user = eval_param.user;
         let segment_repo = eval_param.segment_repo;
         match self

src/evalutate.rs

@@ -154,7 +154,7 @@ impl FeatureProbe {
             time: unix_timestamp(),
             key: toggle.to_owned(),
             value: value.clone(),
-            index: detail.rule_index,
+            index: detail.variation_index,
             version: detail.version,
             reason: detail.reason.clone(),
         });

src/feature_probe.rs

@@ -160,6 +160,7 @@ mod tests {
     use super::*;
     use crate::SdkAuthorization;
     use axum::{routing::get, Json, Router, TypedHeader};
+    use headers::UserAgent;
     use std::{fs, net::SocketAddr, path::PathBuf};
 
     #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
@@ -206,8 +207,11 @@ mod tests {
 
     async fn server_sdk_toggles(
         TypedHeader(SdkAuthorization(sdk_key)): TypedHeader<SdkAuthorization>,
+        TypedHeader(user_agent): TypedHeader<UserAgent>,
     ) -> Json<Repository> {
         assert_eq!(sdk_key, "sdk-key");
+        assert!(user_agent.to_string().len() > 0);
+        println!(">>> {}", user_agent);
         let mut path = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
         path.push("resources/fixtures/repo.json");
         let json_str = fs::read_to_string(path).unwrap();