[router] cleaned up all the redundant comments in the config module (#12147)
This commit is contained in:
@@ -5,9 +5,7 @@ use crate::core::ConnectionMode;
|
||||
pub struct ConfigValidator;
|
||||
|
||||
impl ConfigValidator {
|
||||
/// Validate a complete router configuration
|
||||
pub fn validate(config: &RouterConfig) -> ConfigResult<()> {
|
||||
// Check if service discovery is enabled
|
||||
let has_service_discovery = config.discovery.as_ref().is_some_and(|d| d.enabled);
|
||||
|
||||
Self::validate_mode(&config.mode, has_service_discovery)?;
|
||||
@@ -24,55 +22,46 @@ impl ConfigValidator {
|
||||
|
||||
Self::validate_compatibility(config)?;
|
||||
|
||||
// Validate effective retry/CB configs (respect disable flags)
|
||||
let retry_cfg = config.effective_retry_config();
|
||||
let cb_cfg = config.effective_circuit_breaker_config();
|
||||
Self::validate_retry(&retry_cfg)?;
|
||||
Self::validate_circuit_breaker(&cb_cfg)?;
|
||||
|
||||
// Validate Oracle configuration if enabled
|
||||
if config.history_backend == HistoryBackend::Oracle {
|
||||
if config.oracle.is_none() {
|
||||
return Err(ConfigError::MissingRequired {
|
||||
field: "oracle".to_string(),
|
||||
});
|
||||
}
|
||||
// Validate Oracle configuration details
|
||||
if let Some(oracle) = &config.oracle {
|
||||
Self::validate_oracle(oracle)?;
|
||||
}
|
||||
}
|
||||
|
||||
// Validate tokenizer cache configuration
|
||||
Self::validate_tokenizer_cache(&config.tokenizer_cache)?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Validate Oracle configuration
|
||||
fn validate_oracle(oracle: &OracleConfig) -> ConfigResult<()> {
|
||||
// Validate username is not empty
|
||||
if oracle.username.is_empty() {
|
||||
return Err(ConfigError::MissingRequired {
|
||||
field: "oracle.username".to_string(),
|
||||
});
|
||||
}
|
||||
|
||||
// Validate password is not empty
|
||||
if oracle.password.is_empty() {
|
||||
return Err(ConfigError::MissingRequired {
|
||||
field: "oracle.password".to_string(),
|
||||
});
|
||||
}
|
||||
|
||||
// Validate connect_descriptor is not empty
|
||||
if oracle.connect_descriptor.is_empty() {
|
||||
return Err(ConfigError::MissingRequired {
|
||||
field: "oracle_dsn or oracle_tns_alias".to_string(),
|
||||
});
|
||||
}
|
||||
|
||||
// Validate pool_min is at least 1
|
||||
if oracle.pool_min < 1 {
|
||||
return Err(ConfigError::InvalidValue {
|
||||
field: "oracle.pool_min".to_string(),
|
||||
@@ -81,7 +70,6 @@ impl ConfigValidator {
|
||||
});
|
||||
}
|
||||
|
||||
// Validate pool_max is greater than or equal to pool_min
|
||||
if oracle.pool_max < oracle.pool_min {
|
||||
return Err(ConfigError::InvalidValue {
|
||||
field: "oracle.pool_max".to_string(),
|
||||
@@ -90,7 +78,6 @@ impl ConfigValidator {
|
||||
});
|
||||
}
|
||||
|
||||
// Validate pool_timeout_secs is greater than 0
|
||||
if oracle.pool_timeout_secs == 0 {
|
||||
return Err(ConfigError::InvalidValue {
|
||||
field: "oracle.pool_timeout_secs".to_string(),
|
||||
@@ -102,17 +89,13 @@ impl ConfigValidator {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Validate routing mode configuration
|
||||
fn validate_mode(mode: &RoutingMode, has_service_discovery: bool) -> ConfigResult<()> {
|
||||
match mode {
|
||||
RoutingMode::Regular { worker_urls } => {
|
||||
// Validate URLs if any are provided
|
||||
if !worker_urls.is_empty() {
|
||||
Self::validate_urls(worker_urls)?;
|
||||
}
|
||||
// Note: We allow empty worker URLs even without service discovery
|
||||
// to let the router start and fail at runtime when routing requests.
|
||||
// This matches legacy behavior and test expectations.
|
||||
// Allow empty URLs without service discovery to match legacy behavior
|
||||
}
|
||||
RoutingMode::PrefillDecode {
|
||||
prefill_urls,
|
||||
@@ -120,7 +103,6 @@ impl ConfigValidator {
|
||||
prefill_policy,
|
||||
decode_policy,
|
||||
} => {
|
||||
// Only require URLs if service discovery is disabled
|
||||
if !has_service_discovery {
|
||||
if prefill_urls.is_empty() {
|
||||
return Err(ConfigError::ValidationFailed {
|
||||
@@ -134,7 +116,6 @@ impl ConfigValidator {
|
||||
}
|
||||
}
|
||||
|
||||
// Validate URLs if any are provided
|
||||
if !prefill_urls.is_empty() {
|
||||
let prefill_url_strings: Vec<String> =
|
||||
prefill_urls.iter().map(|(url, _)| url.clone()).collect();
|
||||
@@ -144,7 +125,6 @@ impl ConfigValidator {
|
||||
Self::validate_urls(decode_urls)?;
|
||||
}
|
||||
|
||||
// Validate bootstrap ports
|
||||
for (_url, port) in prefill_urls {
|
||||
if let Some(port) = port {
|
||||
if *port == 0 {
|
||||
@@ -157,7 +137,6 @@ impl ConfigValidator {
|
||||
}
|
||||
}
|
||||
|
||||
// Validate optional prefill and decode policies
|
||||
if let Some(p_policy) = prefill_policy {
|
||||
Self::validate_policy(p_policy)?;
|
||||
}
|
||||
@@ -166,25 +145,20 @@ impl ConfigValidator {
|
||||
}
|
||||
}
|
||||
RoutingMode::OpenAI { worker_urls } => {
|
||||
// Require at least one worker URL for OpenAI router
|
||||
if worker_urls.is_empty() {
|
||||
return Err(ConfigError::ValidationFailed {
|
||||
reason: "OpenAI mode requires at least one --worker-urls entry".to_string(),
|
||||
});
|
||||
}
|
||||
// Validate URLs
|
||||
Self::validate_urls(worker_urls)?;
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Validate policy configuration
|
||||
fn validate_policy(policy: &PolicyConfig) -> ConfigResult<()> {
|
||||
match policy {
|
||||
PolicyConfig::Random | PolicyConfig::RoundRobin => {
|
||||
// No specific validation needed
|
||||
}
|
||||
PolicyConfig::Random | PolicyConfig::RoundRobin => {}
|
||||
PolicyConfig::CacheAware {
|
||||
cache_threshold,
|
||||
balance_abs_threshold: _,
|
||||
@@ -239,7 +213,6 @@ impl ConfigValidator {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Validate server configuration
|
||||
fn validate_server_settings(config: &RouterConfig) -> ConfigResult<()> {
|
||||
if config.port == 0 {
|
||||
return Err(ConfigError::InvalidValue {
|
||||
@@ -302,10 +275,9 @@ impl ConfigValidator {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Validate service discovery configuration
|
||||
fn validate_discovery(discovery: &DiscoveryConfig, mode: &RoutingMode) -> ConfigResult<()> {
|
||||
if !discovery.enabled {
|
||||
return Ok(()); // No validation needed if disabled
|
||||
return Ok(());
|
||||
}
|
||||
|
||||
if discovery.port == 0 {
|
||||
@@ -324,7 +296,6 @@ impl ConfigValidator {
|
||||
});
|
||||
}
|
||||
|
||||
// Validate selectors based on mode
|
||||
match mode {
|
||||
RoutingMode::Regular { .. } => {
|
||||
if discovery.selector.is_empty() {
|
||||
@@ -342,7 +313,6 @@ impl ConfigValidator {
|
||||
}
|
||||
}
|
||||
RoutingMode::OpenAI { .. } => {
|
||||
// OpenAI mode doesn't use service discovery
|
||||
return Err(ConfigError::ValidationFailed {
|
||||
reason: "OpenAI mode does not support service discovery".to_string(),
|
||||
});
|
||||
@@ -352,7 +322,6 @@ impl ConfigValidator {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Validate metrics configuration
|
||||
fn validate_metrics(metrics: &MetricsConfig) -> ConfigResult<()> {
|
||||
if metrics.port == 0 {
|
||||
return Err(ConfigError::InvalidValue {
|
||||
@@ -373,7 +342,6 @@ impl ConfigValidator {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Validate retry configuration
|
||||
fn validate_retry(retry: &RetryConfig) -> ConfigResult<()> {
|
||||
if retry.max_retries < 1 {
|
||||
return Err(ConfigError::InvalidValue {
|
||||
@@ -413,7 +381,6 @@ impl ConfigValidator {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Validate circuit breaker configuration
|
||||
fn validate_circuit_breaker(cb: &CircuitBreakerConfig) -> ConfigResult<()> {
|
||||
if cb.failure_threshold < 1 {
|
||||
return Err(ConfigError::InvalidValue {
|
||||
@@ -446,9 +413,7 @@ impl ConfigValidator {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Validate tokenizer cache configuration
|
||||
fn validate_tokenizer_cache(cache: &TokenizerCacheConfig) -> ConfigResult<()> {
|
||||
// Validate L0 max entries when L0 is enabled
|
||||
if cache.enable_l0 && cache.l0_max_entries == 0 {
|
||||
return Err(ConfigError::InvalidValue {
|
||||
field: "tokenizer_cache.l0_max_entries".to_string(),
|
||||
@@ -457,7 +422,6 @@ impl ConfigValidator {
|
||||
});
|
||||
}
|
||||
|
||||
// Validate L1 max memory when L1 is enabled
|
||||
if cache.enable_l1 && cache.l1_max_memory == 0 {
|
||||
return Err(ConfigError::InvalidValue {
|
||||
field: "tokenizer_cache.l1_max_memory".to_string(),
|
||||
@@ -469,9 +433,7 @@ impl ConfigValidator {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Validate mTLS certificate configuration
|
||||
fn validate_mtls(config: &RouterConfig) -> ConfigResult<()> {
|
||||
// Validate that if we have client_identity, it's not empty
|
||||
if let Some(identity) = &config.client_identity {
|
||||
if identity.is_empty() {
|
||||
return Err(ConfigError::ValidationFailed {
|
||||
@@ -480,7 +442,6 @@ impl ConfigValidator {
|
||||
}
|
||||
}
|
||||
|
||||
// Validate CA certificates are not empty
|
||||
for (idx, ca_cert) in config.ca_certificates.iter().enumerate() {
|
||||
if ca_cert.is_empty() {
|
||||
return Err(ConfigError::ValidationFailed {
|
||||
@@ -492,14 +453,11 @@ impl ConfigValidator {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Validate compatibility between different configuration sections
|
||||
fn validate_compatibility(config: &RouterConfig) -> ConfigResult<()> {
|
||||
// IGW mode is independent - skip other compatibility checks when enabled
|
||||
if config.enable_igw {
|
||||
return Ok(());
|
||||
}
|
||||
|
||||
// Validate gRPC connection mode requires tokenizer configuration
|
||||
if matches!(config.connection_mode, ConnectionMode::Grpc { .. })
|
||||
&& config.tokenizer_path.is_none()
|
||||
&& config.model_path.is_none()
|
||||
@@ -509,18 +467,11 @@ impl ConfigValidator {
|
||||
});
|
||||
}
|
||||
|
||||
// Validate mTLS configuration
|
||||
Self::validate_mtls(config)?;
|
||||
|
||||
// All policies are now supported for both router types thanks to the unified trait design
|
||||
// No mode/policy restrictions needed anymore
|
||||
|
||||
// Check if service discovery is enabled for worker count validation
|
||||
let has_service_discovery = config.discovery.as_ref().is_some_and(|d| d.enabled);
|
||||
|
||||
// Only validate worker counts if service discovery is disabled
|
||||
if !has_service_discovery {
|
||||
// Check if power-of-two policy makes sense with insufficient workers
|
||||
if let PolicyConfig::PowerOfTwo { .. } = &config.policy {
|
||||
let worker_count = config.mode.worker_count();
|
||||
if worker_count < 2 {
|
||||
@@ -530,7 +481,6 @@ impl ConfigValidator {
|
||||
}
|
||||
}
|
||||
|
||||
// For PD mode, validate that policies have sufficient workers
|
||||
if let RoutingMode::PrefillDecode {
|
||||
prefill_urls,
|
||||
decode_urls,
|
||||
@@ -538,7 +488,6 @@ impl ConfigValidator {
|
||||
decode_policy,
|
||||
} = &config.mode
|
||||
{
|
||||
// Check power-of-two for prefill
|
||||
if let Some(PolicyConfig::PowerOfTwo { .. }) = prefill_policy {
|
||||
if prefill_urls.len() < 2 {
|
||||
return Err(ConfigError::IncompatibleConfig {
|
||||
@@ -547,7 +496,6 @@ impl ConfigValidator {
|
||||
}
|
||||
}
|
||||
|
||||
// Check power-of-two for decode
|
||||
if let Some(PolicyConfig::PowerOfTwo { .. }) = decode_policy {
|
||||
if decode_urls.len() < 2 {
|
||||
return Err(ConfigError::IncompatibleConfig {
|
||||
@@ -560,8 +508,6 @@ impl ConfigValidator {
|
||||
}
|
||||
}
|
||||
|
||||
// Service discovery is conflict with dp_aware routing for now
|
||||
// since it's not fully supported yet
|
||||
if has_service_discovery && config.dp_aware {
|
||||
return Err(ConfigError::IncompatibleConfig {
|
||||
reason: "DP-aware routing is not compatible with service discovery".to_string(),
|
||||
@@ -571,7 +517,6 @@ impl ConfigValidator {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Validate URL format
|
||||
fn validate_urls(urls: &[String]) -> ConfigResult<()> {
|
||||
for url in urls {
|
||||
if url.is_empty() {
|
||||
@@ -593,10 +538,8 @@ impl ConfigValidator {
|
||||
});
|
||||
}
|
||||
|
||||
// Basic URL validation
|
||||
match ::url::Url::parse(url) {
|
||||
Ok(parsed) => {
|
||||
// Additional validation
|
||||
if parsed.host_str().is_none() {
|
||||
return Err(ConfigError::InvalidValue {
|
||||
field: "worker_url".to_string(),
|
||||
|
||||
Reference in New Issue
Block a user