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

Jump to bottom

Feat/use etag from upstream #390

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Feat/use etag from upstream #390

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6dcf336
feat: Custom ETag middleware using feature refresher
chriswk Dec 28, 2023
045a426
Calculate etags on feature refresh
chriswk Dec 28, 2023
aefbd01
added tests to see etags based on relevant filter for token
chriswk Dec 29, 2023
c731115
Update tests
chriswk Jan 15, 2024
7fefc52
Clippy warnings
chriswk Jan 15, 2024
3074617
fix: Use if let some instead of single branch match
chriswk Jan 22, 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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ debug/
*.ipr
*.iws
.vscode
mutants.out

.project
.classpath
Expand Down
11 changes: 7 additions & 4 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions server/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ ahash = "0.8.7"

anyhow = "1.0.79"
async-trait = "0.1.77"
base64 = "0.21.7"
chrono = { version = "0.4.31", features = ["serde"] }
cidr = "0.2.2"
clap = { version = "4.4.16", features = ["derive", "env"] }
Expand Down Expand Up @@ -70,6 +71,7 @@ serde = { version = "1.0.195", features = ["derive"] }
serde_json = "1.0.111"
serde_qs = { version = "0.12.0", features = ["actix4", "tracing"] }
shadow-rs = { version = "0.26.0" }
str-buf = "3.0.2"
tokio = { version = "1.35.1", features = [
"macros",
"rt-multi-thread",
Expand All @@ -83,6 +85,7 @@ unleash-types = { version = "0.10", features = ["openapi", "hashes"] }
unleash-yggdrasil = { version = "0.8.0" }
utoipa = { version = "4.2.0", features = ["actix_extras", "chrono"] }
utoipa-swagger-ui = { version = "6", features = ["actix-web"] }
xxhash-rust = { version = "0.8.8", features = ["xxh3"] }
[dev-dependencies]
actix-http = "3.5.1"
actix-http-test = "3.1.0"
Expand Down
138 changes: 132 additions & 6 deletions server/src/builder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
use actix_web::http::header::EntityTag;
use chrono::Duration;
use dashmap::DashMap;
use reqwest::Url;
Expand All @@ -14,6 +15,7 @@ use crate::{
auth::token_validator::TokenValidator,
cli::{CliArgs, EdgeArgs, EdgeMode, OfflineArgs},
error::EdgeError,
filters, hashing,
http::{feature_refresher::FeatureRefresher, unleash_client::UnleashClient},
types::{EdgeResult, EdgeToken, TokenType},
};
Expand All @@ -24,6 +26,7 @@ type CacheContainer = (
Arc<DashMap<String, EdgeToken>>,
Arc<DashMap<String, ClientFeatures>>,
Arc<DashMap<String, EngineState>>,
Arc<DashMap<EdgeToken, EntityTag>>,
);
type EdgeInfo = (
CacheContainer,
Expand All @@ -36,10 +39,12 @@ fn build_caches() -> CacheContainer {
let token_cache: DashMap<String, EdgeToken> = DashMap::default();
let features_cache: DashMap<String, ClientFeatures> = DashMap::default();
let engine_cache: DashMap<String, EngineState> = DashMap::default();
let etag_cache: DashMap<EdgeToken, EntityTag> = DashMap::default();
(
Arc::new(token_cache),
Arc::new(features_cache),
Arc::new(engine_cache),
Arc::new(etag_cache),
)
}

Expand All @@ -48,18 +53,20 @@ async fn hydrate_from_persistent_storage(
feature_refresher: Arc<FeatureRefresher>,
storage: Arc<dyn EdgePersistence>,
) {
let (token_cache, features_cache, engine_cache) = cache;
let (token_cache, features_cache, engine_cache, etag_cache) = cache;
let tokens = storage.load_tokens().await.unwrap_or_default();
let features = storage.load_features().await.unwrap_or_default();
let refresh_targets = storage.load_refresh_targets().await.unwrap_or_default();
for token in tokens {
tracing::debug!("Hydrating tokens {token:?}");
token_cache.insert(token.token.clone(), token);
token_cache.insert(token.token.clone(), token.clone());
etag_cache.insert(token.clone(), EntityTag::new_weak("".to_string()));
}

for (key, features) in features {
tracing::debug!("Hydrating features for {key:?}");
features_cache.insert(key.clone(), features.clone());
update_etags(etag_cache.clone(), &key, &features);
let mut engine_state = EngineState::default();
engine_state.take_state(features);
engine_cache.insert(key, engine_state);
Expand All @@ -73,11 +80,25 @@ async fn hydrate_from_persistent_storage(
}
}

fn update_etags(
etag_cache: Arc<DashMap<EdgeToken, EntityTag>>,
key: &str,
features: &ClientFeatures,
) {
let etag = crate::hashing::client_features_to_etag(features);
let token = EdgeToken::from_str(key).unwrap();
etag_cache.iter_mut().for_each(|mut t| {
if token.subsumes(t.key()) || &token == t.key() {
*t.value_mut() = etag.clone();
}
})
}

pub(crate) fn build_offline_mode(
client_features: ClientFeatures,
tokens: Vec<String>,
) -> EdgeResult<CacheContainer> {
let (token_cache, features_cache, engine_cache) = build_caches();
let (token_cache, features_cache, engine_cache, etag_cache) = build_caches();

let edge_tokens: Vec<EdgeToken> = tokens
.iter()
Expand All @@ -93,8 +114,13 @@ pub(crate) fn build_offline_mode(
engine_cache.clone(),
client_features.clone(),
);
let filtered = filters::filter_features_for_token(&client_features, &edge_token);
etag_cache.insert(
edge_token.clone(),
hashing::client_features_to_etag(&filtered),
);
}
Ok((token_cache, features_cache, engine_cache))
Ok((token_cache, features_cache, engine_cache, etag_cache))
}

fn build_offline(offline_args: OfflineArgs) -> EdgeResult<CacheContainer> {
Expand Down Expand Up @@ -131,7 +157,7 @@ async fn get_data_source(args: &EdgeArgs) -> Option<Arc<dyn EdgePersistence>> {
}

async fn build_edge(args: &EdgeArgs) -> EdgeResult<EdgeInfo> {
let (token_cache, feature_cache, engine_cache) = build_caches();
let (token_cache, feature_cache, engine_cache, etag_cache) = build_caches();

let persistence = get_data_source(args).await;

Expand Down Expand Up @@ -162,6 +188,7 @@ async fn build_edge(args: &EdgeArgs) -> EdgeResult<EdgeInfo> {
unleash_client,
feature_cache.clone(),
engine_cache.clone(),
etag_cache.clone(),
Duration::seconds(args.features_refresh_interval_seconds.try_into().unwrap()),
persistence.clone(),
));
Expand All @@ -173,6 +200,7 @@ async fn build_edge(args: &EdgeArgs) -> EdgeResult<EdgeInfo> {
token_cache.clone(),
feature_cache.clone(),
engine_cache.clone(),
etag_cache.clone(),
),
feature_refresher.clone(),
persistence,
Expand All @@ -189,7 +217,7 @@ async fn build_edge(args: &EdgeArgs) -> EdgeResult<EdgeInfo> {
.await;
}
Ok((
(token_cache, feature_cache, engine_cache),
(token_cache, feature_cache, engine_cache, etag_cache),
Some(token_validator),
Some(feature_refresher),
persistence,
Expand All @@ -205,3 +233,101 @@ pub async fn build_caches_and_refreshers(args: CliArgs) -> EdgeResult<EdgeInfo>
_ => unreachable!(),
}
}

#[cfg(test)]
mod tests {
use unleash_types::client_features::{ClientFeature, Strategy};

use super::*;

#[test]
fn building_an_initial_state_from_backup_also_adds_etags_for_features() {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice test case!

let client_features = ClientFeatures {
version: 2,
features: vec![
ClientFeature {
name: "first_feature".into(),
feature_type: Some("Release".into()),
description: None,
created_at: None,
last_seen_at: None,
enabled: true,
stale: Some(false),
impression_data: Some(false),
project: Some("default".into()),
strategies: Some(vec![Strategy {
name: "gradualRollout".into(),
sort_order: Some(1),
segments: None,
constraints: None,
parameters: None,
variants: None,
}]),
variants: None,
dependencies: None,
},
ClientFeature {
name: "second_feature".into(),
feature_type: Some("Release".into()),
description: None,
created_at: None,
last_seen_at: None,
enabled: true,
stale: Some(false),
impression_data: Some(false),
project: Some("eg".into()),
strategies: Some(vec![Strategy {
name: "gradualRollout".into(),
sort_order: Some(1),
segments: None,
constraints: None,
parameters: None,
variants: None,
}]),
variants: None,
dependencies: None,
},
ClientFeature {
name: "third_feature".into(),
feature_type: Some("Release".into()),
description: None,
created_at: None,
last_seen_at: None,
enabled: true,
stale: Some(false),
impression_data: Some(false),
project: Some("default".into()),
strategies: Some(vec![Strategy {
name: "gradualRollout".into(),
sort_order: Some(1),
segments: None,
constraints: None,
parameters: None,
variants: None,
}]),
variants: None,
dependencies: None,
},
],
segments: None,
query: None,
};
let wildcard_token = EdgeToken::from_str("*:development.somerandomstring").unwrap();
let subsumed_token = EdgeToken::from_str("eg:development.someotherrandomstring").unwrap();
let (_, _, _, etag_cache) = build_offline_mode(
client_features,
vec![wildcard_token.token.clone(), subsumed_token.token.clone()],
)
.unwrap();
assert!(etag_cache.contains_key(&wildcard_token));
assert!(etag_cache.contains_key(&subsumed_token));
assert_eq!(
etag_cache.get(&wildcard_token).unwrap().value(),
&EntityTag::new_weak("248-ISJs9qZR-gpTrJaMsTeZ8g==".into())
);
assert_eq!(
etag_cache.get(&subsumed_token).unwrap().value(),
&EntityTag::new_weak("da-ufCoeTJdSw9a7U9Av9k1qQ==".into())
);
}
}
Loading