attune-core 0.1.0

Core traits and types for attune: runtime-mutable, persisted, observable configuration.
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
use std::{collections::HashMap, env};

use crate::{SettingsError, StoredValue};

/// Function pointer used to parse legacy persisted values.
pub type DeserializeFallback<T> = fn(&str) -> Result<T, String>;

/// Inputs used to resolve a single read-only config field.
pub struct FieldResolveOptions<'a, T> {
    pub env: Option<&'a str>,
    pub toml: Option<&'a toml::Table>,
    pub key: &'a str,
    pub default: T,
}

/// Inputs used to resolve a single persisted config field.
pub struct PersistResolveOptions<'a, T> {
    pub stored: &'a HashMap<String, StoredValue>,
    pub key: &'a str,
    pub deserialize_fallback: Option<DeserializeFallback<T>>,
    pub fallback: FieldResolveOptions<'a, T>,
}

/// Resolves a read-only config field from environment, TOML, or a default.
///
/// Resolution order:
///
/// 1. If `options.env` names a set environment variable, parse that value.
/// 2. If `options.toml` contains `options.key`, deserialize that TOML value.
/// 3. Otherwise, return `options.default`.
///
/// Environment values are first parsed as TOML expressions. If that fails, the
/// raw environment value is treated as a string. For example, `8080`, `true`,
/// `dark`, and `"dark"` all parse as expected for compatible field types.
///
/// # Errors
///
/// Returns [`SettingsError::EnvParse`] when the selected environment variable
/// cannot be parsed as the requested field type. Returns
/// [`SettingsError::ConfigValueParse`] when the selected TOML value cannot be
/// deserialized as the requested field type.
pub fn resolve_readonly_field<T>(options: FieldResolveOptions<T>) -> Result<T, SettingsError>
where
    T: serde::de::DeserializeOwned,
{
    // 1. Try to resolve field from environment variable.
    if let Some(env_name) = options.env
        && let Ok(env_var) = env::var(env_name)
    {
        return parse_env_value(env_name, &env_var);

    // 2. Try to resolve field from TOML table.
    } else if let Some(table) = options.toml
        && let Some(table_value) = table.get(options.key)
    {
        let field_value =
            table_value
                .clone()
                .try_into::<T>()
                .map_err(|e| SettingsError::ConfigValueParse {
                    key: options.key.to_string(),
                    source: e,
                })?;
        return Ok(field_value);
    };

    // 3. Fallback to default value.
    Ok(options.default)
}

/// Resolves a persisted config field from stored values or read-only fallback sources.
///
/// Resolution order:
///
/// 1. If `options.stored` contains `options.key`, decode that persisted value.
/// 2. Otherwise, resolve the field from `options.fallback`.
///
/// A present stored value is authoritative. Invalid persisted data returns an
/// error instead of falling back to env, TOML, or default.
///
/// # Errors
///
/// Returns [`SettingsError::PersistValueParse`] when a stored value exists but
/// cannot be decoded as the requested field type. Returns the same errors as
/// [`resolve_readonly_field`] when falling back to read-only sources.
pub fn resolve_persist_field<T>(options: PersistResolveOptions<T>) -> Result<T, SettingsError>
where
    T: serde::de::DeserializeOwned,
{
    if let Some(stored_value) = options.stored.get(options.key) {
        return decode_persist_value(options.key, stored_value, options.deserialize_fallback);
    }

    resolve_readonly_field(options.fallback)
}

/// Decodes a persisted value, with an optional legacy fallback parser.
///
/// Normal JSON decoding is always attempted first. If it fails and
/// `deserialize_fallback` is present, the fallback receives the raw stored
/// string and may return a value of the requested type.
///
/// # Errors
///
/// Returns [`SettingsError::PersistValueParse`] when normal decoding fails and
/// no fallback is present. Returns [`SettingsError::PersistFallbackParse`] when the
/// fallback is present but cannot parse the raw value.
pub fn decode_persist_value<T>(
    key: &str,
    stored_value: &StoredValue,
    deserialize_fallback: Option<DeserializeFallback<T>>,
) -> Result<T, SettingsError>
where
    T: serde::de::DeserializeOwned,
{
    match stored_value.decode::<T>() {
        Ok(value) => Ok(value),
        Err(source) => match deserialize_fallback {
            Some(fallback) => fallback(stored_value.as_str()).map_err(|error| {
                SettingsError::PersistFallbackParse {
                    key: key.to_string(),
                    error,
                }
            }),
            None => Err(SettingsError::PersistValueParse {
                key: key.to_string(),
                source,
            }),
        },
    }
}

/// Parses an environment variable value into the requested field type.
///
/// The raw value is first parsed as a TOML expression. If that parse fails, the
/// raw value is treated as a string. This keeps scalar values like `8080` and
/// `true` typed, while still allowing ordinary unquoted string environment
/// values like `dark`.
///
/// # Errors
///
/// Returns [`SettingsError::EnvParse`] when neither the TOML expression nor the
/// string fallback can be deserialized as `T`.
fn parse_env_value<T>(name: &str, raw: &str) -> Result<T, SettingsError>
where
    T: serde::de::DeserializeOwned,
{
    let parsed = raw
        .parse::<toml::Value>()
        .unwrap_or_else(|_| toml::Value::String(raw.to_string()));

    parsed
        .clone()
        .try_into::<T>()
        .or_else(|_| toml::Value::String(raw.to_string()).try_into::<T>())
        .map_err(|source| SettingsError::EnvParse {
            name: name.to_string(),
            source,
        })
}

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

    #[test]
    fn test_resolve_readonly_field_env_wins_over_toml_and_default() {
        let env_var_key = "TEST_APP_PORT";
        let table = "port = 3000".parse::<toml::Table>().unwrap();
        let options = FieldResolveOptions::<u16> {
            env: Some(env_var_key),
            toml: Some(&table),
            key: "port",
            default: 1000,
        };

        temp_env::with_var(env_var_key, Some("8080"), || {
            let field_value = resolve_readonly_field(options).unwrap();
            assert_eq!(field_value, 8080);
        });
    }

    #[test]
    fn test_resolve_readonly_field_toml_wins_over_default_when_env_is_absent() {
        let table = "port = 3000".parse::<toml::Table>().unwrap();
        let options = FieldResolveOptions::<u16> {
            env: Some("TEST_APP_MISSING_PORT"),
            toml: Some(&table),
            key: "port",
            default: 1000,
        };

        temp_env::with_var("TEST_APP_MISSING_PORT", None::<&str>, || {
            let field_value = resolve_readonly_field(options).unwrap();
            assert_eq!(field_value, 3000);
        });
    }

    #[test]
    fn test_resolve_readonly_field_uses_default_when_env_and_toml_are_absent() {
        let table = "other = 3000".parse::<toml::Table>().unwrap();
        let options = FieldResolveOptions::<u16> {
            env: Some("TEST_APP_DEFAULT_PORT"),
            toml: Some(&table),
            key: "port",
            default: 1000,
        };

        temp_env::with_var("TEST_APP_DEFAULT_PORT", None::<&str>, || {
            let field_value = resolve_readonly_field(options).unwrap();
            assert_eq!(field_value, 1000);
        });
    }

    #[test]
    fn test_resolve_readonly_field_returns_env_parse_error_for_invalid_env_value() {
        let env_var_key = "TEST_APP_BAD_PORT";
        let table = "port = 3000".parse::<toml::Table>().unwrap();
        let options = FieldResolveOptions::<u16> {
            env: Some(env_var_key),
            toml: Some(&table),
            key: "port",
            default: 1000,
        };

        temp_env::with_var(env_var_key, Some("\"not-a-number\""), || {
            let error = resolve_readonly_field(options).unwrap_err();
            assert_matches!(error, SettingsError::EnvParse { name, .. } if name == env_var_key);
        });
    }

    #[test]
    fn test_resolve_readonly_field_returns_config_value_parse_error_for_bad_toml_type() {
        let table = "port = 'not-a-number'".parse::<toml::Table>().unwrap();
        let options = FieldResolveOptions::<u16> {
            env: None,
            toml: Some(&table),
            key: "port",
            default: 1000,
        };

        let error = resolve_readonly_field(options).unwrap_err();
        assert_matches!(error, SettingsError::ConfigValueParse { key, .. } if key == "port");
    }

    #[test]
    fn test_resolve_readonly_field_parses_unquoted_env_string() {
        let env_var_key = "TEST_APP_THEME";
        let options = FieldResolveOptions::<String> {
            env: Some(env_var_key),
            toml: None,
            key: "theme",
            default: "system".to_string(),
        };

        temp_env::with_var(env_var_key, Some("dark"), || {
            let field_value = resolve_readonly_field(options).unwrap();
            assert_eq!(field_value, "dark");
        });
    }

    #[test]
    fn test_resolve_readonly_field_parses_toml_boolean_env_value() {
        let env_var_key = "TEST_APP_DEBUG";
        let options = FieldResolveOptions::<bool> {
            env: Some(env_var_key),
            toml: None,
            key: "debug",
            default: false,
        };

        temp_env::with_var(env_var_key, Some("true"), || {
            let field_value = resolve_readonly_field(options).unwrap();
            assert!(field_value);
        });
    }

    #[test]
    fn test_resolve_persist_field_uses_stored_value_when_present() {
        let mut stored = HashMap::new();
        stored.insert(
            "theme".to_string(),
            StoredValue::encode(&"dark".to_string()).unwrap(),
        );
        let table = "theme = 'light'".parse::<toml::Table>().unwrap();
        let options = PersistResolveOptions {
            stored: &stored,
            key: "theme",
            deserialize_fallback: None,
            fallback: FieldResolveOptions::<String> {
                env: Some("TEST_APP_PERSIST_THEME"),
                toml: Some(&table),
                key: "theme",
                default: "system".to_string(),
            },
        };

        temp_env::with_var("TEST_APP_PERSIST_THEME", Some("env-dark"), || {
            let field_value = resolve_persist_field(options).unwrap();
            assert_eq!(field_value, "dark");
        });
    }

    #[test]
    fn test_resolve_persist_field_falls_back_to_env_when_stored_value_is_missing() {
        let stored = HashMap::new();
        let table = "theme = 'light'".parse::<toml::Table>().unwrap();
        let options = PersistResolveOptions {
            stored: &stored,
            key: "theme",
            deserialize_fallback: None,
            fallback: FieldResolveOptions::<String> {
                env: Some("TEST_APP_PERSIST_ENV_THEME"),
                toml: Some(&table),
                key: "theme",
                default: "system".to_string(),
            },
        };

        temp_env::with_var("TEST_APP_PERSIST_ENV_THEME", Some("env-dark"), || {
            let field_value = resolve_persist_field(options).unwrap();
            assert_eq!(field_value, "env-dark");
        });
    }

    #[test]
    fn test_resolve_persist_field_falls_back_to_toml_when_env_and_stored_value_are_missing() {
        let stored = HashMap::new();
        let table = "theme = 'light'".parse::<toml::Table>().unwrap();
        let options = PersistResolveOptions {
            stored: &stored,
            key: "theme",
            deserialize_fallback: None,
            fallback: FieldResolveOptions::<String> {
                env: Some("TEST_APP_PERSIST_MISSING_THEME"),
                toml: Some(&table),
                key: "theme",
                default: "system".to_string(),
            },
        };

        temp_env::with_var("TEST_APP_PERSIST_MISSING_THEME", None::<&str>, || {
            let field_value = resolve_persist_field(options).unwrap();
            assert_eq!(field_value, "light");
        });
    }

    #[test]
    fn test_resolve_persist_field_falls_back_to_default_when_other_sources_are_missing() {
        let stored = HashMap::new();
        let table = "other = 'light'".parse::<toml::Table>().unwrap();
        let options = PersistResolveOptions {
            stored: &stored,
            key: "theme",
            deserialize_fallback: None,
            fallback: FieldResolveOptions::<String> {
                env: Some("TEST_APP_PERSIST_DEFAULT_THEME"),
                toml: Some(&table),
                key: "theme",
                default: "system".to_string(),
            },
        };

        temp_env::with_var("TEST_APP_PERSIST_DEFAULT_THEME", None::<&str>, || {
            let field_value = resolve_persist_field(options).unwrap();
            assert_eq!(field_value, "system");
        });
    }

    #[test]
    fn test_resolve_persist_field_returns_error_for_bad_stored_value() {
        let mut stored = HashMap::new();
        stored.insert(
            "port".to_string(),
            StoredValue::from_raw("\"not-a-number\"".to_string()),
        );
        let options = PersistResolveOptions {
            stored: &stored,
            key: "port",
            deserialize_fallback: None,
            fallback: FieldResolveOptions::<u16> {
                env: None,
                toml: None,
                key: "port",
                default: 8080,
            },
        };

        let error = resolve_persist_field(options).unwrap_err();
        assert_matches!(error, SettingsError::PersistValueParse { key, .. } if key == "port");
    }

    #[test]
    fn test_resolve_persist_field_uses_deserialize_fallback_for_bad_stored_value() {
        fn legacy_port(raw: &str) -> Result<u16, String> {
            match raw {
                "\"legacy-port\"" => Ok(9000),
                other => Err(format!("unknown legacy port: {other}")),
            }
        }

        let mut stored = HashMap::new();
        stored.insert(
            "port".to_string(),
            StoredValue::encode(&"legacy-port".to_string()).unwrap(),
        );
        let options = PersistResolveOptions {
            stored: &stored,
            key: "port",
            deserialize_fallback: Some(legacy_port),
            fallback: FieldResolveOptions::<u16> {
                env: None,
                toml: None,
                key: "port",
                default: 8080,
            },
        };

        let field_value = resolve_persist_field(options).unwrap();
        assert_eq!(field_value, 9000);
    }

    #[test]
    fn test_resolve_persist_field_returns_fallback_error_when_fallback_fails() {
        fn legacy_port(raw: &str) -> Result<u16, String> {
            Err(format!("unknown legacy port: {raw}"))
        }

        let mut stored = HashMap::new();
        stored.insert(
            "port".to_string(),
            StoredValue::encode(&"unknown".to_string()).unwrap(),
        );
        let options = PersistResolveOptions {
            stored: &stored,
            key: "port",
            deserialize_fallback: Some(legacy_port),
            fallback: FieldResolveOptions::<u16> {
                env: None,
                toml: None,
                key: "port",
                default: 8080,
            },
        };

        let error = resolve_persist_field(options).unwrap_err();
        assert_matches!(error, SettingsError::PersistFallbackParse { key, error } if key == "port" && error.contains("unknown legacy port"));
    }
}