feat: upgrade types library, unfortunately this does two things - add…

…s new optional metrics data and adds backwards compatability for impression_data (#489)
Unleash · Jul 19, 2024 · 9795c7c · 9795c7c
1 parent 4b43ff0
commit 9795c7c
Show file tree

Hide file tree

Showing 6 changed files with 142 additions and 18 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/server/Cargo.toml b/server/Cargo.toml
@@ -83,8 +83,8 @@ tokio = { version = "1.38.0", features = [
 tracing = { version = "0.1.40", features = ["log"] }
 tracing-subscriber = { version = "0.3.18", features = ["json", "env-filter"] }
 ulid = "1.1.2"
-unleash-types = { version = "0.12", features = ["openapi", "hashes"] }
-unleash-yggdrasil = { version = "0.12.0" }
+unleash-types = { version = "0.13", features = ["openapi", "hashes"] }
+unleash-yggdrasil = { version = "0.13.0" }
 utoipa = { version = "4.2.3", features = ["actix_extras", "chrono"] }
 utoipa-swagger-ui = { version = "7.1.0", features = ["actix-web"] }
 [dev-dependencies]

diff --git a/server/src/client_api.rs b/server/src/client_api.rs
@@ -283,7 +283,7 @@ mod tests {
         ClientFeature, Constraint, Operator, Strategy, StrategyVariant,
     };
     use unleash_types::client_metrics::{
-        ClientMetricsEnv, ConnectViaBuilder, MetricBucket, ToggleStats,
+        ClientMetricsEnv, ConnectViaBuilder, MetricBucket, MetricsMetadata, ToggleStats,
     };
     use unleash_yggdrasil::EngineState;
 
@@ -310,6 +310,12 @@ mod tests {
                     },
                 },
                 environment: Some("development".into()),
+                metadata: MetricsMetadata {
+                    platform_name: Some("test".into()),
+                    platform_version: Some("1.0".into()),
+                    sdk_version: Some("1.0".into()),
+                    yggdrasil_version: None,
+                },
             }))
             .to_request()
     }
@@ -329,9 +335,14 @@ mod tests {
                 environment: None,
                 instance_id: None,
                 interval: 10,
-                sdk_version: None,
                 started: Default::default(),
                 strategies: vec![],
+                metadata: MetricsMetadata {
+                    platform_name: None,
+                    platform_version: None,
+                    sdk_version: None,
+                    yggdrasil_version: None,
+                },
             }],
             metrics: vec![ClientMetricsEnv {
                 feature_name: "".to_string(),
@@ -341,6 +352,12 @@ mod tests {
                 yes: 0,
                 no: 0,
                 variants: Default::default(),
+                metadata: MetricsMetadata {
+                    platform_name: None,
+                    platform_version: None,
+                    sdk_version: None,
+                    yggdrasil_version: None,
+                },
             }],
         }))
         .to_request()
@@ -407,6 +424,12 @@ mod tests {
             yes: 1,
             no: 0,
             variants: HashMap::new(),
+            metadata: MetricsMetadata {
+                platform_name: None,
+                platform_version: None,
+                sdk_version: None,
+                yggdrasil_version: None
+            }
         };
 
         assert_eq!(found_metric.yes, expected.yes);

diff --git a/server/src/frontend_api.rs b/server/src/frontend_api.rs
@@ -487,6 +487,7 @@ pub fn evaluate_feature(
                 payload: r.variant.payload,
             },
             impression_data: r.impression_data,
+            impressionData: r.impression_data
         })
         .ok_or_else(|| EdgeError::FeatureNotFound(feature_name.clone()))
 }
@@ -735,6 +736,7 @@ pub fn frontend_from_yggdrasil(
                 payload: resolved.variant.payload.clone(),
             },
             impression_data: resolved.impression_data,
+            impressionData: resolved.impression_data
         })
         .collect::<Vec<EvaluatedToggle>>();
     FrontendResult { toggles }
@@ -792,7 +794,7 @@ mod tests {
     use std::str::FromStr;
     use std::sync::Arc;
     use tracing_test::traced_test;
-    use unleash_types::client_metrics::ClientMetricsEnv;
+    use unleash_types::client_metrics::{ClientMetricsEnv, MetricsMetadata};
     use unleash_types::{
         client_features::{ClientFeature, ClientFeatures, Constraint, Operator, Strategy},
         frontend::{EvaluatedToggle, EvaluatedVariant, FrontendResult},
@@ -1005,6 +1007,7 @@ mod tests {
                     payload: None,
                 },
                 impression_data: false,
+                impressionData: false
             }],
         };
 
@@ -1062,6 +1065,7 @@ mod tests {
                     payload: None,
                 },
                 impression_data: false,
+                impressionData: false
             }],
         };
 
@@ -1117,6 +1121,7 @@ mod tests {
                     payload: None,
                 },
                 impression_data: false,
+                impressionData: false
             }],
         };
 
@@ -1192,6 +1197,12 @@ mod tests {
             yes: 1,
             no: 0,
             variants: HashMap::new(),
+            metadata: MetricsMetadata {
+                platform_name: None,
+                platform_version: None,
+                sdk_version: None,
+                yggdrasil_version: None,
+            },
         };
 
         assert_eq!(found_metric.yes, expected.yes);

diff --git a/server/src/http/feature_refresher.rs b/server/src/http/feature_refresher.rs
@@ -7,7 +7,7 @@ use dashmap::DashMap;
 use reqwest::StatusCode;
 use tracing::{debug, info, warn};
 use unleash_types::client_features::Segment;
-use unleash_types::client_metrics::ClientApplication;
+use unleash_types::client_metrics::{ClientApplication, MetricsMetadata};
 use unleash_types::{
     client_features::{ClientFeature, ClientFeatures},
     Deduplicate,
@@ -124,9 +124,14 @@ fn client_application_from_token(token: EdgeToken, refresh_interval: i64) -> Cli
         environment: token.environment,
         instance_id: None,
         interval: refresh_interval as u32,
-        sdk_version: Some(format!("unleash-edge:{}", build::PKG_VERSION)),
         started: Utc::now(),
         strategies: vec![],
+        metadata: MetricsMetadata {
+            platform_name: None,
+            platform_version: None,
+            sdk_version: Some(format!("unleash-edge:{}", build::PKG_VERSION)),
+            yggdrasil_version: None
+        }
     }
 }