bamboo-config 2026.10.13

Configuration, settings, paths, encryption and keyword-masking for the Bamboo agent framework
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
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
//! Legacy-provider compatibility at the provider-instance boundary.
//!
//! Runtime code consumes [`ProviderInstanceConfig`] directly.  The helpers in
//! this module are deliberately limited to materializing a legacy-only
//! configuration into durable provider instances. Legacy config input remains
//! supported for cold starts, but it is not re-projected into an HTTP response.

use super::config::{Config, ProviderInstanceConfig};
use serde_json::Value;

/// Marker stored in an instance's forward-compatible fields when its API key
/// may be overridden by the provider type's standard `BAMBOO_*_API_KEY`
/// environment variable. The marker is metadata only; plaintext is injected at
/// runtime and is never encrypted or persisted by ordinary config saves.
///
/// Legacy materialization keeps this binding even when a stable
/// [`crate::CredentialRef`] exists. That preserves the historical precedence
/// contract: an environment key wins while present and the stored credential is
/// the fallback after the variable is removed.
pub const PROVIDER_INSTANCE_API_KEY_FROM_ENV_CONFIG_KEY: &str = "api_key_from_env";

/// Whether a provider instance accepts its provider type's standard runtime
/// environment-variable override.
pub fn provider_instance_api_key_from_env(instance: &ProviderInstanceConfig) -> bool {
    instance
        .extra
        .get(PROVIDER_INSTANCE_API_KEY_FROM_ENV_CONFIG_KEY)
        .and_then(Value::as_bool)
        .unwrap_or(false)
}

/// Whether a marked provider instance is currently using its standard runtime
/// environment-variable override.
///
/// Merely persisting the binding is not enough: the variable must be non-empty
/// and the live instance must have been hydrated with that exact value. This
/// keeps credential-status projections honest when an environment variable is
/// added after startup but before the next configuration reload.
pub fn provider_instance_environment_override_active(instance: &ProviderInstanceConfig) -> bool {
    if !provider_instance_api_key_from_env(instance) {
        return false;
    }
    provider_api_key_environment_override_active(&instance.provider_type, &instance.api_key)
}

/// Whether a provider key currently matches its standard environment override.
///
/// Compatibility projections use this without fabricating a temporary
/// [`ProviderInstanceConfig`]. A persisted environment binding alone is not
/// active: the variable must still be present and equal the hydrated runtime
/// value.
pub fn provider_api_key_environment_override_active(provider_type: &str, api_key: &str) -> bool {
    let Some(env_var) = standard_provider_api_key_env(provider_type) else {
        return false;
    };
    let Ok(value) = crate::runtime_env_var(env_var) else {
        return false;
    };
    let value = value.trim();
    !value.is_empty() && api_key.trim() == value
}

fn copy_runtime_env_marker(
    extra: &mut std::collections::BTreeMap<String, Value>,
    from_environment: bool,
) {
    if from_environment {
        extra.insert(
            PROVIDER_INSTANCE_API_KEY_FROM_ENV_CONFIG_KEY.to_string(),
            Value::Bool(true),
        );
    }
}

fn insert_optional_extra(
    extra: &mut std::collections::BTreeMap<String, Value>,
    key: &str,
    value: Option<Value>,
) {
    if let Some(value) = value {
        extra.entry(key.to_string()).or_insert(value);
    }
}

/// Create synthetic provider instances from legacy `providers` config.
///
/// For each configured legacy provider that does not already have a
/// corresponding entry in `provider_instances`, a synthetic instance
/// is created using the provider type as the instance id (e.g. `"openai"`).
/// This allows the instance-keyed registry to fall back to legacy config
/// without requiring user migration.
pub fn synthesize_legacy_instances(config: &Config) -> Vec<(String, ProviderInstanceConfig)> {
    let mut result = Vec::new();

    if let Some(openai) = &config.providers.openai {
        let id = "openai".to_string();
        if !config.provider_instances.contains_key(&id) {
            let mut extra = openai.extra.clone();
            copy_runtime_env_marker(&mut extra, openai.api_key_from_env);
            result.push((
                id,
                ProviderInstanceConfig {
                    provider_type: "openai".to_string(),
                    label: Some("OpenAI".to_string()),
                    api_key: openai.api_key.clone(),
                    api_key_encrypted: openai.api_key_encrypted.clone(),
                    credential_ref: openai.credential_ref.clone(),
                    base_url: openai.base_url.clone(),
                    model: openai.model.clone(),
                    fast_model: openai.fast_model.clone(),
                    vision_model: openai.vision_model.clone(),
                    reasoning_effort: openai.reasoning_effort,
                    responses_only_models: openai.responses_only_models.clone(),
                    request_overrides: openai.request_overrides.clone(),
                    enabled: true,
                    extra,
                },
            ));
        }
    }

    if let Some(anthropic) = &config.providers.anthropic {
        let id = "anthropic".to_string();
        if !config.provider_instances.contains_key(&id) {
            let mut extra = anthropic.extra.clone();
            copy_runtime_env_marker(&mut extra, anthropic.api_key_from_env);
            insert_optional_extra(
                &mut extra,
                "max_tokens",
                anthropic.max_tokens.map(Value::from),
            );
            insert_optional_extra(
                &mut extra,
                "thinking_replay_always",
                anthropic.thinking_replay_always.map(Value::Bool),
            );
            result.push((
                id,
                ProviderInstanceConfig {
                    provider_type: "anthropic".to_string(),
                    label: Some("Anthropic".to_string()),
                    api_key: anthropic.api_key.clone(),
                    api_key_encrypted: anthropic.api_key_encrypted.clone(),
                    credential_ref: anthropic.credential_ref.clone(),
                    base_url: anthropic.base_url.clone(),
                    model: anthropic.model.clone(),
                    fast_model: anthropic.fast_model.clone(),
                    vision_model: anthropic.vision_model.clone(),
                    reasoning_effort: anthropic.reasoning_effort,
                    responses_only_models: vec![],
                    request_overrides: anthropic.request_overrides.clone(),
                    enabled: true,
                    extra,
                },
            ));
        }
    }

    if let Some(gemini) = &config.providers.gemini {
        let id = "gemini".to_string();
        if !config.provider_instances.contains_key(&id) {
            let mut extra = gemini.extra.clone();
            copy_runtime_env_marker(&mut extra, gemini.api_key_from_env);
            result.push((
                id,
                ProviderInstanceConfig {
                    provider_type: "gemini".to_string(),
                    label: Some("Gemini".to_string()),
                    api_key: gemini.api_key.clone(),
                    api_key_encrypted: gemini.api_key_encrypted.clone(),
                    credential_ref: gemini.credential_ref.clone(),
                    base_url: gemini.base_url.clone(),
                    model: gemini.model.clone(),
                    fast_model: gemini.fast_model.clone(),
                    vision_model: gemini.vision_model.clone(),
                    reasoning_effort: gemini.reasoning_effort,
                    responses_only_models: vec![],
                    request_overrides: gemini.request_overrides.clone(),
                    enabled: true,
                    extra,
                },
            ));
        }
    }

    if let Some(copilot) = &config.providers.copilot {
        let id = "copilot".to_string();
        if !config.provider_instances.contains_key(&id) {
            // Copilot doesn't have a traditional api_key; it uses device auth.
            let mut extra = copilot.extra.clone();
            extra
                .entry("headless_auth".to_string())
                .or_insert(Value::Bool(copilot.headless_auth));
            result.push((
                id,
                ProviderInstanceConfig {
                    provider_type: "copilot".to_string(),
                    label: Some("GitHub Copilot".to_string()),
                    api_key: String::new(),
                    api_key_encrypted: None,
                    credential_ref: None,
                    base_url: None,
                    model: copilot.model.clone(),
                    fast_model: copilot.fast_model.clone(),
                    vision_model: copilot.vision_model.clone(),
                    reasoning_effort: copilot.reasoning_effort,
                    responses_only_models: copilot.responses_only_models.clone(),
                    request_overrides: copilot.request_overrides.clone(),
                    enabled: copilot.enabled || config.provider == "copilot",
                    extra,
                },
            ));
        }
    }

    if let Some(bodhi) = &config.providers.bodhi {
        let id = "bodhi".to_string();
        if !config.provider_instances.contains_key(&id) {
            let mut extra = bodhi.extra.clone();
            insert_optional_extra(
                &mut extra,
                "target_provider",
                bodhi.target_provider.clone().map(Value::String),
            );
            result.push((
                id,
                ProviderInstanceConfig {
                    provider_type: "bodhi".to_string(),
                    label: Some("Bodhi".to_string()),
                    api_key: bodhi.api_key.clone(),
                    api_key_encrypted: bodhi.api_key_encrypted.clone(),
                    credential_ref: bodhi.credential_ref.clone(),
                    base_url: bodhi.base_url.clone(),
                    model: None,
                    fast_model: None,
                    vision_model: None,
                    reasoning_effort: bodhi.reasoning_effort,
                    responses_only_models: vec![],
                    request_overrides: None,
                    enabled: true,
                    extra,
                },
            ));
        }
    }

    result
}

/// Idempotently materialize legacy provider configuration.
///
/// The provider type is retained as the instance id so existing routing keys,
/// `BAMBOO_PROVIDER`, and old clients remain deterministic. An explicitly
/// configured instance matching the selected routing key always wins. Hybrid
/// configs may materialize a missing legacy default without changing any
/// explicit instance.
///
/// Every non-conflicting legacy alias is preserved, even when the selected
/// default already resolves to an explicit instance. Stored credentials reuse
/// the legacy provider's stable `credential_ref`. Materialized
/// OpenAI/Anthropic/Gemini aliases retain their standard environment override
/// binding while keeping the stored credential as a fallback; environment-only
/// aliases carry only the marker and never persist plaintext.
pub fn materialize_legacy_provider_instances(config: &mut Config) -> bool {
    let selected = config.effective_default_provider().trim().to_string();
    if selected.is_empty() {
        return false;
    }
    let selected_is_explicit = config.provider_instances.contains_key(&selected);

    let mut candidates = synthesize_legacy_instances(config);

    if !selected_is_explicit
        && selected == "copilot"
        && !candidates.iter().any(|(id, _)| id == &selected)
    {
        candidates.push((
            selected.clone(),
            default_copilot_instance(config.headless_auth),
        ));
    }

    // Preserve every standard legacy env-only provider, not just the selected
    // one. A custom explicit instance id must not absorb a type-wide legacy
    // override, so the compatibility alias keeps the provider type as its id.
    for provider_type in ["openai", "anthropic", "gemini"] {
        if standard_provider_api_key_env_is_available(provider_type)
            && !config.provider_instances.contains_key(provider_type)
            && !candidates.iter().any(|(id, _)| id == provider_type)
        {
            let mut instance = empty_provider_instance(provider_type);
            instance.label = Some(provider_display_label(provider_type).to_string());
            copy_runtime_env_marker(&mut instance.extra, true);
            candidates.push((provider_type.to_string(), instance));
        }
    }

    // Credential migration must isolate ordinary legacy plaintext/ciphertext
    // before provider metadata can be materialized. Refuse to turn an
    // unisolated secret into an env-bound instance, which would otherwise make
    // an ordinary save omit the plaintext and silently lose it.
    if candidates.iter().any(|(_, instance)| {
        instance.credential_ref.is_none()
            && !provider_instance_api_key_from_env(instance)
            && (!instance.api_key.trim().is_empty() || instance.api_key_encrypted.is_some())
    }) {
        return false;
    }

    for (_, instance) in &mut candidates {
        if standard_provider_api_key_env(&instance.provider_type).is_some() {
            copy_runtime_env_marker(&mut instance.extra, true);
            if instance.credential_ref.is_none() {
                // The only possible plaintext at this point is a runtime env
                // value already identified by the legacy flag above.
                instance.api_key.clear();
                instance.api_key_encrypted = None;
            }
        }
    }

    if let Some((_, selected_instance)) = candidates
        .iter_mut()
        .find(|(id, _)| id == &selected && selected == "copilot")
    {
        selected_instance.enabled = true;
    }

    let selected_is_usable = selected_is_explicit
        || candidates.iter().any(|(id, instance)| {
            id == &selected
                && instance.enabled
                && (instance.provider_type == "copilot"
                    || instance.credential_ref.is_some()
                    || (provider_instance_api_key_from_env(instance)
                        && standard_provider_api_key_env_is_available(&instance.provider_type)))
        });
    if !selected_is_usable {
        return false;
    }

    let mut changed = !candidates.is_empty();
    config.provider_instances.extend(candidates);
    if config.default_provider_instance.as_deref() != Some(&selected) {
        config.default_provider_instance = Some(selected);
        changed = true;
    }
    changed
}

fn standard_provider_api_key_env(provider_type: &str) -> Option<&'static str> {
    match provider_type {
        "openai" => Some("BAMBOO_OPENAI_API_KEY"),
        "anthropic" => Some("BAMBOO_ANTHROPIC_API_KEY"),
        "gemini" => Some("BAMBOO_GEMINI_API_KEY"),
        _ => None,
    }
}

fn standard_provider_api_key_env_is_available(provider_type: &str) -> bool {
    standard_provider_api_key_env(provider_type)
        .and_then(|env_var| crate::runtime_env_var(env_var).ok())
        .is_some_and(|value| !value.trim().is_empty())
}

fn provider_display_label(provider_type: &str) -> &str {
    match provider_type {
        "openai" => "OpenAI",
        "anthropic" => "Anthropic",
        "gemini" => "Gemini",
        "copilot" => "GitHub Copilot",
        "bodhi" => "Bodhi",
        other => other,
    }
}

fn empty_provider_instance(provider_type: &str) -> ProviderInstanceConfig {
    ProviderInstanceConfig {
        provider_type: provider_type.to_string(),
        label: None,
        api_key: String::new(),
        api_key_encrypted: None,
        credential_ref: None,
        base_url: None,
        model: None,
        fast_model: None,
        vision_model: None,
        reasoning_effort: None,
        responses_only_models: Vec::new(),
        request_overrides: None,
        enabled: true,
        extra: Default::default(),
    }
}

fn default_copilot_instance(headless_auth: bool) -> ProviderInstanceConfig {
    let mut instance = empty_provider_instance("copilot");
    instance.label = Some("GitHub Copilot".to_string());
    instance
        .extra
        .insert("headless_auth".to_string(), Value::Bool(headless_auth));
    instance
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::config::{
        AnthropicConfig, BodhiConfig, CopilotConfig, GeminiConfig, OpenAIConfig, ProviderConfigs,
    };

    /// Build a test config with explicit empty providers/instances. (Since #38,
    /// `Config::default()` is in-memory only — no filesystem/env bleed — so the
    /// remaining fields come from clean defaults.)
    fn clean_test_config() -> Config {
        Config::default()
    }

    #[test]
    fn synthesize_produces_nothing_when_no_legacy_config() {
        let config = clean_test_config();
        let instances = synthesize_legacy_instances(&config);
        // May produce entries if user's default config has providers,
        // so we just verify no duplicates and valid structure.
        for (id, inst) in &instances {
            assert!(!id.is_empty());
            assert!(!inst.provider_type.is_empty());
        }
    }

    #[test]
    fn synthesize_produces_openai_from_legacy() {
        let mut config = clean_test_config();
        let mut extra = std::collections::BTreeMap::new();
        extra.insert(
            crate::OPENAI_EXPLICIT_PROMPT_CACHE_CONFIG_KEY.to_string(),
            serde_json::json!(false),
        );
        config.providers.openai = Some(crate::config::OpenAIConfig {
            api_key: "sk-test".to_string(),
            api_key_encrypted: None,
            credential_ref: None,
            base_url: Some("https://api.openai.com/v1".to_string()),
            model: Some("gpt-4o".to_string()),
            fast_model: Some("gpt-4o-mini".to_string()),
            vision_model: None,
            reasoning_effort: None,
            responses_only_models: vec![],
            request_overrides: None,
            extra,
            api_key_from_env: false,
        });
        // Clear any other legacy providers to isolate this test.
        config.providers.anthropic = None;
        config.providers.gemini = None;
        config.providers.copilot = None;
        config.providers.bodhi = None;

        let instances = synthesize_legacy_instances(&config);
        assert_eq!(instances.len(), 1);

        let (id, inst) = &instances[0];
        assert_eq!(id, "openai");
        assert_eq!(inst.provider_type, "openai");
        assert_eq!(inst.api_key, "sk-test");
        assert_eq!(inst.model.as_deref(), Some("gpt-4o"));
        assert_eq!(
            inst.extra
                .get(crate::OPENAI_EXPLICIT_PROMPT_CACHE_CONFIG_KEY),
            Some(&serde_json::json!(false))
        );
    }

    #[test]
    fn synthesize_skips_if_instance_already_exists() {
        let mut config = clean_test_config();
        config.providers.openai = Some(crate::config::OpenAIConfig {
            api_key: "sk-test".to_string(),
            api_key_encrypted: None,
            credential_ref: None,
            base_url: None,
            model: Some("gpt-4o".to_string()),
            fast_model: None,
            vision_model: None,
            reasoning_effort: None,
            responses_only_models: vec![],
            request_overrides: None,
            extra: Default::default(),
            api_key_from_env: false,
        });
        // Clear other providers to isolate.
        config.providers.anthropic = None;
        config.providers.gemini = None;
        config.providers.copilot = None;
        config.providers.bodhi = None;

        config.provider_instances.insert(
            "openai".to_string(),
            ProviderInstanceConfig {
                provider_type: "openai".to_string(),
                label: Some("Custom OpenAI".to_string()),
                api_key: "sk-custom".to_string(),
                api_key_encrypted: None,
                credential_ref: None,
                base_url: None,
                model: Some("gpt-4".to_string()),
                fast_model: None,
                vision_model: None,
                reasoning_effort: None,
                responses_only_models: vec![],
                request_overrides: None,
                enabled: true,
                extra: Default::default(),
            },
        );

        let instances = synthesize_legacy_instances(&config);
        assert!(instances.is_empty());
    }

    #[test]
    fn synthesize_preserves_credential_reference_and_provider_specific_fields() {
        let mut config = clean_test_config();
        config.providers.openai = None;
        config.providers.gemini = None;
        config.providers.copilot = Some(CopilotConfig {
            enabled: true,
            headless_auth: true,
            extra: [(
                "copilot_extension".to_string(),
                Value::String("kept".into()),
            )]
            .into_iter()
            .collect(),
            ..CopilotConfig::default()
        });
        config.providers.bodhi = Some(BodhiConfig {
            api_key: String::new(),
            api_key_encrypted: None,
            credential_ref: Some(crate::CredentialRef::parse("provider.bodhi.api_key").unwrap()),
            base_url: None,
            target_provider: Some("anthropic".to_string()),
            reasoning_effort: None,
            extra: [("bodhi_extension".to_string(), Value::Bool(true))]
                .into_iter()
                .collect(),
        });
        config.providers.anthropic = Some(AnthropicConfig {
            credential_ref: Some(
                crate::CredentialRef::parse("provider.anthropic.api_key").unwrap(),
            ),
            max_tokens: Some(8192),
            thinking_replay_always: Some(true),
            extra: [(
                "anthropic_extension".to_string(),
                Value::String("kept".into()),
            )]
            .into_iter()
            .collect(),
            ..AnthropicConfig::default()
        });

        let instances = synthesize_legacy_instances(&config)
            .into_iter()
            .collect::<std::collections::BTreeMap<_, _>>();
        let anthropic = &instances["anthropic"];
        assert_eq!(
            anthropic
                .credential_ref
                .as_ref()
                .map(|value| value.as_str()),
            Some("provider.anthropic.api_key")
        );
        assert_eq!(anthropic.extra["max_tokens"], serde_json::json!(8192));
        assert_eq!(anthropic.extra["thinking_replay_always"], Value::Bool(true));
        assert_eq!(
            anthropic.extra["anthropic_extension"],
            Value::String("kept".into())
        );
        assert_eq!(instances["copilot"].extra["headless_auth"], true);
        assert_eq!(instances["copilot"].extra["copilot_extension"], "kept");
        assert_eq!(instances["bodhi"].extra["target_provider"], "anthropic");
        assert_eq!(instances["bodhi"].extra["bodhi_extension"], true);
    }

    #[test]
    fn materialization_is_idempotent_and_reuses_stable_credential_reference() {
        let mut config = clean_test_config();
        config.provider = "openai".to_string();
        config.providers.anthropic = None;
        config.providers.gemini = None;
        config.providers.copilot = None;
        config.providers.bodhi = None;
        config.providers.openai = Some(OpenAIConfig {
            credential_ref: Some(crate::CredentialRef::parse("provider.openai.api_key").unwrap()),
            model: Some("gpt-4.1".to_string()),
            ..OpenAIConfig::default()
        });

        assert!(materialize_legacy_provider_instances(&mut config));
        let first = serde_json::to_value(&config.provider_instances).unwrap();
        assert!(!materialize_legacy_provider_instances(&mut config));
        assert_eq!(
            serde_json::to_value(&config.provider_instances).unwrap(),
            first
        );
        assert_eq!(config.default_provider_instance.as_deref(), Some("openai"));
        assert_eq!(
            config.provider_instances["openai"]
                .credential_ref
                .as_ref()
                .map(|value| value.as_str()),
            Some("provider.openai.api_key")
        );
        assert!(provider_instance_api_key_from_env(
            &config.provider_instances["openai"]
        ));
        assert!(!first.to_string().contains("api_key_encrypted"));
    }

    #[test]
    fn explicit_disabled_default_is_never_rewritten_from_stale_legacy_config() {
        let mut config = clean_test_config();
        config.provider = "openai".to_string();
        config.providers.openai = Some(OpenAIConfig {
            credential_ref: Some(crate::CredentialRef::parse("provider.openai.api_key").unwrap()),
            ..OpenAIConfig::default()
        });
        let mut explicit = empty_provider_instance("openai");
        explicit.enabled = false;
        config
            .provider_instances
            .insert("openai".to_string(), explicit);
        config.default_provider_instance = Some("openai".to_string());

        assert!(!materialize_legacy_provider_instances(&mut config));
        assert!(!config.provider_instances["openai"].enabled);
    }

    #[test]
    fn hybrid_missing_legacy_default_is_materialized_with_all_missing_aliases() {
        let mut config = clean_test_config();
        config
            .provider_instances
            .insert("work".to_string(), empty_provider_instance("openai"));
        config.providers.openai = Some(OpenAIConfig {
            credential_ref: Some(crate::CredentialRef::parse("provider.openai.api_key").unwrap()),
            ..OpenAIConfig::default()
        });
        config.providers.anthropic = Some(AnthropicConfig {
            credential_ref: Some(
                crate::CredentialRef::parse("provider.anthropic.api_key").unwrap(),
            ),
            ..AnthropicConfig::default()
        });
        config.default_provider_instance = Some("openai".to_string());

        assert!(materialize_legacy_provider_instances(&mut config));
        assert!(config.provider_instances.contains_key("work"));
        assert!(config.provider_instances.contains_key("openai"));
        assert!(config.provider_instances.contains_key("anthropic"));
        assert_eq!(config.default_provider_instance.as_deref(), Some("openai"));
    }

    #[test]
    fn explicit_default_materializes_noncolliding_legacy_aliases_without_changing_default() {
        let mut config = clean_test_config();
        config.provider = "work".to_string();
        config
            .provider_instances
            .insert("work".to_string(), empty_provider_instance("openai"));
        config.default_provider_instance = Some("work".to_string());
        config.providers.openai = Some(OpenAIConfig {
            credential_ref: Some(crate::CredentialRef::parse("provider.openai.api_key").unwrap()),
            model: Some("gpt-legacy".to_string()),
            ..OpenAIConfig::default()
        });
        config.providers.anthropic = Some(AnthropicConfig {
            credential_ref: Some(
                crate::CredentialRef::parse("provider.anthropic.api_key").unwrap(),
            ),
            model: Some("claude-legacy".to_string()),
            ..AnthropicConfig::default()
        });

        assert!(materialize_legacy_provider_instances(&mut config));
        assert_eq!(config.default_provider_instance.as_deref(), Some("work"));
        assert_eq!(
            config.provider_instances["openai"].model.as_deref(),
            Some("gpt-legacy")
        );
        assert_eq!(
            config.provider_instances["anthropic"].model.as_deref(),
            Some("claude-legacy")
        );
        assert!(provider_instance_api_key_from_env(
            &config.provider_instances["openai"]
        ));
        assert!(provider_instance_api_key_from_env(
            &config.provider_instances["anthropic"]
        ));
    }

    #[test]
    fn ordinary_missing_key_does_not_gain_an_environment_marker() {
        let mut config = clean_test_config();
        config.providers.anthropic = None;
        config.providers.gemini = None;
        config.providers.copilot = None;
        config.providers.bodhi = None;
        config.providers.openai = Some(OpenAIConfig::default());

        let synthesized = synthesize_legacy_instances(&config);
        assert_eq!(synthesized.len(), 1);
        assert!(!provider_instance_api_key_from_env(&synthesized[0].1));
    }

    #[test]
    fn missing_unusable_default_does_not_create_dangling_instance() {
        let mut config = clean_test_config();
        config.provider = "bodhi".to_string();
        *config.providers_mut() = ProviderConfigs {
            bodhi: Some(BodhiConfig {
                api_key: String::new(),
                api_key_encrypted: None,
                credential_ref: None,
                base_url: None,
                target_provider: None,
                reasoning_effort: None,
                extra: Default::default(),
            }),
            ..ProviderConfigs::default()
        };

        assert!(!materialize_legacy_provider_instances(&mut config));
        assert!(config.provider_instances.is_empty());
        assert!(config.default_provider_instance.is_none());
    }

    #[test]
    fn env_owned_legacy_key_migrates_as_marker_without_secret_material() {
        let _openai = crate::test_support::override_runtime_env_var("BAMBOO_OPENAI_API_KEY", None);
        let _anthropic =
            crate::test_support::override_runtime_env_var("BAMBOO_ANTHROPIC_API_KEY", None);
        let _gemini = crate::test_support::override_runtime_env_var(
            "BAMBOO_GEMINI_API_KEY",
            Some("runtime-only"),
        );
        let mut config = clean_test_config();
        config.provider = "gemini".to_string();
        *config.providers_mut() = ProviderConfigs {
            gemini: Some(GeminiConfig {
                api_key: "runtime-only".to_string(),
                api_key_from_env: true,
                ..GeminiConfig::default()
            }),
            ..ProviderConfigs::default()
        };

        assert!(materialize_legacy_provider_instances(&mut config));
        let instance = &config.provider_instances["gemini"];
        assert!(provider_instance_api_key_from_env(instance));
        let disk = serde_json::to_value(instance).unwrap();
        assert_eq!(disk[PROVIDER_INSTANCE_API_KEY_FROM_ENV_CONFIG_KEY], true);
        assert!(disk.get("api_key").is_none());
        assert!(disk.get("api_key_encrypted").is_none());
    }

    #[test]
    fn materialized_legacy_ref_keeps_environment_override_and_stored_fallback() {
        let openai = crate::test_support::override_runtime_env_var("BAMBOO_OPENAI_API_KEY", None);
        let _anthropic =
            crate::test_support::override_runtime_env_var("BAMBOO_ANTHROPIC_API_KEY", None);
        let _gemini = crate::test_support::override_runtime_env_var("BAMBOO_GEMINI_API_KEY", None);
        let mut config = clean_test_config();
        config.provider = "openai".to_string();
        config.providers.openai = Some(OpenAIConfig {
            api_key: "sk-stored-fallback".to_string(),
            credential_ref: Some(crate::CredentialRef::parse("provider.openai.api_key").unwrap()),
            ..OpenAIConfig::default()
        });

        assert!(materialize_legacy_provider_instances(&mut config));
        assert!(provider_instance_api_key_from_env(
            &config.provider_instances["openai"]
        ));
        config.apply_runtime_env_overrides();
        assert_eq!(
            config.provider_instances["openai"].api_key,
            "sk-stored-fallback"
        );
        assert!(!provider_instance_environment_override_active(
            &config.provider_instances["openai"]
        ));

        openai.replace(Some("sk-runtime-override"));
        config.apply_runtime_env_overrides();
        assert_eq!(
            config.provider_instances["openai"].api_key,
            "sk-runtime-override"
        );
        assert!(provider_instance_environment_override_active(
            &config.provider_instances["openai"]
        ));

        openai.replace(None);
        config.provider_instances.get_mut("openai").unwrap().api_key =
            "sk-stored-fallback".to_string();
        config.apply_runtime_env_overrides();
        assert_eq!(
            config.provider_instances["openai"].api_key,
            "sk-stored-fallback"
        );
        assert!(!provider_instance_environment_override_active(
            &config.provider_instances["openai"]
        ));
    }

    #[test]
    fn nonselected_environment_only_provider_is_materialized_and_hydrated() {
        let _openai = crate::test_support::override_runtime_env_var("BAMBOO_OPENAI_API_KEY", None);
        let _anthropic = crate::test_support::override_runtime_env_var(
            "BAMBOO_ANTHROPIC_API_KEY",
            Some("sk-ant-runtime"),
        );
        let _gemini = crate::test_support::override_runtime_env_var("BAMBOO_GEMINI_API_KEY", None);
        let mut config = clean_test_config();
        config.provider = "openai".to_string();
        config.providers.openai = Some(OpenAIConfig {
            api_key: "sk-openai-stored".to_string(),
            credential_ref: Some(crate::CredentialRef::parse("provider.openai.api_key").unwrap()),
            ..OpenAIConfig::default()
        });

        assert!(materialize_legacy_provider_instances(&mut config));
        assert_eq!(config.default_provider_instance.as_deref(), Some("openai"));
        let anthropic = &config.provider_instances["anthropic"];
        assert!(provider_instance_api_key_from_env(anthropic));
        assert!(anthropic.credential_ref.is_none());
        assert!(anthropic.api_key.is_empty());

        config.apply_runtime_env_overrides();
        assert_eq!(
            config.provider_instances["anthropic"].api_key,
            "sk-ant-runtime"
        );
        assert!(provider_instance_environment_override_active(
            &config.provider_instances["anthropic"]
        ));
    }

    #[test]
    fn selected_copilot_without_legacy_stanza_gets_a_default_instance() {
        let mut config = clean_test_config();
        config.provider = "copilot".to_string();
        *config.providers_mut() = ProviderConfigs::default();

        assert!(materialize_legacy_provider_instances(&mut config));
        assert_eq!(config.default_provider_instance.as_deref(), Some("copilot"));
        assert!(config.provider_instances["copilot"].enabled);
    }
}