vtcode-core 0.154.0

Core library for VT Code - a Rust-based terminal coding agent
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
/// Approval Decision Recording and Learning
///
/// Records user approval decisions for high-risk tools and enables pattern learning
/// to reduce approval friction over time.
use super::justification::{ApprovalPattern, JustificationManager};
use anyhow::Result;
use std::path::PathBuf;
use std::sync::Arc;
use tokio::sync::RwLock;
use vtcode_commons::VtCodePaths;

/// Records tool approval decisions for learning
#[derive(Clone)]
pub struct ApprovalRecorder {
    manager: Arc<RwLock<JustificationManager>>,
}

impl ApprovalRecorder {
    /// Create a new approval recorder
    pub fn new(cache_dir: PathBuf) -> Self {
        let manager = JustificationManager::new(cache_dir);
        Self { manager: Arc::new(RwLock::new(manager)) }
    }

    /// Create a recorder that can recover approval patterns from older cache directories.
    pub fn new_with_legacy_cache_dirs(
        cache_dir: PathBuf,
        legacy_cache_dirs: impl IntoIterator<Item = PathBuf>,
    ) -> Self {
        let legacy_pattern_files = legacy_cache_dirs
            .into_iter()
            .map(|directory| directory.join("approval_patterns.json"));
        let manager = JustificationManager::new_with_legacy_pattern_files(cache_dir, legacy_pattern_files);
        Self { manager: Arc::new(RwLock::new(manager)) }
    }
}

impl Default for ApprovalRecorder {
    fn default() -> Self {
        match VtCodePaths::resolve() {
            Ok(paths) => match paths.ensure_cache_child_dir("approval") {
                Ok(cache_dir) => {
                    let legacy_cache_dirs = [
                        paths.cache_dir().to_path_buf(),
                        paths.config_dir().join("cache"),
                        paths.legacy_dir().join("cache"),
                    ];
                    Self::new_with_legacy_cache_dirs(cache_dir, legacy_cache_dirs)
                }
                Err(_) => Self::fallback(),
            },
            Err(_) => Self::fallback(),
        }
    }
}

impl ApprovalRecorder {
    fn fallback() -> Self {
        let cache_dir = std::env::temp_dir()
            .join(format!("vtcode-{}", std::process::id()))
            .join("approval");
        Self::new(cache_dir)
    }
}

impl ApprovalRecorder {
    /// Record a user's approval decision for a learned approval key
    pub async fn record_approval(
        &self,
        approval_key: &str,
        display_name: Option<&str>,
        approved: bool,
        reason: Option<String>,
    ) -> Result<()> {
        let manager = self.manager.write().await;
        manager.record_decision(approval_key, display_name, approved, reason);
        Ok(())
    }

    /// Get the approval pattern for a learned approval key
    pub async fn get_pattern(&self, approval_key: &str) -> Option<ApprovalPattern> {
        let manager = self.manager.read().await;
        manager.get_pattern(approval_key)
    }

    /// Check if a key has high approval rate from history
    pub async fn has_high_approval_rate(&self, approval_key: &str) -> bool {
        let manager = self.manager.read().await;
        if let Some(pattern) = manager.get_pattern(approval_key) {
            pattern.has_high_approval_rate()
        } else {
            false
        }
    }

    /// Get learning summary for a learned approval key
    pub async fn get_learning_summary(&self, approval_key: &str) -> Option<String> {
        let manager = self.manager.read().await;
        manager.get_learning_summary(approval_key)
    }

    /// Get approval count for a learned approval key
    pub async fn get_approval_count(&self, approval_key: &str) -> u32 {
        let manager = self.manager.read().await;
        if let Some(pattern) = manager.get_pattern(approval_key) {
            pattern.approval_count()
        } else {
            0
        }
    }

    /// Should auto-approve based on approval pattern
    /// Rules:
    /// - At least 3 approvals
    /// - Approval rate > 80%
    ///
    /// Refreshes the in-memory pattern map from disk first so we observe
    /// approvals recorded by concurrent sessions (e.g. another running vtcode
    /// instance sharing the same user cache approval-pattern file).
    pub async fn should_auto_approve(&self, approval_key: &str) -> bool {
        let manager = self.manager.write().await;
        if let Err(err) = manager.refresh_patterns() {
            tracing::debug!(
                approval_key = %approval_key,
                error = %err,
                "Failed to refresh approval patterns before auto-approve check"
            );
        }
        if let Some(pattern) = manager.get_pattern(approval_key) {
            pattern.has_high_approval_rate()
        } else {
            false
        }
    }

    /// Suggest auto-approval message if user has approved this target many times
    pub async fn get_auto_approval_suggestion(
        &self,
        approval_key: &str,
        fallback_display_name: &str,
    ) -> Option<String> {
        let manager = self.manager.read().await;
        if let Some(pattern) = manager.get_pattern(approval_key) {
            let rate = pattern.approval_rate();
            if pattern.approval_count() >= 5 {
                let display_name = pattern.display_name(fallback_display_name);
                return Some(format!(
                    "You've approved {} {} times ({:.0}% approval rate)",
                    display_name,
                    pattern.approval_count(),
                    rate * 100.0
                ));
            }
        }
        None
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::collections::HashMap;
    use tempfile::TempDir;

    fn temp_cache_dir() -> TempDir {
        TempDir::new().expect("temp approval cache")
    }

    #[tokio::test]
    async fn test_approval_recording() {
        let temp_dir = temp_cache_dir();
        let recorder = ApprovalRecorder::new(temp_dir.path().to_path_buf());

        // Record some approvals
        recorder
            .record_approval("read_file", Some("Read File"), true, None)
            .await
            .unwrap();
        recorder
            .record_approval("read_file", Some("Read File"), true, None)
            .await
            .unwrap();
        recorder
            .record_approval("read_file", Some("Read File"), false, None)
            .await
            .unwrap();

        // Check pattern
        let pattern = recorder.get_pattern("read_file").await;
        assert!(pattern.is_some());
        assert_eq!(pattern.unwrap().approval_count(), 2);
    }

    #[tokio::test]
    async fn test_auto_approval_suggestion() {
        let temp_dir = temp_cache_dir();
        let recorder = ApprovalRecorder::new(temp_dir.path().to_path_buf());

        // Not enough approvals initially
        assert!(recorder.get_auto_approval_suggestion("read_file", "Read File").await.is_none());

        // Add 5 approvals
        for _ in 0..5 {
            let _ = recorder.record_approval("read_file", Some("Read File"), true, None).await;
        }

        // Now we should get a suggestion
        let suggestion = recorder.get_auto_approval_suggestion("read_file", "Read File").await;
        assert!(suggestion.is_some());
        assert!(suggestion.unwrap().contains("100%"));
    }

    #[tokio::test]
    async fn test_should_auto_approve() {
        let temp_dir = temp_cache_dir();
        let recorder = ApprovalRecorder::new(temp_dir.path().to_path_buf());

        // Not approved initially
        assert!(!recorder.should_auto_approve("run_command").await);

        // Add 3 approvals (minimum threshold)
        for _ in 0..3 {
            let _ = recorder.record_approval("run_command", Some("Run Command"), true, None).await;
        }

        // Now should auto-approve
        assert!(recorder.should_auto_approve("run_command").await);
    }

    #[tokio::test]
    async fn test_auto_approval_suggestion_uses_display_name() {
        let temp_dir = temp_cache_dir();
        let recorder = ApprovalRecorder::new(temp_dir.path().to_path_buf());

        for _ in 0..5 {
            let _ = recorder
                .record_approval(
                    "cargo test|sandbox_permissions=\"require_escalated\"|additional_permissions=null",
                    Some("commands starting with `cargo test`"),
                    true,
                    None,
                )
                .await;
        }

        let suggestion = recorder
            .get_auto_approval_suggestion(
                "cargo test|sandbox_permissions=\"require_escalated\"|additional_permissions=null",
                "fallback label",
            )
            .await
            .expect("suggestion");
        assert!(suggestion.contains("commands starting with `cargo test`"));
    }

    #[tokio::test]
    async fn test_should_auto_approve_refreshes_patterns_from_disk() {
        // Simulates a second vtcode session: one ApprovalRecorder records
        // approvals to disk, then a separately constructed recorder must
        // observe them on the next auto-approve check without restart.
        let temp_dir = temp_cache_dir();

        let key =
            "find src -type f -name '*.rs' '|' sort|sandbox_permissions=\"use_default\"|additional_permissions=null";

        let reader = ApprovalRecorder::new(temp_dir.path().to_path_buf());
        assert!(!reader.should_auto_approve(key).await);

        let writer = ApprovalRecorder::new(temp_dir.path().to_path_buf());
        for _ in 0..3 {
            writer.record_approval(key, Some("find src"), true, None).await.unwrap();
        }

        // Without the disk refresh in should_auto_approve, the reader's
        // in-memory map would still be empty and this assertion would fail.
        assert!(reader.should_auto_approve(key).await);
    }

    #[tokio::test]
    async fn recovers_legacy_patterns_and_republishes_to_canonical_cache() {
        let temp_dir = temp_cache_dir();
        let legacy_dir = temp_dir.path().join("legacy-cache");
        let canonical_dir = temp_dir.path().join("cache/approval");
        std::fs::create_dir_all(&legacy_dir).expect("legacy cache directory");

        let mut patterns = HashMap::new();
        patterns.insert(
            "run_command".to_string(),
            ApprovalPattern {
                tool_name: "run_command".to_string(),
                display_name: Some("Run Command".to_string()),
                approve_count: 3,
                deny_count: 0,
                last_decision: Some(true),
                recent_reason: None,
            },
        );
        std::fs::write(
            legacy_dir.join("approval_patterns.json"),
            serde_json::to_vec(&patterns).expect("serialize legacy patterns"),
        )
        .expect("write legacy patterns");

        let recorder = ApprovalRecorder::new_with_legacy_cache_dirs(canonical_dir.clone(), [legacy_dir]);
        assert_eq!(recorder.get_approval_count("run_command").await, 3);
        assert!(recorder.has_high_approval_rate("run_command").await);
        assert!(canonical_dir.join("approval_patterns.json").is_file());
    }

    #[tokio::test]
    async fn canonical_patterns_take_precedence_over_legacy_patterns() {
        let temp_dir = temp_cache_dir();
        let legacy_dir = temp_dir.path().join("legacy-cache");
        let canonical_dir = temp_dir.path().join("cache/approval");
        std::fs::create_dir_all(&legacy_dir).expect("legacy cache directory");
        std::fs::create_dir_all(&canonical_dir).expect("canonical cache directory");

        let pattern = |approve_count| ApprovalPattern {
            tool_name: "run_command".to_owned(),
            display_name: Some("Run Command".to_owned()),
            approve_count,
            deny_count: 0,
            last_decision: Some(true),
            recent_reason: None,
        };
        let mut canonical_patterns = HashMap::new();
        canonical_patterns.insert("run_command".to_owned(), pattern(1));
        let mut legacy_patterns = HashMap::new();
        legacy_patterns.insert("run_command".to_owned(), pattern(5));

        std::fs::write(
            canonical_dir.join("approval_patterns.json"),
            serde_json::to_vec(&canonical_patterns).expect("serialize canonical patterns"),
        )
        .expect("write canonical patterns");
        std::fs::write(
            legacy_dir.join("approval_patterns.json"),
            serde_json::to_vec(&legacy_patterns).expect("serialize legacy patterns"),
        )
        .expect("write legacy patterns");

        let recorder = ApprovalRecorder::new_with_legacy_cache_dirs(canonical_dir, [legacy_dir]);
        assert_eq!(recorder.get_approval_count("run_command").await, 1);
    }

    #[tokio::test]
    async fn malformed_canonical_patterns_recover_legacy_without_replacing_them() {
        let temp_dir = temp_cache_dir();
        let legacy_dir = temp_dir.path().join("legacy-cache");
        let canonical_dir = temp_dir.path().join("cache/approval");
        std::fs::create_dir_all(&legacy_dir).expect("legacy cache directory");
        std::fs::create_dir_all(&canonical_dir).expect("canonical cache directory");
        let canonical_file = canonical_dir.join("approval_patterns.json");
        std::fs::write(&canonical_file, b"not json").expect("malformed canonical patterns");

        let mut patterns = HashMap::new();
        patterns.insert(
            "run_command".to_owned(),
            ApprovalPattern {
                tool_name: "run_command".to_owned(),
                display_name: Some("Run Command".to_owned()),
                approve_count: 3,
                deny_count: 0,
                last_decision: Some(true),
                recent_reason: None,
            },
        );
        std::fs::write(
            legacy_dir.join("approval_patterns.json"),
            serde_json::to_vec(&patterns).expect("serialize legacy patterns"),
        )
        .expect("write legacy patterns");

        let recorder = ApprovalRecorder::new_with_legacy_cache_dirs(canonical_dir, [legacy_dir]);

        assert_eq!(recorder.get_approval_count("run_command").await, 3);
        assert_eq!(std::fs::read(canonical_file).expect("read canonical patterns"), b"not json");
    }

    #[tokio::test]
    async fn test_shell_scoped_history_does_not_reuse_tool_level_key() {
        let temp_dir = temp_cache_dir();
        let recorder = ApprovalRecorder::new(temp_dir.path().to_path_buf());

        for _ in 0..5 {
            let _ = recorder
                .record_approval("command_session", Some("Unified Exec"), true, None)
                .await;
        }

        assert_eq!(
            recorder
                .get_approval_count("cargo test|sandbox_permissions=\"require_escalated\"|additional_permissions=null")
                .await,
            0
        );
        assert!(
            recorder
                .get_auto_approval_suggestion(
                    "cargo test|sandbox_permissions=\"require_escalated\"|additional_permissions=null",
                    "commands starting with `cargo test`",
                )
                .await
                .is_none()
        );
    }
}