tier 0.1.17

Rust configuration library for layered TOML, env, and CLI settings
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

use crate::loader::de::insert_path;
use crate::loader::overrides::{ParsedOverride, parse_env_override_value};
use crate::loader::path::{
    ensure_path_safe_keys, indexed_array_container_paths, record_direct_array_state,
    record_indexed_array_state,
};
use crate::loader::trace::record_layer_entry_traces;
use crate::path::join_path;
use crate::{ConfigError, EnvDecoder};

use super::context::EnvLayerContext;
use crate::loader::env::decoder::{custom_env_decoder_for_path, env_decoder_for_path};
use crate::loader::env::state::EnvLayerState;
use crate::loader::env::target::{canonicalize_runtime_env_target_path, claim_env_path};

pub(super) fn insert_env_value(
    context: &EnvLayerContext<'_>,
    state: &mut EnvLayerState,
    name: &str,
    raw_value: &str,
    path: &str,
    external_path: Option<String>,
    decoder: Option<EnvDecoder>,
) -> Result<(), ConfigError> {
    let original_path = external_path.unwrap_or_else(|| path.to_owned());
    let path = canonicalize_runtime_env_target_path(
        name,
        &original_path,
        context.alias_overrides,
        context.runtime_layers,
        &state.root,
    )?;
    if path.is_empty() {
        return Ok(());
    }

    claim_env_path(name, &path, &mut state.claimed_paths)?;
    let parsed = decode_env_value(context, name, raw_value, &path, decoder)?;
    let is_direct_array = parsed.value.is_array();
    let segments = path.split('.').collect::<Vec<_>>();

    record_array_state(state, &path, &segments, is_direct_array, &parsed.value);
    insert_path(&mut state.root, &segments, parsed.value).map_err(|message| {
        ConfigError::InvalidEnv {
            name: name.to_owned(),
            path: path.clone(),
            message,
        }
    })?;
    record_insert_metadata(
        state,
        name,
        &path,
        &segments,
        is_direct_array,
        parsed.string_coercion_suffixes,
    );

    Ok(())
}

fn decode_env_value(
    context: &EnvLayerContext<'_>,
    name: &str,
    raw_value: &str,
    path: &str,
    decoder: Option<EnvDecoder>,
) -> Result<ParsedOverride, ConfigError> {
    let custom_decoder = decoder
        .is_none()
        .then(|| custom_env_decoder_for_path(path, context.custom_env_decoders))
        .flatten();
    let metadata_env_decoder = context
        .metadata
        .effective_field_for(path)
        .and_then(|field| field.env_decode);
    let decoder = decoder
        .or_else(|| env_decoder_for_path(path, context.env_decoders))
        .or(metadata_env_decoder);

    let parsed =
        parse_env_override_value(raw_value, decoder, custom_decoder).map_err(|message| {
            ConfigError::InvalidEnv {
                name: name.to_owned(),
                path: path.to_owned(),
                message,
            }
        })?;
    ensure_path_safe_keys(&parsed.value, path).map_err(|error| match error {
        ConfigError::InvalidPathKey { path, key, message } => ConfigError::InvalidEnv {
            name: name.to_owned(),
            path,
            message: format!(
                "decoded environment value contains unsupported object key `{key}`: {message}"
            ),
        },
        _ => error,
    })?;

    Ok(parsed)
}

fn record_array_state(
    state: &mut EnvLayerState,
    path: &str,
    segments: &[&str],
    is_direct_array: bool,
    value: &serde_json::Value,
) {
    record_indexed_array_state(
        &mut state.current_array_lengths,
        &mut state.indexed_array_base_lengths,
        path,
        segments,
    );
    if is_direct_array {
        record_direct_array_state(
            &mut state.current_array_lengths,
            &mut state.indexed_array_base_lengths,
            path,
            value,
        );
    }
}

fn record_insert_metadata(
    state: &mut EnvLayerState,
    name: &str,
    path: &str,
    segments: &[&str],
    is_direct_array: bool,
    string_coercion_suffixes: std::collections::BTreeSet<String>,
) {
    for suffix in string_coercion_suffixes {
        state.coercible_string_paths.insert(if suffix.is_empty() {
            path.to_owned()
        } else {
            join_path(path, &suffix)
        });
    }
    state
        .indexed_array_paths
        .extend(indexed_array_container_paths(segments));
    if is_direct_array {
        state.direct_array_paths.insert(path.to_owned());
    }

    record_layer_entry_traces(
        &mut state.entries,
        crate::loader::SourceKind::Environment,
        "environment",
        name,
        path,
        segments,
    );
}