Skip to content

Commit

Permalink
fix: ready if no tokens and no features (#464)
Browse files Browse the repository at this point in the history
  • Loading branch information
@chriswk
chriswk committed May 15, 2024
1 parent ef7d1db commit 9abab18
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 24 deletions.
72 changes: 54 additions & 18 deletions server/src/internal_backstage.rs
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
use std::collections::HashMap;

use crate::auth::token_validator::TokenValidator;
use crate::error::EdgeError;
use crate::http::feature_refresher::FeatureRefresher;
use crate::metrics::actix_web_metrics::PrometheusMetricsHandler;
use crate::metrics::client_metrics::MetricsCache;
use crate::types::{BuildInfo, EdgeJsonResult, EdgeToken, TokenInfo, TokenRefresh};
use crate::types::{ClientMetric, MetricsInfo, Status};
use actix_web::{
get,
web::{self, Json},
Expand All @@ -17,6 +10,14 @@ use serde::{Deserialize, Serialize};
use unleash_types::client_features::ClientFeatures;
use unleash_types::client_metrics::ClientApplication;

use crate::auth::token_validator::TokenValidator;
use crate::error::EdgeError;
use crate::http::feature_refresher::FeatureRefresher;
use crate::metrics::actix_web_metrics::PrometheusMetricsHandler;
use crate::metrics::client_metrics::MetricsCache;
use crate::types::{BuildInfo, EdgeJsonResult, EdgeToken, TokenInfo, TokenRefresh};
use crate::types::{ClientMetric, MetricsInfo, Status};

#[derive(Debug, Serialize, Deserialize)]
pub struct EdgeStatus {
pub status: Status,
Expand Down Expand Up @@ -52,9 +53,10 @@ pub async fn info() -> EdgeJsonResult<BuildInfo> {

#[get("/ready")]
pub async fn ready(
token_cache: web::Data<DashMap<String, EdgeToken>>,
features_cache: web::Data<DashMap<String, ClientFeatures>>,
) -> EdgeJsonResult<EdgeStatus> {
if features_cache.is_empty() {
if !token_cache.is_empty() && features_cache.is_empty() {
Err(EdgeError::NotReady)
} else {
Ok(Json(EdgeStatus::ready()))
Expand Down Expand Up @@ -137,6 +139,15 @@ mod tests {
use std::str::FromStr;
use std::sync::Arc;

use actix_web::{App, web};
use actix_web::body::MessageBody;
use actix_web::http::header::ContentType;
use actix_web::test;
use chrono::Duration;
use dashmap::DashMap;
use unleash_types::client_features::{ClientFeature, ClientFeatures};
use unleash_yggdrasil::EngineState;

use crate::auth::token_validator::TokenValidator;
use crate::http::feature_refresher::FeatureRefresher;
use crate::http::unleash_client::UnleashClient;
Expand All @@ -145,14 +156,6 @@ mod tests {
use crate::tests::upstream_server;
use crate::tokens::cache_key;
use crate::types::{BuildInfo, EdgeToken, Status, TokenInfo, TokenType, TokenValidationStatus};
use actix_web::body::MessageBody;
use actix_web::http::header::ContentType;
use actix_web::test;
use actix_web::{web, App};
use chrono::Duration;
use dashmap::DashMap;
use unleash_types::client_features::{ClientFeature, ClientFeatures};
use unleash_yggdrasil::EngineState;

#[actix_web::test]
async fn test_health_ok() {
Expand Down Expand Up @@ -186,12 +189,17 @@ mod tests {
}

#[actix_web::test]
async fn test_ready_endpoint_without_toggles() {
async fn test_ready_endpoint_with_tokens_without_toggles() {
let client_features: DashMap<String, ClientFeatures> = DashMap::default();
let client_features_arc = Arc::new(client_features);
let token_cache: DashMap<String, EdgeToken> = DashMap::default();
let token = EdgeToken::from_str("[]:fancyenvironment.somerandomsecretstring").unwrap();
token_cache.insert(token.token.clone(), token);
let token_cache_arc = Arc::new(token_cache);
let app = test::init_service(
App::new()
.app_data(web::Data::from(client_features_arc))
.app_data(web::Data::from(token_cache_arc))
.service(web::scope("/internal-backstage").service(super::ready)),
)
.await;
Expand All @@ -206,7 +214,7 @@ mod tests {
}

#[actix_web::test]
async fn test_ready_endpoint_with_toggles() {
async fn test_ready_endpoint_with_tokens_and_toggles() {
let features = ClientFeatures {
features: vec![ClientFeature {
name: "test".to_string(),
Expand All @@ -222,9 +230,37 @@ mod tests {
features.clone(),
);
let client_features_arc = Arc::new(client_features);
let token_cache: DashMap<String, EdgeToken> = DashMap::default();
let token = EdgeToken::from_str("[]:fancyenvironment.somerandomsecretstring").unwrap();
token_cache.insert(token.token.clone(), token);
let token_cache_arc = Arc::new(token_cache);
let app = test::init_service(
App::new()
.app_data(web::Data::from(client_features_arc))
.app_data(web::Data::from(token_cache_arc))
.service(web::scope("/internal-backstage").service(super::ready)),
)
.await;
let req = test::TestRequest::get()
.uri("/internal-backstage/ready")
.insert_header(ContentType::json())
.to_request();
let resp = test::call_service(&app, req).await;
assert!(resp.status().is_success());
let status: EdgeStatus = test::read_body_json(resp).await;
assert_eq!(status.status, Status::Ready);
}

#[actix_web::test]
async fn test_ready_endpoint_without_tokens_and_toggles() {
let client_features: DashMap<String, ClientFeatures> = DashMap::default();
let client_features_arc = Arc::new(client_features);
let token_cache: DashMap<String, EdgeToken> = DashMap::default();
let token_cache_arc = Arc::new(token_cache);
let app = test::init_service(
App::new()
.app_data(web::Data::from(client_features_arc))
.app_data(web::Data::from(token_cache_arc))
.service(web::scope("/internal-backstage").service(super::ready)),
)
.await;
Expand Down
23 changes: 17 additions & 6 deletions server/src/ready_checker.rs
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
use reqwest::{ClientBuilder, Url};

use crate::cli::ReadyCheckArgs;
use crate::error::EdgeError;
use crate::internal_backstage::EdgeStatus;
use crate::tls::build_upstream_certificate;
use crate::types::Status;
use reqwest::{ClientBuilder, Url};

fn build_ready_url(url: &Url) -> Url {
let mut with_path = url.clone();
Expand Down Expand Up @@ -61,18 +62,22 @@ pub async fn check_ready(ready_check_args: ReadyCheckArgs) -> Result<(), EdgeErr

#[cfg(test)]
mod tests {
use crate::cli::ReadyCheckArgs;
use crate::internal_backstage::ready;
use crate::ready_checker::check_ready;
use std::str::FromStr;
use std::sync::Arc;

use actix_http::HttpService;
use actix_http_test::test_server;
use actix_service::map_config;
use actix_web::{App, HttpResponse, web};
use actix_web::dev::AppConfig;
use actix_web::{web, App, HttpResponse};
use dashmap::DashMap;
use std::sync::Arc;
use unleash_types::client_features::{ClientFeature, ClientFeatures};

use crate::cli::ReadyCheckArgs;
use crate::internal_backstage::ready;
use crate::ready_checker::check_ready;
use crate::types::EdgeToken;

#[tokio::test]
pub async fn runs_ready_check() {
let features = ClientFeatures {
Expand All @@ -90,10 +95,16 @@ mod tests {
features.clone(),
);
let client_features_arc = Arc::new(client_features);
let token_cache: DashMap<String, EdgeToken> = DashMap::default();
let token = EdgeToken::from_str("[]:fancyenvironment.somerandomsecretstring").unwrap();
token_cache.insert(token.token.clone(), token);
let token_cache_arc = Arc::new(token_cache);

let srv = test_server(move || {
HttpService::new(map_config(
App::new()
.app_data(web::Data::from(client_features_arc.clone()))
.app_data(web::Data::from(token_cache_arc.clone()))
.service(web::scope("/internal-backstage").service(ready)),
|_| AppConfig::default(),
))
Expand Down

0 comments on commit 9abab18

Please sign in to comment.