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.

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

chore(1-3244): only expose streaming endpoint if in streaming mode #663

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 15 additions & 4 deletions server/src/client_api.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
use crate::cli::{EdgeArgs, EdgeMode};
use crate::error::EdgeError;
use crate::feature_cache::FeatureCache;
use crate::filters::{
Expand Down Expand Up @@ -45,12 +46,22 @@ pub async fn stream_features(
edge_token: EdgeToken,
broadcaster: Data<Broadcaster>,
token_cache: Data<DashMap<String, EdgeToken>>,
edge_mode: Data<EdgeMode>,
filter_query: Query<FeatureFilters>,
) -> EdgeResult<impl Responder> {
let (validated_token, _filter_set, query) =
get_feature_filter(&edge_token, &token_cache, filter_query.clone())?;
match edge_mode.get_ref() {
EdgeMode::Edge(EdgeArgs {
streaming: true, ..
}) => {
let (validated_token, _filter_set, query) =
get_feature_filter(&edge_token, &token_cache, filter_query.clone())?;

broadcaster.connect(validated_token, query).await
broadcaster.connect(validated_token, query).await
}
_ => Err(EdgeError::Forbidden(
"This endpoint is only enabled in streaming mode".into(),
)),
}
}

#[utoipa::path(
Expand Down Expand Up @@ -299,7 +310,7 @@ mod tests {

use crate::auth::token_validator::TokenValidator;
use crate::cli::{OfflineArgs, TokenHeader};
use crate::http::unleash_client::{UnleashClient, ClientMetaInformation};
use crate::http::unleash_client::{ClientMetaInformation, UnleashClient};
use crate::middleware;
use crate::tests::{features_from_disk, upstream_server};
use actix_http::{Request, StatusCode};
Expand Down
3 changes: 3 additions & 0 deletions server/src/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ pub enum EdgeError {
EdgeTokenError,
EdgeTokenParseError,
FeatureNotFound(String),
Forbidden(String),
FrontendExpectedToBeHydrated(String),
FrontendNotYetHydrated(FrontendHydrationMissing),
HealthCheckError(String),
Expand Down Expand Up @@ -212,6 +213,7 @@ impl Display for EdgeError {
}
EdgeError::InvalidTokenWithStrictBehavior => write!(f, "Edge is running with strict behavior and the token is not subsumed by any registered tokens"),
EdgeError::SseError(message) => write!(f, "{}", message),
EdgeError::Forbidden(reason) => write!(f, "{}", reason),
}
}
}
Expand Down Expand Up @@ -253,6 +255,7 @@ impl ResponseError for EdgeError {
EdgeError::NotReady => StatusCode::SERVICE_UNAVAILABLE,
EdgeError::InvalidTokenWithStrictBehavior => StatusCode::FORBIDDEN,
EdgeError::SseError(_) => StatusCode::INTERNAL_SERVER_ERROR,
EdgeError::Forbidden(_) => StatusCode::FORBIDDEN,
}
}

Expand Down
32 changes: 32 additions & 0 deletions server/tests/streaming_test.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ mod streaming_test {
sync::Arc,
};
use unleash_edge::{
cli::{EdgeArgs, EdgeMode, TokenHeader},
feature_cache::FeatureCache,
http::broadcaster::Broadcaster,
tokens::cache_key,
Expand Down Expand Up @@ -188,6 +189,36 @@ mod streaming_test {
});

test_server(move || {
// the streaming endpoint doesn't work unless app data contains an EdgeMode::Edge with streaming: true
let edge_mode = EdgeMode::Edge(EdgeArgs {
streaming: true,
upstream_url: "".into(),
backup_folder: None,
metrics_interval_seconds: 60,
features_refresh_interval_seconds: 60,
token_revalidation_interval_seconds: 60,
tokens: vec!["".into()],
custom_client_headers: vec![],
skip_ssl_verification: false,
client_identity: None,
upstream_certificate_file: None,
upstream_request_timeout: 5,
upstream_socket_timeout: 5,
redis: None,
s3: None,
token_header: TokenHeader {
token_header: "".into(),
},
strict: true,
dynamic: false,
delta: false,
prometheus_remote_write_url: None,
prometheus_push_interval: 60,
prometheus_username: None,
prometheus_password: None,
prometheus_user_id: None,
});

let config = serde_qs::actix::QsQueryConfig::default()
.qs_config(serde_qs::Config::new(5, false));
let metrics_cache = MetricsCache::default();
Expand All @@ -205,6 +236,7 @@ mod streaming_test {
.app_data(web::Data::from(upstream_token_cache.clone()))
.app_data(web::Data::new(metrics_cache))
.app_data(web::Data::new(connect_via))
.app_data(web::Data::new(edge_mode))
.service(
web::scope("/api")
.configure(unleash_edge::client_api::configure_client_api)
Expand Down
Loading