Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[wip] fix: handle top-level properties #442

Closed
wants to merge 9 commits into from
Closed

[wip] fix: handle top-level properties #442

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
959d614
test: add test
thomasheartman Mar 11, 2024
b71b940
fix: add missing instrumentation line
thomasheartman Mar 12, 2024
a2fe693
fix: add wrapper type
thomasheartman Mar 12, 2024
1267243
fix: overwrite logic
thomasheartman Mar 12, 2024
1966067
fix: remove derive
thomasheartman Mar 12, 2024
0d2c244
fix: support incoming in get requests
thomasheartman Mar 12, 2024
3fd5bc1
fix: support post endpoints
thomasheartman Mar 12, 2024
0f43e3c
fix: remove unused attributes. That feature doesn't even exist. Proba…
thomasheartman Mar 12, 2024
73241c7
fix: start updating other places
thomasheartman Mar 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
164 changes: 149 additions & 15 deletions server/src/frontend_api.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
use unleash_yggdrasil::{EngineState, ResolvedToggle};

use crate::error::EdgeError::ContextParseError;
use crate::types::ClientIp;
use crate::types::{ClientIp, IncomingContext};
use crate::{
error::{EdgeError, FrontendHydrationMissing},
metrics::client_metrics::MetricsCache,
Expand Down Expand Up @@ -103,7 +103,7 @@
edge_token: EdgeToken,
engine_cache: Data<DashMap<String, EngineState>>,
token_cache: Data<DashMap<String, EdgeToken>>,
context: Json<Context>,
context: Json<IncomingContext>,
req: HttpRequest,
) -> EdgeJsonResult<FrontendResult> {
post_all_features(
Expand Down Expand Up @@ -184,7 +184,7 @@
edge_token: EdgeToken,
engine_cache: Data<DashMap<String, EngineState>>,
token_cache: Data<DashMap<String, EdgeToken>>,
context: Json<Context>,
context: Json<IncomingContext>,
req: HttpRequest,
) -> EdgeJsonResult<FrontendResult> {
post_all_features(
Expand All @@ -200,10 +200,10 @@
edge_token: EdgeToken,
engine_cache: Data<DashMap<String, EngineState>>,
token_cache: Data<DashMap<String, EdgeToken>>,
context: Json<Context>,
context: Json<IncomingContext>,
client_ip: Option<&ClientIp>,
) -> EdgeJsonResult<FrontendResult> {
let context = context.into_inner();
let context = context.into_inner().into();

Check failure

Code scanning / clippy

type annotations needed Error

type annotations needed
let context_with_ip = if context.remote_address.is_none() {
Context {
remote_address: client_ip.map(|ip| ip.to_string()),
Expand Down Expand Up @@ -241,11 +241,12 @@
)
)]
#[get("")]
#[instrument(skip(edge_token, req, engine_cache, token_cache))]
async fn get_enabled_proxy(
edge_token: EdgeToken,
engine_cache: Data<DashMap<String, EngineState>>,
token_cache: Data<DashMap<String, EdgeToken>>,
context: QsQuery<Context>,
context: QsQuery<IncomingContext>,
req: HttpRequest,
) -> EdgeJsonResult<FrontendResult> {
get_enabled_features(
Expand Down Expand Up @@ -275,7 +276,7 @@
edge_token: EdgeToken,
engine_cache: Data<DashMap<String, EngineState>>,
token_cache: Data<DashMap<String, EdgeToken>>,
context: QsQuery<Context>,
context: QsQuery<IncomingContext>,
req: HttpRequest,
) -> EdgeJsonResult<FrontendResult> {
debug!("getting enabled features");
Expand All @@ -293,9 +294,10 @@
edge_token: EdgeToken,
engine_cache: Data<DashMap<String, EngineState>>,
token_cache: Data<DashMap<String, EdgeToken>>,
context: Context,
incoming_context: IncomingContext,
client_ip: Option<ClientIp>,
) -> EdgeJsonResult<FrontendResult> {
let context = incoming_context.into();

Check failure

Code scanning / clippy

type annotations needed Error

type annotations needed
let context_with_ip = if context.remote_address.is_none() {
Context {
remote_address: client_ip.map(|ip| ip.to_string()),
Expand Down Expand Up @@ -341,7 +343,7 @@
edge_token: EdgeToken,
engine_cache: Data<DashMap<String, EngineState>>,
token_cache: Data<DashMap<String, EdgeToken>>,
context: Json<Context>,
context: Json<IncomingContext>,
req: HttpRequest,
) -> EdgeJsonResult<FrontendResult> {
let client_ip = req.extensions().get::<ClientIp>().cloned();
Expand All @@ -365,7 +367,7 @@
edge_token: EdgeToken,
engine_cache: Data<DashMap<String, EngineState>>,
token_cache: Data<DashMap<String, EdgeToken>>,
context: Json<Context>,
context: Json<IncomingContext>,
req: HttpRequest,
) -> EdgeJsonResult<FrontendResult> {
let client_ip = req.extensions().get::<ClientIp>().cloned();
Expand Down Expand Up @@ -445,18 +447,19 @@
pub fn evaluate_feature(
edge_token: EdgeToken,
feature_name: String,
context: &Context,
incoming_context: &IncomingContext,
token_cache: Data<DashMap<String, EdgeToken>>,
engine_cache: Data<DashMap<String, EngineState>>,
client_ip: Option<ClientIp>,
) -> EdgeResult<EvaluatedToggle> {
let context: Context = incoming_context.clone().into();
let context_with_ip = if context.remote_address.is_none() {
Context {
remote_address: client_ip.map(|ip| ip.to_string()),
..context.clone()
..context
}
} else {
context.clone()
context
};
let validated_token = token_cache
.get(&edge_token.token)
Expand Down Expand Up @@ -492,10 +495,10 @@
edge_token: EdgeToken,
engine_cache: Data<DashMap<String, EngineState>>,
token_cache: Data<DashMap<String, EdgeToken>>,
context: Json<Context>,
context: Json<IncomingContext>,
client_ip: Option<ClientIp>,
) -> EdgeJsonResult<FrontendResult> {
let context = context.into_inner();
let context: Context = context.into_inner().into();
let context_with_ip = if context.remote_address.is_none() {
Context {
remote_address: client_ip.map(|ip| ip.to_string()),
Expand Down Expand Up @@ -859,6 +862,34 @@
}
}

fn client_features_with_constraint_requiring_test_property_to_be_42() -> ClientFeatures {
ClientFeatures {
version: 1,
features: vec![ClientFeature {
name: "test".into(),
enabled: true,
strategies: Some(vec![Strategy {
name: "default".into(),
sort_order: None,
segments: None,
variants: None,
constraints: Some(vec![Constraint {
context_name: "test_property".into(),
operator: Operator::In,
case_insensitive: false,
inverted: false,
values: Some(vec!["42".into()]),
value: None,
}]),
parameters: None,
}]),
..ClientFeature::default()
}],
segments: None,
query: None,
}
}

fn client_features_with_constraint_one_enabled_toggle_and_one_disabled_toggle() -> ClientFeatures
{
ClientFeatures {
Expand Down Expand Up @@ -979,6 +1010,109 @@
assert_eq!(result, serde_json::to_vec(&expected).unwrap());
}


#[actix_web::test]
#[traced_test]
async fn calling_get_requests_resolves_top_level_properties_correctly() {
let (feature_cache, token_cache, engine_cache) = build_offline_mode(
client_features_with_constraint_requiring_test_property_to_be_42(),
vec![
"*:development.03fa5f506428fe80ed5640c351c7232e38940814d2923b08f5c05fa7"
.to_string(),
],
)
.unwrap();
let app = test::init_service(
App::new()
.app_data(Data::from(token_cache))
.app_data(Data::from(feature_cache))
.app_data(Data::from(engine_cache))
.service(web::scope("/api/frontend").service(super::get_enabled_frontend))
.service(web::scope("/api/proxy").service(super::get_enabled_proxy)),
)
.await;

let req = |endpoint| test::TestRequest::get()
.uri(format!("/api/{endpoint}?test_property=42").as_str())
.insert_header((
"Authorization",
"*:development.03fa5f506428fe80ed5640c351c7232e38940814d2923b08f5c05fa7",
))
.to_request();

let frontend_result = test::call_and_read_body(&app, req("frontend")).await;
let proxy_result = test::call_and_read_body(&app, req("proxy")).await;
assert_eq!(frontend_result, proxy_result);

let expected = FrontendResult {
toggles: vec![EvaluatedToggle {
name: "test".into(),
enabled: true,
variant: EvaluatedVariant {
name: "disabled".into(),
enabled: false,
payload: None,
},
impression_data: false,
}],
};

assert_eq!(frontend_result, serde_json::to_vec(&expected).unwrap());
}

#[actix_web::test]
#[traced_test]
async fn calling_post_requests_resolves_top_level_properties_correctly() {
let (feature_cache, token_cache, engine_cache) = build_offline_mode(
client_features_with_constraint_requiring_test_property_to_be_42(),
vec![
"*:development.03fa5f506428fe80ed5640c351c7232e38940814d2923b08f5c05fa7"
.to_string(),
],
)
.unwrap();
let app = test::init_service(
App::new()
.app_data(Data::from(token_cache))
.app_data(Data::from(feature_cache))
.app_data(Data::from(engine_cache))
.service(web::scope("/api/frontend").service(super::post_frontend_enabled_features))
.service(web::scope("/api/proxy").service(super::post_proxy_enabled_features)),
)
.await;

let req = |endpoint| test::TestRequest::post()
.uri(format!("/api/{endpoint}").as_str())
.insert_header(ContentType::json())
.insert_header((
"Authorization",
"*:development.03fa5f506428fe80ed5640c351c7232e38940814d2923b08f5c05fa7",
))
.set_json(json!({
"test_property": "42"
}))
.to_request();

let frontend_result = test::call_and_read_body(&app, req("frontend")).await;
let proxy_result = test::call_and_read_body(&app, req("proxy")).await;
assert_eq!(frontend_result, proxy_result);

let expected = FrontendResult {
toggles: vec![EvaluatedToggle {
name: "test".into(),
enabled: true,
variant: EvaluatedVariant {
name: "disabled".into(),
enabled: false,
payload: None,
},
impression_data: false,
}],
};

assert_eq!(frontend_result, serde_json::to_vec(&expected).unwrap());
}

#[actix_web::test]
#[traced_test]
async fn calling_get_requests_resolves_context_values_correctly_with_enabled_filter() {
Expand Down
Loading
Loading