blz-core 1.5.5

Core library for fast local llms.txt search
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
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
//! Refresh helpers shared by CLI and MCP consumers.

use std::path::PathBuf;

use crate::{
    FetchResult, Fetcher, HeadingFilterStats, LanguageFilter, MarkdownParser, ParseResult,
    PerformanceMetrics, Result, SearchIndex, Source, SourceType, Storage, TocEntry,
};

use crate::json_builder::build_llms_json;
use crate::url_resolver::resolve_best_url;

/// Abstraction over storage interactions used by refresh routines.
pub trait RefreshStorage {
    /// Load stored metadata for a source alias.
    fn load_metadata(&self, alias: &str) -> Result<Source>;
    /// Load alias list from the cached llms.json for a source.
    fn load_llms_aliases(&self, alias: &str) -> Result<Vec<String>>;
    /// Persist the latest llms.txt content.
    fn save_llms_txt(&self, alias: &str, content: &str) -> Result<()>;
    /// Persist the computed llms.json metadata payload.
    fn save_llms_json(&self, alias: &str, data: &crate::LlmsJson) -> Result<()>;
    /// Persist updated source metadata.
    fn save_metadata(&self, alias: &str, metadata: &Source) -> Result<()>;
    /// Resolve the on-disk index path for a source.
    fn index_path(&self, alias: &str) -> Result<PathBuf>;
    /// Load cached llms.txt content for a source.
    fn load_llms_txt(&self, alias: &str) -> Result<String>;
}

impl RefreshStorage for Storage {
    fn load_metadata(&self, alias: &str) -> Result<Source> {
        Self::load_source_metadata(self, alias)?
            .ok_or_else(|| crate::Error::NotFound(format!("Missing metadata for {alias}")))
    }

    fn load_llms_aliases(&self, alias: &str) -> Result<Vec<String>> {
        match Self::load_llms_json(self, alias) {
            Ok(llms) => Ok(llms.metadata.aliases),
            Err(_) => Ok(Vec::new()),
        }
    }

    fn save_llms_txt(&self, alias: &str, content: &str) -> Result<()> {
        Self::save_llms_txt(self, alias, content)
    }

    fn save_llms_json(&self, alias: &str, data: &crate::LlmsJson) -> Result<()> {
        Self::save_llms_json(self, alias, data)
    }

    fn save_metadata(&self, alias: &str, metadata: &Source) -> Result<()> {
        Self::save_source_metadata(self, alias, metadata)
    }

    fn index_path(&self, alias: &str) -> Result<PathBuf> {
        Self::index_dir(self, alias)
    }

    fn load_llms_txt(&self, alias: &str) -> Result<String> {
        Self::load_llms_txt(self, alias)
    }
}

/// Interface for indexing refreshed content.
pub trait RefreshIndexer {
    /// Index a set of heading blocks for the given alias.
    fn index(
        &self,
        alias: &str,
        index_path: &std::path::Path,
        metrics: PerformanceMetrics,
        blocks: &[crate::HeadingBlock],
    ) -> Result<()>;
}

/// Default indexer that writes to the Tantivy search index.
#[derive(Default)]
pub struct DefaultRefreshIndexer;

impl RefreshIndexer for DefaultRefreshIndexer {
    fn index(
        &self,
        alias: &str,
        index_path: &std::path::Path,
        metrics: PerformanceMetrics,
        blocks: &[crate::HeadingBlock],
    ) -> Result<()> {
        let index = SearchIndex::create_or_open(index_path)?.with_metrics(metrics);
        index.index_blocks(alias, blocks)
    }
}

/// Result summary for a refresh operation.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum RefreshOutcome {
    /// The source content changed and was re-indexed.
    Refreshed {
        /// Canonical alias for the refreshed source.
        alias: String,
        /// Number of headings indexed.
        headings: usize,
        /// Total line count in the source.
        lines: usize,
    },
    /// The source content was unchanged.
    Unchanged {
        /// Canonical alias for the unchanged source.
        alias: String,
    },
}

/// Result summary for a reindex operation.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ReindexOutcome {
    /// Canonical alias for the reindexed source.
    pub alias: String,
    /// Heading count before filtering.
    pub headings_before: usize,
    /// Heading count after filtering.
    pub headings_after: usize,
    /// Number of headings filtered out.
    pub filtered: usize,
}

/// Data describing remote changes.
#[derive(Debug, Clone)]
pub struct RefreshPayload {
    /// Refreshed llms.txt content.
    pub content: String,
    /// SHA256 hash of the refreshed content.
    pub sha256: String,
    /// `ETag` header value from the response.
    pub etag: Option<String>,
    /// Last-Modified header value from the response.
    pub last_modified: Option<String>,
}

/// URL resolution details for refresh operations.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct RefreshUrlResolution {
    /// Final URL used for refresh.
    pub final_url: String,
    /// Variant chosen for the URL.
    pub variant: crate::SourceVariant,
    /// Whether the source was upgraded to llms-full.txt.
    pub upgraded: bool,
}

/// Resolve the best refresh URL (llms.txt → llms-full.txt) when available.
pub async fn resolve_refresh_url(
    fetcher: &Fetcher,
    metadata: &Source,
) -> Result<RefreshUrlResolution> {
    if metadata.variant != crate::SourceVariant::Llms {
        return Ok(RefreshUrlResolution {
            final_url: metadata.url.clone(),
            variant: metadata.variant.clone(),
            upgraded: false,
        });
    }

    match resolve_best_url(fetcher, &metadata.url).await {
        Ok(resolved) if resolved.variant == crate::SourceVariant::LlmsFull => {
            Ok(RefreshUrlResolution {
                final_url: resolved.final_url,
                variant: resolved.variant,
                upgraded: true,
            })
        },
        Ok(_) | Err(_) => Ok(RefreshUrlResolution {
            final_url: metadata.url.clone(),
            variant: metadata.variant.clone(),
            upgraded: false,
        }),
    }
}

/// Refresh a source using its current metadata.
pub async fn refresh_source<S, I>(
    storage: &S,
    fetcher: &Fetcher,
    alias: &str,
    metrics: PerformanceMetrics,
    indexer: &I,
    filter_preference: bool,
) -> Result<RefreshOutcome>
where
    S: RefreshStorage + Sync,
    I: RefreshIndexer + Sync,
{
    let existing_metadata = storage.load_metadata(alias)?;
    let existing_aliases = storage.load_llms_aliases(alias)?;
    let resolution = resolve_refresh_url(fetcher, &existing_metadata).await?;

    refresh_source_with_metadata(
        storage,
        fetcher,
        alias,
        existing_metadata,
        existing_aliases,
        &resolution,
        metrics,
        indexer,
        filter_preference,
    )
    .await
}

/// Refresh a source using preloaded metadata and URL resolution.
#[allow(clippy::too_many_arguments)]
pub async fn refresh_source_with_metadata<S, I>(
    storage: &S,
    fetcher: &Fetcher,
    alias: &str,
    existing_metadata: Source,
    existing_aliases: Vec<String>,
    resolution: &RefreshUrlResolution,
    metrics: PerformanceMetrics,
    indexer: &I,
    filter_preference: bool,
) -> Result<RefreshOutcome>
where
    S: RefreshStorage + Sync,
    I: RefreshIndexer + Sync,
{
    let fetch_result = fetcher
        .fetch_with_cache(
            &resolution.final_url,
            existing_metadata.etag.as_deref(),
            existing_metadata.last_modified.as_deref(),
        )
        .await?;

    match fetch_result {
        FetchResult::NotModified { .. } => {
            if existing_metadata.filter_non_english.unwrap_or(true) != filter_preference {
                let mut updated_metadata = existing_metadata.clone();
                updated_metadata.filter_non_english = Some(filter_preference);
                storage.save_metadata(alias, &updated_metadata)?;
            }
            Ok(RefreshOutcome::Unchanged {
                alias: alias.to_string(),
            })
        },
        FetchResult::Modified {
            content,
            sha256,
            etag,
            last_modified,
        } => {
            let payload = RefreshPayload {
                content,
                sha256,
                etag,
                last_modified,
            };

            let mut updated_metadata = existing_metadata.clone();
            updated_metadata.url.clone_from(&resolution.final_url);
            updated_metadata.variant = resolution.variant.clone();
            updated_metadata.filter_non_english = Some(filter_preference);

            apply_refresh(
                storage,
                alias,
                updated_metadata,
                existing_aliases,
                payload,
                metrics,
                indexer,
            )
        },
    }
}

/// Re-parse and re-index a source using cached content.
pub fn reindex_source<S, I>(
    storage: &S,
    alias: &str,
    metrics: PerformanceMetrics,
    indexer: &I,
    filter_preference: bool,
) -> Result<ReindexOutcome>
where
    S: RefreshStorage,
    I: RefreshIndexer,
{
    let content = storage.load_llms_txt(alias)?;
    let mut parser = MarkdownParser::new()?;
    let mut parse_result = parser.parse(&content)?;

    let before_count = parse_result.heading_blocks.len();
    apply_language_filter(&mut parse_result, filter_preference);
    let after_count = parse_result.heading_blocks.len();

    let index_path = storage.index_path(alias)?;
    indexer.index(
        alias,
        index_path.as_path(),
        metrics,
        &parse_result.heading_blocks,
    )?;

    Ok(ReindexOutcome {
        alias: alias.to_string(),
        headings_before: before_count,
        headings_after: after_count,
        filtered: before_count.saturating_sub(after_count),
    })
}

/// Apply a refresh: persist content and re-index the source.
#[allow(clippy::too_many_arguments)]
#[allow(clippy::too_many_lines)]
pub fn apply_refresh<S, I>(
    storage: &S,
    alias: &str,
    existing_metadata: Source,
    existing_aliases: Vec<String>,
    payload: RefreshPayload,
    metrics: PerformanceMetrics,
    indexer: &I,
) -> Result<RefreshOutcome>
where
    S: RefreshStorage,
    I: RefreshIndexer,
{
    let mut parser = MarkdownParser::new()?;
    let mut parse_result = parser.parse(&payload.content)?;

    let filter_enabled = existing_metadata.filter_non_english.unwrap_or(true);
    let filter_stats = Some(apply_language_filter(&mut parse_result, filter_enabled));

    storage.save_llms_txt(alias, &payload.content)?;

    let mut llms_json = build_llms_json(
        alias,
        &existing_metadata.url,
        "llms.txt",
        payload.sha256.clone(),
        payload.etag.clone(),
        payload.last_modified.clone(),
        &parse_result,
    );

    let mut metadata_aliases = existing_aliases;
    for alias_value in &existing_metadata.aliases {
        if !metadata_aliases.contains(alias_value) {
            metadata_aliases.push(alias_value.clone());
        }
    }
    metadata_aliases.sort();
    metadata_aliases.dedup();
    llms_json.metadata.aliases = metadata_aliases;
    llms_json.metadata.tags.clone_from(&existing_metadata.tags);
    llms_json
        .metadata
        .description
        .clone_from(&existing_metadata.description);
    llms_json
        .metadata
        .category
        .clone_from(&existing_metadata.category);
    llms_json
        .metadata
        .npm_aliases
        .clone_from(&existing_metadata.npm_aliases);
    llms_json
        .metadata
        .github_aliases
        .clone_from(&existing_metadata.github_aliases);
    llms_json.metadata.variant = existing_metadata.variant.clone();
    llms_json.filter_stats = filter_stats;

    storage.save_llms_json(alias, &llms_json)?;

    let mut origin = existing_metadata.origin.clone();
    origin.source_type = match (&origin.source_type, &existing_metadata.origin.source_type) {
        (Some(SourceType::Remote { .. }), _) | (None, None) => Some(SourceType::Remote {
            url: existing_metadata.url.clone(),
        }),
        (Some(SourceType::LocalFile { path }), _) => {
            Some(SourceType::LocalFile { path: path.clone() })
        },
        (None, Some(existing)) => Some(existing.clone()),
    };

    llms_json.metadata.origin = origin.clone();

    let metadata = Source {
        url: existing_metadata.url,
        etag: payload.etag,
        last_modified: payload.last_modified,
        fetched_at: chrono::Utc::now(),
        sha256: payload.sha256,
        variant: existing_metadata.variant,
        aliases: existing_metadata.aliases,
        tags: existing_metadata.tags,
        description: existing_metadata.description,
        category: existing_metadata.category,
        npm_aliases: existing_metadata.npm_aliases,
        github_aliases: existing_metadata.github_aliases,
        origin,
        filter_non_english: existing_metadata.filter_non_english,
    };
    storage.save_metadata(alias, &metadata)?;

    let index_path = storage.index_path(alias)?;
    indexer.index(
        alias,
        index_path.as_path(),
        metrics,
        &parse_result.heading_blocks,
    )?;

    Ok(RefreshOutcome::Refreshed {
        alias: alias.to_string(),
        headings: count_headings(&llms_json.toc),
        lines: llms_json.line_index.total_lines,
    })
}

fn apply_language_filter(
    parse_result: &mut ParseResult,
    filter_enabled: bool,
) -> HeadingFilterStats {
    let original_count = parse_result.heading_blocks.len();
    if filter_enabled {
        let mut language_filter = LanguageFilter::new(true);
        parse_result.heading_blocks.retain(|block| {
            let urls_in_content = extract_urls_from_content(&block.content);
            let url_check = urls_in_content.is_empty()
                || urls_in_content
                    .iter()
                    .all(|url| language_filter.is_english_url(url));

            let heading_check = language_filter.is_english_heading_path(&block.path);

            url_check && heading_check
        });
    }

    let accepted = parse_result.heading_blocks.len();
    let filtered_count = original_count.saturating_sub(accepted);
    HeadingFilterStats {
        enabled: filter_enabled,
        headings_total: original_count,
        headings_accepted: accepted,
        headings_rejected: filtered_count,
        reason: if filter_enabled {
            "non-English content removed".to_string()
        } else {
            "filtering disabled".to_string()
        },
    }
}

fn count_headings(entries: &[TocEntry]) -> usize {
    entries
        .iter()
        .map(|entry| 1 + count_headings(&entry.children))
        .sum()
}

fn extract_urls_from_content(content: &str) -> Vec<String> {
    let mut urls = Vec::new();

    let mut search_start = 0;
    while let Some(rel) = content[search_start..].find('[') {
        let open_idx = search_start + rel;
        if let Some(close_rel) = content[open_idx + 1..].find(']') {
            let close_idx = open_idx + 1 + close_rel;
            let after_bracket = content.get(close_idx + 1..).unwrap_or("");
            if let Some(rest) = after_bracket.strip_prefix('(') {
                if let Some(paren_rel) = rest.find(')') {
                    if let Some(cleaned) = clean_url_slice(&rest[..paren_rel]) {
                        urls.push(cleaned.to_string());
                    }
                }
            }
        }
        search_start = open_idx + 1;
    }

    urls
}

fn clean_url_slice(s: &str) -> Option<&str> {
    let trimmed = s.trim();
    if trimmed.is_empty() {
        return None;
    }

    let trimmed = trimmed
        .strip_prefix('"')
        .or_else(|| trimmed.strip_prefix('\''))
        .unwrap_or(trimmed);

    let trimmed = trimmed
        .strip_suffix('"')
        .or_else(|| trimmed.strip_suffix('\''))
        .unwrap_or(trimmed);

    let mut end = trimmed.len();
    for (idx, ch) in trimmed.char_indices().rev() {
        if trailing_punctuation(ch) {
            end = idx;
        } else {
            break;
        }
    }

    if end == 0 {
        None
    } else {
        Some(&trimmed[..end])
    }
}

const fn trailing_punctuation(c: char) -> bool {
    matches!(c, ',' | '.' | ';' | ':' | '!' | '?')
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::cell::RefCell;
    use std::collections::HashMap;

    use anyhow::Result;

    #[derive(Default)]
    struct MockStorage {
        metadata: HashMap<String, Source>,
        saved_txt: RefCell<Vec<String>>,
        saved_json: RefCell<Vec<String>>,
        saved_metadata: RefCell<Vec<Source>>,
        index_paths: HashMap<String, PathBuf>,
        cached_txt: HashMap<String, String>,
    }

    impl RefreshStorage for MockStorage {
        fn load_metadata(&self, alias: &str) -> crate::Result<Source> {
            self.metadata
                .get(alias)
                .cloned()
                .ok_or_else(|| crate::Error::NotFound("missing metadata".to_string()))
        }

        fn load_llms_aliases(&self, _alias: &str) -> crate::Result<Vec<String>> {
            Ok(Vec::new())
        }

        fn save_llms_txt(&self, alias: &str, _content: &str) -> crate::Result<()> {
            self.saved_txt.borrow_mut().push(alias.to_string());
            Ok(())
        }

        fn save_llms_json(&self, alias: &str, _data: &crate::LlmsJson) -> crate::Result<()> {
            self.saved_json.borrow_mut().push(alias.to_string());
            Ok(())
        }

        fn save_metadata(&self, _alias: &str, metadata: &Source) -> crate::Result<()> {
            self.saved_metadata.borrow_mut().push(metadata.clone());
            Ok(())
        }

        fn index_path(&self, alias: &str) -> crate::Result<PathBuf> {
            self.index_paths
                .get(alias)
                .cloned()
                .ok_or_else(|| crate::Error::NotFound("missing index path".to_string()))
        }

        fn load_llms_txt(&self, alias: &str) -> crate::Result<String> {
            self.cached_txt
                .get(alias)
                .cloned()
                .ok_or_else(|| crate::Error::NotFound(format!("missing llms.txt for {alias}")))
        }
    }

    #[derive(Default)]
    struct MockIndexer {
        indexed: RefCell<Vec<String>>,
    }

    impl RefreshIndexer for MockIndexer {
        fn index(
            &self,
            alias: &str,
            _index_path: &std::path::Path,
            _metrics: PerformanceMetrics,
            _blocks: &[crate::HeadingBlock],
        ) -> crate::Result<()> {
            self.indexed.borrow_mut().push(alias.to_string());
            Ok(())
        }
    }

    fn sample_source() -> Source {
        Source {
            url: "https://example.com/llms.txt".to_string(),
            etag: None,
            last_modified: None,
            fetched_at: chrono::Utc::now(),
            sha256: "abc123".to_string(),
            variant: crate::SourceVariant::Llms,
            aliases: Vec::new(),
            tags: Vec::new(),
            description: None,
            category: None,
            npm_aliases: Vec::new(),
            github_aliases: Vec::new(),
            origin: crate::SourceOrigin {
                manifest: None,
                source_type: Some(SourceType::Remote {
                    url: "https://example.com/llms.txt".to_string(),
                }),
            },
            filter_non_english: Some(true),
        }
    }

    fn sample_payload() -> RefreshPayload {
        RefreshPayload {
            content: "# Title\n\nSome content.\n".to_string(),
            sha256: "abc123".to_string(),
            etag: None,
            last_modified: None,
        }
    }

    #[test]
    fn apply_refresh_persists_changes() -> Result<()> {
        let mut storage = MockStorage::default();
        storage.metadata.insert("test".to_string(), sample_source());
        storage
            .index_paths
            .insert("test".to_string(), PathBuf::from("index"));

        let indexer = MockIndexer::default();
        let outcome = apply_refresh(
            &storage,
            "test",
            sample_source(),
            Vec::new(),
            sample_payload(),
            PerformanceMetrics::default(),
            &indexer,
        )?;

        assert!(matches!(outcome, RefreshOutcome::Refreshed { .. }));
        assert_eq!(storage.saved_txt.borrow().len(), 1);
        assert_eq!(storage.saved_json.borrow().len(), 1);
        assert_eq!(storage.saved_metadata.borrow().len(), 1);
        assert_eq!(indexer.indexed.borrow().len(), 1);
        Ok(())
    }
}