crawlrs 0.2.0

crawlrs - Enterprise-grade web scraping and crawling platform built with Rust
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
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
// Copyright (c) 2025-2026 Kirky.X🌠
// SPDX-License-Identifier: Apache-2.0

//! 语义重排(rerank)能力
//!
//! 领域层只定义 `RerankProvider` 抽象与 `SearchReranker` 编排;具体实现:
//! - `local`:vecboost 进程内推理(`rag-local` feature,
//!   `infrastructure::services::vecboost_provider`)
//! - `http`:通用 /rerank REST 适配(无条件编译,
//!   `infrastructure::services::http_rerank_provider`)
//!
//! 搜索管线中的挂点:`SearchService::perform_search` 结果映射之后——
//! RRF/启发式融合给出统计排序,重排补上 query-doc 语义相关性,score 透出 API。

use std::sync::Arc;

use crate::domain::services::search_service::SearchResult;

/// 单条重排评分:`index` 为文档在输入切片中的下标
#[derive(Debug, Clone, PartialEq)]
pub struct RerankScore {
    pub index: usize,
    pub score: f32,
}

#[derive(Debug, thiserror::Error)]
pub enum RerankError {
    /// provider 侧失败(网络、上游 5xx、响应解析等)
    #[error("rerank provider error: {0}")]
    Provider(String),
    /// 输入不合法(空 query / 空文档集等)
    #[error("invalid rerank input: {0}")]
    InvalidInput(String),
}

/// 重排 provider 抽象:query 与候选文档 → 按相关性打分
#[async_trait::async_trait]
pub trait RerankProvider: Send + Sync {
    /// 对 `documents` 按 `query` 相关性评分。
    ///
    /// `top_k` 为 `Some(n)` 时仅要求返回前 n 条(provider 可自由返回更多,
    /// 由调用方截断);返回的 `index` 必须落在 `0..documents.len`。
    async fn rerank(
        &self,
        query: &str,
        documents: &[String],
        top_k: Option<usize>,
    ) -> Result<Vec<RerankScore>, RerankError>;

    /// provider 标识(日志用):`vecboost` / `http` 等
    fn name(&self) -> &str;
}

/// 复合重排 provider(fluxweir-llm-gateway D5 降级链)
///
/// primary 成功直用;primary 出错 **单次** 切换 secondary(log warn 显性记录,
/// 无内嵌重试防风暴);双失败时交由 [`SearchReranker`] 的 fail-open 语义
/// 保原序返回(错误链携带双方上下文,不阻塞检索可用性)。
/// 典型装配:vecboost/http 为 primary、fluxweir 为 secondary。
pub struct FallbackRerankProvider {
    primary: Arc<dyn RerankProvider>,
    secondary: Arc<dyn RerankProvider>,
}

impl FallbackRerankProvider {
    pub fn new(primary: Arc<dyn RerankProvider>, secondary: Arc<dyn RerankProvider>) -> Self {
        Self { primary, secondary }
    }
}

#[async_trait::async_trait]
impl RerankProvider for FallbackRerankProvider {
    async fn rerank(
        &self,
        query: &str,
        documents: &[String],
        top_k: Option<usize>,
    ) -> Result<Vec<RerankScore>, RerankError> {
        match self.primary.rerank(query, documents, top_k).await {
            Ok(scores) => Ok(scores),
            Err(primary_err) => {
                log::warn!(
                    "primary rerank provider failed, falling back to secondary: {primary_err}"
                );
                self.secondary
                    .rerank(query, documents, top_k)
                    .await
                    .map_err(|secondary_err| {
                        RerankError::Provider(format!(
                            "both rerank providers failed; primary: {primary_err}; \
                             secondary: {secondary_err}"
                        ))
                    })
            }
        }
    }

    fn name(&self) -> &str {
        "fallback"
    }
}

/// 搜索结果重排器(领域层编排,无条件编译)
///
/// `provider` 为 `None` 时完全直通(RAG 能力未启用 / 未配置),零开销。
/// 重排失败 fail-open:保留原序返回,不让检索可用性绑在重排上(与
/// robots 遵从的 fail-open 语义一致)。
pub struct SearchReranker {
    provider: Option<Arc<dyn RerankProvider>>,
    max_documents: usize,
}

impl SearchReranker {
    /// `max_documents`:送入 provider 的文档数上限——只重排当前顺序的前 N 条,
    /// 防止大结果集把重排延迟拖爆;其余条目原序追加在重排子集之后。
    pub fn new(provider: Option<Arc<dyn RerankProvider>>, max_documents: usize) -> Self {
        Self {
            provider,
            max_documents: max_documents.clamp(1, 100),
        }
    }

    pub fn is_enabled(&self) -> bool {
        self.provider.is_some()
    }

    pub fn provider(&self) -> Option<&Arc<dyn RerankProvider>> {
        self.provider.as_ref()
    }

    /// 对搜索结果做语义重排;写入 `SearchResult.score`(0..1 相关性)。
    ///
    /// 排序规则:送排的前 N 条按 score 降序置顶,其余按原序追加(score 为
    /// `None`)——保证尾部结果不会被丢弃。
    pub async fn rerank_results(
        &self,
        query: &str,
        results: Vec<SearchResult>,
    ) -> Vec<SearchResult> {
        let Some(provider) = self.provider.as_ref() else {
            return results;
        };
        if results.len() < 2 || query.trim().is_empty() {
            return results;
        }

        let head_len = results.len().min(self.max_documents);
        let documents: Vec<String> = results[..head_len].iter().map(result_to_document).collect();

        let started = std::time::Instant::now();
        let scored = match provider.rerank(query, &documents, Some(head_len)).await {
            Ok(scores) => scores,
            Err(err) => {
                log::warn!(
                    "search rerank failed (fail-open, keeping original order): \
                     provider={} results={} err={err}",
                    provider.name(),
                    results.len()
                );
                return results;
            }
        };

        let (reranked, scored_count) = apply_rerank_scores(results, scored, head_len);

        log::info!(
            "search rerank applied: provider={} docs={head_len} scored={} elapsed_ms={}",
            provider.name(),
            scored_count,
            started.elapsed().as_millis()
        );
        reranked
    }
}

/// 应用重排分数:合法下标按 score 降序置顶,其余按原序追加(score 为 `None`)。
///
/// index 越界/重复防御:只取合法下标,缺失者保持原位(排在有分者之后)。
/// 返回(重排后的结果, 有效评分数)。
fn apply_rerank_scores(
    results: Vec<SearchResult>,
    scored: Vec<RerankScore>,
    head_len: usize,
) -> (Vec<SearchResult>, usize) {
    let mut valid: Vec<(usize, f32)> = scored
        .into_iter()
        .filter(|s| s.index < head_len)
        .map(|s| (s.index, s.score))
        .collect();
    valid.sort_by(|a, b| b.1.partial_cmp(&a.1).unwrap_or(std::cmp::Ordering::Equal));

    let mut seen = vec![false; head_len];
    let mut reranked: Vec<SearchResult> = Vec::with_capacity(results.len());
    for (index, score) in &valid {
        seen[*index] = true;
        let mut item = results[*index].clone();
        item.score = Some(*score as f64);
        reranked.push(item);
    }
    for (position, mut item) in results.into_iter().enumerate() {
        let scored_here = position < head_len && seen[position];
        if !scored_here {
            item.score = None;
            reranked.push(item);
        }
    }

    (reranked, valid.len())
}

/// 结果 → 重排文档文本:标题为主,description 有值时拼接(重排模型按全文理解)
fn result_to_document(result: &SearchResult) -> String {
    match result.description.as_deref() {
        Some(desc) if !desc.trim().is_empty() => {
            format!("{}. {}", result.title.trim(), desc.trim())
        }
        _ => result.title.trim().to_string(),
    }
}

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

    /// 固定打分 mock:`fail=true` 模拟 provider 故障(fail-open 路径)
    struct MockProvider {
        fail: bool,
        scores: Vec<RerankScore>,
    }

    #[async_trait::async_trait]
    impl RerankProvider for MockProvider {
        async fn rerank(
            &self,
            _query: &str,
            _documents: &[String],
            _top_k: Option<usize>,
        ) -> Result<Vec<RerankScore>, RerankError> {
            if self.fail {
                return Err(RerankError::Provider("mock down".to_string()));
            }
            // 不做合法性断言:越界/缺失 index 的防御是被测对象(SearchReranker)的职责
            Ok(self.scores.clone())
        }

        fn name(&self) -> &str {
            "mock"
        }
    }

    /// 可编程故障 mock(降级链测试):调用计数经 AtomicUsize 外部断言
    struct FallbackMockProvider {
        fail: bool,
        calls: std::sync::Arc<std::sync::atomic::AtomicUsize>,
    }

    #[async_trait::async_trait]
    impl RerankProvider for FallbackMockProvider {
        async fn rerank(
            &self,
            _query: &str,
            _documents: &[String],
            _top_k: Option<usize>,
        ) -> Result<Vec<RerankScore>, RerankError> {
            self.calls
                .fetch_add(1, std::sync::atomic::Ordering::Relaxed);
            if self.fail {
                return Err(RerankError::Provider("fallback mock down".to_string()));
            }
            Ok(vec![RerankScore {
                index: 0,
                score: 0.9,
            }])
        }

        fn name(&self) -> &str {
            "fallback-mock"
        }
    }

    #[tokio::test]
    async fn fallback_rerank_primary_success_skips_secondary() {
        let primary_calls = std::sync::Arc::new(std::sync::atomic::AtomicUsize::new(0));
        let secondary_calls = std::sync::Arc::new(std::sync::atomic::AtomicUsize::new(0));
        let fallback = FallbackRerankProvider::new(
            Arc::new(FallbackMockProvider {
                fail: false,
                calls: primary_calls.clone(),
            }),
            Arc::new(FallbackMockProvider {
                fail: true,
                calls: secondary_calls.clone(),
            }),
        );
        let out = fallback
            .rerank("q", &["d".to_string()], None)
            .await
            .expect("primary ok");
        assert_eq!(out.len(), 1);
        assert_eq!(primary_calls.load(std::sync::atomic::Ordering::Relaxed), 1);
        assert_eq!(
            secondary_calls.load(std::sync::atomic::Ordering::Relaxed),
            0,
            "secondary must not be called when primary succeeds"
        );
    }

    #[tokio::test]
    async fn fallback_rerank_primary_failure_switches_once() {
        let primary_calls = std::sync::Arc::new(std::sync::atomic::AtomicUsize::new(0));
        let secondary_calls = std::sync::Arc::new(std::sync::atomic::AtomicUsize::new(0));
        let fallback = FallbackRerankProvider::new(
            Arc::new(FallbackMockProvider {
                fail: true,
                calls: primary_calls.clone(),
            }),
            Arc::new(FallbackMockProvider {
                fail: false,
                calls: secondary_calls.clone(),
            }),
        );
        let out = fallback
            .rerank("q", &["d".to_string()], None)
            .await
            .expect("secondary ok");
        assert_eq!(out[0].score, 0.9);
        assert_eq!(primary_calls.load(std::sync::atomic::Ordering::Relaxed), 1);
        assert_eq!(
            secondary_calls.load(std::sync::atomic::Ordering::Relaxed),
            1
        );
    }

    #[tokio::test]
    async fn fallback_rerank_both_fail_reports_both_contexts() {
        let fallback = FallbackRerankProvider::new(
            Arc::new(FallbackMockProvider {
                fail: true,
                calls: std::sync::Arc::new(std::sync::atomic::AtomicUsize::new(0)),
            }),
            Arc::new(FallbackMockProvider {
                fail: true,
                calls: std::sync::Arc::new(std::sync::atomic::AtomicUsize::new(0)),
            }),
        );
        let err = fallback
            .rerank("q", &["d".to_string()], None)
            .await
            .expect_err("must error");
        let rendered = err.to_string();
        assert!(
            rendered.contains("both rerank providers failed"),
            "{rendered}"
        );
        assert!(rendered.contains("fallback mock down"), "{rendered}");
    }

    fn result(title: &str, description: Option<&str>) -> SearchResult {
        SearchResult {
            title: title.to_string(),
            url: format!("https://example.org/{title}"),
            description: description.map(str::to_string),
            engine: "mock".to_string(),
            score: None,
        }
    }

    #[tokio::test]
    async fn test_disabled_reranker_passthrough() {
        let reranker = SearchReranker::new(None, 25);
        assert!(!reranker.is_enabled());

        let results = vec![result("a", None), result("b", None)];
        let out = reranker.rerank_results("q", results.clone()).await;
        assert_eq!(out.len(), 2);
        assert!(out.iter().all(|r| r.score.is_none()));
    }

    #[tokio::test]
    async fn test_single_result_short_circuits() {
        let reranker = SearchReranker::new(
            Some(Arc::new(MockProvider {
                fail: false,
                scores: vec![RerankScore {
                    index: 0,
                    score: 0.9,
                }],
            })),
            25,
        );
        let out = reranker
            .rerank_results("q", vec![result("only", None)])
            .await;
        assert_eq!(out.len(), 1);
        assert!(
            out[0].score.is_none(),
            "single result must not be re-scored"
        );
    }

    #[tokio::test]
    async fn test_reorder_by_score_desc() {
        // 原序 a/b/c;provider 认为 b(0.9) > c(0.7) > a(0.1)
        let reranker = SearchReranker::new(
            Some(Arc::new(MockProvider {
                fail: false,
                scores: vec![
                    RerankScore {
                        index: 0,
                        score: 0.1,
                    },
                    RerankScore {
                        index: 1,
                        score: 0.9,
                    },
                    RerankScore {
                        index: 2,
                        score: 0.7,
                    },
                ],
            })),
            25,
        );
        let results = vec![result("a", None), result("b", None), result("c", None)];
        let out = reranker.rerank_results("rust rerank", results).await;

        let titles: Vec<&str> = out.iter().map(|r| r.title.as_str()).collect();
        assert_eq!(titles, vec!["b", "c", "a"]);
        assert!((out[0].score.unwrap() - 0.9).abs() < 1e-6);
        assert!((out[1].score.unwrap() - 0.7).abs() < 1e-6);
        assert!((out[2].score.unwrap() - 0.1).abs() < 1e-6);
    }

    #[tokio::test]
    async fn test_fail_open_keeps_original_order() {
        let reranker = SearchReranker::new(
            Some(Arc::new(MockProvider {
                fail: true,
                scores: vec![],
            })),
            25,
        );
        let results = vec![result("a", None), result("b", None), result("c", None)];
        let out = reranker.rerank_results("q", results).await;
        let titles: Vec<&str> = out.iter().map(|r| r.title.as_str()).collect();
        assert_eq!(titles, vec!["a", "b", "c"], "fail-open must keep order");
        assert!(out.iter().all(|r| r.score.is_none()));
    }

    #[tokio::test]
    async fn test_max_documents_caps_head_and_keeps_tail_in_order() {
        // top_n=2:只重排 a/b,c/d 原序追加且无分
        let reranker = SearchReranker::new(
            Some(Arc::new(MockProvider {
                fail: false,
                scores: vec![
                    RerankScore {
                        index: 1,
                        score: 0.8,
                    },
                    RerankScore {
                        index: 0,
                        score: 0.2,
                    },
                ],
            })),
            2,
        );
        let results = vec![
            result("a", None),
            result("b", None),
            result("c", None),
            result("d", None),
        ];
        let out = reranker.rerank_results("q", results).await;

        let titles: Vec<&str> = out.iter().map(|r| r.title.as_str()).collect();
        assert_eq!(titles, vec!["b", "a", "c", "d"]);
        assert!((out[0].score.unwrap() - 0.8).abs() < 1e-6);
        assert!((out[1].score.unwrap() - 0.2).abs() < 1e-6);
        assert!(out[2].score.is_none());
        assert!(out[3].score.is_none());
    }

    #[tokio::test]
    async fn test_out_of_range_and_missing_indices_are_defended() {
        // provider 返回越界 index(99),且漏掉 index 1
        let reranker = SearchReranker::new(
            Some(Arc::new(MockProvider {
                fail: false,
                scores: vec![
                    RerankScore {
                        index: 99,
                        score: 1.0,
                    },
                    RerankScore {
                        index: 0,
                        score: 0.5,
                    },
                ],
            })),
            25,
        );
        let results = vec![result("a", None), result("b", None), result("c", None)];
        let out = reranker.rerank_results("q", results).await;

        // 只有 a 有分且置顶;b/c(未评分)原序追加
        let titles: Vec<&str> = out.iter().map(|r| r.title.as_str()).collect();
        assert_eq!(titles, vec!["a", "b", "c"]);
        assert!((out[0].score.unwrap() - 0.5).abs() < 1e-6);
    }

    #[tokio::test]
    async fn test_empty_query_short_circuits() {
        let reranker = SearchReranker::new(
            Some(Arc::new(MockProvider {
                fail: false,
                scores: vec![],
            })),
            25,
        );
        let results = vec![result("a", None), result("b", None)];
        let out = reranker.rerank_results("   ", results).await;
        assert_eq!(out.len(), 2);
    }

    #[test]
    fn test_document_text_includes_description() {
        let with_desc = result("Title", Some("  Some description.  "));
        assert_eq!(result_to_document(&with_desc), "Title. Some description.");

        let blank_desc = result("Title", Some("   "));
        assert_eq!(result_to_document(&blank_desc), "Title");

        let no_desc = result("Title", None);
        assert_eq!(result_to_document(&no_desc), "Title");
    }
}