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
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
// Copyright (c) 2025-2026 Kirky.X🌠
// SPDX-License-Identifier: Apache-2.0

//! LLM 边界与提取编排
//!
//! [`LLMServiceTrait`] 是 crawlrs 唯一的 LLM 边界:供应商访问由宿主注入的
//! carrier 承担(默认 [`ExplicitErrorCarrier`] 在未注入时显式报错)。
//! `prompt_builder`(模板 + prompt 构造)、`chunker`(token 窗口分块并行)、
//! `provenance`(字符级溯源)保留为编排工具,宿主 carrier 可复用。

pub mod chunker; // token 窗口分块 + 并行提问 + merge(F8)
pub mod prompt_builder;
pub mod provenance; // 提取结果字符级溯源对齐(F9)
                    // 视觉模型适配器:trait 无条件编译(域抽象,mock/测试可用);
                    // FluxweirVisionAdapter 实现挂 gateway 门控(vision 经网关承载,无直连态)
pub mod vision_adapter;

use anyhow::Result;
use async_trait::async_trait;
use serde::{Deserialize, Serialize};
use serde_json::Value;

/// Token usage tracking for LLM calls
#[derive(Debug, Default, Clone, PartialEq, Serialize, Deserialize)]
pub struct TokenUsage {
    pub prompt_tokens: u32,
    pub completion_tokens: u32,
    pub total_tokens: u32,
}

#[async_trait]
pub trait LLMServiceTrait: Send + Sync {
    async fn extract_data(
        &self,
        text: &str,
        schema: &Value,
        format: &str,
    ) -> Result<(Value, TokenUsage), anyhow::Error>;

    /// 分块提取:长文按模型窗口切块 → 并行提问 → merge 综合(F8)
    ///
    /// 默认实现等价 [`LLMServiceTrait::extract_data`](未接入分块的实现方零改动);
    /// 宿主 carrier 可复用 [`chunker::extract_chunked`] 覆盖实现,
    /// `[llm.chunking].enabled = false` 时同样直走单发路径。
    async fn extract_data_chunked(
        &self,
        text: &str,
        schema: &Value,
        format: &str,
    ) -> Result<(Value, TokenUsage), anyhow::Error> {
        self.extract_data(text, schema, format).await
    }

    /// 提取 + 字符级溯源(F9):结果字符串字段对齐回原文字符区间。
    ///
    /// 返回 `(value, provenance, usage)`;`provenance` 为
    /// `{field_path: {start, end, coverage}}` 映射(对齐失败字段为 null,调用方
    /// 过滤),`llm.provenance_enabled = false` 时为 `None`(mock 零改动)。
    /// 启用时 `value` 额外并列挂载 `_provenance` 键,RAG 入库链可直接持久该 JSON。
    async fn extract_data_with_provenance(
        &self,
        text: &str,
        schema: &Value,
        format: &str,
    ) -> Result<(Value, Option<Value>, TokenUsage), anyhow::Error> {
        let (value, usage) = self.extract_data(text, schema, format).await?;
        Ok((value, None, usage))
    }
}

/// 默认装配的显式失败承载(未注入宿主 carrier 时)
///
/// crawlrs 不再内置 LLM 供应商访问栈;LLM 能力由宿主经装配面注入
/// [`LLMServiceTrait`] 实现(`Services.llm_service` / `init_llm_service` / kit 注册)。
/// 未注入时本承载把「LLM 不可用」变成可观测的结构化错误,而不是静默降级或 panic。
pub struct ExplicitErrorCarrier;

impl ExplicitErrorCarrier {
    /// 按 locale 取译文案;该 locale 未被启动束加载时用规范串,
    /// 避免 Fluent 回退到默认语言导致「双语」退化为单语。
    fn localized(
        bundle: &crate::i18n::I18nBundle,
        locale: &crate::i18n::Locale,
        key: &str,
        fallback: &str,
    ) -> String {
        if bundle.supported_locales().contains(locale) {
            crate::i18n::t(locale, bundle, key)
        } else {
            fallback.to_string()
        }
    }

    /// 构造结构化错误:anyhow 链 + i18n 双语载荷(en | zh)。
    ///
    /// 启动期 i18n 全局束已初始化时经 Fluent 输出双语;未初始化(单测、轻量面)
    /// 时回退同语义的英文/中文规范串(双轨基准,与 `CrawlRsError::user_message`
    /// 同惯例)。
    fn missing_carrier_error() -> anyhow::Error {
        const KEY: &str = "domain-error-llm-carrier-not-injected";
        const EN_FALLBACK: &str = "LLM carrier is not injected: crawlrs no longer bundles \
             LLM provider access; inject a host implementation of LLMServiceTrait";
        const ZH_FALLBACK: &str = "LLM 未接入承载方:crawlrs 不再内置 LLM 供应商访问,\
             请经宿主注入 LLMServiceTrait 实现";

        let (en, zh) = match crate::i18n::startup_i18n() {
            Some((_, bundle)) => {
                let en_locale = "en-US".parse::<crate::i18n::Locale>();
                let zh_locale = "zh-CN".parse::<crate::i18n::Locale>();
                match (en_locale, zh_locale) {
                    (Ok(en_locale), Ok(zh_locale)) => (
                        Self::localized(bundle, &en_locale, KEY, EN_FALLBACK),
                        Self::localized(bundle, &zh_locale, KEY, ZH_FALLBACK),
                    ),
                    _ => (EN_FALLBACK.to_string(), ZH_FALLBACK.to_string()),
                }
            }
            None => (EN_FALLBACK.to_string(), ZH_FALLBACK.to_string()),
        };
        anyhow::anyhow!("{en} | {zh}")
    }
}

#[async_trait]
impl LLMServiceTrait for ExplicitErrorCarrier {
    async fn extract_data(
        &self,
        _text: &str,
        _schema: &Value,
        _format: &str,
    ) -> Result<(Value, TokenUsage)> {
        Err(Self::missing_carrier_error())
    }

    /// 分块入口同样显式失败:未注入承载时不得静默退化为单发/空结果。
    async fn extract_data_chunked(
        &self,
        _text: &str,
        _schema: &Value,
        _format: &str,
    ) -> Result<(Value, TokenUsage)> {
        Err(Self::missing_carrier_error())
    }

    /// 溯源入口同样显式失败:未注入承载时不得返回空成功。
    async fn extract_data_with_provenance(
        &self,
        _text: &str,
        _schema: &Value,
        _format: &str,
    ) -> Result<(Value, Option<Value>, TokenUsage)> {
        Err(Self::missing_carrier_error())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use prompt_builder::{
        FileTemplateLoader, InMemoryTemplateLoader, TemplateLoader, TemplateLoaderTrait,
    };
    use std::sync::atomic::{AtomicU32, Ordering};
    use std::sync::Arc;

    // ===== ExplicitErrorCarrier(默认装配:未注入承载)=====

    /// 默认装配态:`extract_data` 调用返回结构化错误,不 panic、不返回空成功。
    /// 错误载荷为 i18n 双语(en/zh 均含「未接入承载」语义)。
    #[tokio::test]
    async fn test_explicit_error_carrier_extract_data_reports_missing_carrier() {
        let carrier = ExplicitErrorCarrier;
        let schema = serde_json::json!({"type": "object"});
        let err = carrier
            .extract_data("text", &schema, "json")
            .await
            .expect_err("未注入承载时必须显式失败");
        let message = format!("{err:#}");
        assert!(
            message.contains("carrier is not injected"),
            "en payload missing: {message}"
        );
        assert!(
            message.contains("未接入承载方"),
            "zh payload missing: {message}"
        );
    }

    /// 默认装配态:分块入口同样显式失败(不静默降级为单发/空结果)。
    #[tokio::test]
    async fn test_explicit_error_carrier_chunked_reports_missing_carrier() {
        let carrier = ExplicitErrorCarrier;
        let schema = serde_json::json!({"type": "object"});
        let err = carrier
            .extract_data_chunked("text", &schema, "json")
            .await
            .expect_err("未注入承载时分块入口必须显式失败");
        let message = format!("{err:#}");
        assert!(
            message.contains("carrier is not injected"),
            "en payload missing: {message}"
        );
        assert!(
            message.contains("未接入承载方"),
            "zh payload missing: {message}"
        );
    }

    /// 默认装配态:溯源入口同样显式失败(不返回空成功)。
    #[tokio::test]
    async fn test_explicit_error_carrier_provenance_reports_missing_carrier() {
        let carrier = ExplicitErrorCarrier;
        let schema = serde_json::json!({"type": "object"});
        let err = carrier
            .extract_data_with_provenance("text", &schema, "json")
            .await
            .expect_err("未注入承载时溯源入口必须显式失败");
        let message = format!("{err:#}");
        assert!(
            message.contains("carrier is not injected"),
            "en payload missing: {message}"
        );
        assert!(
            message.contains("未接入承载方"),
            "zh payload missing: {message}"
        );
    }

    /// 启动期 i18n 束就绪时双语载荷来自 FTL(en/zh 各自命中语义键)。
    #[test]
    fn test_explicit_error_carrier_bilingual_payload_from_bundle() {
        let bundle = crate::i18n::I18nBundle::load("en-US", &["en-US", "zh-CN"])
            .expect("locales bundle should load");
        let en_locale = "en-US".parse::<crate::i18n::Locale>().expect("en locale");
        let zh_locale = "zh-CN".parse::<crate::i18n::Locale>().expect("zh locale");
        const KEY: &str = "domain-error-llm-carrier-not-injected";

        let en = ExplicitErrorCarrier::localized(&bundle, &en_locale, KEY, "fallback");
        let zh = ExplicitErrorCarrier::localized(&bundle, &zh_locale, KEY, "fallback");
        assert!(en.contains("carrier is not injected"), "en payload: {en}");
        assert!(zh.contains("未接入承载方"), "zh payload: {zh}");
    }

    // ===== TokenUsage tests =====

    #[test]
    fn test_token_usage_default_is_zero() {
        let usage = TokenUsage::default();
        assert_eq!(usage.prompt_tokens, 0);
        assert_eq!(usage.completion_tokens, 0);
        assert_eq!(usage.total_tokens, 0);
    }

    #[test]
    fn test_token_usage_serde_roundtrip() {
        let usage = TokenUsage {
            prompt_tokens: 100,
            completion_tokens: 50,
            total_tokens: 150,
        };
        let serialized = serde_json::to_string(&usage).unwrap();
        let deserialized: TokenUsage = serde_json::from_str(&serialized).unwrap();
        assert_eq!(deserialized.prompt_tokens, 100);
        assert_eq!(deserialized.completion_tokens, 50);
        assert_eq!(deserialized.total_tokens, 150);
    }

    #[test]
    fn test_token_usage_clone_preserves_values() {
        let usage = TokenUsage {
            prompt_tokens: 42,
            completion_tokens: 21,
            total_tokens: 63,
        };
        let cloned = usage.clone();
        assert_eq!(cloned.prompt_tokens, 42);
        assert_eq!(cloned.completion_tokens, 21);
        assert_eq!(cloned.total_tokens, 63);
    }

    // ===== FileTemplateLoader tests =====

    #[test]
    fn test_file_template_loader_new_valid_file_loads_templates() {
        use std::io::Write;
        let dir = std::env::temp_dir().join("crawlrs_test_llm_loader");
        let _ = std::fs::create_dir_all(&dir);
        let file_path = dir.join("test_prompts.toml");
        let mut f = std::fs::File::create(&file_path).unwrap();
        writeln!(
            f,
            r#"
[extraction]
json = 'Extract JSON from {{{{text}}}} using schema {{{{schema}}}}'
markdown = 'Extract Markdown from {{{{text}}}}'
"#
        )
        .unwrap();

        let loader = FileTemplateLoader::new(file_path.to_str().unwrap());
        let templates = loader.load_templates().unwrap();
        assert!(templates.contains_key("json"));
        assert!(templates.contains_key("markdown"));

        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_file_template_loader_read_templates_valid_toml() {
        use std::io::Write;
        let dir = std::env::temp_dir().join("crawlrs_test_llm_loader2");
        let _ = std::fs::create_dir_all(&dir);
        let file_path = dir.join("test_prompts2.toml");
        let mut f = std::fs::File::create(&file_path).unwrap();
        writeln!(
            f,
            r#"
[extraction]
json = 'json template'
"#
        )
        .unwrap();

        let loader = FileTemplateLoader::new(file_path.to_str().unwrap());
        let templates = loader.load_templates().unwrap();
        assert_eq!(templates.get("json").unwrap(), "json template");

        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_file_template_loader_read_templates_invalid_toml_returns_empty() {
        use std::io::Write;
        let dir = std::env::temp_dir().join("crawlrs_test_llm_loader3");
        let _ = std::fs::create_dir_all(&dir);
        let file_path = dir.join("invalid.toml");
        let mut f = std::fs::File::create(&file_path).unwrap();
        writeln!(f, "this is not valid toml {{{{").unwrap();

        let loader = FileTemplateLoader::new(file_path.to_str().unwrap());
        let templates = loader.load_templates().unwrap();
        assert!(templates.is_empty());

        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_file_template_loader_read_templates_partial_toml_only_json() {
        use std::io::Write;
        let dir = std::env::temp_dir().join("crawlrs_test_llm_loader4");
        let _ = std::fs::create_dir_all(&dir);
        let file_path = dir.join("partial.toml");
        let mut f = std::fs::File::create(&file_path).unwrap();
        writeln!(
            f,
            r#"
[extraction]
json = 'json only'
"#
        )
        .unwrap();

        let loader = FileTemplateLoader::new(file_path.to_str().unwrap());
        let templates = loader.load_templates().unwrap();
        assert_eq!(templates.len(), 1);
        assert!(templates.contains_key("json"));

        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_file_template_loader_read_templates_no_extraction_key() {
        use std::io::Write;
        let dir = std::env::temp_dir().join("crawlrs_test_llm_loader5");
        let _ = std::fs::create_dir_all(&dir);
        let file_path = dir.join("no_extraction.toml");
        let mut f = std::fs::File::create(&file_path).unwrap();
        writeln!(f, "[other]\nkey = \"value\"").unwrap();

        let loader = FileTemplateLoader::new(file_path.to_str().unwrap());
        let templates = loader.load_templates().unwrap();
        assert!(templates.is_empty());

        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_file_template_loader_load_templates_returns_clone() {
        use std::io::Write;
        let dir = std::env::temp_dir().join("crawlrs_test_llm_loader6");
        let _ = std::fs::create_dir_all(&dir);
        let file_path = dir.join("clone_test.toml");
        let mut f = std::fs::File::create(&file_path).unwrap();
        writeln!(f, "[extraction]\njson = 'test'").unwrap();

        let loader = FileTemplateLoader::new(file_path.to_str().unwrap());
        let mut t1 = loader.load_templates().unwrap();
        t1.insert("new".to_string(), "val".to_string());
        let t2 = loader.load_templates().unwrap();
        assert!(!t2.contains_key("new"));

        let _ = std::fs::remove_dir_all(&dir);
    }

    // ===== extract_data_chunked(F8)=====

    /// trait 默认实现:mock 只实现 extract_data 时,extract_data_chunked 行为等价
    /// extract_data(mock 零改动编译通过)
    #[tokio::test]
    async fn test_extract_data_chunked_default_impl_delegates_to_extract_data() {
        struct ChunklessMock {
            calls: Arc<AtomicU32>,
        }

        #[async_trait]
        impl LLMServiceTrait for ChunklessMock {
            async fn extract_data(
                &self,
                text: &str,
                _schema: &Value,
                _format: &str,
            ) -> Result<(Value, TokenUsage)> {
                self.calls.fetch_add(1, Ordering::SeqCst);
                Ok((serde_json::json!({"echo": text}), TokenUsage::default()))
            }
        }

        let calls = Arc::new(AtomicU32::new(0));
        let mock = ChunklessMock {
            calls: calls.clone(),
        };
        let schema = serde_json::json!({"type": "object"});
        let (value, usage) = mock
            .extract_data_chunked("some text", &schema, "json")
            .await
            .expect("chunked call ok");
        assert_eq!(value, serde_json::json!({"echo": "some text"}));
        assert_eq!(usage, TokenUsage::default());
        assert_eq!(calls.load(Ordering::SeqCst), 1);
    }

    // ===== extract_data_with_provenance(F9)=====

    /// trait 默认实现:mock 只实现 extract_data 时,溯源方法返回 None(mock 零破坏)
    #[tokio::test]
    async fn test_extract_data_with_provenance_default_impl_yields_none() {
        struct ProvenancelessMock {
            calls: Arc<AtomicU32>,
        }

        #[async_trait]
        impl LLMServiceTrait for ProvenancelessMock {
            async fn extract_data(
                &self,
                text: &str,
                _schema: &Value,
                _format: &str,
            ) -> Result<(Value, TokenUsage)> {
                self.calls.fetch_add(1, Ordering::SeqCst);
                Ok((serde_json::json!({"echo": text}), TokenUsage::default()))
            }
        }

        let calls = Arc::new(AtomicU32::new(0));
        let mock = ProvenancelessMock {
            calls: calls.clone(),
        };
        let schema = serde_json::json!({"type": "object"});
        let (value, provenance, usage) = mock
            .extract_data_with_provenance("some text", &schema, "json")
            .await
            .expect("provenance call ok");
        assert_eq!(value, serde_json::json!({"echo": "some text"}));
        assert!(provenance.is_none(), "默认实现溯源为 None");
        assert!(value.get("_provenance").is_none(), "不挂载 _provenance");
        assert_eq!(usage, TokenUsage::default());
        assert_eq!(calls.load(Ordering::SeqCst), 1);
    }

    /// 注入面:宿主 carrier 经 `Arc<dyn LLMServiceTrait>` 装配后,
    /// `ExtractionService::extract_with_schema` 全链路(清洗 → carrier → 溯源挂载)工作。
    ///
    /// 模拟宿主经 `Services.llm_service` pub 字段注入自有实现;编排工具
    /// ([`provenance::apply_provenance`])由 carrier 复用,证明边界开放且编排保留。
    #[tokio::test]
    async fn test_injected_carrier_full_provenance_chain_works() {
        use crate::domain::services::extraction_service::{
            ExtractionService, ExtractionServiceTrait,
        };

        struct MockCarrier {
            calls: Arc<AtomicU32>,
        }

        #[async_trait]
        impl LLMServiceTrait for MockCarrier {
            async fn extract_data(
                &self,
                _text: &str,
                _schema: &Value,
                _format: &str,
            ) -> Result<(Value, TokenUsage)> {
                self.calls.fetch_add(1, Ordering::SeqCst);
                Ok((
                    serde_json::json!({"name": "crawlrs"}),
                    TokenUsage::default(),
                ))
            }

            /// 宿主 carrier 复用 crawlrs 公开的溯源编排工具(F9)
            async fn extract_data_with_provenance(
                &self,
                text: &str,
                schema: &Value,
                format: &str,
            ) -> Result<(Value, Option<Value>, TokenUsage)> {
                let (value, usage) = self.extract_data(text, schema, format).await?;
                let config = provenance::ProvenanceConfig {
                    enabled: true,
                    min_coverage: 0.0,
                };
                let (value, prov) = provenance::apply_provenance(text, value, &config);
                Ok((value, prov, usage))
            }
        }

        let calls = Arc::new(AtomicU32::new(0));
        // 等价于宿主向 `Services.llm_service`(`Arc<dyn LLMServiceTrait>`)注入 carrier
        let carrier: Arc<dyn LLMServiceTrait> = Arc::new(MockCarrier {
            calls: calls.clone(),
        });
        let service = ExtractionService::new(carrier);
        let schema = serde_json::json!({"type": "object"});
        let html = "<html><body><p>crawlrs is a scraper</p></body></html>";

        let (result, _usage) = service
            .extract_with_schema(html, &schema)
            .await
            .expect("注入 carrier 后提取链路应成功");

        assert_eq!(result["name"], "crawlrs");
        assert_eq!(
            result["_provenance"]["name"]["start"], 0,
            "溯源映射应由 carrier 复用编排工具生成并挂载: {result}"
        );
        assert_eq!(calls.load(Ordering::SeqCst), 1);
    }

    /// 溯源配置映射:`[llm]` 的 `provenance_*` 两键直接映射进编排配置
    /// (不依赖任何供应商栈)
    #[test]
    fn test_provenance_config_from_settings() {
        let llm = crate::config::settings::LLMSettings {
            provenance_enabled: true,
            provenance_min_coverage: 0.6,
            ..Default::default()
        };
        let config = provenance::ProvenanceConfig::from_settings(&llm);
        assert!(config.enabled);
        assert!((config.min_coverage - 0.6).abs() < f64::EPSILON);
    }

    /// 模板加载器默认构造可用(prompt_builder 保留为编排工具)
    #[test]
    fn test_in_memory_template_loader_available() {
        let loader: TemplateLoader = Arc::new(InMemoryTemplateLoader::new());
        assert!(loader.load_templates().unwrap().is_empty());
    }
}