Skip to main content

ai_usagebar/
active.rs

1//! Active-vendor state file. Set by `--cycle-next` / `--cycle-prev` (which
2//! Waybar's `on-scroll-up`/`on-scroll-down` invoke), read by the widget on
3//! every tick. The TUI does NOT consult this — it has its own tab state.
4//!
5//! On-disk shape: a single line with the vendor slug (e.g. `openai`). Located
6//! at `<cache-dir>/active_vendor`.
7
8use std::fs;
9use std::path::{Path, PathBuf};
10use std::time::Duration;
11
12use crate::cache::{acquire_lock, atomic_write};
13use crate::error::{AppError, Result};
14use crate::vendor::VendorId;
15
16/// Much shorter than the vendors' fetch locks (15–45s): the critical section
17/// here is one small read plus a rename, so a wait this long already means a
18/// wedged holder — and a scroll event that blocks for seconds is worse than a
19/// dropped one.
20const LOCK_TIMEOUT: Duration = Duration::from_secs(5);
21
22fn state_dir() -> Result<PathBuf> {
23    let base = directories::BaseDirs::new()
24        .ok_or_else(|| AppError::Other("could not resolve XDG cache dir".into()))?;
25    Ok(base.cache_dir().join("ai-usagebar"))
26}
27
28fn state_path() -> Result<PathBuf> {
29    Ok(state_dir()?.join("active_vendor"))
30}
31
32/// Read the persisted active vendor, if any. `None` means "no override —
33/// callers fall back to [ui] primary or anthropic".
34pub fn read() -> Option<VendorId> {
35    read_from(&state_path().ok()?)
36}
37
38/// Read the persisted active vendor from an explicit path. The real-path
39/// [`read`] is a thin wrapper over this; tests use this directly with a
40/// `TempDir`-backed path so they never touch `~/.cache/ai-usagebar`.
41pub fn read_from(path: &Path) -> Option<VendorId> {
42    let raw = fs::read_to_string(path).ok()?;
43    parse_slug(raw.trim())
44}
45
46/// Persist `vendor` as the active one. Atomic.
47pub fn write(vendor: VendorId) -> Result<()> {
48    write_to(&state_path()?, vendor)
49}
50
51/// Persist `vendor` to an explicit path. Atomic. Test-friendly counterpart
52/// to [`write`] (mirrors [`crate::cache::Cache::at`] vs `for_vendor`).
53pub fn write_to(path: &Path, vendor: VendorId) -> Result<()> {
54    atomic_write(path, vendor.slug().as_bytes())
55}
56
57/// Cycle the active vendor by `delta` positions through `enabled` (which
58/// preserves canonical order). Wraps. If no state exists, starts at `start`
59/// (usually `[ui] primary` or anthropic).
60pub fn cycle(enabled: &[VendorId], start: VendorId, delta: i32) -> Result<VendorId> {
61    cycle_at(&state_path()?, enabled, start, delta)
62}
63
64/// The flock guarding a state file's read-modify-write, as a sibling of the
65/// state file itself (mirroring `Cache::lock_path`'s `.fetch.lock`).
66fn lock_path_for(state: &Path) -> PathBuf {
67    let mut p = state.as_os_str().to_os_string();
68    p.push(".lock");
69    PathBuf::from(p)
70}
71
72/// Cycle using an explicit state-file path. The real-path [`cycle`] is a thin
73/// wrapper over this; tests drive this with a `TempDir` path so the cycle +
74/// persistence logic is covered without reading or writing the real cache.
75pub fn cycle_at(
76    path: &Path,
77    enabled: &[VendorId],
78    start: VendorId,
79    delta: i32,
80) -> Result<VendorId> {
81    if enabled.is_empty() {
82        return Err(AppError::Other("no enabled vendors to cycle".into()));
83    }
84    // One flick of a scroll wheel fires several `--cycle-next` processes at
85    // once. An atomic *write* only guarantees no torn file — it does not stop
86    // two of them reading the same current vendor and both persisting the same
87    // next one, silently eating a step. The lock has to span read→compute→write.
88    let _lock = acquire_lock(&lock_path_for(path), LOCK_TIMEOUT)?;
89    let current = read_from(path)
90        .filter(|v| enabled.contains(v))
91        .unwrap_or(start);
92    let cur_idx = enabled.iter().position(|v| *v == current).unwrap_or(0);
93    let n = enabled.len() as i32;
94    let next_idx = ((cur_idx as i32 + delta).rem_euclid(n)) as usize;
95    let next = enabled[next_idx];
96    write_to(path, next)?;
97    Ok(next)
98}
99
100fn parse_slug(s: &str) -> Option<VendorId> {
101    match s {
102        "anthropic" => Some(VendorId::Anthropic),
103        "anthropic_api" => Some(VendorId::AnthropicApi),
104        "openai" => Some(VendorId::Openai),
105        "zai" => Some(VendorId::Zai),
106        "openrouter" => Some(VendorId::Openrouter),
107        "deepseek" => Some(VendorId::Deepseek),
108        "kimi" => Some(VendorId::Kimi),
109        "kilo" => Some(VendorId::Kilo),
110        "novita" => Some(VendorId::Novita),
111        "moonshot" => Some(VendorId::Moonshot),
112        "grok" => Some(VendorId::Grok),
113        _ => None,
114    }
115}
116
117#[cfg(test)]
118mod tests {
119    use super::*;
120    use tempfile::TempDir;
121
122    // Deliberately excludes Deepseek so the not-in-enabled-set fallback test
123    // below has a real vendor to persist that is outside this cycle set.
124    const CYCLE_SET: [VendorId; 4] = [
125        VendorId::Anthropic,
126        VendorId::Openai,
127        VendorId::Zai,
128        VendorId::Openrouter,
129    ];
130
131    /// One flick of a scroll wheel fires several `--cycle-next` processes at
132    /// once. Before the lock spanned the read-modify-write, two of them could
133    /// read the same current vendor and both persist the same next one, so N
134    /// events advanced fewer than N steps. With the lock held across the whole
135    /// operation, every cycle observes its predecessor's write.
136    #[test]
137    fn concurrent_cycles_do_not_lose_a_step() {
138        let td = TempDir::new().unwrap();
139        let path = td.path().join("active_vendor");
140        let start = VendorId::Anthropic;
141
142        // Four threads, each doing one +1 step, over a 4-vendor set: if no step
143        // is lost the value returns exactly to `start`.
144        const THREADS: usize = 4;
145        std::thread::scope(|s| {
146            for _ in 0..THREADS {
147                s.spawn(|| {
148                    let _ = cycle_at(&path, &CYCLE_SET, start, 1);
149                });
150            }
151        });
152
153        let landed = read_from(&path).expect("a vendor must have been persisted");
154        assert_eq!(
155            landed,
156            start,
157            "{THREADS} single steps over {} vendors must return to the start; \
158             landing on {landed:?} means a step was lost to a race",
159            CYCLE_SET.len()
160        );
161    }
162
163    #[test]
164    fn parse_slug_round_trip() {
165        for id in VendorId::all() {
166            assert_eq!(parse_slug(id.slug()), Some(*id));
167        }
168    }
169
170    #[test]
171    fn parse_slug_unknown_returns_none() {
172        assert!(parse_slug("not-a-vendor").is_none());
173        assert!(parse_slug("").is_none());
174    }
175
176    #[test]
177    fn read_from_missing_or_garbage_returns_none() {
178        let td = TempDir::new().unwrap();
179        // Missing file → None.
180        assert!(read_from(&td.path().join("active_vendor")).is_none());
181        // Round-trip a real slug.
182        let path = td.path().join("active_vendor");
183        write_to(&path, VendorId::Zai).unwrap();
184        assert_eq!(read_from(&path), Some(VendorId::Zai));
185        // Garbage content → None (not a known slug).
186        fs::write(&path, "not-a-vendor").unwrap();
187        assert!(read_from(&path).is_none());
188    }
189
190    #[test]
191    fn cycle_at_persists_state_across_calls() {
192        let td = TempDir::new().unwrap();
193        let path = td.path().join("active_vendor");
194
195        // No state yet → starts at `start`, steps forward to Openai.
196        let v = cycle_at(&path, &CYCLE_SET, VendorId::Anthropic, 1).unwrap();
197        assert_eq!(v, VendorId::Openai);
198        assert_eq!(read_from(&path), Some(VendorId::Openai));
199
200        // Next forward step reads the persisted Openai → Zai.
201        let v = cycle_at(&path, &CYCLE_SET, VendorId::Anthropic, 1).unwrap();
202        assert_eq!(v, VendorId::Zai);
203        assert_eq!(read_from(&path), Some(VendorId::Zai));
204    }
205
206    #[test]
207    fn cycle_at_wraps_forward_and_backward() {
208        let td = TempDir::new().unwrap();
209        let path = td.path().join("active_vendor");
210        write_to(&path, VendorId::Anthropic).unwrap();
211
212        // backward from Anthropic wraps to Openrouter
213        assert_eq!(
214            cycle_at(&path, &CYCLE_SET, VendorId::Anthropic, -1).unwrap(),
215            VendorId::Openrouter
216        );
217        // forward from Openrouter wraps back to Anthropic
218        assert_eq!(
219            cycle_at(&path, &CYCLE_SET, VendorId::Anthropic, 1).unwrap(),
220            VendorId::Anthropic
221        );
222    }
223
224    #[test]
225    fn cycle_at_ignores_persisted_vendor_not_in_enabled_set() {
226        let td = TempDir::new().unwrap();
227        let path = td.path().join("active_vendor");
228        // Persist a vendor that isn't in the enabled set → fall back to `start`.
229        write_to(&path, VendorId::Deepseek).unwrap();
230        let enabled = [VendorId::Anthropic, VendorId::Openai];
231        // start=Openai (idx 1), +1 wraps to idx 0 = Anthropic.
232        let v = cycle_at(&path, &enabled, VendorId::Openai, 1).unwrap();
233        assert_eq!(v, VendorId::Anthropic);
234    }
235
236    #[test]
237    fn cycle_at_errors_on_empty_enabled() {
238        let td = TempDir::new().unwrap();
239        let path = td.path().join("active_vendor");
240        let res = cycle_at(&path, &[], VendorId::Anthropic, 1);
241        assert!(matches!(res, Err(AppError::Other(_))));
242    }
243}