crabmate 0.5.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
//! `gh pr merge` / `gh pr review` / `gh pr comment`(写远端 PR 状态)。

use std::path::Path;

use super::common::{
    gh_allowed, run_gh_vec, validate_extra_args, validate_pr_body, validate_pr_ref_token,
    validate_pr_title, validate_repo, write_workspace_temp_markdown,
};

fn parse_optional_pr_number(v: &serde_json::Value) -> Result<Option<String>, String> {
    match v.get("number") {
        None => Ok(None),
        Some(n) => {
            let num = n
                .as_u64()
                .ok_or_else(|| "错误:number 须为正整数".to_string())?;
            if num == 0 || num > 999_999 {
                return Err("错误:number 须为 1~999999 的正整数或省略".to_string());
            }
            Ok(Some(num.to_string()))
        }
    }
}

fn push_repo(v: &serde_json::Value, argv: &mut Vec<String>) -> Result<(), String> {
    if let Some(r) = v.get("repo").and_then(|x| x.as_str()) {
        validate_repo(r)?;
        argv.push("-R".into());
        argv.push(r.trim().to_string());
    }
    Ok(())
}

fn push_extra(v: &serde_json::Value, argv: &mut Vec<String>) -> Result<(), String> {
    if let Some(arr) = v.get("extra_args").and_then(|x| x.as_array()) {
        let extra: Vec<String> = arr
            .iter()
            .filter_map(|x| x.as_str().map(String::from))
            .collect();
        validate_extra_args(&extra)?;
        argv.extend(extra);
    }
    Ok(())
}

/// `gh pr merge`(写远端:合并 PR)
pub fn gh_pr_merge(
    args_json: &str,
    max_output_len: usize,
    allowed_commands: &[String],
    working_dir: &Path,
) -> String {
    if let Err(e) = gh_allowed(allowed_commands) {
        return e;
    }
    let v = match crate::cm_tools::tools::parse_args_json(args_json) {
        Ok(x) => x,
        Err(e) => return e,
    };
    let mut argv = vec!["pr".into(), "merge".into()];
    if let Ok(Some(num)) = parse_optional_pr_number(&v) {
        argv.push(num);
    }
    if let Err(e) = push_repo(&v, &mut argv) {
        return e;
    }
    let method = v
        .get("merge_method")
        .and_then(|x| x.as_str())
        .unwrap_or("rebase")
        .trim()
        .to_ascii_lowercase();
    match method.as_str() {
        "merge" => argv.push("--merge".into()),
        "squash" => argv.push("--squash".into()),
        "rebase" => argv.push("--rebase".into()),
        _ => return "错误:merge_method 须为 merge、squash 或 rebase".to_string(),
    }
    if v.get("auto").and_then(|x| x.as_bool()) == Some(true) {
        argv.push("--auto".into());
    }
    if v.get("delete_branch").and_then(|x| x.as_bool()) == Some(true) {
        argv.push("--delete-branch".into());
    }
    if v.get("admin").and_then(|x| x.as_bool()) == Some(true) {
        argv.push("--admin".into());
    }
    if let Err(e) = push_extra(&v, &mut argv) {
        return e;
    }
    run_gh_vec(argv, max_output_len, allowed_commands, working_dir)
}

fn gh_pr_review_argv(v: &serde_json::Value) -> Result<Vec<String>, String> {
    let event = match v.get("event").and_then(|x| x.as_str()) {
        Some(s) => s.trim().to_ascii_lowercase(),
        None => return Err("错误:缺少 event(approve / request-changes / comment)".to_string()),
    };
    let mut argv = vec!["pr".into(), "review".into()];
    if let Ok(Some(num)) = parse_optional_pr_number(v) {
        argv.push(num);
    }
    push_repo(v, &mut argv)?;
    match event.as_str() {
        "approve" => argv.push("--approve".into()),
        "request-changes" | "request_changes" => argv.push("--request-changes".into()),
        "comment" => argv.push("--comment".into()),
        _ => return Err("错误:event 须为 approve、request-changes 或 comment".to_string()),
    }
    if let Some(b) = v.get("body").and_then(|x| x.as_str()) {
        validate_pr_body(b)?;
        if !b.trim().is_empty() {
            argv.push("--body".into());
            argv.push(b.trim().to_string());
        }
    } else if matches!(
        event.as_str(),
        "comment" | "request-changes" | "request_changes"
    ) {
        return Err("错误:comment / request-changes 须提供 body".to_string());
    }
    push_extra(v, &mut argv)?;
    Ok(argv)
}

/// `gh pr review`(写远端:审批 / 请求修改 / 评论)
pub fn gh_pr_review(
    args_json: &str,
    max_output_len: usize,
    allowed_commands: &[String],
    working_dir: &Path,
) -> String {
    if let Err(e) = gh_allowed(allowed_commands) {
        return e;
    }
    let v = match crate::cm_tools::tools::parse_args_json(args_json) {
        Ok(x) => x,
        Err(e) => return e,
    };
    match gh_pr_review_argv(&v) {
        Ok(argv) => run_gh_vec(argv, max_output_len, allowed_commands, working_dir),
        Err(e) => e,
    }
}

/// `gh pr comment`(写远端:在 PR 上评论)
pub fn gh_pr_comment(
    args_json: &str,
    max_output_len: usize,
    allowed_commands: &[String],
    working_dir: &Path,
) -> String {
    if let Err(e) = gh_allowed(allowed_commands) {
        return e;
    }
    let v = match crate::cm_tools::tools::parse_args_json(args_json) {
        Ok(x) => x,
        Err(e) => return e,
    };
    let body = match v.get("body").and_then(|x| x.as_str()) {
        Some(s) if !s.trim().is_empty() => s,
        _ => return "错误:缺少 body".to_string(),
    };
    if let Err(e) = validate_pr_body(body) {
        return e;
    }
    let mut argv = vec!["pr".into(), "comment".into()];
    if let Ok(Some(num)) = parse_optional_pr_number(&v) {
        argv.push(num);
    }
    if let Err(e) = push_repo(&v, &mut argv) {
        return e;
    }
    argv.push("--body".into());
    argv.push(body.trim().to_string());
    if let Err(e) = push_extra(&v, &mut argv) {
        return e;
    }
    run_gh_vec(argv, max_output_len, allowed_commands, working_dir)
}

/// `gh pr edit`(写远端:编辑 PR 标题 / 正文 / 标签 / reviewer / assignee / 基线分支 / 草稿状态)。
pub fn gh_pr_edit(
    args_json: &str,
    max_output_len: usize,
    allowed_commands: &[String],
    working_dir: &Path,
) -> String {
    if let Err(e) = gh_allowed(allowed_commands) {
        return e;
    }
    let v = match crate::cm_tools::tools::parse_args_json(args_json) {
        Ok(x) => x,
        Err(e) => return e,
    };

    // 若提供 body,先写入工作区内临时文件(与 `gh_pr_create` 一致),
    // 再统一构建 argv,使 body 可与标签 / base / draft 等编辑项组合,避免提前返回丢弃其余编辑项。
    let mut body_opt: Option<(tempfile::TempDir, String)> = None;
    if let Some(b) = v.get("body").and_then(|x| x.as_str()) {
        if let Err(e) = validate_pr_body(b) {
            return e;
        }
        let (dir, body_path) = match write_workspace_temp_markdown(
            working_dir,
            "crabmate_pr_body.md",
            b.as_bytes(),
            "PR 正文",
        ) {
            Ok(x) => x,
            Err(e) => return e,
        };
        body_opt = Some((dir, body_path.clone()));
    }
    let argv = match build_gh_pr_edit_argv(&v, body_opt.as_ref().map(|(_, p)| p.clone())) {
        Ok(a) => a,
        Err(e) => return e,
    };
    let out = run_gh_vec(argv, max_output_len, allowed_commands, working_dir);
    if let Some((dir, _)) = body_opt {
        drop(dir);
    }
    out
}

/// 构建 `gh pr edit` 的 argv。`body_path_opt` 为调用方已写入的临时正文文件路径
/// (`None` 表示本次不编辑正文);校验所有编辑项至少提供其一。
fn build_gh_pr_edit_argv(
    v: &serde_json::Value,
    body_path_opt: Option<String>,
) -> Result<Vec<String>, String> {
    let mut argv = vec!["pr".into(), "edit".into()];
    if let Ok(Some(num)) = parse_optional_pr_number(v) {
        argv.push(num);
    }
    push_repo(v, &mut argv)?;

    let mut has_edit = false;
    has_edit |= push_scalar_edits(v, body_path_opt, &mut argv)?;
    has_edit |= push_multi_edit_items(v, &mut argv)?;
    if !has_edit {
        return Err(
            "错误:gh pr edit 至少需要 title / body / add_label / remove_label / add_reviewer / remove_reviewer / add_assignee / remove_assignee / base / draft / undraft 之一"
                .to_string(),
        );
    }
    push_extra(v, &mut argv)?;
    Ok(argv)
}

/// 处理标量编辑项:title、body、base、draft/undraft。返回是否产生了任何编辑。
fn push_scalar_edits(
    v: &serde_json::Value,
    body_path_opt: Option<String>,
    argv: &mut Vec<String>,
) -> Result<bool, String> {
    let mut has_edit = false;
    if let Some(t) = v.get("title").and_then(|x| x.as_str()) {
        validate_pr_title(t)?;
        let tt = t.trim();
        if !tt.is_empty() {
            argv.push("--title".into());
            argv.push(tt.to_string());
            has_edit = true;
        }
    }
    if let Some(path) = body_path_opt {
        argv.push("--body-file".into());
        argv.push(path);
        has_edit = true;
    }
    if let Some(b) = v.get("base").and_then(|x| x.as_str()) {
        validate_pr_ref_token(b)?;
        let bb = b.trim();
        if !bb.is_empty() {
            argv.push("--base".into());
            argv.push(bb.to_string());
            has_edit = true;
        }
    }
    if v.get("draft").and_then(|x| x.as_bool()) == Some(true) {
        argv.push("--draft".into());
        has_edit = true;
    }
    if v.get("undraft").and_then(|x| x.as_bool()) == Some(true) {
        argv.push("--undraft".into());
        has_edit = true;
    }
    Ok(has_edit)
}

/// 处理可重复的标签 / reviewer / assignee 编辑项。返回是否产生了任何编辑。
fn push_multi_edit_items(v: &serde_json::Value, argv: &mut Vec<String>) -> Result<bool, String> {
    let mut has_edit = false;
    for (key, flag) in [
        ("add_label", "--add-label"),
        ("remove_label", "--remove-label"),
        ("add_reviewer", "--add-reviewer"),
        ("remove_reviewer", "--remove-reviewer"),
        ("add_assignee", "--add-assignee"),
        ("remove_assignee", "--remove-assignee"),
    ] {
        if let Some(arr) = v.get(key).and_then(|x| x.as_array()) {
            for item in arr.iter().filter_map(|x| x.as_str()) {
                let t = item.trim();
                if t.is_empty() {
                    continue;
                }
                if !is_safe_token_item(t) {
                    return Err(format!(
                        "错误:{key} 中含非法值 {t:?}(不得含 \"..\" 或以 \"/\" 开头)"
                    ));
                }
                argv.push(flag.into());
                argv.push(t.to_string());
                has_edit = true;
            }
        }
    }
    Ok(has_edit)
}

/// 校验 `gh pr edit` 多值参数项(标签 / reviewer / assignee 等):不允许 `..` 或以 `/` 开头。
fn is_safe_token_item(s: &str) -> bool {
    !s.contains("..") && !s.starts_with('/')
}

#[cfg(test)]
mod tests {
    use super::{build_gh_pr_edit_argv, is_safe_token_item};

    #[test]
    fn gh_pr_edit_requires_gh_in_allowlist() {
        let dir = tempfile::tempdir().expect("tempdir");
        let out = super::gh_pr_edit(r#"{"title":"t"}"#, 4096, &[], dir.path());
        assert!(out.contains("未包含 gh"), "{}", out);
    }

    #[test]
    fn build_argv_title_and_body() {
        let v = serde_json::json!({"title": " 新标题 ", "body": "正文"});
        let argv = build_gh_pr_edit_argv(&v, Some("tmp/body.md".into())).expect("ok");
        assert_eq!(argv[0], "pr");
        assert_eq!(argv[1], "edit");
        assert!(argv.iter().any(|a| a == "--title"), "{argv:?}");
        assert!(argv.iter().any(|a| a == "新标题"), "{argv:?}");
        assert!(argv.iter().any(|a| a == "--body-file"), "{argv:?}");
        assert!(argv.iter().any(|a| a == "tmp/body.md"), "{argv:?}");
    }

    #[test]
    fn build_argv_body_combines_with_labels_and_base() {
        let v = serde_json::json!({
            "body": "正文",
            "add_label": ["bug", "enh"],
            "base": "main",
            "draft": true
        });
        let argv = build_gh_pr_edit_argv(&v, Some("tmp/body.md".into())).expect("ok");
        assert!(argv.iter().any(|a| a == "--body-file"), "{argv:?}");
        assert!(argv.iter().any(|a| a == "--add-label"), "{argv:?}");
        assert!(argv.iter().any(|a| a == "bug"), "{argv:?}");
        assert!(
            argv.iter().any(|a| a == "--base") && argv.iter().any(|a| a == "main"),
            "{argv:?}"
        );
        assert!(argv.iter().any(|a| a == "--draft"), "{argv:?}");
    }

    #[test]
    fn build_argv_rejects_no_edit() {
        let v = serde_json::json!({});
        let err = build_gh_pr_edit_argv(&v, None).expect_err("should err");
        assert!(err.contains("至少需要"), "{}", err);
    }

    #[test]
    fn build_argv_rejects_unsafe_label() {
        let v = serde_json::json!({"add_label": ["../x"]});
        let err = build_gh_pr_edit_argv(&v, None).expect_err("should err");
        assert!(err.contains("非法值"), "{}", err);
    }

    #[test]
    fn build_argv_rejects_bad_title() {
        let v = serde_json::json!({"title": "a\nb"});
        let err = build_gh_pr_edit_argv(&v, None).expect_err("should err");
        assert!(err.contains("title"), "{}", err);
    }

    #[test]
    fn build_argv_rejects_bad_base() {
        let v = serde_json::json!({"base": "main..x"});
        let err = build_gh_pr_edit_argv(&v, None).expect_err("should err");
        assert!(err.contains("base"), "{}", err);
    }

    #[test]
    fn is_safe_token_item_cases() {
        assert!(!is_safe_token_item("../x"));
        assert!(!is_safe_token_item("/abs"));
        assert!(is_safe_token_item("bug"));
        assert!(is_safe_token_item("feat/x"));
    }
}