xz-rag 0.1.1

Multi-channel Retrieval-Augmented Generation engine
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
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
use std::sync::Arc;

use async_trait::async_trait;
use xz_rag::{
    ChannelConfig, ChannelPipeline, ChunkMetadata, ContextBuilder, DefaultRagEngineBuilder,
    Embedder, KnowledgeGraphSearch, MetadataStore, PromptTemplate, RagEngine, RagError, RagRequest,
    RetrieveRequest, SemanticSearch, StructuredFilter,
};

#[tokio::test]
async fn test_engine_builder() {
    let engine = DefaultRagEngineBuilder::default()
        .name("test-engine")
        .version("0.1.0")
        .pipeline(ChannelPipeline::new(vec![ChannelConfig::semantic(0.5, 10)]))
        .build();

    let info = engine.engine_info();
    assert_eq!(info.name, "test-engine");
    assert!(info.supported_channels.contains(&"semantic".to_string()));
}

#[tokio::test]
async fn test_retrieve_empty_returns_error() {
    let engine = DefaultRagEngineBuilder::default().pipeline(ChannelPipeline::new(vec![])).build();

    let request = RetrieveRequest::builder("test query").build();

    let result = engine.retrieve(&request).await.unwrap();
    // Empty pipeline returns empty hits
    assert!(result.hits.is_empty());
    assert!(result.channel_report.is_empty());
}

#[tokio::test]
async fn test_retrieve_and_generate_no_hits() {
    let engine = DefaultRagEngineBuilder::default().pipeline(ChannelPipeline::new(vec![])).build();

    let request = RagRequest::builder("test query").build();

    let result = engine.retrieve_and_generate(&request).await;
    assert!(result.is_err());
}

#[test]
fn test_context_builder() {
    let builder = ContextBuilder::new(4096);
    let budget = builder.context_budget();
    assert!(budget > 0);
}

#[test]
fn test_prompt_template_render() {
    let template = PromptTemplate::default_qa();
    let rendered = template.render("What is Rust?", "Rust is a systems programming language.");
    assert!(rendered.contains("What is Rust?"));
    assert!(rendered.contains("Rust is a systems programming language"));
}

// ── Mock Implementations ──────────────────────────────────────────────

/// Mock embedder returning fixed-dimension dummy vectors.
struct MockEmbedder;

#[async_trait]
impl Embedder for MockEmbedder {
    async fn embed(&self, texts: &[String]) -> Result<Vec<Vec<f32>>, RagError> {
        Ok(texts.iter().map(|_| vec![0.1, 0.2, 0.3]).collect())
    }
    fn dimensions(&self) -> usize {
        3
    }
}

/// Mock semantic search store returning one high-score result.
struct MockSemanticStore;

#[async_trait]
impl SemanticSearch for MockSemanticStore {
    async fn search(
        &self,
        _query_embedding: &[f32],
        _top_k: usize,
        _namespace: Option<&str>,
    ) -> Result<Vec<(String, f32, ChunkMetadata, String, String)>, RagError> {
        Ok(vec![(
            "chunk-sem-1".into(),
            0.95,
            ChunkMetadata::default(),
            "Rust is a systems programming language focused on safety and performance.".into(),
            "doc-1".into(),
        )])
    }
}

/// Mock metadata store returning one result for any query.
struct MockMetadataStore;

#[async_trait]
impl MetadataStore for MockMetadataStore {
    async fn search_by_metadata(
        &self,
        _query: &str,
        _filters: &[StructuredFilter],
        _top_k: usize,
        _namespace: Option<&str>,
    ) -> Result<Vec<(String, f32, ChunkMetadata, String, String)>, RagError> {
        Ok(vec![(
            "chunk-meta-1".into(),
            0.87,
            ChunkMetadata::default(),
            "Tokio is an async runtime for Rust providing a multi-threaded work-stealing scheduler."
                .into(),
            "doc-2".into(),
        )])
    }
}

/// Mock knowledge-graph store.
struct MockGraphStore;

#[async_trait]
impl KnowledgeGraphSearch for MockGraphStore {
    async fn search(
        &self,
        _query: &str,
        _top_k: usize,
    ) -> Result<Vec<(String, f32, ChunkMetadata, String, String)>, RagError> {
        Ok(vec![(
            "graph-node-1".into(),
            0.82,
            ChunkMetadata::default(),
            "Entity: Rust — a systems programming language; relates-to: performance, safety."
                .into(),
            "kg-doc-1".into(),
        )])
    }
}

/// Mock semantic store that returns multiple results for multi-channel fusion tests.
struct MultiResultSemanticStore;

#[async_trait]
impl SemanticSearch for MultiResultSemanticStore {
    async fn search(
        &self,
        _query_embedding: &[f32],
        top_k: usize,
        _namespace: Option<&str>,
    ) -> Result<Vec<(String, f32, ChunkMetadata, String, String)>, RagError> {
        let hits = vec![
            ("chunk-a".into(), 0.95, ChunkMetadata::default(), "Content A".into(), "doc-a".into()),
            ("chunk-b".into(), 0.85, ChunkMetadata::default(), "Content B".into(), "doc-b".into()),
            ("chunk-c".into(), 0.75, ChunkMetadata::default(), "Content C".into(), "doc-c".into()),
        ];
        Ok(hits.into_iter().take(top_k).collect())
    }
}

// ── Integration Tests ─────────────────────────────────────────────────

// 1. End-to-end retrieve with semantic store (mock).
#[tokio::test]
async fn test_retrieve_with_semantic_store() {
    let engine = DefaultRagEngineBuilder::default()
        .name("test-e2e")
        .pipeline(ChannelPipeline::new(vec![ChannelConfig::semantic(0.5, 10)]))
        .embedder(Arc::new(MockEmbedder))
        .semantic_store(Arc::new(MockSemanticStore))
        .build();

    let retrieve_req = RetrieveRequest::builder("What is Rust?")
        .channels(vec![ChannelConfig::semantic(0.5, 10)])
        .build();

    let result = engine.retrieve(&retrieve_req).await.unwrap();

    assert_eq!(result.hits.len(), 1);
    assert!(result.hits[0].content.contains("Rust is a systems"));
    assert!(!result.channel_report.is_empty());
    assert_eq!(result.effective_query, "What is Rust?");
}

// 2. Multi-channel retrieval with fusion (semantic + metadata).
#[tokio::test]
async fn test_multi_channel_retrieval_fusion() {
    let engine = DefaultRagEngineBuilder::default()
        .name("test-multi")
        .pipeline(
            ChannelPipeline::new(vec![
                ChannelConfig::semantic(0.5, 10),
                ChannelConfig::metadata(0.3, 5),
            ])
            .with_rrf_k(60)
            .with_normalize(true),
        )
        .embedder(Arc::new(MockEmbedder))
        .semantic_store(Arc::new(MultiResultSemanticStore))
        .metadata_store(Arc::new(MockMetadataStore))
        .build();

    let retrieve_req = RetrieveRequest::builder("What is async Rust?")
        .channels(vec![ChannelConfig::semantic(0.5, 10), ChannelConfig::metadata(0.3, 5)])
        .top_k(5)
        .build();

    let result = engine.retrieve(&retrieve_req).await.unwrap();

    // Both channels reported.
    assert!(result.channel_report.len() >= 2);
    // Fused results should be at most top_k.
    assert!(result.hits.len() <= 5);
    // Some contents should appear from both channels.
    let all_content: String =
        result.hits.iter().map(|h| &h.content[..]).collect::<Vec<_>>().concat();
    assert!(
        all_content.contains("Content") && all_content.contains("Tokio"),
        "Expected content from both channels in fused results"
    );
    // Effective query should be set.
    assert_eq!(result.effective_query, "What is async Rust?");
}

// 3. Retrieve with graph channel.
#[tokio::test]
async fn test_retrieve_with_graph_channel() {
    let engine = DefaultRagEngineBuilder::default()
        .name("test-graph")
        .pipeline(ChannelPipeline::new(vec![ChannelConfig::new(
            xz_rag::ChannelType::Graph,
            0.4,
            10,
        )]))
        .graph_store(Arc::new(MockGraphStore))
        .build();

    let retrieve_req = RetrieveRequest::builder("rust language")
        .channels(vec![ChannelConfig::new(xz_rag::ChannelType::Graph, 0.4, 10)])
        .build();

    let result = engine.retrieve(&retrieve_req).await.unwrap();

    assert_eq!(result.hits.len(), 1);
    assert_eq!(result.hits[0].chunk_id, "graph-node-1");
    assert!(result.hits[0].content.contains("Entity"));
}

// 4. Empty results → NoResults error.
#[tokio::test]
async fn test_retrieve_and_generate_empty_hits_error() {
    let engine = DefaultRagEngineBuilder::default()
        .name("test-empty")
        .pipeline(ChannelPipeline::new(vec![]))
        .build();

    let rag_req = RagRequest::builder("nobody has this").build();

    let result = engine.retrieve_and_generate(&rag_req).await;
    assert!(result.is_err());
    match result {
        Err(RagError::NoResults(msg)) => {
            assert!(msg.contains("nobody has this"), "Expected query in error, got: {msg}");
        }
        other => panic!("Expected NoResults error, got: {other:?}"),
    }
}

#[cfg(feature = "llm-generation")]
mod streaming_tests {
    use std::pin::Pin;
    use std::sync::Arc;

    use async_trait::async_trait;
    use futures::stream::{self, Stream, StreamExt};
    use xz_provider::{
        CompletionRequest, CompletionResponse, FinishReason, LlmProvider, ModelInfo, ProviderError,
        RequestOptions as ProviderRequestOptions, StreamEvent, TokenUsage,
    };
    use xz_rag::{
        ChannelConfig, ChannelPipeline, ChunkMetadata, DefaultRagEngineBuilder, Embedder,
        RagEngine, RagError, RagRequest, RagStreamEvent, RetrieveRequest, SemanticSearch,
    };

    /// Mock embedder for stream tests.
    struct StreamEmbedder;

    #[async_trait]
    impl Embedder for StreamEmbedder {
        async fn embed(&self, texts: &[String]) -> Result<Vec<Vec<f32>>, RagError> {
            Ok(texts.iter().map(|_| vec![0.1, 0.2, 0.3]).collect())
        }
        fn dimensions(&self) -> usize {
            3
        }
    }

    /// Mock semantic store for stream tests.
    struct StreamSemanticStore;

    #[async_trait]
    impl SemanticSearch for StreamSemanticStore {
        async fn search(
            &self,
            _query_embedding: &[f32],
            _top_k: usize,
            _namespace: Option<&str>,
        ) -> Result<Vec<(String, f32, ChunkMetadata, String, String)>, RagError> {
            Ok(vec![(
                "stream-chunk".into(),
                0.92,
                ChunkMetadata::default(),
                "Streaming is an efficient way to handle large data flows.".into(),
                "doc-stream".into(),
            )])
        }
    }

    /// Mock LLM provider that returns a fixed stream of deltas.
    #[derive(Debug)]
    struct StreamingMockProvider {
        deltas: Vec<String>,
    }

    impl StreamingMockProvider {
        fn new(deltas: Vec<String>) -> Self {
            Self { deltas }
        }
    }

    #[async_trait]
    impl LlmProvider for StreamingMockProvider {
        async fn complete(
            &self,
            _request: CompletionRequest,
            _options: ProviderRequestOptions,
        ) -> Result<CompletionResponse, ProviderError> {
            let all = self.deltas.concat();
            Ok(CompletionResponse {
                content: Some(all),
                thinking: None,
                tool_calls: vec![],
                usage: TokenUsage::new(10, 20),
                model: "mock-model".into(),
                finish_reason: FinishReason::Stop,
                latency_ms: 0,
                cache_info: None,
            })
        }

        async fn complete_stream(
            &self,
            _request: CompletionRequest,
            _options: ProviderRequestOptions,
        ) -> Result<
            Pin<Box<dyn Stream<Item = Result<StreamEvent, ProviderError>> + Send>>,
            ProviderError,
        > {
            let deltas = self.deltas.clone();
            let stream = stream::iter(
                deltas
                    .into_iter()
                    .map(|d| Ok(StreamEvent::ContentDelta { delta: d }))
                    .chain(std::iter::once(Ok(StreamEvent::Done {
                        finish_reason: FinishReason::Stop,
                        usage: Some(TokenUsage::new(10, 20)),
                    })))
                    .collect::<Vec<_>>(),
            );
            Ok(Box::pin(stream))
        }

        fn models(&self) -> &[ModelInfo] {
            &[]
        }

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

    #[tokio::test]
    async fn test_retrieve_and_generate_stream_success() {
        let engine = DefaultRagEngineBuilder::default()
            .name("test-stream")
            .pipeline(ChannelPipeline::new(vec![ChannelConfig::semantic(0.5, 10)]))
            .embedder(Arc::new(StreamEmbedder))
            .semantic_store(Arc::new(StreamSemanticStore))
            .provider(Arc::new(StreamingMockProvider::new(vec![
                "Hello ".into(),
                "streaming ".into(),
                "world!".into(),
            ])))
            .build();

        let retrieve_req = RetrieveRequest::builder("stream test")
            .channels(vec![ChannelConfig::semantic(0.5, 10)])
            .build();

        let rag_req = RagRequest::builder("stream test").retrieve_config(retrieve_req).build();

        let mut stream = engine.retrieve_and_generate_stream(&rag_req).await.unwrap();

        let mut events: Vec<RagStreamEvent> = vec![];
        while let Some(event) = stream.next().await {
            events.push(event.unwrap());
        }

        assert!(events.len() >= 3, "Expected at least 3 events, got {}", events.len());

        let started = events.iter().any(|e| matches!(e, RagStreamEvent::GenerationStarted { .. }));
        assert!(started, "Missing GenerationStarted event");

        let deltas: Vec<&str> = events
            .iter()
            .filter_map(|e| {
                if let RagStreamEvent::ContentDelta { delta } = e {
                    Some(delta.as_str())
                } else {
                    None
                }
            })
            .collect();
        let full: String = deltas.concat();
        assert_eq!(full, "Hello streaming world!");

        let done = events.iter().any(|e| matches!(e, RagStreamEvent::Done { .. }));
        assert!(done, "Missing Done event");
    }

    #[tokio::test]
    async fn test_retrieve_and_generate_stream_empty_hits() {
        let engine = DefaultRagEngineBuilder::default()
            .name("test-stream-empty")
            .pipeline(ChannelPipeline::new(vec![]))
            .provider(Arc::new(StreamingMockProvider::new(vec![])))
            .build();

        let rag_req = RagRequest::builder("no results").build();

        let result = engine.retrieve_and_generate_stream(&rag_req).await;
        assert!(result.is_err());
        match result {
            Err(RagError::NoResults(msg)) => {
                assert!(msg.contains("no results"));
            }
            _other => panic!("Expected NoResults, got unexpected result"),
        }
    }
}

// 5. Retrieve preserves effective_query after preprocessing.
#[tokio::test]
async fn test_retrieve_effective_query_tracking() {
    let engine = DefaultRagEngineBuilder::default()
        .name("test-eff-query")
        .pipeline(ChannelPipeline::new(vec![]))
        .build();

    let retrieve_req = RetrieveRequest::builder("original search phrase").build();
    let result = engine.retrieve(&retrieve_req).await.unwrap();

    assert_eq!(result.effective_query, "original search phrase");
    assert!(result.hits.is_empty());
}

// 6. retrieve with chat history — history is only used during generation;
// this test verifies retrieval works and the effective query is preserved.
#[tokio::test]
async fn test_retrieve_with_chat_history_setup() {
    let engine = DefaultRagEngineBuilder::default()
        .name("test-history")
        .pipeline(ChannelPipeline::new(vec![ChannelConfig::semantic(0.5, 10)]))
        .embedder(Arc::new(MockEmbedder))
        .semantic_store(Arc::new(MockSemanticStore))
        .build();

    let retrieve_req = RetrieveRequest::builder("What about memory safety?")
        .channels(vec![ChannelConfig::semantic(0.5, 10)])
        .build();

    let result = engine.retrieve(&retrieve_req).await.unwrap();

    assert_eq!(result.hits.len(), 1);
    assert!(result.hits[0].content.contains("Rust is a systems"));
    assert_eq!(result.effective_query, "What about memory safety?");
}

// 7. Query preprocessing HYDE — behavior depends on feature flags.
#[tokio::test]
async fn test_retrieve_with_hyde_preprocessing() {
    use xz_rag::QueryPreprocessing;

    let engine = DefaultRagEngineBuilder::default()
        .name("test-hyde")
        .pipeline(ChannelPipeline::new(vec![]))
        .build();

    let retrieve_req = RetrieveRequest {
        query: "explain Rust ownership".into(),
        channels: vec![],
        global_filters: vec![],
        top_k: 10,
        namespace: None,
        include_embeddings: false,
        query_preprocessing: Some(QueryPreprocessing::Hyde),
    };

    let result = engine.retrieve(&retrieve_req).await;

    // With hyde feature + no provider → error; without hyde → returns original query.
    match result {
        Ok(retrieve_result) => {
            assert_eq!(retrieve_result.effective_query, "explain Rust ownership");
            assert!(retrieve_result.hits.is_empty());
        }
        Err(RagError::QueryPreprocessing(_)) => {
            // Expected when hyde feature is active but no provider configured.
        }
        Err(other) => panic!("Unexpected error: {other:?}"),
    }
}

// 8. Full builder with all channel types and engine_info validation.
#[tokio::test]
async fn test_engine_builder_full_config() {
    let engine = DefaultRagEngineBuilder::default()
        .name("full-engine")
        .version("1.0.0-test")
        .pipeline(
            ChannelPipeline::new(vec![
                ChannelConfig::semantic(0.5, 10).with_min_score(0.1),
                ChannelConfig::metadata(0.3, 5),
                ChannelConfig::new(xz_rag::ChannelType::Bm25, 0.2, 3),
            ])
            .with_rrf_k(60),
        )
        .embedder(Arc::new(MockEmbedder))
        .semantic_store(Arc::new(MockSemanticStore))
        .metadata_store(Arc::new(MockMetadataStore))
        .context_builder(ContextBuilder::new(8192))
        .prompt_template(PromptTemplate::default_qa())
        .build();

    let info = engine.engine_info();
    assert_eq!(info.name, "full-engine");
    assert_eq!(info.version, "1.0.0-test");
    assert!(info.supported_channels.contains(&"semantic".to_string()));
    assert!(info.supported_channels.contains(&"metadata".to_string()));
    assert_eq!(info.max_context_window, 7296);

    let retrieve_req = RetrieveRequest::builder("test all channels")
        .channels(vec![ChannelConfig::semantic(0.5, 10), ChannelConfig::metadata(0.3, 5)])
        .top_k(5)
        .build();

    let result = engine.retrieve(&retrieve_req).await.unwrap();
    assert!(!result.hits.is_empty());
    assert!(result.channel_report.len() >= 2);
}

// 9. retrieve_and_generate with system_prompt override — requires LLM provider;
// this test verifies retrieval with a custom system_prompt route.
#[tokio::test]
async fn test_retrieve_with_system_prompt_setup() {
    let engine = DefaultRagEngineBuilder::default()
        .name("test-custom-system")
        .pipeline(ChannelPipeline::new(vec![ChannelConfig::semantic(0.5, 10)]))
        .embedder(Arc::new(MockEmbedder))
        .semantic_store(Arc::new(MockSemanticStore))
        .build();

    let retrieve_req = RetrieveRequest::builder("Rust traits")
        .channels(vec![ChannelConfig::semantic(0.5, 10)])
        .build();

    let result = engine.retrieve(&retrieve_req).await.unwrap();

    assert_eq!(result.hits.len(), 1);
    assert!(result.hits[0].content.contains("Rust is a systems"));
}

// 10. verify retrieve result includes stats and metadata.
#[tokio::test]
async fn test_retrieve_result_includes_stats() {
    let engine = DefaultRagEngineBuilder::default()
        .name("test-stats")
        .pipeline(ChannelPipeline::new(vec![ChannelConfig::semantic(0.5, 10)]))
        .embedder(Arc::new(MockEmbedder))
        .semantic_store(Arc::new(MockSemanticStore))
        .build();

    let retrieve_req = RetrieveRequest::builder("stats test")
        .channels(vec![ChannelConfig::semantic(0.5, 10)])
        .build();

    let result = engine.retrieve(&retrieve_req).await.unwrap();

    assert!(!result.channel_report.is_empty());
    assert_eq!(result.hits.len(), 1);
    assert_eq!(result.effective_query, "stats test");
    let _ = result.latency_ms; // smoke check: latency_ms is populated
}

// ── Rerank Integration Tests ──────────────────────────────────────────

#[cfg(feature = "rerank")]
mod rerank_tests {
    use std::sync::Arc;

    use xz_rag::{
        ChannelConfig, ChannelPipeline, ChunkMetadata, DefaultRagEngineBuilder, Embedder,
        RagEngine, RagError, RetrieveRequest, SemanticSearch,
    };
    use xz_rerank::MockReranker;

    struct RerankEmbedder;

    #[async_trait::async_trait]
    impl Embedder for RerankEmbedder {
        async fn embed(&self, texts: &[String]) -> Result<Vec<Vec<f32>>, RagError> {
            Ok(texts.iter().map(|_| vec![0.1, 0.2, 0.3]).collect())
        }
        fn dimensions(&self) -> usize {
            3
        }
    }

    struct RerankSemanticStore;

    #[async_trait::async_trait]
    impl SemanticSearch for RerankSemanticStore {
        async fn search(
            &self,
            _query_embedding: &[f32],
            top_k: usize,
            _namespace: Option<&str>,
        ) -> Result<Vec<(String, f32, ChunkMetadata, String, String)>, RagError> {
            let all = vec![
                (
                    "r1".into(),
                    0.60,
                    ChunkMetadata::default(),
                    "First candidate content".into(),
                    "doc-r1".into(),
                ),
                (
                    "r2".into(),
                    0.85,
                    ChunkMetadata::default(),
                    "Second candidate content".into(),
                    "doc-r2".into(),
                ),
                (
                    "r3".into(),
                    0.50,
                    ChunkMetadata::default(),
                    "Third candidate content".into(),
                    "doc-r3".into(),
                ),
            ];
            Ok(all.into_iter().take(top_k).collect())
        }
    }

    #[tokio::test]
    async fn test_rerank_integration_with_mock_reranker() {
        let engine = DefaultRagEngineBuilder::default()
            .name("test-rerank")
            .pipeline(ChannelPipeline::new(vec![ChannelConfig::semantic(0.5, 10)]))
            .embedder(Arc::new(RerankEmbedder))
            .semantic_store(Arc::new(RerankSemanticStore))
            .reranker(Arc::new(MockReranker::new("mock-reranker")))
            .build();

        let retrieve_req = RetrieveRequest::builder("important query")
            .channels(vec![ChannelConfig::semantic(0.5, 10)])
            .top_k(2)
            .build();

        let result = engine.retrieve(&retrieve_req).await.unwrap();

        assert_eq!(result.hits.len(), 2);
        let hit_ids: Vec<&str> = result.hits.iter().map(|h| h.chunk_id.as_str()).collect();
        assert!(hit_ids.contains(&"r2"), "Expected r2 in top results, got: {hit_ids:?}");

        let info = engine.engine_info();
        assert!(info.reranking_enabled);
    }

    #[tokio::test]
    async fn test_rerank_engine_info_reflects_reranker() {
        let engine = DefaultRagEngineBuilder::default()
            .name("test-rerank-info")
            .pipeline(ChannelPipeline::new(vec![ChannelConfig::semantic(0.5, 10)]))
            .reranker(Arc::new(MockReranker::new("mock-reranker")))
            .build();

        let info = engine.engine_info();
        assert!(info.reranking_enabled);
        assert_eq!(info.name, "test-rerank-info");
    }
}

#[cfg(feature = "llm-generation")]
mod llm_tests {
    use std::pin::Pin;
    use std::sync::Arc;

    use async_trait::async_trait;
    use futures::Stream;
    use xz_provider::{
        CompletionRequest, CompletionResponse, FinishReason, LlmProvider, ModelInfo, ProviderError,
        RequestOptions, StreamEvent, TokenUsage,
    };
    use xz_rag::{
        ChannelConfig, ChannelPipeline, ChunkMetadata, DefaultRagEngineBuilder, MetadataStore,
        RagEngine, RagError, RagRequest, RetrieveRequest, StructuredFilter,
    };

    /// Mock LLM provider that always returns an error.
    #[derive(Debug)]
    struct FailingProvider;

    #[async_trait]
    impl LlmProvider for FailingProvider {
        async fn complete(
            &self,
            _request: CompletionRequest,
            _options: RequestOptions,
        ) -> Result<CompletionResponse, ProviderError> {
            Err(ProviderError::Config("mock LLM failure".into()))
        }

        async fn complete_stream(
            &self,
            _request: CompletionRequest,
            _options: RequestOptions,
        ) -> Result<
            Pin<Box<dyn Stream<Item = Result<StreamEvent, ProviderError>> + Send>>,
            ProviderError,
        > {
            Err(ProviderError::Config("mock LLM stream failure".into()))
        }

        fn models(&self) -> &[ModelInfo] {
            &[]
        }

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

    /// Mock LLM provider that returns a successful response.
    #[derive(Debug)]
    struct SuccessMockProvider;

    #[async_trait]
    impl LlmProvider for SuccessMockProvider {
        async fn complete(
            &self,
            _request: CompletionRequest,
            _options: RequestOptions,
        ) -> Result<CompletionResponse, ProviderError> {
            Ok(CompletionResponse {
                content: Some("Rust is a modern systems programming language.".into()),
                thinking: None,
                tool_calls: vec![],
                usage: TokenUsage::new(10, 20),
                model: "mock-model".into(),
                finish_reason: FinishReason::Stop,
                latency_ms: 0,
                cache_info: None,
            })
        }

        async fn complete_stream(
            &self,
            _request: CompletionRequest,
            _options: RequestOptions,
        ) -> Result<
            Pin<Box<dyn Stream<Item = Result<StreamEvent, ProviderError>> + Send>>,
            ProviderError,
        > {
            Err(ProviderError::Config("streaming not supported".into()))
        }

        fn models(&self) -> &[ModelInfo] {
            &[]
        }

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

    /// Mock metadata store that returns one result so retrieval succeeds.
    #[derive(Debug)]
    struct MockMetadataStore;

    #[async_trait]
    impl MetadataStore for MockMetadataStore {
        async fn search_by_metadata(
            &self,
            _query: &str,
            _filters: &[StructuredFilter],
            _top_k: usize,
            _namespace: Option<&str>,
        ) -> Result<Vec<(String, f32, ChunkMetadata, String, String)>, RagError> {
            Ok(vec![(
                "chunk-1".into(),
                0.9,
                ChunkMetadata::default(),
                "Rust is a systems programming language for performance and safety.".into(),
                "doc-1".into(),
            )])
        }
    }

    #[tokio::test]
    async fn test_llm_failure_propagates_error() {
        let engine = DefaultRagEngineBuilder::default()
            .name("test-engine")
            .pipeline(ChannelPipeline::new(vec![ChannelConfig::metadata(0.5, 10)]))
            .metadata_store(Arc::new(MockMetadataStore))
            .provider(Arc::new(FailingProvider))
            .build();

        let retrieve_req = RetrieveRequest::builder("What is Rust?")
            .channels(vec![ChannelConfig::metadata(0.5, 10)])
            .build();

        let rag_request =
            RagRequest::builder("What is Rust?").retrieve_config(retrieve_req).build();

        let result = engine.retrieve_and_generate(&rag_request).await;

        assert!(result.is_err(), "Expected error from failing LLM provider, but got success");

        match result {
            Err(RagError::Provider(msg)) => {
                assert!(
                    msg.contains("LLM generation failed"),
                    "Expected Provider error about LLM generation failure, got: {}",
                    msg
                );
            }
            other => panic!("Expected Err(RagError::Provider(...)), got: {:?}", other),
        }
    }

    #[tokio::test]
    async fn test_no_provider_configured_returns_error() {
        let engine = DefaultRagEngineBuilder::default()
            .name("test-engine")
            .pipeline(ChannelPipeline::new(vec![ChannelConfig::metadata(0.5, 10)]))
            .metadata_store(Arc::new(MockMetadataStore))
            .build();

        let retrieve_req = RetrieveRequest::builder("What is Rust?")
            .channels(vec![ChannelConfig::metadata(0.5, 10)])
            .build();

        let rag_request =
            RagRequest::builder("What is Rust?").retrieve_config(retrieve_req).build();

        let result = engine.retrieve_and_generate(&rag_request).await;

        assert!(result.is_err(), "Expected error when no provider configured, but got success");

        match result {
            Err(RagError::Provider(msg)) => {
                assert!(
                    msg.contains("no LLM provider configured"),
                    "Expected 'no LLM provider configured', got: {}",
                    msg
                );
            }
            other => panic!("Expected Err(RagError::Provider(...)), got: {:?}", other),
        }
    }

    #[tokio::test]
    async fn test_retrieve_and_generate_with_mock_provider() {
        let engine = DefaultRagEngineBuilder::default()
            .name("test-e2e-gen")
            .pipeline(ChannelPipeline::new(vec![ChannelConfig::metadata(0.5, 10)]))
            .metadata_store(Arc::new(MockMetadataStore))
            .provider(Arc::new(SuccessMockProvider))
            .build();

        let retrieve_req = RetrieveRequest::builder("What is Rust?")
            .channels(vec![ChannelConfig::metadata(0.5, 10)])
            .build();

        let rag_req = RagRequest::builder("What is Rust?").retrieve_config(retrieve_req).build();

        let response = engine.retrieve_and_generate(&rag_req).await.unwrap();

        assert!(response.answer.contains("Rust is"));
        assert_eq!(response.retrieve_stats.hits.len(), 1);
    }
}