use clap::{Args, Parser};
use ipnetwork::IpNetwork;
#[derive(Clone, Debug, Parser)]
#[command(version, about, long_about = None)]
pub struct Config {
#[arg(long, env = "OBSCURA_TTL_DAYS", default_value_t = Config::default().ttl_days)]
pub ttl_days: i64,
#[command(flatten)]
pub database: DatabaseConfig,
#[command(flatten)]
pub server: ServerConfig,
#[command(flatten)]
pub auth: AuthConfig,
#[command(flatten)]
pub rate_limit: RateLimitConfig,
#[command(flatten)]
pub health: HealthConfig,
#[command(flatten)]
pub messaging: MessagingConfig,
#[command(flatten)]
pub notifications: NotificationConfig,
#[command(flatten)]
pub pubsub: PubSubConfig,
#[command(flatten)]
pub websocket: WsConfig,
#[command(flatten)]
pub backup: BackupConfig,
#[command(flatten)]
pub attachment: AttachmentConfig,
#[command(flatten)]
pub storage: StorageConfig,
#[command(flatten)]
pub telemetry: TelemetryConfig,
}
impl Default for Config {
fn default() -> Self {
Self {
ttl_days: 30,
database: DatabaseConfig::default(),
server: ServerConfig::default(),
auth: AuthConfig::default(),
rate_limit: RateLimitConfig::default(),
health: HealthConfig::default(),
messaging: MessagingConfig::default(),
notifications: NotificationConfig::default(),
pubsub: PubSubConfig::default(),
websocket: WsConfig::default(),
backup: BackupConfig::default(),
attachment: AttachmentConfig::default(),
storage: StorageConfig::default(),
telemetry: TelemetryConfig::default(),
}
}
}
impl Config {
#[must_use]
pub fn load() -> Self {
Self::parse()
}
}
#[derive(Clone, Debug, Args)]
pub struct DatabaseConfig {
#[arg(
long = "db-url",
id = "DATABASE_URL",
env = "OBSCURA_DATABASE_URL",
default_value_t = DatabaseConfig::default().url
)]
pub url: String,
#[arg(
long = "db-max-connections",
id = "DATABASE_MAX_CONNECTIONS",
env = "OBSCURA_DATABASE_MAX_CONNECTIONS",
default_value_t = DatabaseConfig::default().max_connections
)]
pub max_connections: u32,
#[arg(long = "db-min-connections", env = "OBSCURA_DATABASE_MIN_CONNECTIONS", default_value_t = DatabaseConfig::default().min_connections)]
pub min_connections: u32,
#[arg(long = "db-acquire-timeout-secs", env = "OBSCURA_DATABASE_ACQUIRE_TIMEOUT_SECS", default_value_t = DatabaseConfig::default().acquire_timeout_secs)]
pub acquire_timeout_secs: u64,
#[arg(long = "db-idle-timeout-secs", env = "OBSCURA_DATABASE_IDLE_TIMEOUT_SECS", default_value_t = DatabaseConfig::default().idle_timeout_secs)]
pub idle_timeout_secs: u64,
#[arg(long = "db-max-lifetime-secs", env = "OBSCURA_DATABASE_MAX_LIFETIME_SECS", default_value_t = DatabaseConfig::default().max_lifetime_secs)]
pub max_lifetime_secs: u64,
}
impl Default for DatabaseConfig {
fn default() -> Self {
Self {
url: "postgres://user:password@localhost/signal_server".to_string(),
max_connections: 20,
min_connections: 5,
acquire_timeout_secs: 3,
idle_timeout_secs: 600,
max_lifetime_secs: 1800,
}
}
}
#[derive(Clone, Debug, Args)]
pub struct PubSubConfig {
#[arg(
long = "pubsub-url",
id = "PUBSUB_URL",
env = "OBSCURA_PUBSUB_URL",
default_value_t = PubSubConfig::default().url
)]
pub url: String,
#[arg(
long = "pubsub-min-backoff-secs",
id = "PUBSUB_MIN_BACKOFF_SECS",
env = "OBSCURA_PUBSUB_MIN_BACKOFF_SECS",
default_value_t = PubSubConfig::default().min_backoff_secs
)]
pub min_backoff_secs: u64,
#[arg(
long = "pubsub-max-backoff-secs",
id = "PUBSUB_MAX_BACKOFF_SECS",
env = "OBSCURA_PUBSUB_MAX_BACKOFF_SECS",
default_value_t = PubSubConfig::default().max_backoff_secs
)]
pub max_backoff_secs: u64,
}
impl Default for PubSubConfig {
fn default() -> Self {
Self { url: "redis://localhost:6379".to_string(), min_backoff_secs: 1, max_backoff_secs: 30 }
}
}
#[derive(Clone, Debug, Default, clap::ValueEnum)]
pub enum LogFormat {
#[default]
Text,
Json,
}
#[derive(Clone, Debug, Args)]
pub struct TelemetryConfig {
#[arg(long = "telemetry-otlp-endpoint", env = "OBSCURA_TELEMETRY_OTLP_ENDPOINT")]
pub otlp_endpoint: Option<String>,
#[arg(
long = "telemetry-log-format",
env = "OBSCURA_TELEMETRY_LOG_FORMAT",
default_value_t = TelemetryConfig::default().log_format
)]
pub log_format: LogFormat,
#[arg(
long = "telemetry-trace-sampling-ratio",
env = "OBSCURA_TELEMETRY_TRACE_SAMPLING_RATIO",
default_value_t = TelemetryConfig::default().trace_sampling_ratio
)]
pub trace_sampling_ratio: f64,
#[arg(
long = "telemetry-metrics-export-interval-secs",
env = "OBSCURA_TELEMETRY_METRICS_EXPORT_INTERVAL_SECS",
default_value_t = TelemetryConfig::default().metrics_export_interval_secs
)]
pub metrics_export_interval_secs: u64,
#[arg(
long = "telemetry-export-timeout-secs",
env = "OBSCURA_TELEMETRY_EXPORT_TIMEOUT_SECS",
default_value_t = TelemetryConfig::default().export_timeout_secs
)]
pub export_timeout_secs: u64,
}
impl Default for TelemetryConfig {
fn default() -> Self {
Self {
otlp_endpoint: None,
log_format: LogFormat::Text,
trace_sampling_ratio: 1.0,
metrics_export_interval_secs: 60,
export_timeout_secs: 10,
}
}
}
impl std::fmt::Display for LogFormat {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Self::Text => write!(f, "text"),
Self::Json => write!(f, "json"),
}
}
}
#[derive(Clone, Debug, Args)]
pub struct ServerConfig {
#[arg(long = "server-host", env = "OBSCURA_SERVER_HOST", default_value_t = ServerConfig::default().host)]
pub host: String,
#[arg(long = "server-port", env = "OBSCURA_SERVER_PORT", default_value_t = ServerConfig::default().port)]
pub port: u16,
#[arg(
long = "server-mgmt-port",
env = "OBSCURA_SERVER_MGMT_PORT",
default_value_t = ServerConfig::default().mgmt_port
)]
pub mgmt_port: u16,
#[arg(long = "server-shutdown-timeout-secs", env = "OBSCURA_SERVER_SHUTDOWN_TIMEOUT_SECS", default_value_t = ServerConfig::default().shutdown_timeout_secs)]
pub shutdown_timeout_secs: u64,
#[arg(long = "server-request-timeout-secs", env = "OBSCURA_SERVER_REQUEST_TIMEOUT_SECS", default_value_t = ServerConfig::default().request_timeout_secs)]
pub request_timeout_secs: u64,
#[arg(long = "server-global-timeout-secs", env = "OBSCURA_SERVER_GLOBAL_TIMEOUT_SECS", default_value_t = ServerConfig::default().global_timeout_secs)]
pub global_timeout_secs: u64,
#[arg(
long,
env = "OBSCURA_SERVER_TRUSTED_PROXIES",
default_value = "10.0.0.0/8,172.16.0.0/12,192.168.0.0/16,127.0.0.1/32",
value_delimiter = ','
)]
pub trusted_proxies: Vec<IpNetwork>,
}
impl Default for ServerConfig {
fn default() -> Self {
Self {
host: "0.0.0.0".to_string(),
port: 3000,
mgmt_port: 9090,
shutdown_timeout_secs: 5,
request_timeout_secs: 30,
global_timeout_secs: 600,
trusted_proxies: vec![
"10.0.0.0/8".parse().expect("Invalid default CIDR for private network"),
"172.16.0.0/12".parse().expect("Invalid default CIDR for private network"),
"192.168.0.0/16".parse().expect("Invalid default CIDR for private network"),
"127.0.0.1/32".parse().expect("Invalid default CIDR for localhost"),
],
}
}
}
#[derive(Clone, Debug, Args)]
pub struct AuthConfig {
#[arg(long = "auth-jwt-secret", env = "OBSCURA_AUTH_JWT_SECRET", default_value_t = AuthConfig::default().jwt_secret)]
pub jwt_secret: String,
#[arg(long = "auth-token-ttl-secs", env = "OBSCURA_AUTH_TOKEN_TTL_SECS", default_value_t = AuthConfig::default().access_token_ttl_secs)]
pub access_token_ttl_secs: u64,
#[arg(long = "auth-refresh-token-ttl-days", env = "OBSCURA_AUTH_REFRESH_TOKEN_TTL_DAYS", default_value_t = AuthConfig::default().refresh_token_ttl_days)]
pub refresh_token_ttl_days: i64,
#[arg(
long = "auth-refresh-token-cleanup-interval-secs",
env = "OBSCURA_AUTH_REFRESH_TOKEN_CLEANUP_INTERVAL_SECS",
default_value_t = AuthConfig::default().refresh_token_cleanup_interval_secs
)]
pub refresh_token_cleanup_interval_secs: u64,
#[arg(
long = "auth-max-devices-per-user",
env = "OBSCURA_AUTH_MAX_DEVICES_PER_USER",
default_value_t = AuthConfig::default().max_devices_per_user
)]
pub max_devices_per_user: i64,
}
impl Default for AuthConfig {
fn default() -> Self {
Self {
jwt_secret: "change_me_in_production".to_string(),
access_token_ttl_secs: 900,
refresh_token_ttl_days: 30,
refresh_token_cleanup_interval_secs: 86400, max_devices_per_user: 10,
}
}
}
#[derive(Clone, Debug, Args)]
pub struct RateLimitConfig {
#[arg(long = "rate-limit-per-second", env = "OBSCURA_RATE_LIMIT_PER_SECOND", default_value_t = RateLimitConfig::default().per_second)]
pub per_second: u32,
#[arg(long = "rate-limit-burst", env = "OBSCURA_RATE_LIMIT_BURST", default_value_t = RateLimitConfig::default().burst)]
pub burst: u32,
#[arg(long = "auth-rate-limit-per-second", env = "OBSCURA_RATE_LIMIT_AUTH_PER_SECOND", default_value_t = RateLimitConfig::default().auth_per_second)]
pub auth_per_second: u32,
#[arg(long = "auth-rate-limit-burst", env = "OBSCURA_RATE_LIMIT_AUTH_BURST", default_value_t = RateLimitConfig::default().auth_burst)]
pub auth_burst: u32,
}
impl Default for RateLimitConfig {
fn default() -> Self {
Self { per_second: 10, burst: 20, auth_per_second: 1, auth_burst: 3 }
}
}
#[derive(Clone, Debug, Args)]
pub struct MessagingConfig {
#[arg(long = "messaging-inbox-max-size", env = "OBSCURA_MESSAGING_INBOX_MAX_SIZE", default_value_t = MessagingConfig::default().max_inbox_size)]
pub max_inbox_size: i64,
#[arg(
long = "messaging-cleanup-interval-secs",
id = "MESSAGING_CLEANUP_INTERVAL_SECS",
env = "OBSCURA_MESSAGING_CLEANUP_INTERVAL_SECS",
default_value_t = MessagingConfig::default().cleanup_interval_secs
)]
pub cleanup_interval_secs: u64,
#[arg(
long = "messaging-send-batch-limit",
env = "OBSCURA_MESSAGING_SEND_BATCH_LIMIT",
default_value_t = MessagingConfig::default().send_batch_limit
)]
pub send_batch_limit: i64,
#[arg(
long = "messaging-idempotency-ttl-secs",
env = "OBSCURA_MESSAGING_IDEMPOTENCY_TTL_SECS",
default_value_t = MessagingConfig::default().idempotency_ttl_secs
)]
pub idempotency_ttl_secs: u64,
#[arg(
long = "messaging-pre-key-refill-threshold",
env = "OBSCURA_PRE_KEY_REFILL_THRESHOLD",
default_value_t = MessagingConfig::default().pre_key_refill_threshold
)]
pub pre_key_refill_threshold: i32,
#[arg(
long = "messaging-pre-keys-max",
env = "OBSCURA_PRE_KEYS_MAX",
default_value_t = MessagingConfig::default().max_pre_keys
)]
pub max_pre_keys: i64,
}
impl Default for MessagingConfig {
fn default() -> Self {
Self {
max_inbox_size: 1000,
cleanup_interval_secs: 300,
send_batch_limit: 100,
idempotency_ttl_secs: 86400,
pre_key_refill_threshold: 20,
max_pre_keys: 100,
}
}
}
#[derive(Clone, Debug, Args)]
pub struct NotificationConfig {
#[arg(long = "notifications-cleanup-interval-secs", env = "OBSCURA_NOTIFICATIONS_CLEANUP_INTERVAL_SECS", default_value_t = NotificationConfig::default().cleanup_interval_secs)]
pub cleanup_interval_secs: u64,
#[arg(long = "notifications-global-channel-capacity", env = "OBSCURA_NOTIFICATIONS_GLOBAL_CHANNEL_CAPACITY", default_value_t = NotificationConfig::default().global_channel_capacity)]
pub global_channel_capacity: usize,
#[arg(long = "notifications-user-channel-capacity", env = "OBSCURA_NOTIFICATIONS_USER_CHANNEL_CAPACITY", default_value_t = NotificationConfig::default().user_channel_capacity)]
pub user_channel_capacity: usize,
#[arg(long = "notifications-push-delay-secs", env = "OBSCURA_NOTIFICATIONS_PUSH_DELAY_SECS", default_value_t = NotificationConfig::default().push_delay_secs)]
pub push_delay_secs: u64,
#[arg(long = "notifications-worker-interval-secs", env = "OBSCURA_NOTIFICATIONS_WORKER_INTERVAL_SECS", default_value_t = NotificationConfig::default().worker_interval_secs)]
pub worker_interval_secs: u64,
#[arg(long = "notifications-worker-concurrency", env = "OBSCURA_NOTIFICATIONS_WORKER_CONCURRENCY", default_value_t = NotificationConfig::default().worker_concurrency)]
pub worker_concurrency: usize,
#[arg(long = "notifications-push-queue-key", env = "OBSCURA_NOTIFICATIONS_PUSH_QUEUE_KEY", default_value_t = NotificationConfig::default().push_queue_key)]
pub push_queue_key: String,
#[arg(long = "notifications-channel-prefix", env = "OBSCURA_NOTIFICATIONS_CHANNEL_PREFIX", default_value_t = NotificationConfig::default().channel_prefix)]
pub channel_prefix: String,
#[arg(long = "notifications-visibility-timeout-secs", env = "OBSCURA_NOTIFICATIONS_VISIBILITY_TIMEOUT_SECS", default_value_t = NotificationConfig::default().visibility_timeout_secs)]
pub visibility_timeout_secs: u64,
#[arg(long = "notifications-invalid-token-cleanup-interval-secs", env = "OBSCURA_NOTIFICATIONS_INVALID_TOKEN_CLEANUP_INTERVAL_SECS", default_value_t = NotificationConfig::default().invalid_token_cleanup_interval_secs)]
pub invalid_token_cleanup_interval_secs: u64,
#[arg(long = "notifications-invalid-token-cleanup-batch-size", env = "OBSCURA_NOTIFICATIONS_INVALID_TOKEN_CLEANUP_BATCH_SIZE", default_value_t = NotificationConfig::default().invalid_token_cleanup_batch_size)]
pub invalid_token_cleanup_batch_size: usize,
#[arg(long = "notifications-invalid-token-cleanup-channel-capacity", env = "OBSCURA_NOTIFICATIONS_INVALID_TOKEN_CLEANUP_CHANNEL_CAPACITY", default_value_t = NotificationConfig::default().invalid_token_cleanup_channel_capacity)]
pub invalid_token_cleanup_channel_capacity: usize,
}
impl Default for NotificationConfig {
fn default() -> Self {
Self {
cleanup_interval_secs: 60,
global_channel_capacity: 1024,
user_channel_capacity: 64,
push_delay_secs: 2,
worker_interval_secs: 1,
worker_concurrency: 100,
push_queue_key: "jobs:push_notifications".to_string(),
channel_prefix: "user:".to_string(),
visibility_timeout_secs: 30,
invalid_token_cleanup_interval_secs: 5,
invalid_token_cleanup_batch_size: 50,
invalid_token_cleanup_channel_capacity: 256,
}
}
}
#[derive(Clone, Debug, Args)]
pub struct WsConfig {
#[arg(long = "ws-outbound-buffer-size", env = "OBSCURA_WS_OUTBOUND_BUFFER_SIZE", default_value_t = WsConfig::default().outbound_buffer_size)]
pub outbound_buffer_size: usize,
#[arg(long = "ws-ack-buffer-size", env = "OBSCURA_WS_ACK_BUFFER_SIZE", default_value_t = WsConfig::default().ack_buffer_size)]
pub ack_buffer_size: usize,
#[arg(long = "ws-ack-batch-size", env = "OBSCURA_WS_ACK_BATCH_SIZE", default_value_t = WsConfig::default().ack_batch_size)]
pub ack_batch_size: usize,
#[arg(long = "ws-ack-flush-interval-ms", env = "OBSCURA_WS_ACK_FLUSH_INTERVAL_MS", default_value_t = WsConfig::default().ack_flush_interval_ms)]
pub ack_flush_interval_ms: u64,
#[arg(
long = "ws-ping-interval-secs",
env = "OBSCURA_WS_PING_INTERVAL_SECS",
default_value_t = WsConfig::default().ping_interval_secs
)]
pub ping_interval_secs: u64,
#[arg(long = "ws-ping-timeout-secs", env = "OBSCURA_WS_PING_TIMEOUT_SECS", default_value_t = WsConfig::default().ping_timeout_secs)]
pub ping_timeout_secs: u64,
#[arg(long = "ws-prekey-debounce-interval-ms", env = "OBSCURA_WS_PREKEY_DEBOUNCE_INTERVAL_MS", default_value_t = WsConfig::default().prekey_debounce_interval_ms)]
pub prekey_debounce_interval_ms: u64,
#[arg(
long = "ws-message-fetch-batch-size",
env = "OBSCURA_WS_MESSAGE_FETCH_BATCH_SIZE",
default_value_t = WsConfig::default().message_fetch_batch_size
)]
pub message_fetch_batch_size: i64,
#[arg(
long = "ws-ticket-ttl-secs",
env = "OBSCURA_WS_TICKET_TTL_SECS",
default_value_t = WsConfig::default().ticket_ttl_secs
)]
pub ticket_ttl_secs: u64,
}
impl Default for WsConfig {
fn default() -> Self {
Self {
outbound_buffer_size: 32,
ack_buffer_size: 1000,
ack_batch_size: 100,
ack_flush_interval_ms: 500,
ping_interval_secs: 30,
ping_timeout_secs: 10,
prekey_debounce_interval_ms: 500,
message_fetch_batch_size: 50,
ticket_ttl_secs: 30,
}
}
}
#[derive(Clone, Debug, Args)]
pub struct BackupConfig {
#[arg(
long = "backup-prefix",
id = "BACKUP_PREFIX",
env = "OBSCURA_BACKUP_PREFIX",
default_value_t = BackupConfig::default().prefix
)]
pub prefix: String,
#[arg(
long = "backup-max-size-bytes",
id = "BACKUP_MAX_SIZE_BYTES",
env = "OBSCURA_BACKUP_MAX_SIZE_BYTES",
default_value_t = BackupConfig::default().max_size_bytes
)]
pub max_size_bytes: usize,
#[arg(
long = "backup-min-size-bytes",
id = "BACKUP_MIN_SIZE_BYTES",
env = "OBSCURA_BACKUP_MIN_SIZE_BYTES",
default_value_t = BackupConfig::default().min_size_bytes
)]
pub min_size_bytes: usize,
#[arg(
long = "backup-timeout-secs",
id = "BACKUP_TIMEOUT_SECS",
env = "OBSCURA_BACKUP_TIMEOUT_SECS",
default_value_t = BackupConfig::default().request_timeout_secs
)]
pub request_timeout_secs: u64,
#[arg(
long = "backup-stale-threshold-mins",
id = "BACKUP_STALE_THRESHOLD_MINS",
env = "OBSCURA_BACKUP_STALE_THRESHOLD_MINS",
default_value_t = BackupConfig::default().stale_threshold_mins
)]
pub stale_threshold_mins: i64,
#[arg(
long = "backup-cleanup-interval-secs",
id = "BACKUP_CLEANUP_INTERVAL_SECS",
env = "OBSCURA_BACKUP_CLEANUP_INTERVAL_SECS",
default_value_t = BackupConfig::default().cleanup_interval_secs
)]
pub cleanup_interval_secs: u64,
}
impl Default for BackupConfig {
fn default() -> Self {
Self {
prefix: "backups/".to_string(),
max_size_bytes: 2_097_152,
min_size_bytes: 32,
request_timeout_secs: 60,
stale_threshold_mins: 30,
cleanup_interval_secs: 300,
}
}
}
#[derive(Clone, Debug, Args)]
pub struct AttachmentConfig {
#[arg(
long = "attachment-max-size-bytes",
id = "ATTACHMENT_MAX_SIZE_BYTES",
env = "OBSCURA_ATTACHMENT_MAX_SIZE_BYTES",
default_value_t = AttachmentConfig::default().max_size_bytes
)]
pub max_size_bytes: usize,
#[arg(
long = "attachment-min-size-bytes",
id = "ATTACHMENT_MIN_SIZE_BYTES",
env = "OBSCURA_ATTACHMENT_MIN_SIZE_BYTES",
default_value_t = AttachmentConfig::default().min_size_bytes
)]
pub min_size_bytes: usize,
#[arg(
long = "attachment-prefix",
id = "ATTACHMENT_PREFIX",
env = "OBSCURA_ATTACHMENT_PREFIX",
default_value_t = AttachmentConfig::default().prefix
)]
pub prefix: String,
#[arg(
long = "attachment-cleanup-interval-secs",
id = "ATTACHMENT_CLEANUP_INTERVAL_SECS",
env = "OBSCURA_ATTACHMENT_CLEANUP_INTERVAL_SECS",
default_value_t = AttachmentConfig::default().cleanup_interval_secs
)]
pub cleanup_interval_secs: u64,
#[arg(
long = "attachment-cleanup-batch-size",
id = "ATTACHMENT_CLEANUP_BATCH_SIZE",
env = "OBSCURA_ATTACHMENT_CLEANUP_BATCH_SIZE",
default_value_t = AttachmentConfig::default().cleanup_batch_size
)]
pub cleanup_batch_size: u64,
#[arg(
long = "attachment-timeout-secs",
id = "ATTACHMENT_TIMEOUT_SECS",
env = "OBSCURA_ATTACHMENT_TIMEOUT_SECS",
default_value_t = AttachmentConfig::default().request_timeout_secs
)]
pub request_timeout_secs: u64,
}
impl Default for AttachmentConfig {
fn default() -> Self {
Self {
max_size_bytes: 52_428_800,
min_size_bytes: 1,
prefix: "attachments/".to_string(),
cleanup_interval_secs: 3600,
cleanup_batch_size: 100,
request_timeout_secs: 120,
}
}
}
#[derive(Clone, Debug, Args)]
pub struct StorageConfig {
#[arg(
long = "storage-bucket",
id = "STORAGE_BUCKET",
env = "OBSCURA_STORAGE_BUCKET",
default_value_t = StorageConfig::default().bucket
)]
pub bucket: String,
#[arg(
long = "storage-region",
id = "STORAGE_REGION",
env = "OBSCURA_STORAGE_REGION",
default_value_t = StorageConfig::default().region
)]
pub region: String,
#[arg(long = "storage-endpoint", id = "STORAGE_ENDPOINT", env = "OBSCURA_STORAGE_ENDPOINT")]
pub endpoint: Option<String>,
#[arg(long = "storage-access-key", id = "STORAGE_ACCESS_KEY", env = "OBSCURA_STORAGE_ACCESS_KEY")]
pub access_key: Option<String>,
#[arg(long = "storage-secret-key", id = "STORAGE_SECRET_KEY", env = "OBSCURA_STORAGE_SECRET_KEY")]
pub secret_key: Option<String>,
#[arg(
long = "storage-force-path-style",
id = "STORAGE_FORCE_PATH_STYLE",
env = "OBSCURA_STORAGE_FORCE_PATH_STYLE",
default_value_t = StorageConfig::default().force_path_style
)]
pub force_path_style: bool,
}
impl Default for StorageConfig {
fn default() -> Self {
Self {
bucket: "obscura-storage".to_string(),
region: "us-east-1".to_string(),
endpoint: None,
access_key: None,
secret_key: None,
force_path_style: false,
}
}
}
#[derive(Clone, Debug, Args)]
pub struct HealthConfig {
#[arg(
long = "health-db-timeout-ms",
id = "HEALTH_DB_TIMEOUT_MS",
env = "OBSCURA_HEALTH_DB_TIMEOUT_MS",
default_value_t = HealthConfig::default().db_timeout_ms
)]
pub db_timeout_ms: u64,
#[arg(
long = "health-storage-timeout-ms",
id = "HEALTH_STORAGE_TIMEOUT_MS",
env = "OBSCURA_HEALTH_STORAGE_TIMEOUT_MS",
default_value_t = HealthConfig::default().storage_timeout_ms
)]
pub storage_timeout_ms: u64,
#[arg(
long = "health-pubsub-timeout-ms",
id = "HEALTH_PUBSUB_TIMEOUT_MS",
env = "OBSCURA_HEALTH_PUBSUB_TIMEOUT_MS",
default_value_t = HealthConfig::default().pubsub_timeout_ms
)]
pub pubsub_timeout_ms: u64,
}
impl Default for HealthConfig {
fn default() -> Self {
Self { db_timeout_ms: 2000, storage_timeout_ms: 2000, pubsub_timeout_ms: 2000 }
}
}
#[cfg(test)]
mod tests {
use super::*;
use clap::CommandFactory;
#[test]
fn verify_cli() {
Config::command().debug_assert();
}
#[test]
#[allow(clippy::panic)]
fn test_docs_up_to_date() {
let docs = std::fs::read_to_string("docs/CONFIGURATION.md").expect("Could not read CONFIGURATION.md");
let cmd = Config::command();
for arg in cmd.get_arguments() {
if arg.is_hide_set() {
continue;
}
let env = arg.get_env();
if env.is_none() {
continue;
}
let env_name = env.expect("Missing environment variable name").to_string_lossy();
let env_pattern = format!("`{env_name}`");
let env_count = docs.matches(&env_pattern).count();
assert_eq!(
env_count, 1,
"Environment variable {env_pattern} must appear exactly once in documentation, found {env_count}"
);
if let Some(long) = arg.get_long() {
let flag_pattern = format!("`--{long}`");
let flag_count = docs.matches(&flag_pattern).count();
assert_eq!(
flag_count, 1,
"Flag {flag_pattern} must appear exactly once in documentation, found {flag_count}"
);
let defaults = arg.get_default_values();
let expected_default = if defaults.is_empty() {
if arg.get_id() == "STORAGE_FORCE_PATH_STYLE" { "false".to_string() } else { "None".to_string() }
} else {
defaults.iter().map(|v| v.to_string_lossy()).collect::<Vec<_>>().join(",")
};
let row_pattern =
format!(r"\| `--{}` \| `{}` \| ([^|]+) \|", regex::escape(long), regex::escape(&env_name));
let re = regex::Regex::new(&row_pattern).expect("Invalid regex pattern");
if let Some(caps) = re.captures(&docs) {
let actual_default = caps.get(1).expect("Missing capture group").as_str().trim().replace('`', "");
assert_eq!(
actual_default, expected_default,
"Default value mismatch for flag --{long}. Expected '{expected_default}', found '{actual_default}' in docs"
);
} else {
panic!(
"Could not find documentation row for flag --{long} and env {env_name}. \
Ensure it matches the format: | `--{long}` | `{env_name}` | Default | Description |"
);
}
}
}
}
}