pipedash-core 0.4.0

Framework-agnostic core library for Pipedash
Documentation
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
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
use std::collections::HashMap;
use std::path::PathBuf;

use indexmap::IndexMap;
use serde::{
    Deserialize,
    Serialize,
};

use super::token_ref::TokenReference;

pub(super) const DEFAULT_REFRESH_INTERVAL_SECS: u32 = 30;

pub const MIN_REFRESH_INTERVAL_SECS: u32 = 5;

pub const MAX_REFRESH_INTERVAL_SECS: u32 = 300;

pub(super) const DEFAULT_BIND_ADDR_DESKTOP: &str = "127.0.0.1:8080";

pub(super) const DEFAULT_BIND_ADDR_SERVER: &str = "0.0.0.0:8080";

pub(super) const DEFAULT_CORS_ALLOW_ALL: bool = false;

pub(super) const DEFAULT_METRICS_ENABLED: bool = true;

pub(super) const DEFAULT_DATA_DIR_SERVER: &str = "./data";

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Default)]
#[serde(rename_all = "lowercase")]
pub enum StorageBackend {
    #[default]
    Sqlite,
    Postgres,
}

impl StorageBackend {
    pub fn requires_postgres(&self) -> bool {
        matches!(self, Self::Postgres)
    }

    pub fn is_sqlite(&self) -> bool {
        matches!(self, Self::Sqlite)
    }
}

impl std::fmt::Display for StorageBackend {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Sqlite => write!(f, "sqlite"),
            Self::Postgres => write!(f, "postgres"),
        }
    }
}

impl std::str::FromStr for StorageBackend {
    type Err = String;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.to_lowercase().as_str() {
            "sqlite" => Ok(Self::Sqlite),
            "postgres" | "postgresql" => Ok(Self::Postgres),
            _ => Err(format!(
                "Unknown storage backend: {}. Valid options: sqlite, postgres",
                s
            )),
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct PipedashConfig {
    #[serde(default)]
    pub general: GeneralConfig,

    #[serde(default)]
    pub server: ServerConfig,

    #[serde(default)]
    pub storage: StorageConfig,

    #[serde(default)]
    pub providers: IndexMap<String, ProviderFileConfig>,
}

impl PipedashConfig {
    pub fn data_dir(&self) -> PathBuf {
        if self.storage.data_dir.is_empty() {
            Self::default_data_dir()
        } else {
            PathBuf::from(&self.storage.data_dir)
        }
    }

    pub fn default_data_dir() -> PathBuf {
        std::env::var("PIPEDASH_DATA_DIR")
            .map(PathBuf::from)
            .unwrap_or_else(|_| {
                dirs::data_dir()
                    .map(|p| p.join("pipedash"))
                    .unwrap_or_else(|| PathBuf::from(".pipedash"))
            })
    }

    pub fn db_path(&self) -> PathBuf {
        self.data_dir().join("pipedash.db")
    }

    pub fn metrics_db_path(&self) -> PathBuf {
        self.data_dir().join("metrics.db")
    }

    pub fn cache_dir(&self) -> PathBuf {
        self.data_dir().join("cache")
    }

    pub fn vault_path(&self) -> PathBuf {
        self.data_dir().join("vault.db")
    }

    pub fn config_path(&self) -> PathBuf {
        self.data_dir().join("config.toml")
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GeneralConfig {
    #[serde(default = "default_metrics_enabled")]
    pub metrics_enabled: bool,

    #[serde(default = "default_refresh_interval")]
    pub default_refresh_interval: u32,

    #[serde(default = "default_true")]
    pub status_pages_enabled: bool,
}

impl Default for GeneralConfig {
    fn default() -> Self {
        Self {
            metrics_enabled: default_metrics_enabled(),
            default_refresh_interval: default_refresh_interval(),
            status_pages_enabled: default_true(),
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub struct GeneralSettingsUpdate {
    pub metrics_enabled: bool,
    pub default_refresh_interval: u32,
    pub status_pages_enabled: bool,
}

fn default_metrics_enabled() -> bool {
    DEFAULT_METRICS_ENABLED
}

fn default_refresh_interval() -> u32 {
    DEFAULT_REFRESH_INTERVAL_SECS
}

fn default_true() -> bool {
    true
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ServerConfig {
    #[serde(default = "default_bind_addr")]
    pub bind_addr: String,

    #[serde(default = "default_cors_allow_all")]
    pub cors_allow_all: bool,

    #[serde(default)]
    pub base_path: String,
}

impl Default for ServerConfig {
    fn default() -> Self {
        Self {
            bind_addr: default_bind_addr(),
            cors_allow_all: default_cors_allow_all(),
            base_path: String::new(),
        }
    }
}

fn default_bind_addr() -> String {
    DEFAULT_BIND_ADDR_DESKTOP.to_string()
}

fn default_cors_allow_all() -> bool {
    DEFAULT_CORS_ALLOW_ALL
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct StorageConfig {
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub data_dir: String,

    #[serde(default)]
    pub backend: StorageBackend,

    #[serde(default, skip_serializing_if = "is_default_postgres_config")]
    pub postgres: PostgresConfig,

    #[serde(default, skip_serializing)]
    pub vault_password: Option<String>,
}

fn is_default_postgres_config(c: &PostgresConfig) -> bool {
    c.connection_string.is_empty()
}

impl StorageConfig {
    pub fn validate(&self) -> Result<(), String> {
        if self.backend.requires_postgres() && self.postgres.connection_string.is_empty() {
            return Err("PostgreSQL backend selected but connection_string is empty".to_string());
        }

        Ok(())
    }

    pub fn summary(&self) -> String {
        format!("Storage: {} backend", self.backend)
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct PostgresConfig {
    #[serde(default)]
    pub connection_string: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ProviderFileConfig {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,

    #[serde(rename = "type")]
    pub provider_type: String,

    #[serde(default)]
    pub token: String,

    #[serde(default = "default_provider_refresh")]
    pub refresh_interval: u32,

    #[serde(default)]
    pub config: HashMap<String, String>,
}

impl Default for ProviderFileConfig {
    fn default() -> Self {
        Self {
            name: None,
            provider_type: String::new(),
            token: String::new(),
            refresh_interval: default_provider_refresh(),
            config: HashMap::new(),
        }
    }
}

fn default_provider_refresh() -> u32 {
    DEFAULT_REFRESH_INTERVAL_SECS
}

impl ProviderFileConfig {
    pub fn display_name<'a>(&'a self, id: &'a str) -> &'a str {
        self.name.as_deref().unwrap_or(id)
    }

    pub fn token_reference(&self) -> Result<TokenReference, super::token_ref::TokenRefError> {
        TokenReference::parse(&self.token)
    }

    pub fn has_token(&self) -> bool {
        match self.token_reference() {
            Ok(ref tr) => tr.is_configured(),
            Err(_) => false,
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum ConfigKey {
    MetricsEnabled,
    DefaultRefreshInterval,
    StatusPagesEnabled,
    BindAddr,
    CorsAllowAll,
    DataDir,
    StorageBackend,
    PostgresConnectionString,
}

impl ConfigKey {
    pub fn env_var_name(&self) -> &'static str {
        match self {
            Self::MetricsEnabled => "PIPEDASH_METRICS_ENABLED",
            Self::DefaultRefreshInterval => "PIPEDASH_DEFAULT_REFRESH_INTERVAL",
            Self::StatusPagesEnabled => "PIPEDASH_STATUS_PAGES_ENABLED",
            Self::BindAddr => "PIPEDASH_BIND_ADDR",
            Self::CorsAllowAll => "PIPEDASH_CORS_ALLOW_ALL",
            Self::DataDir => "PIPEDASH_DATA_DIR",
            Self::StorageBackend => "PIPEDASH_STORAGE_BACKEND",
            Self::PostgresConnectionString => "PIPEDASH_POSTGRES_URL",
        }
    }

    pub fn is_storage_field(&self) -> bool {
        matches!(self, Self::StorageBackend)
    }

    pub fn requires_restart(&self) -> bool {
        matches!(self, Self::StorageBackend | Self::BindAddr | Self::DataDir)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_default_config() {
        let config = PipedashConfig::default();

        assert!(config.general.metrics_enabled);
        assert_eq!(config.general.default_refresh_interval, 30);
        assert_eq!(config.server.bind_addr, "127.0.0.1:8080");
        assert_eq!(config.storage.backend, StorageBackend::Sqlite);
        assert!(config.providers.is_empty());
        assert!(!config.server.cors_allow_all);
        assert!(config.general.status_pages_enabled);
    }

    #[test]
    fn test_status_pages_default_to_enabled_when_absent() {
        let config: PipedashConfig = toml::from_str("[general]\nmetrics_enabled = false").unwrap();
        let disabled: PipedashConfig =
            toml::from_str("[general]\nstatus_pages_enabled = false").unwrap();

        assert!(config.general.status_pages_enabled);
        assert!(!disabled.general.status_pages_enabled);
        assert!(GeneralConfig::default().status_pages_enabled);
    }

    #[test]
    fn test_cors_allow_all_defaults_to_false_when_absent() {
        let config: PipedashConfig =
            toml::from_str("[server]\nbind_addr = \"0.0.0.0:8080\"").unwrap();

        assert!(!config.server.cors_allow_all);
        assert!(!ServerConfig::default().cors_allow_all);
    }

    #[test]
    fn test_storage_backend_parsing() {
        assert_eq!(
            "sqlite".parse::<StorageBackend>().unwrap(),
            StorageBackend::Sqlite
        );
        assert_eq!(
            "postgres".parse::<StorageBackend>().unwrap(),
            StorageBackend::Postgres
        );
        assert_eq!(
            "postgresql".parse::<StorageBackend>().unwrap(),
            StorageBackend::Postgres
        );
    }

    #[test]
    fn test_storage_backend_helpers() {
        assert!(StorageBackend::Postgres.requires_postgres());
        assert!(!StorageBackend::Sqlite.requires_postgres());
        assert!(StorageBackend::Sqlite.is_sqlite());
        assert!(!StorageBackend::Postgres.is_sqlite());
    }

    #[test]
    fn test_storage_config_validation() {
        let sqlite_config = StorageConfig::default();
        assert!(sqlite_config.validate().is_ok());

        let pg_config = StorageConfig {
            backend: StorageBackend::Postgres,
            ..Default::default()
        };
        assert!(pg_config.validate().is_err());

        let pg_config_with_conn = StorageConfig {
            backend: StorageBackend::Postgres,
            postgres: PostgresConfig {
                connection_string: "postgres://localhost/test".to_string(),
            },
            ..Default::default()
        };
        assert!(pg_config_with_conn.validate().is_ok());
    }

    #[test]
    fn test_provider_token_reference() {
        let provider = ProviderFileConfig {
            name: Some("Test Provider".to_string()),
            provider_type: "github".to_string(),
            token: "${GITHUB_TOKEN}".to_string(),
            refresh_interval: 30,
            config: HashMap::new(),
        };

        let token_ref = provider.token_reference().unwrap();
        assert_eq!(
            token_ref,
            TokenReference::EnvVar("GITHUB_TOKEN".to_string())
        );
        assert!(provider.has_token());
    }

    #[test]
    fn test_provider_display_name() {
        let with_name = ProviderFileConfig {
            name: Some("My GitHub".to_string()),
            provider_type: "github".to_string(),
            ..Default::default()
        };
        assert_eq!(with_name.display_name("github-main"), "My GitHub");

        let without_name = ProviderFileConfig {
            name: None,
            provider_type: "github".to_string(),
            ..Default::default()
        };
        assert_eq!(without_name.display_name("github-main"), "github-main");
    }

    #[test]
    fn test_config_key_env_vars() {
        assert_eq!(
            ConfigKey::MetricsEnabled.env_var_name(),
            "PIPEDASH_METRICS_ENABLED"
        );
        assert_eq!(
            ConfigKey::StorageBackend.env_var_name(),
            "PIPEDASH_STORAGE_BACKEND"
        );
        assert_eq!(
            ConfigKey::PostgresConnectionString.env_var_name(),
            "PIPEDASH_POSTGRES_URL"
        );
    }

    #[test]
    fn test_config_paths() {
        let config = PipedashConfig::default();
        let data_dir = config.data_dir();

        assert!(config.db_path().starts_with(&data_dir));
        assert!(config.metrics_db_path().starts_with(&data_dir));
        assert!(config.cache_dir().starts_with(&data_dir));
        assert!(config.vault_path().starts_with(&data_dir));
    }
}