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
425
426
427
428
429
//! 联网网页搜索:默认经 [worbrow](https://crates.io/crates/worbrow) 驱动本机浏览器;
//! 亦可选用 Brave / Tavily HTTP API(需 API Key)。

use std::time::Duration;

use crate::cm_tools::redact::{self, HTTP_BODY_PREVIEW_LOG_CHARS};
use crate::cm_config::WebSearchProvider;
use log::warn;
use serde::Deserialize;
use worbrow::{BrowserKind, Config as WorbrowConfig, DoctorReport, Outcome, ResultKind, search};

use super::ToolContext;

const BRAVE_SEARCH_URL: &str = "https://api.search.brave.com/res/v1/web/search";
const TAVILY_SEARCH_URL: &str = "https://api.tavily.com/search";

#[derive(Debug, Deserialize)]
struct BraveWebSearchResponse {
    web: Option<BraveWeb>,
}

#[derive(Debug, Deserialize)]
struct BraveWeb {
    results: Option<Vec<BraveWebResult>>,
}

#[derive(Debug, Deserialize)]
struct BraveWebResult {
    title: Option<String>,
    url: Option<String>,
    description: Option<String>,
}

#[derive(Debug, Deserialize)]
struct TavilySearchResponse {
    results: Option<Vec<TavilyResult>>,
}

#[derive(Debug, Deserialize)]
struct TavilyResult {
    title: Option<String>,
    url: Option<String>,
    content: Option<String>,
}

/// 执行 `web_search` 工具:参数 JSON 含 `query`,可选 `max_results`(1~20)。
pub fn run(args_json: &str, ctx: &ToolContext<'_>) -> String {
    let args: super::tool_param_types::WebSearchArgs = match serde_json::from_str(args_json) {
        Ok(a) => a,
        Err(e) => return format!("参数 JSON 无效: {e}"),
    };
    let query = args.query.trim();
    let query = if query.len() >= 2 {
        query.to_string()
    } else if query.is_empty() {
        return "错误:缺少 query 参数".to_string();
    } else {
        return "错误:query 至少 2 个字符".to_string();
    };

    let max_results = args
        .max_results
        .map(|n| n.clamp(1, 20) as u32)
        .unwrap_or(ctx.web_search_max_results)
        .clamp(1, 20);

    let raw = match ctx.web_search_provider {
        WebSearchProvider::Worbrow => {
            search_worbrow(&query, max_results, ctx.web_search_timeout_secs)
        }
        WebSearchProvider::Brave | WebSearchProvider::Tavily => {
            if ctx.web_search_api_key.trim().is_empty() {
                return "错误:未配置联网搜索 API Key。请在配置中设置 web_search_api_key,或设置环境变量 CM_WEB_SEARCH_API_KEY;并设置 web_search_provider 为 brave 或 tavily。若希望免 Key,请使用默认的 worbrow(本机浏览器)或将 web_search_provider 设为 worbrow。".to_string();
            }
            let client = match reqwest::blocking::Client::builder()
                .timeout(Duration::from_secs(ctx.web_search_timeout_secs))
                .build()
            {
                Ok(c) => c,
                Err(e) => return format!("HTTP 客户端创建失败:{}", e),
            };
            match ctx.web_search_provider {
                WebSearchProvider::Brave => {
                    search_brave(&client, ctx.web_search_api_key, &query, max_results)
                }
                WebSearchProvider::Tavily => {
                    search_tavily(&client, ctx.web_search_api_key, &query, max_results)
                }
                WebSearchProvider::Worbrow => unreachable!("worbrow 已在上方分支处理"),
            }
        }
    };

    let raw = match raw {
        Ok(s) => s,
        Err(e) => return e,
    };

    truncate_output(&raw, ctx.command_max_output_len)
}

/// 首选 Bing,验证码/低质低产时降级 DuckDuckGo(worbrow 引擎链)。
const WORBROW_ENGINE_CHAIN: &str = "bing,duckduckgo";

fn search_worbrow(query: &str, max_results: u32, timeout_secs: u64) -> Result<String, String> {
    let browser = resolve_worbrow_browser()?;
    let cfg = WorbrowConfig::new(query, WORBROW_ENGINE_CHAIN, browser)
        .with_max_results(max_results as usize)
        .with_timeout(Duration::from_secs(timeout_secs.max(1)))
        // 瞬时网络错误退避重试(验证码/超时不重试);计入全局超时预算。
        .with_retry(1);
    let outcome = search(cfg).map_err(|e| format_worbrow_error(&e))?;
    Ok(format_worbrow_outcome(&outcome, browser))
}

/// 优先 Firefox(与 worbrow 默认一致),其次 Chrome/Edge/Chromium。
fn resolve_worbrow_browser() -> Result<BrowserKind, String> {
    let report = DoctorReport::collect();
    for preferred in [BrowserKind::Firefox, BrowserKind::Chrome] {
        if report
            .backends
            .iter()
            .any(|b| b.kind == preferred && b.binary.is_some())
        {
            return Ok(preferred);
        }
    }
    Err(
        "错误:未找到可用的本机浏览器(需 Firefox,或 Chrome/Edge/Chromium)。\
请安装浏览器后重试,或将 web_search_provider 设为 brave/tavily 并配置 web_search_api_key / CM_WEB_SEARCH_API_KEY。"
            .to_string(),
    )
}

fn format_worbrow_error(err: &worbrow::Error) -> String {
    format!(
        "worbrow 搜索失败({}):{}。若环境无浏览器或遇验证码,可改用 brave/tavily 并配置 API Key。",
        err.code_str(),
        err
    )
}

fn format_worbrow_outcome(outcome: &Outcome, browser: BrowserKind) -> String {
    if outcome.results.is_empty() {
        let mut s = String::from("(无网页结果)");
        append_worbrow_meta_notes(&mut s, outcome);
        return s;
    }

    let mut out = format!(
        "联网搜索(worbrow / {} / {})结果:\n\n",
        outcome.meta.engine, browser
    );
    for r in &outcome.results {
        let scheme = if r.https { "https" } else { "http" };
        let domain = if r.domain.is_empty() {
            String::new()
        } else {
            format!(" ({scheme}://{})", r.domain)
        };
        let mut flags: Vec<&str> = Vec::new();
        if r.is_ad {
            flags.push("ad");
        }
        match r.result_kind {
            ResultKind::Web => {}
            ResultKind::Dictionary => flags.push("dictionary"),
            ResultKind::Translation => flags.push("translation"),
        }
        // `url_resolved=false` 含「本就是直链、无需解包」(Bing 常见),不能一律当失败。
        // 仅当仍像跟踪跳转链且未解出时提示。
        if !r.url_resolved && url_looks_like_search_redirect(&r.url) {
            flags.push("url_unresolved");
        }
        let flag_suffix = if flags.is_empty() {
            String::new()
        } else {
            format!(" [{}]", flags.join(", "))
        };
        let published = r
            .published_at
            .as_deref()
            .filter(|s| !s.trim().is_empty())
            .map(|s| format!("\n   发布: {s}"))
            .unwrap_or_default();
        out.push_str(&format!(
            "{}. {}{}{}\n   URL: {}{}\n   {}\n\n",
            r.rank,
            r.title,
            domain,
            flag_suffix,
            r.url,
            published,
            r.snippet.trim()
        ));
    }
    let mut s = out.trim_end().to_string();
    append_worbrow_meta_notes(&mut s, outcome);
    s
}

/// 是否仍像搜索引擎跟踪跳转 URL(解包失败时才值得标 `url_unresolved`)。
fn url_looks_like_search_redirect(url: &str) -> bool {
    let u = url.to_ascii_lowercase();
    u.contains("bing.com/ck/") || u.contains("duckduckgo.com/l/?") || u.contains("uddg=")
}

fn append_worbrow_meta_notes(out: &mut String, outcome: &Outcome) {
    let mut notes = Vec::new();
    if outcome.meta.engine_tried.len() > 1 {
        notes.push(format!(
            "引擎尝试链:{}",
            outcome.meta.engine_tried.join("")
        ));
    }
    if outcome.meta.captcha {
        notes.push("检测到验证码,结果可能不完整".to_string());
    }
    if outcome.meta.low_yield {
        notes.push("内容型结果不足(low_yield)".to_string());
    }
    if outcome.meta.retries > 0 {
        notes.push(format!("网络重试 {}", outcome.meta.retries));
    }
    if let Some(ref e) = outcome.meta.engine_error {
        notes.push("引擎侧异常".to_string());
        warn!(
            target: "crabmate",
            "worbrow engine_error code={} message_len={}",
            e.code,
            e.message.len()
        );
    }
    if notes.is_empty() {
        return;
    }
    out.push_str("\n\n注意:");
    out.push_str(&notes.join(""));
    out.push('');
}

fn search_brave(
    client: &reqwest::blocking::Client,
    api_key: &str,
    query: &str,
    max_results: u32,
) -> Result<String, String> {
    let res = client
        .get(BRAVE_SEARCH_URL)
        .header("X-Subscription-Token", api_key.trim())
        .header("Accept", "application/json")
        .query(&[("q", query), ("count", &max_results.to_string())])
        .send()
        .map_err(|e| format!("Brave 搜索请求失败:{}", e))?;

    if !res.status().is_success() {
        let status = res.status();
        let body = res.text().unwrap_or_default();
        let preview = redact::single_line_preview(&body, HTTP_BODY_PREVIEW_LOG_CHARS);
        warn!(
            target: "crabmate",
            "Brave 搜索 API 非成功响应 provider=brave status={} body_len={} body_preview={}",
            status,
            body.len(),
            preview
        );
        return Err(format!(
            "Brave 搜索 API 返回错误(HTTP {}),请检查 API 密钥或稍后重试",
            status.as_u16()
        ));
    }

    let parsed: BraveWebSearchResponse = res
        .json()
        .map_err(|e| format!("解析 Brave 响应失败:{}", e))?;

    let results = parsed.web.and_then(|w| w.results).unwrap_or_default();

    if results.is_empty() {
        return Ok("(无网页结果)".to_string());
    }

    let mut out = String::from("联网搜索(Brave)结果:\n\n");
    for (i, r) in results.iter().enumerate() {
        let title = r.title.as_deref().unwrap_or("(无标题)");
        let url = r.url.as_deref().unwrap_or("");
        let desc = r.description.as_deref().unwrap_or("");
        out.push_str(&format!(
            "{}. {}\n   URL: {}\n   {}\n\n",
            i + 1,
            title,
            url,
            desc.trim()
        ));
    }
    Ok(out.trim_end().to_string())
}

fn search_tavily(
    client: &reqwest::blocking::Client,
    api_key: &str,
    query: &str,
    max_results: u32,
) -> Result<String, String> {
    let body = serde_json::json!({
        "api_key": api_key.trim(),
        "query": query,
        "max_results": max_results,
        "search_depth": "basic",
    });

    let res = client
        .post(TAVILY_SEARCH_URL)
        .header("Content-Type", "application/json")
        .json(&body)
        .send()
        .map_err(|e| format!("Tavily 搜索请求失败:{}", e))?;

    if !res.status().is_success() {
        let status = res.status();
        let text = res.text().unwrap_or_default();
        let preview = redact::single_line_preview(&text, HTTP_BODY_PREVIEW_LOG_CHARS);
        warn!(
            target: "crabmate",
            "Tavily 搜索 API 非成功响应 provider=tavily status={} body_len={} body_preview={}",
            status,
            text.len(),
            preview
        );
        return Err(format!(
            "Tavily 搜索 API 返回错误(HTTP {}),请检查 API 密钥或稍后重试",
            status.as_u16()
        ));
    }

    let parsed: TavilySearchResponse = res
        .json()
        .map_err(|e| format!("解析 Tavily 响应失败:{}", e))?;

    let results = parsed.results.unwrap_or_default();
    if results.is_empty() {
        return Ok("(无网页结果)".to_string());
    }

    let mut out = String::from("联网搜索(Tavily)结果:\n\n");
    for (i, r) in results.iter().enumerate() {
        let title = r.title.as_deref().unwrap_or("(无标题)");
        let url = r.url.as_deref().unwrap_or("");
        let content = r.content.as_deref().unwrap_or("");
        out.push_str(&format!(
            "{}. {}\n   URL: {}\n   {}\n\n",
            i + 1,
            title,
            url,
            content.trim()
        ));
    }
    Ok(out.trim_end().to_string())
}

fn truncate_output(s: &str, max_chars: usize) -> String {
    if s.len() <= max_chars {
        return s.to_string();
    }
    let mut t: String = s.chars().take(max_chars.saturating_sub(80)).collect();
    t.push_str("\n\n…(输出已按 command_max_output_len 截断)");
    t
}

#[cfg(test)]
mod tests {
    use super::*;
    use worbrow::{BrowserKind, Config as WorbrowConfig, search};

    #[test]
    fn worbrow_fake_formats_non_empty_results() {
        let outcome = search(WorbrowConfig::new("rust", "bing", BrowserKind::Fake))
            .expect("fake backend should succeed offline");
        let text = format_worbrow_outcome(&outcome, BrowserKind::Fake);
        assert!(text.contains("联网搜索(worbrow"));
        assert!(text.contains("URL:"));
        // Fake/直链结果多为 url_resolved=false,不应刷屏 url_unresolved。
        assert!(
            !text.contains("url_unresolved"),
            "unexpected redirect flag on direct/fake URLs: {text}"
        );
    }

    #[test]
    fn search_redirect_heuristic_matches_tracker_urls_only() {
        assert!(url_looks_like_search_redirect(
            "https://www.bing.com/ck/a?!&&u=a1aHR0cHM6Ly9leGFtcGxlLmNvbS8"
        ));
        assert!(url_looks_like_search_redirect(
            "https://duckduckgo.com/l/?uddg=https%3A%2F%2Fexample.com"
        ));
        assert!(!url_looks_like_search_redirect(
            "https://doc.rust-lang.org/book/"
        ));
    }

    #[test]
    fn provider_parse_accepts_worbrow_aliases() {
        assert_eq!(
            WebSearchProvider::parse("worbrow").unwrap(),
            WebSearchProvider::Worbrow
        );
        assert_eq!(
            WebSearchProvider::parse("browser").unwrap(),
            WebSearchProvider::Worbrow
        );
        assert!(!WebSearchProvider::default().requires_api_key());
        assert!(WebSearchProvider::Brave.requires_api_key());
    }

    /// 实网:本机 Firefox/Chrome + Bing。默认忽略;本地:  
    /// `cargo test -p crabmate-tools live_worbrow_search -- --ignored --nocapture`
    #[test]
    #[ignore = "requires local browser + network"]
    fn live_worbrow_search() {
        let out = search_worbrow("Rust async tokio", 5, 90).expect("worbrow search");
        eprintln!("{out}");
        assert!(
            out.contains("URL:") || out.contains("无网页结果"),
            "unexpected output: {out}"
        );
        assert!(!out.contains("搜索失败"), "search reported failure: {out}");
    }
}