crabmate 0.4.0

Rust AI agent: OpenAI-compatible chat/completions, function calling, HTTP serve, ops CLI
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
//! 工作区写操作后使代码语义索引失效(删除 SQLite 中对应块或整表),与 `read_file` 缓存清空语义对齐。

use std::collections::HashSet;
use std::path::Path;
use std::sync::LazyLock;

use rusqlite::params;

use crate::cm_memory::memory::codebase_semantic_index::{
    CODEBASE_SEMANTIC_FILES_TABLE, index_path_for_workspace, open_codebase_semantic_db,
};
use crate::cm_config::AgentConfig;
use crate::cm_types::path_utils::canonical_workspace_root;

use crate::cm_memory::tool_check;

const CHUNKS_TABLE: &str = "crabmate_codebase_chunks";

/// 内建写副作用工具名表,用于判断工具是否只读。
fn builtin_write_effect_tools() -> HashSet<&'static str> {
    HashSet::from([
        "apply_diff",
        "create_file",
        "write_file",
        "edit_file",
        "edit_and_apply",
        "delete_dir",
        "delete_file",
        "move_file",
        "copy_file",
        "create_symlink",
        "format_file",
        "format_check_file",
        "set_env_var",
        "set_dot_env_var",
        "upsert_secret_file",
        "append_lines",
        "create_symbolic_link",
        "write",
        "mkdir",
        "git_add",
        "git_commit",
        "git_push",
        "git_revert",
        "git_stash",
        "git_reset",
        "git_clone",
        "git_fetch",
        "cargo_fix",
        "cargo_clean",
        "python_install_editable",
        "npm_install",
        "go_mod_tidy",
        "docker_build",
        "long_term_remember",
        "long_term_forget",
        "run_command",
        "terminal_session",
        "playbook_run_commands",
        "python_snippet_run",
        "run_executable",
        "workflow_execute",
        "http_request",
        "gh_api",
        "gh_pr_create",
        "gh_pr_merge",
        "gh_pr_review",
        "gh_pr_comment",
        "gh_issue_create",
        "gh_run_rerun",
        "gh_release_create",
    ])
}

/// 判断工具是否为只读(不修改工作区文件系统),供失效决策使用。
/// 写操作工具及未知语义工具(MCP 代理、动态工具)返回 false。
fn is_readonly_tool(cfg: &AgentConfig, name: &str) -> bool {
    static BUILTIN: LazyLock<HashSet<String>> = LazyLock::new(|| {
        builtin_write_effect_tools()
            .into_iter()
            .map(String::from)
            .collect()
    });
    let writes = match &cfg.tool_registry_policy.tool_registry_write_effect_tools {
        None => &BUILTIN,
        Some(arc) => arc.as_ref(),
    };
    // MCP 代理工具与动态工具语义不可静态证明,默认按写副作用处理。
    if name.starts_with("mcp__") || name.starts_with("tool_") {
        return false;
    }
    !writes.contains(name)
}

/// 相对工作区路径(POSIX,`/`);`is_dir` 为 true 时删除该路径及其子路径下所有块。
#[derive(Debug, Clone)]
pub struct RelScope {
    pub path: String,
    pub is_dir: bool,
}

#[derive(Debug, Clone)]
pub enum CodebaseSemanticInvalidation {
    /// 删除当前 `workspace_root` 键下全部块。
    FullWorkspace,
    /// 按路径或目录前缀删除块。
    RelScopes(Vec<RelScope>),
}

fn push_invalidation_scope(scopes: &mut Vec<RelScope>, s: Option<&str>, is_dir: bool) {
    if let Some(t) = s.map(str::trim).filter(|x| !x.is_empty()) {
        scopes.push(RelScope {
            path: t.replace('\\', "/"),
            is_dir,
        });
    }
}

enum InvalScopesFill {
    Ok,
    FullWorkspace,
}

fn fill_invalidation_scopes_for_tool(
    name: &str,
    v: &serde_json::Value,
    scopes: &mut Vec<RelScope>,
) -> InvalScopesFill {
    match name {
        "delete_dir" | "create_dir" => {
            push_invalidation_scope(scopes, v.get("path").and_then(|p| p.as_str()), true);
            InvalScopesFill::Ok
        }
        "create_file" | "modify_file" | "delete_file" | "append_file" | "search_replace"
        | "chmod_file" | "format_file" | "format_check_file" | "extract_in_file"
        | "read_binary_meta" | "hash_file" => {
            push_invalidation_scope(scopes, v.get("path").and_then(|p| p.as_str()), false);
            InvalScopesFill::Ok
        }
        "copy_file" | "move_file" => {
            push_invalidation_scope(scopes, v.get("from").and_then(|p| p.as_str()), false);
            push_invalidation_scope(scopes, v.get("to").and_then(|p| p.as_str()), false);
            InvalScopesFill::Ok
        }
        "apply_patch" => {
            if let Some(patch) = v.get("patch").and_then(|p| p.as_str()) {
                for rel in patch_paths_from_unified_diff(patch) {
                    push_invalidation_scope(scopes, Some(rel.as_str()), false);
                }
            }
            if scopes.is_empty() {
                InvalScopesFill::FullWorkspace
            } else {
                InvalScopesFill::Ok
            }
        }
        "structured_patch" | "markdown_check_links" | "typos_check" | "codespell_check" => {
            push_invalidation_scope(scopes, v.get("path").and_then(|p| p.as_str()), false);
            if name == "markdown_check_links"
                && let Some(roots) = v.get("roots").and_then(|r| r.as_array())
            {
                for x in roots {
                    push_invalidation_scope(scopes, x.as_str(), false);
                }
            }
            if matches!(name, "typos_check" | "codespell_check")
                && let Some(ps) = v.get("paths").and_then(|p| p.as_array())
            {
                for x in ps {
                    push_invalidation_scope(scopes, x.as_str(), false);
                }
            }
            InvalScopesFill::Ok
        }
        "ast_grep_rewrite" => {
            if let Some(ps) = v.get("paths").and_then(|p| p.as_array()) {
                for x in ps {
                    push_invalidation_scope(scopes, x.as_str(), false);
                }
                InvalScopesFill::Ok
            } else {
                InvalScopesFill::FullWorkspace
            }
        }
        _ => InvalScopesFill::FullWorkspace,
    }
}

/// 根据工具名与参数推断应失效的范围;**只读工具**返回 `None`。
pub fn invalidation_for_tool_call(
    cfg: &AgentConfig,
    name: &str,
    args_json: &str,
) -> Option<CodebaseSemanticInvalidation> {
    if is_readonly_tool(cfg, name) {
        return None;
    }

    // 子进程 / 工作流 / 网络写:无法可靠解析受影响路径 → 整表失效。
    if matches!(
        name,
        "run_command"
            | "run_executable"
            | "playbook_run_commands"
            | "workflow_execute"
            | "http_request"
            | "cargo_fix"
            | "cargo_clean"
            | "python_install_editable"
            | "npm_install"
            | "go_mod_tidy"
    ) || name.starts_with("git_")
    {
        return Some(CodebaseSemanticInvalidation::FullWorkspace);
    }

    let v: serde_json::Value = serde_json::from_str(args_json).ok()?;

    let mut scopes: Vec<RelScope> = Vec::new();

    match fill_invalidation_scopes_for_tool(name, &v, &mut scopes) {
        InvalScopesFill::Ok => {}
        InvalScopesFill::FullWorkspace => return Some(CodebaseSemanticInvalidation::FullWorkspace),
    }

    scopes.sort_by(|a, b| a.path.cmp(&b.path));
    scopes.dedup_by(|a, b| {
        if a.path != b.path {
            return false;
        }
        a.is_dir |= b.is_dir;
        true
    });
    if scopes.is_empty() {
        Some(CodebaseSemanticInvalidation::FullWorkspace)
    } else {
        Some(CodebaseSemanticInvalidation::RelScopes(scopes))
    }
}

fn patch_paths_from_unified_diff(patch: &str) -> Vec<String> {
    let mut out = Vec::new();
    for line in patch.lines() {
        let t = line.trim();
        if let Some(rest) = t.strip_prefix("--- ") {
            let path_part = rest.split_whitespace().next().unwrap_or(rest);
            let path_part = path_part.strip_prefix("a/").unwrap_or(path_part);
            if path_part == "/dev/null" || path_part.is_empty() {
                continue;
            }
            if path_part.starts_with("b/") {
                continue;
            }
            out.push(path_part.replace('\\', "/"));
        }
    }
    out.sort();
    out.dedup();
    out
}

/// 工具返回串视为成功时使索引失效(与 `read_file` 缓存清空条件一致:`!is_readonly || workspace_changed` 之后调用本函数时应对**当前**写工具传入 `ok`)。
pub fn apply_after_successful_tool(
    workspace_root: &Path,
    index_sqlite_path_cfg: &str,
    inv: CodebaseSemanticInvalidation,
) {
    let ws_key = match canonical_workspace_root(workspace_root) {
        Ok(p) => p.to_string_lossy().to_string(),
        Err(_) => return,
    };
    let index_path = match index_path_for_workspace(workspace_root, index_sqlite_path_cfg) {
        Ok(p) => p,
        Err(_) => return,
    };
    let mut conn = match open_codebase_semantic_db(&index_path) {
        Ok(c) => c,
        Err(_) => return,
    };

    match inv {
        CodebaseSemanticInvalidation::FullWorkspace => {
            let _ = conn.execute(
                &format!("DELETE FROM {CHUNKS_TABLE} WHERE workspace_root = ?1"),
                params![ws_key],
            );
            let _ = conn.execute(
                &format!("DELETE FROM {CODEBASE_SEMANTIC_FILES_TABLE} WHERE workspace_root = ?1"),
                params![ws_key],
            );
        }
        CodebaseSemanticInvalidation::RelScopes(scopes) => {
            if scopes.is_empty() {
                return;
            }
            let tx = match conn.transaction() {
                Ok(t) => t,
                Err(_) => return,
            };
            let mut ok = true;
            for sc in &scopes {
                let res = if sc.is_dir {
                    let like_pat =
                        sqlite_like_escape(&format!("{}/%", sc.path.trim_end_matches('/')));
                    let r1 = tx.execute(
                        &format!(
                            "DELETE FROM {CHUNKS_TABLE} WHERE workspace_root = ?1 AND (rel_path = ?2 OR rel_path LIKE ?3 ESCAPE '\\')"
                        ),
                        params![ws_key, sc.path.trim_end_matches('/'), like_pat],
                    );
                    let r2 = tx.execute(
                        &format!(
                            "DELETE FROM {CODEBASE_SEMANTIC_FILES_TABLE} WHERE workspace_root = ?1 AND (rel_path = ?2 OR rel_path LIKE ?3 ESCAPE '\\')"
                        ),
                        params![ws_key, sc.path.trim_end_matches('/'), like_pat],
                    );
                    r1.and(r2)
                } else {
                    let r1 = tx.execute(
                        &format!(
                            "DELETE FROM {CHUNKS_TABLE} WHERE workspace_root = ?1 AND rel_path = ?2"
                        ),
                        params![ws_key, sc.path.as_str()],
                    );
                    let r2 = tx.execute(
                        &format!(
                            "DELETE FROM {CODEBASE_SEMANTIC_FILES_TABLE} WHERE workspace_root = ?1 AND rel_path = ?2"
                        ),
                        params![ws_key, sc.path.as_str()],
                    );
                    r1.and(r2)
                };
                if res.is_err() {
                    ok = false;
                    break;
                }
            }
            if ok {
                let _ = tx.commit();
            }
        }
    }
}

fn sqlite_like_escape(s: &str) -> String {
    let mut o = String::with_capacity(s.len());
    for ch in s.chars() {
        if matches!(ch, '\\' | '%' | '_') {
            o.push('\\');
        }
        o.push(ch);
    }
    o
}

/// `run_tool` 成功语义:`crabmate_tool` 信封的 `ok`,或旧式解析的 `ok`。
pub fn tool_output_semantic_success(_tool_name: &str, output: &str) -> bool {
    if let Ok(v) = serde_json::from_str::<serde_json::Value>(output)
        && let Some(ct) = v.get("crabmate_tool").and_then(|x| x.as_object())
    {
        return ct.get("ok").and_then(|x| x.as_bool()) != Some(false);
    }
    tool_check::tool_output_is_ok(output)
}

#[cfg(test)]
mod tests {
    use super::*;

    fn default_cfg() -> AgentConfig {
        crate::cm_config::load_config(None).expect("embed default")
    }

    #[test]
    fn patch_paths_parses_git_style() {
        let p = r#"--- a/src/foo.rs
+++ b/src/foo.rs
@@ -1 +1 @@
"#;
        let v = patch_paths_from_unified_diff(p);
        assert!(v.iter().any(|s| s.ends_with("src/foo.rs")));
    }

    #[test]
    fn run_command_invalidates_full() {
        let cfg = default_cfg();
        let inv =
            invalidation_for_tool_call(&cfg, "run_command", r#"{"command":"touch","args":["x"]}"#);
        assert!(matches!(
            inv,
            Some(CodebaseSemanticInvalidation::FullWorkspace)
        ));
    }

    #[test]
    fn read_file_no_invalidation() {
        let cfg = default_cfg();
        assert!(invalidation_for_tool_call(&cfg, "read_file", r#"{"path":"a.rs"}"#).is_none());
    }

    #[test]
    fn delete_dir_uses_prefix_scope() {
        let cfg = default_cfg();
        let inv = invalidation_for_tool_call(&cfg, "delete_dir", r#"{"path":"src/lib"}"#);
        let Some(CodebaseSemanticInvalidation::RelScopes(sc)) = inv else {
            panic!("expected RelScopes");
        };
        assert_eq!(sc.len(), 1);
        assert!(sc[0].is_dir);
        assert_eq!(sc[0].path, "src/lib");
    }

    #[test]
    fn create_file_is_file_scope() {
        let cfg = default_cfg();
        let inv = invalidation_for_tool_call(&cfg, "create_file", r#"{"path":"a/b.rs"}"#);
        let Some(CodebaseSemanticInvalidation::RelScopes(sc)) = inv else {
            panic!("expected RelScopes");
        };
        assert_eq!(sc.len(), 1);
        assert!(!sc[0].is_dir);
        assert_eq!(sc[0].path, "a/b.rs");
    }
}