vecboost 0.3.0-rc.1

High-performance embedding vector service written in Rust
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
// Copyright (c) 2025-2026 Kirky.X🌠
// SPDX-License-Identifier: Apache-2.0

//! confers-based configuration loader for VecBoost.
//!
//! `VecboostConfig` 通过 `#[derive(Config)]` 从 `confers` crate 派生,统一接管 TOML
//! 文件加载与环境变量覆盖。confers 是必选依赖(`Cargo.toml` 中无 `optional`),
//! 禁止任何手写 `config`/`toml` 解析逻辑。
//!
//! 敏感字段(JWT secret / admin password)的最小长度校验由
//! `app::apply_security_env_overrides` 负责(单一真相源);本模块仅负责
//! confers 加载与默认值填充,不重复实现校验逻辑。

use crate::error::VecboostError;
use serde::{Deserialize, Serialize};
use std::path::PathBuf;

use confers::Config;

#[cfg(feature = "db")]
use super::app::DatabaseConfig;
use super::app::{
    AuditConfig, AuthConfig, DeviceConfig, EmbeddingConfig, MemoryPagingConfig, MemoryPoolConfig,
    ModelConfig, MonitoringConfig, RateLimitConfig, RerankConfig, SemanticCacheConfig,
    ServerConfig, apply_priority_defaults, apply_security_env_overrides,
};
use crate::pipeline::PipelineConfig;

/// VecBoost 顶层配置,由 confers 完全接管加载。
///
/// 子结构体复用 `app.rs` 中的定义,确保下游消费者(services / middleware)
/// 不受加载器切换影响。`env_prefix = "VECBOOST_"` 将环境变量如
/// `VECBOOST_JWT_SECRET` 映射到嵌套字段。
#[derive(Config, Debug, Clone, Serialize, Deserialize, schemars::JsonSchema)]
#[config(env_prefix = "VECBOOST_")]
#[serde(default)]
pub struct VecboostConfig {
    pub server: ServerConfig,
    pub model: ModelConfig,
    pub embedding: EmbeddingConfig,
    pub rerank: RerankConfig,
    pub monitoring: MonitoringConfig,
    pub auth: AuthConfig,
    pub rate_limit: RateLimitConfig,
    pub audit: AuditConfig,
    pub memory_pool: MemoryPoolConfig,
    pub pipeline: PipelineConfig,
    pub logging: crate::config::app::LoggingConfig,
    pub semantic_cache: SemanticCacheConfig,
    pub memory_paging: MemoryPagingConfig,
    /// 设备与硬件感知配置(`[device]` 段,)。
    pub device: DeviceConfig,
    #[cfg(feature = "db")]
    pub database: DatabaseConfig,
}

impl VecboostConfig {
    /// 通过 confers 从默认路径 `config/config.toml` 加载配置。
    ///
    /// 文件不存在时回退到 `Default` 实现 + `VECBOOST_` 前缀环境变量。
    /// 敏感字段校验由 `app::apply_security_env_overrides` 执行,
    /// 校验失败时返回 `VecboostError::ConfigError`。
    pub fn load_via_confers() -> Result<Self, VecboostError> {
        Self::load_via_confers_with_path("config/config.toml")
    }

    /// 通过 confers 从显式路径加载配置。
    ///
    /// 路径是可选的:文件不存在时 confers 回退到 `Default` + 环境变量。
    /// 敏感环境变量(`VECBOOST_JWT_SECRET` / `VECBOOST_ADMIN_PASSWORD`)
    /// 的最小长度校验由 `app::apply_security_env_overrides` 强制执行,
    /// 失败时通过 `?` 显式传播(规则12:错误必须显性化)。
    pub fn load_via_confers_with_path<P: Into<PathBuf>>(path: P) -> Result<Self, VecboostError> {
        let mut config = confers::ConfigBuilder::<Self>::new()
            .allow_absolute_paths()
            .file_optional(path)
            .env_prefix("VECBOOST_")
            .build()
            .map_err(|e| VecboostError::ConfigError(format!("confers: {e}")))?;
        apply_security_env_overrides(&mut config)?;
        apply_priority_defaults(&mut config.pipeline.priority);
        config.validate()?;
        Ok(config)
    }

    /// Generate TypeScript type definitions for `VecboostConfig` using confers'
    /// `TypeScriptGenerator` (backed by `schemars` JSON Schema).
    ///
    /// Useful for generating configuration documentation or frontend type stubs.
    pub fn generate_schema() -> Result<String, VecboostError> {
        confers::schema::TypeScriptGenerator::generate::<Self>()
            .map_err(|e| VecboostError::ConfigError(format!("schema generation failed: {e}")))
    }

    /// Validate configuration fields using garde-derived validation.
    ///
    /// Delegates to sub-struct `validate()` methods (ServerConfig, ModelConfig,
    /// EmbeddingConfig) which use `#[derive(garde::Validate)]` with field-level
    /// `#[garde(...)]` rules. Aggregates all errors into a single `ConfigError`.
    pub fn validate(&self) -> Result<(), VecboostError> {
        use garde::Validate;
        let mut errors = Vec::new();

        let mut collect = |prefix: &str, result: Result<(), garde::Report>| {
            if let Err(report) = result {
                for (path, error) in report.iter() {
                    errors.push(format!("{prefix}.{path}: {error}"));
                }
            }
        };

        collect("server", self.server.validate());
        collect("model", self.model.validate());
        collect("embedding", self.embedding.validate());
        collect("rerank", self.rerank.validate());

        if errors.is_empty() {
            Ok(())
        } else {
            Err(VecboostError::ConfigError(format!(
                "Configuration validation failed:\n  {}",
                errors.join("\n  ")
            )))
        }
    }
}

// trait-kit reload 装配:使 VecboostConfig 可通过 Kit::reload_config::<VecboostConfig>() 热重载
// 依赖 trait-kit `reload` + `confers` feature,底层复用 confers 的 load_via_confers
impl trait_kit::kit::Configurable for VecboostConfig {
    fn load() -> Result<Self, Box<dyn std::error::Error + Send + 'static>> {
        Self::load_via_confers().map_err(|e| Box::new(e) as _)
    }
}

#[cfg(test)]
mod tests {
    use super::VecboostConfig;
    use crate::config::app::test_support::ENV_LOCK;

    #[test]
    fn test_confers_app_config_compiles() {
        let _ = VecboostConfig::default();
    }

    #[test]
    fn test_app_config_default_values() {
        let config = VecboostConfig::default();
        assert!(!config.server.grpc_enabled);
        assert!(config.model.batch_size > 0);
        assert!(config.embedding.max_batch_size > 0);
    }

    #[test]
    fn test_load_via_confers_with_nonexistent_path() {
        let _guard = ENV_LOCK.lock().unwrap_or_else(|e| e.into_inner());
        unsafe {
            std::env::remove_var("VECBOOST_JWT_SECRET");
            std::env::remove_var("VECBOOST_ADMIN_PASSWORD");
        }
        let result = VecboostConfig::load_via_confers_with_path("/nonexistent/config.toml");
        assert!(result.is_ok(), "should fall back to defaults");
        let config = result.unwrap();
        assert!(!config.server.grpc_enabled);
    }

    #[test]
    fn test_load_via_confers_with_valid_toml() {
        let _guard = ENV_LOCK.lock().unwrap_or_else(|e| e.into_inner());
        unsafe {
            std::env::remove_var("VECBOOST_JWT_SECRET");
            std::env::remove_var("VECBOOST_ADMIN_PASSWORD");
        }
        let temp_dir = tempfile::tempdir().expect("Failed to create temp dir");
        let config_path = temp_dir.path().join("test_config.toml");
        std::fs::write(
            &config_path,
            r#"
[server]
host = "0.0.0.0"
port = 8080
grpc_enabled = true

[model]
model_repo = "test/repo"
batch_size = 64

[embedding]
max_batch_size = 128
"#,
        )
        .expect("Failed to write config");

        let result = VecboostConfig::load_via_confers_with_path(&config_path);
        assert!(result.is_ok());
        let config = result.unwrap();
        assert_eq!(config.server.port, 8080);
        assert_eq!(config.server.host, "0.0.0.0");
        assert!(config.server.grpc_enabled);
        assert_eq!(config.model.batch_size, 64);
        assert_eq!(config.embedding.max_batch_size, 128);
    }

    #[test]
    fn test_load_via_confers_with_empty_toml() {
        let _guard = ENV_LOCK.lock().unwrap_or_else(|e| e.into_inner());
        unsafe {
            std::env::remove_var("VECBOOST_JWT_SECRET");
            std::env::remove_var("VECBOOST_ADMIN_PASSWORD");
        }
        let temp_dir = tempfile::tempdir().expect("Failed to create temp dir");
        let config_path = temp_dir.path().join("empty.toml");
        std::fs::write(&config_path, "").expect("Failed to write empty config");

        let result = VecboostConfig::load_via_confers_with_path(&config_path);
        assert!(result.is_ok());
        let config = result.unwrap();
        assert!(!config.server.grpc_enabled);
    }

    #[test]
    fn test_load_via_confers_jwt_secret_env_override() {
        let _guard = ENV_LOCK.lock().unwrap_or_else(|e| e.into_inner());
        unsafe {
            std::env::set_var(
                "VECBOOST_JWT_SECRET",
                "this-is-a-valid-jwt-secret-32chars!!",
            );
        }
        let result = VecboostConfig::load_via_confers_with_path("/nonexistent/config.toml");
        let config = result.expect("load should succeed with valid JWT secret");
        unsafe {
            std::env::remove_var("VECBOOST_JWT_SECRET");
        }
        assert_eq!(
            config.auth.jwt_secret.as_deref(),
            Some("this-is-a-valid-jwt-secret-32chars!!")
        );
    }

    #[test]
    fn test_load_via_confers_empty_jwt_secret_rejected() {
        let _guard = ENV_LOCK.lock().unwrap_or_else(|e| e.into_inner());
        unsafe {
            std::env::set_var("VECBOOST_JWT_SECRET", "");
        }
        let result = VecboostConfig::load_via_confers_with_path("/nonexistent/config.toml");
        unsafe {
            std::env::remove_var("VECBOOST_JWT_SECRET");
        }
        assert!(
            result.is_err(),
            "empty JWT secret must be rejected by apply_security_env_overrides"
        );
    }

    #[test]
    fn test_load_via_confers_short_jwt_secret_rejected() {
        let _guard = ENV_LOCK.lock().unwrap_or_else(|e| e.into_inner());
        unsafe {
            std::env::set_var("VECBOOST_JWT_SECRET", "tooshort");
        }
        let result = VecboostConfig::load_via_confers_with_path("/nonexistent/config.toml");
        unsafe {
            std::env::remove_var("VECBOOST_JWT_SECRET");
        }
        assert!(
            result.is_err(),
            "JWT secret shorter than 32 chars must be rejected"
        );
    }

    #[test]
    fn test_load_via_confers_admin_password_env_override() {
        let _guard = ENV_LOCK.lock().unwrap_or_else(|e| e.into_inner());
        unsafe {
            std::env::set_var("VECBOOST_ADMIN_PASSWORD", "SuperSecurePass123!");
        }
        let result = VecboostConfig::load_via_confers_with_path("/nonexistent/config.toml");
        let config = result.expect("load should succeed with valid admin password");
        unsafe {
            std::env::remove_var("VECBOOST_ADMIN_PASSWORD");
        }
        assert_eq!(
            config.auth.default_admin_password.as_deref(),
            Some("SuperSecurePass123!")
        );
    }

    #[test]
    fn test_load_via_confers_empty_admin_password_rejected() {
        let _guard = ENV_LOCK.lock().unwrap_or_else(|e| e.into_inner());
        unsafe {
            std::env::set_var("VECBOOST_ADMIN_PASSWORD", "");
        }
        let result = VecboostConfig::load_via_confers_with_path("/nonexistent/config.toml");
        unsafe {
            std::env::remove_var("VECBOOST_ADMIN_PASSWORD");
        }
        assert!(
            result.is_err(),
            "empty admin password must be rejected by apply_security_env_overrides"
        );
    }

    #[test]
    fn test_load_via_confers_short_admin_password_rejected() {
        let _guard = ENV_LOCK.lock().unwrap_or_else(|e| e.into_inner());
        unsafe {
            std::env::set_var("VECBOOST_ADMIN_PASSWORD", "short");
        }
        let result = VecboostConfig::load_via_confers_with_path("/nonexistent/config.toml");
        unsafe {
            std::env::remove_var("VECBOOST_ADMIN_PASSWORD");
        }
        assert!(
            result.is_err(),
            "admin password shorter than 12 chars must be rejected"
        );
    }

    #[test]
    fn test_load_via_confers_with_partial_toml() {
        let _guard = ENV_LOCK.lock().unwrap_or_else(|e| e.into_inner());
        unsafe {
            std::env::remove_var("VECBOOST_JWT_SECRET");
            std::env::remove_var("VECBOOST_ADMIN_PASSWORD");
        }
        let temp_dir = tempfile::tempdir().expect("Failed to create temp dir");
        let config_path = temp_dir.path().join("partial.toml");
        std::fs::write(
            &config_path,
            r#"
[server]
port = 9999
"#,
        )
        .expect("Failed to write partial config");

        let result = VecboostConfig::load_via_confers_with_path(&config_path);
        assert!(result.is_ok());
        let config = result.unwrap();
        assert_eq!(config.server.port, 9999);
    }

    #[test]
    fn test_app_config_clone() {
        let config = VecboostConfig::default();
        let cloned = config.clone();
        assert_eq!(config.server.port, cloned.server.port);
    }

    #[test]
    fn test_app_config_debug_format() {
        let config = VecboostConfig::default();
        let debug_str = format!("{:?}", config);
        assert!(debug_str.contains("VecboostConfig"));
    }

    #[test]
    fn test_app_config_validate_default_succeeds() {
        let config = VecboostConfig::default();
        assert!(config.validate().is_ok());
    }

    #[test]
    fn test_app_config_validate_bad_server_port() {
        let mut config = VecboostConfig::default();
        config.server.port = 0;
        assert!(config.validate().is_err());
    }

    #[test]
    fn test_app_config_serialize_roundtrip() {
        let config = VecboostConfig::default();
        let json = serde_json::to_string(&config).unwrap();
        let deserialized: VecboostConfig = serde_json::from_str(&json).unwrap();
        assert_eq!(deserialized.server.port, config.server.port);
    }

    #[test]
    fn test_app_config_generate_schema() {
        let result = VecboostConfig::generate_schema();
        assert!(result.is_ok());
        let schema = result.unwrap();
        assert!(!schema.is_empty());
    }

    #[test]
    fn test_app_config_load_via_confers_default() {
        let _guard = ENV_LOCK.lock().unwrap_or_else(|e| e.into_inner());
        unsafe {
            std::env::remove_var("VECBOOST_JWT_SECRET");
            std::env::remove_var("VECBOOST_ADMIN_PASSWORD");
        }
        let result = VecboostConfig::load_via_confers();
        assert!(result.is_ok());
    }

    #[tokio::test]
    async fn test_app_config_configurable_load() {
        use trait_kit::kit::Configurable;
        let _guard = ENV_LOCK.lock().unwrap_or_else(|e| e.into_inner());
        unsafe {
            std::env::remove_var("VECBOOST_JWT_SECRET");
            std::env::remove_var("VECBOOST_ADMIN_PASSWORD");
        }
        // Call the Configurable trait's load() explicitly to cover the trait impl
        let result = <VecboostConfig as Configurable>::load();
        assert!(result.is_ok());
    }
}