Make cfgsync runtime source modes explicit

This commit is contained in:
andrussal 2026-03-10 14:44:28 +01:00
parent daadbcfa15
commit 5e9b59140d
3 changed files with 82 additions and 29 deletions

View File

@ -8,7 +8,7 @@ pub use client::{
run_cfgsync_client_from_env, run_cfgsync_client_from_env,
}; };
pub use server::{ pub use server::{
CfgsyncServerConfig, CfgsyncServingMode, LoadCfgsyncServerConfigError, CfgsyncServerConfig, CfgsyncServerSource, LoadCfgsyncServerConfigError,
build_persisted_snapshot_cfgsync_router, build_snapshot_cfgsync_router, build_persisted_snapshot_cfgsync_router, build_snapshot_cfgsync_router,
serve_cfgsync_from_config, serve_persisted_snapshot_cfgsync, serve_snapshot_cfgsync, serve_cfgsync_from_config, serve_persisted_snapshot_cfgsync, serve_snapshot_cfgsync,
}; };

View File

@ -10,26 +10,38 @@ use cfgsync_core::{
BundleConfigSource, CfgsyncServerState, NodeArtifactsBundle, NodeConfigSource, RunCfgsyncError, BundleConfigSource, CfgsyncServerState, NodeArtifactsBundle, NodeConfigSource, RunCfgsyncError,
build_cfgsync_router, serve_cfgsync, build_cfgsync_router, serve_cfgsync,
}; };
use serde::Deserialize; use serde::{Deserialize, de::Error as _};
use thiserror::Error; use thiserror::Error;
/// Runtime cfgsync server config loaded from YAML. /// Runtime cfgsync server config loaded from YAML.
#[derive(Debug, Deserialize, Clone)] #[derive(Debug, Clone, PartialEq, Eq)]
pub struct CfgsyncServerConfig { pub struct CfgsyncServerConfig {
pub port: u16, pub port: u16,
pub bundle_path: String, pub source: CfgsyncServerSource,
#[serde(default)]
pub serving_mode: CfgsyncServingMode,
} }
#[derive(Debug, Clone, Copy, Deserialize, PartialEq, Eq, Default)] #[derive(Debug, Clone, Deserialize, PartialEq, Eq)]
#[serde(tag = "kind", rename_all = "snake_case")]
pub enum CfgsyncServerSource {
Bundle { bundle_path: String },
RegistrationBundle { bundle_path: String },
}
#[derive(Debug, Clone, Copy, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "snake_case")] #[serde(rename_all = "snake_case")]
pub enum CfgsyncServingMode { enum LegacyServingMode {
#[default]
Bundle, Bundle,
Registration, Registration,
} }
#[derive(Debug, Deserialize)]
struct RawCfgsyncServerConfig {
port: u16,
source: Option<CfgsyncServerSource>,
bundle_path: Option<String>,
serving_mode: Option<LegacyServingMode>,
}
#[derive(Debug, Error)] #[derive(Debug, Error)]
pub enum LoadCfgsyncServerConfigError { pub enum LoadCfgsyncServerConfigError {
#[error("failed to read cfgsync config file {path}: {source}")] #[error("failed to read cfgsync config file {path}: {source}")]
@ -56,11 +68,17 @@ impl CfgsyncServerConfig {
source, source,
})?; })?;
serde_yaml::from_str(&config_content).map_err(|source| { let raw: RawCfgsyncServerConfig =
LoadCfgsyncServerConfigError::Parse { serde_yaml::from_str(&config_content).map_err(|source| {
path: config_path, LoadCfgsyncServerConfigError::Parse {
source, path: config_path,
} source,
}
})?;
Self::from_raw(raw).map_err(|source| LoadCfgsyncServerConfigError::Parse {
path: path.display().to_string(),
source,
}) })
} }
@ -68,19 +86,43 @@ impl CfgsyncServerConfig {
pub fn for_bundle(port: u16, bundle_path: impl Into<String>) -> Self { pub fn for_bundle(port: u16, bundle_path: impl Into<String>) -> Self {
Self { Self {
port, port,
bundle_path: bundle_path.into(), source: CfgsyncServerSource::Bundle {
serving_mode: CfgsyncServingMode::Bundle, bundle_path: bundle_path.into(),
},
} }
} }
#[must_use] #[must_use]
pub fn for_registration(port: u16, bundle_path: impl Into<String>) -> Self { pub fn for_registration_bundle(port: u16, bundle_path: impl Into<String>) -> Self {
Self { Self {
port, port,
bundle_path: bundle_path.into(), source: CfgsyncServerSource::RegistrationBundle {
serving_mode: CfgsyncServingMode::Registration, bundle_path: bundle_path.into(),
},
} }
} }
fn from_raw(raw: RawCfgsyncServerConfig) -> Result<Self, serde_yaml::Error> {
let source = match (raw.source, raw.bundle_path, raw.serving_mode) {
(Some(source), _, _) => source,
(None, Some(bundle_path), Some(LegacyServingMode::Registration)) => {
CfgsyncServerSource::RegistrationBundle { bundle_path }
}
(None, Some(bundle_path), None | Some(LegacyServingMode::Bundle)) => {
CfgsyncServerSource::Bundle { bundle_path }
}
(None, None, _) => {
return Err(serde_yaml::Error::custom(
"cfgsync server config requires source.kind or legacy bundle_path",
));
}
};
Ok(Self {
port: raw.port,
source,
})
}
} }
fn load_bundle_provider(bundle_path: &Path) -> anyhow::Result<Arc<dyn NodeConfigSource>> { fn load_bundle_provider(bundle_path: &Path) -> anyhow::Result<Arc<dyn NodeConfigSource>> {
@ -137,7 +179,7 @@ fn resolve_bundle_path(config_path: &Path, bundle_path: &str) -> std::path::Path
/// Loads runtime config and starts cfgsync HTTP server process. /// Loads runtime config and starts cfgsync HTTP server process.
pub async fn serve_cfgsync_from_config(config_path: &Path) -> anyhow::Result<()> { pub async fn serve_cfgsync_from_config(config_path: &Path) -> anyhow::Result<()> {
let config = CfgsyncServerConfig::load_from_file(config_path)?; let config = CfgsyncServerConfig::load_from_file(config_path)?;
let bundle_path = resolve_bundle_path(config_path, &config.bundle_path); let bundle_path = resolve_source_path(config_path, &config.source);
let state = build_server_state(&config, &bundle_path)?; let state = build_server_state(&config, &bundle_path)?;
serve_cfgsync(config.port, state).await?; serve_cfgsync(config.port, state).await?;
@ -209,12 +251,21 @@ async fn serve_router(port: u16, router: Router) -> Result<(), RunCfgsyncError>
fn build_server_state( fn build_server_state(
config: &CfgsyncServerConfig, config: &CfgsyncServerConfig,
bundle_path: &Path, source_path: &Path,
) -> anyhow::Result<CfgsyncServerState> { ) -> anyhow::Result<CfgsyncServerState> {
let repo = match config.serving_mode { let repo = match &config.source {
CfgsyncServingMode::Bundle => load_bundle_provider(bundle_path)?, CfgsyncServerSource::Bundle { .. } => load_bundle_provider(source_path)?,
CfgsyncServingMode::Registration => load_registration_source(bundle_path)?, CfgsyncServerSource::RegistrationBundle { .. } => load_registration_source(source_path)?,
}; };
Ok(CfgsyncServerState::new(repo)) Ok(CfgsyncServerState::new(repo))
} }
fn resolve_source_path(config_path: &Path, source: &CfgsyncServerSource) -> std::path::PathBuf {
match source {
CfgsyncServerSource::Bundle { bundle_path }
| CfgsyncServerSource::RegistrationBundle { bundle_path } => {
resolve_bundle_path(config_path, bundle_path)
}
}
}

View File

@ -116,15 +116,17 @@ fn build_cfgsync_server_config() -> Value {
Value::Number(4400_u64.into()), Value::Number(4400_u64.into()),
); );
root.insert( let mut source = Mapping::new();
source.insert(
Value::String("kind".to_string()),
Value::String("registration_bundle".to_string()),
);
source.insert(
Value::String("bundle_path".to_string()), Value::String("bundle_path".to_string()),
Value::String("cfgsync.bundle.yaml".to_string()), Value::String("cfgsync.bundle.yaml".to_string()),
); );
root.insert( root.insert(Value::String("source".to_string()), Value::Mapping(source));
Value::String("serving_mode".to_string()),
Value::String("registration".to_string()),
);
Value::Mapping(root) Value::Mapping(root)
} }