sloc_core/
history.rs

1// SPDX-License-Identifier: AGPL-3.0-or-later
2// Copyright (C) 2026 Nima Shafie <nimzshafie@gmail.com>
3
4use std::cmp::Reverse;
5use std::path::{Path, PathBuf};
6
7use anyhow::Result;
8use chrono::{DateTime, Utc};
9use serde::{Deserialize, Serialize};
10
11/// Lightweight summary snapshot stored in the registry — avoids loading full JSON per entry.
12#[derive(Debug, Clone, Serialize, Deserialize, Default)]
13pub struct ScanSummarySnapshot {
14    pub files_analyzed: u64,
15    pub files_skipped: u64,
16    pub total_physical_lines: u64,
17    pub code_lines: u64,
18    pub comment_lines: u64,
19    pub blank_lines: u64,
20    #[serde(default)]
21    pub functions: u64,
22    #[serde(default)]
23    pub classes: u64,
24    #[serde(default)]
25    pub variables: u64,
26    #[serde(default)]
27    pub imports: u64,
28    #[serde(default)]
29    pub test_count: u64,
30    #[serde(default)]
31    pub coverage_lines_found: u64,
32    #[serde(default)]
33    pub coverage_lines_hit: u64,
34    #[serde(default)]
35    pub coverage_functions_found: u64,
36    #[serde(default)]
37    pub coverage_functions_hit: u64,
38    #[serde(default)]
39    pub coverage_branches_found: u64,
40    #[serde(default)]
41    pub coverage_branches_hit: u64,
42}
43
44impl From<&crate::SummaryTotals> for ScanSummarySnapshot {
45    /// Project the full per-run totals down to the lightweight registry/baseline snapshot.
46    /// Centralises the field-by-field copy that callers (CLI baseline, web registry) would
47    /// otherwise duplicate.
48    fn from(t: &crate::SummaryTotals) -> Self {
49        Self {
50            files_analyzed: t.files_analyzed,
51            files_skipped: t.files_skipped,
52            total_physical_lines: t.total_physical_lines,
53            code_lines: t.code_lines,
54            comment_lines: t.comment_lines,
55            blank_lines: t.blank_lines,
56            functions: t.functions,
57            classes: t.classes,
58            variables: t.variables,
59            imports: t.imports,
60            test_count: t.test_count,
61            coverage_lines_found: t.coverage_lines_found,
62            coverage_lines_hit: t.coverage_lines_hit,
63            coverage_functions_found: t.coverage_functions_found,
64            coverage_functions_hit: t.coverage_functions_hit,
65            coverage_branches_found: t.coverage_branches_found,
66            coverage_branches_hit: t.coverage_branches_hit,
67        }
68    }
69}
70
71/// One entry in the scan registry — one per completed analysis run.
72#[derive(Debug, Clone, Serialize, Deserialize)]
73pub struct RegistryEntry {
74    pub run_id: String,
75    pub timestamp_utc: DateTime<Utc>,
76    pub project_label: String,
77    pub input_roots: Vec<String>,
78    pub json_path: Option<PathBuf>,
79    pub html_path: Option<PathBuf>,
80    #[serde(default)]
81    pub pdf_path: Option<PathBuf>,
82    #[serde(default)]
83    pub csv_path: Option<PathBuf>,
84    #[serde(default)]
85    pub xlsx_path: Option<PathBuf>,
86    pub summary: ScanSummarySnapshot,
87    /// Git branch active at scan time, if the project is a git repo.
88    #[serde(default)]
89    pub git_branch: Option<String>,
90    /// Short git commit SHA active at scan time.
91    #[serde(default)]
92    pub git_commit: Option<String>,
93    /// Full-length git commit SHA active at scan time (shown on hover).
94    #[serde(default)]
95    pub git_commit_long: Option<String>,
96    /// Author of the last git commit at scan time.
97    #[serde(default)]
98    pub git_author: Option<String>,
99    /// Comma-separated git tags pointing at HEAD at scan time.
100    #[serde(default)]
101    pub git_tags: Option<String>,
102    /// Nearest ancestor release tag (output of `git describe --tags --abbrev=0`).
103    #[serde(default)]
104    pub git_nearest_tag: Option<String>,
105    /// ISO 8601 author-date of the last git commit at scan time.
106    #[serde(default)]
107    pub git_commit_date: Option<String>,
108}
109
110/// Persistent list of directories the user has chosen to watch for new reports.
111/// Stored as `watched_dirs.json` adjacent to `registry.json`.
112#[derive(Debug, Default, Serialize, Deserialize)]
113pub struct WatchedDirsStore {
114    pub dirs: Vec<PathBuf>,
115}
116
117impl WatchedDirsStore {
118    #[must_use]
119    pub fn load(path: &Path) -> Self {
120        std::fs::read_to_string(path)
121            .ok()
122            .and_then(|s| serde_json::from_str(&s).ok())
123            .unwrap_or_default()
124    }
125
126    /// # Errors
127    ///
128    /// Returns an error if the file cannot be written.
129    pub fn save(&self, path: &Path) -> Result<()> {
130        if let Some(parent) = path.parent() {
131            std::fs::create_dir_all(parent)?;
132        }
133        std::fs::write(path, serde_json::to_string_pretty(self)?)?;
134        Ok(())
135    }
136
137    pub fn add(&mut self, dir: PathBuf) {
138        if !self.dirs.contains(&dir) {
139            self.dirs.push(dir);
140        }
141    }
142
143    pub fn remove(&mut self, dir: &Path) {
144        self.dirs.retain(|d| d != dir);
145    }
146}
147
148/// Persistent on-disk index of all past scans for this workspace.
149/// Stored as `registry.json` adjacent to the scan output directories.
150#[derive(Debug, Default, Serialize, Deserialize)]
151pub struct ScanRegistry {
152    pub entries: Vec<RegistryEntry>,
153}
154
155impl ScanRegistry {
156    /// Load from disk; returns an empty registry on missing file or parse error.
157    #[must_use]
158    pub fn load(registry_path: &Path) -> Self {
159        std::fs::read_to_string(registry_path)
160            .ok()
161            .and_then(|s| serde_json::from_str(&s).ok())
162            .unwrap_or_default()
163    }
164
165    /// # Errors
166    ///
167    /// Returns an error if the parent directory cannot be created or the file cannot be written.
168    pub fn save(&self, registry_path: &Path) -> Result<()> {
169        if let Some(parent) = registry_path.parent() {
170            std::fs::create_dir_all(parent)?;
171        }
172        let json = serde_json::to_string_pretty(self)?;
173        std::fs::write(registry_path, json)?;
174        Ok(())
175    }
176
177    pub fn add_entry(&mut self, entry: RegistryEntry) {
178        self.entries.retain(|e| e.run_id != entry.run_id);
179        self.entries.push(entry);
180        self.entries.sort_by_key(|e| Reverse(e.timestamp_utc));
181    }
182
183    /// All entries whose `input_roots` exactly match, newest first.
184    #[must_use]
185    pub fn entries_for_roots(&self, roots: &[String]) -> Vec<&RegistryEntry> {
186        self.entries
187            .iter()
188            .filter(|e| e.input_roots == roots)
189            .collect()
190    }
191
192    #[must_use]
193    pub fn find_by_run_id(&self, run_id: &str) -> Option<&RegistryEntry> {
194        self.entries.iter().find(|e| e.run_id == run_id)
195    }
196
197    /// Remove entries whose `json_path` no longer exists on disk.
198    pub fn prune_stale(&mut self) {
199        self.entries
200            .retain(|e| e.json_path.as_ref().is_none_or(|p| p.exists()));
201    }
202
203    /// Remove every entry whose artifacts live under `dir` (the directory itself or any
204    /// descendant). Used when a watched folder is un-watched so its linked reports leave the
205    /// list too. Returns the number of entries removed.
206    pub fn remove_entries_under(&mut self, dir: &Path) -> usize {
207        let before = self.entries.len();
208        self.entries.retain(|e| {
209            let under = |p: &Option<PathBuf>| p.as_ref().is_some_and(|path| path.starts_with(dir));
210            !(under(&e.json_path) || under(&e.html_path))
211        });
212        before - self.entries.len()
213    }
214
215    /// Keep only entries whose artifacts live under one of `roots` — the currently-watched
216    /// folders plus the app's own output directory. Everything else (leftovers from folders
217    /// that are no longer watched, or other external strays) is dropped. This enforces the
218    /// invariant that the report list reflects exactly the watched folders and native scans.
219    /// Returns the number of entries removed.
220    pub fn retain_under_roots(&mut self, roots: &[PathBuf]) -> usize {
221        let before = self.entries.len();
222        self.entries.retain(|e| {
223            let under = |p: &Option<PathBuf>| {
224                p.as_ref()
225                    .is_some_and(|path| roots.iter().any(|r| path.starts_with(r)))
226            };
227            under(&e.json_path) || under(&e.html_path)
228        });
229        before - self.entries.len()
230    }
231}
232
233const fn default_interval_hours() -> u32 {
234    24
235}
236
237/// Rules for automatic periodic cleanup of old scan runs.
238#[derive(Debug, Clone, Serialize, Deserialize)]
239pub struct CleanupPolicy {
240    pub enabled: bool,
241    /// Delete runs older than this many days. `None` disables age-based cleanup.
242    #[serde(default)]
243    pub max_age_days: Option<u32>,
244    /// Keep only the N most recent runs; delete older ones. `None` disables count-based cleanup.
245    #[serde(default)]
246    pub max_run_count: Option<u32>,
247    /// Hours between automatic cleanup passes (minimum 1, default 24).
248    #[serde(default = "default_interval_hours")]
249    pub interval_hours: u32,
250}
251
252/// Persisted store for the auto-cleanup policy and last-run metadata.
253/// Stored as `cleanup_policy.json` adjacent to `registry.json`.
254#[derive(Debug, Default, Clone, Serialize, Deserialize)]
255pub struct CleanupPolicyStore {
256    pub policy: Option<CleanupPolicy>,
257    /// When the background task last ran a cleanup pass.
258    #[serde(default)]
259    pub last_run_at: Option<DateTime<Utc>>,
260    /// Number of runs deleted in the last cleanup pass.
261    #[serde(default)]
262    pub last_run_deleted: Option<u32>,
263}
264
265impl CleanupPolicyStore {
266    #[must_use]
267    pub fn load(path: &Path) -> Self {
268        std::fs::read_to_string(path)
269            .ok()
270            .and_then(|s| serde_json::from_str(&s).ok())
271            .unwrap_or_default()
272    }
273
274    /// # Errors
275    ///
276    /// Returns an error if the file cannot be written.
277    pub fn save(&self, path: &Path) -> Result<()> {
278        if let Some(parent) = path.parent() {
279            std::fs::create_dir_all(parent)?;
280        }
281        std::fs::write(path, serde_json::to_string_pretty(self)?)?;
282        Ok(())
283    }
284}
285
286#[cfg(test)]
287mod tests {
288    use super::*;
289
290    fn entry(run_id: &str, json: &str) -> RegistryEntry {
291        RegistryEntry {
292            run_id: run_id.to_string(),
293            timestamp_utc: Utc::now(),
294            project_label: "proj".to_string(),
295            input_roots: vec![],
296            json_path: Some(PathBuf::from(json)),
297            html_path: None,
298            pdf_path: None,
299            csv_path: None,
300            xlsx_path: None,
301            summary: ScanSummarySnapshot::default(),
302            git_branch: None,
303            git_commit: None,
304            git_commit_long: None,
305            git_author: None,
306            git_tags: None,
307            git_nearest_tag: None,
308            git_commit_date: None,
309        }
310    }
311
312    #[test]
313    fn remove_entries_under_drops_only_matching_folder() {
314        let mut reg = ScanRegistry::default();
315        reg.entries
316            .push(entry("a", "/watched/scans/run1/result.json"));
317        reg.entries
318            .push(entry("b", "/watched/scans/sub/json/result.json"));
319        reg.entries.push(entry("c", "/other/place/result.json"));
320
321        let removed = reg.remove_entries_under(Path::new("/watched/scans"));
322        assert_eq!(removed, 2);
323        assert_eq!(reg.entries.len(), 1);
324        assert_eq!(reg.entries[0].run_id, "c");
325    }
326
327    #[test]
328    fn remove_entries_under_no_match_is_noop() {
329        let mut reg = ScanRegistry::default();
330        reg.entries.push(entry("a", "/other/result.json"));
331        assert_eq!(reg.remove_entries_under(Path::new("/watched")), 0);
332        assert_eq!(reg.entries.len(), 1);
333    }
334
335    #[test]
336    fn retain_under_roots_keeps_only_watched_and_native() {
337        let mut reg = ScanRegistry::default();
338        reg.entries
339            .push(entry("native", "/app/out/web/run1/json/result.json"));
340        reg.entries
341            .push(entry("watched", "/watched/scans/run2/json/result.json"));
342        reg.entries
343            .push(entry("orphan", "/removed/folder/run3/json/result.json"));
344
345        let roots = vec![
346            PathBuf::from("/app/out/web"),
347            PathBuf::from("/watched/scans"),
348        ];
349        let removed = reg.retain_under_roots(&roots);
350        assert_eq!(removed, 1);
351        assert_eq!(reg.entries.len(), 2);
352        assert!(reg.entries.iter().all(|e| e.run_id != "orphan"));
353    }
354
355    #[test]
356    fn retain_under_roots_empty_roots_clears_all() {
357        let mut reg = ScanRegistry::default();
358        reg.entries.push(entry("a", "/somewhere/result.json"));
359        reg.entries.push(entry("b", "/elsewhere/result.json"));
360        assert_eq!(reg.retain_under_roots(&[]), 2);
361        assert!(reg.entries.is_empty());
362    }
363}
sloc_core/history.rs

sloc_core/
history.rs
