hermes_core/
index.rs

1//! Index - multi-segment async search index
2//!
3//! Components:
4//! - Index: main entry point for searching
5//! - IndexWriter: for adding documents and committing segments
6//! - Supports multiple segments with merge
7
8use std::path::Path;
9use std::sync::Arc;
10
11use parking_lot::RwLock;
12#[cfg(feature = "native")]
13use rustc_hash::FxHashMap;
14
15use crate::DocId;
16#[cfg(feature = "native")]
17use crate::directories::DirectoryWriter;
18use crate::directories::{Directory, SliceCachingDirectory};
19use crate::dsl::{Document, Field, Schema};
20use crate::error::{Error, Result};
21#[cfg(feature = "native")]
22use crate::segment::{SegmentBuilder, SegmentBuilderConfig, SegmentMerger};
23use crate::segment::{SegmentId, SegmentReader};
24use crate::structures::BlockPostingList;
25#[cfg(feature = "native")]
26use crate::tokenizer::BoxedTokenizer;
27
28#[cfg(feature = "native")]
29use tokio::sync::Mutex as AsyncMutex;
30
31/// Default file name for the slice cache
32pub const SLICE_CACHE_FILENAME: &str = "index.slicecache";
33
34/// Index configuration
35#[derive(Debug, Clone)]
36pub struct IndexConfig {
37    /// Number of threads for CPU-intensive tasks (search parallelism)
38    pub num_threads: usize,
39    /// Number of parallel segment builders (documents distributed round-robin)
40    pub num_indexing_threads: usize,
41    /// Number of threads for parallel block compression within each segment
42    pub num_compression_threads: usize,
43    /// Block cache size for term dictionary per segment
44    pub term_cache_blocks: usize,
45    /// Block cache size for document store per segment
46    pub store_cache_blocks: usize,
47    /// Max documents per segment before auto-commit
48    pub max_docs_per_segment: u32,
49    /// Index optimization mode (adaptive, size-optimized, performance-optimized)
50    pub optimization: crate::structures::IndexOptimization,
51}
52
53impl Default for IndexConfig {
54    fn default() -> Self {
55        #[cfg(feature = "native")]
56        let cpus = num_cpus::get().max(1);
57        #[cfg(not(feature = "native"))]
58        let cpus = 1;
59
60        Self {
61            num_threads: cpus,
62            num_indexing_threads: 1,
63            num_compression_threads: cpus,
64            term_cache_blocks: 256,
65            store_cache_blocks: 32,
66            max_docs_per_segment: 100_000,
67            optimization: crate::structures::IndexOptimization::default(),
68        }
69    }
70}
71
72/// Multi-segment async Index
73///
74/// The main entry point for searching. Manages multiple segments
75/// and provides unified search across all of them.
76pub struct Index<D: Directory> {
77    directory: Arc<D>,
78    schema: Arc<Schema>,
79    config: IndexConfig,
80    segments: RwLock<Vec<Arc<SegmentReader>>>,
81    default_fields: Vec<crate::Field>,
82    tokenizers: Arc<crate::tokenizer::TokenizerRegistry>,
83    #[cfg(feature = "native")]
84    thread_pool: Arc<rayon::ThreadPool>,
85}
86
87impl<D: Directory> Index<D> {
88    /// Open an existing index from a directory
89    pub async fn open(directory: D, config: IndexConfig) -> Result<Self> {
90        let directory = Arc::new(directory);
91
92        // Read schema
93        let schema_slice = directory.open_read(Path::new("schema.json")).await?;
94        let schema_bytes = schema_slice.read_bytes().await?;
95        let schema: Schema = serde_json::from_slice(schema_bytes.as_slice())
96            .map_err(|e| Error::Serialization(e.to_string()))?;
97        let schema = Arc::new(schema);
98
99        // Read segment list
100        let segments = Self::load_segments(&directory, &schema, &config).await?;
101
102        #[cfg(feature = "native")]
103        let thread_pool = {
104            let pool = rayon::ThreadPoolBuilder::new()
105                .num_threads(config.num_threads)
106                .build()
107                .map_err(|e| Error::Io(std::io::Error::other(e)))?;
108            Arc::new(pool)
109        };
110
111        // Use schema's default_fields if specified, otherwise fall back to all indexed text fields
112        let default_fields: Vec<crate::Field> = if !schema.default_fields().is_empty() {
113            schema.default_fields().to_vec()
114        } else {
115            schema
116                .fields()
117                .filter(|(_, entry)| {
118                    entry.indexed && entry.field_type == crate::dsl::FieldType::Text
119                })
120                .map(|(field, _)| field)
121                .collect()
122        };
123
124        Ok(Self {
125            directory,
126            schema,
127            config,
128            segments: RwLock::new(segments),
129            default_fields,
130            tokenizers: Arc::new(crate::tokenizer::TokenizerRegistry::default()),
131            #[cfg(feature = "native")]
132            thread_pool,
133        })
134    }
135
136    async fn load_segments(
137        directory: &Arc<D>,
138        schema: &Arc<Schema>,
139        config: &IndexConfig,
140    ) -> Result<Vec<Arc<SegmentReader>>> {
141        // Read segments.json which lists all segment IDs
142        let segments_path = Path::new("segments.json");
143        if !directory.exists(segments_path).await? {
144            return Ok(Vec::new());
145        }
146
147        let segments_slice = directory.open_read(segments_path).await?;
148        let segments_bytes = segments_slice.read_bytes().await?;
149        let segment_ids: Vec<String> = serde_json::from_slice(segments_bytes.as_slice())
150            .map_err(|e| Error::Serialization(e.to_string()))?;
151
152        let mut segments = Vec::new();
153        let mut doc_id_offset = 0u32;
154
155        for id_str in segment_ids {
156            let segment_id = SegmentId::from_hex(&id_str)
157                .ok_or_else(|| Error::Corruption(format!("Invalid segment ID: {}", id_str)))?;
158            let reader = SegmentReader::open(
159                directory.as_ref(),
160                segment_id,
161                Arc::clone(schema),
162                doc_id_offset,
163                config.term_cache_blocks,
164            )
165            .await?;
166
167            doc_id_offset += reader.meta().num_docs;
168            segments.push(Arc::new(reader));
169        }
170
171        Ok(segments)
172    }
173
174    /// Get the schema
175    pub fn schema(&self) -> &Schema {
176        &self.schema
177    }
178
179    /// Get a reference to the underlying directory
180    pub fn directory(&self) -> &D {
181        &self.directory
182    }
183
184    /// Total number of documents across all segments
185    pub fn num_docs(&self) -> u32 {
186        self.segments.read().iter().map(|s| s.num_docs()).sum()
187    }
188
189    /// Get a document by global doc_id (async)
190    pub async fn doc(&self, doc_id: DocId) -> Result<Option<Document>> {
191        let segments = self.segments.read().clone();
192
193        let mut offset = 0u32;
194        for segment in segments.iter() {
195            let segment_docs = segment.meta().num_docs;
196            if doc_id < offset + segment_docs {
197                let local_doc_id = doc_id - offset;
198                return segment.doc(local_doc_id).await;
199            }
200            offset += segment_docs;
201        }
202
203        Ok(None)
204    }
205
206    /// Get posting lists for a term across all segments (async)
207    pub async fn get_postings(
208        &self,
209        field: Field,
210        term: &[u8],
211    ) -> Result<Vec<(Arc<SegmentReader>, BlockPostingList)>> {
212        let segments = self.segments.read().clone();
213        let mut results = Vec::new();
214
215        for segment in segments.iter() {
216            if let Some(postings) = segment.get_postings(field, term).await? {
217                results.push((Arc::clone(segment), postings));
218            }
219        }
220
221        Ok(results)
222    }
223
224    /// Execute CPU-intensive work on thread pool (native only)
225    #[cfg(feature = "native")]
226    pub async fn spawn_blocking<F, R>(&self, f: F) -> R
227    where
228        F: FnOnce() -> R + Send + 'static,
229        R: Send + 'static,
230    {
231        let (tx, rx) = tokio::sync::oneshot::channel();
232        self.thread_pool.spawn(move || {
233            let result = f();
234            let _ = tx.send(result);
235        });
236        rx.await.expect("Thread pool task panicked")
237    }
238
239    /// Get segment readers for query execution
240    pub fn segment_readers(&self) -> Vec<Arc<SegmentReader>> {
241        self.segments.read().clone()
242    }
243
244    /// Reload segments from directory (after new segments added)
245    pub async fn reload(&self) -> Result<()> {
246        let new_segments = Self::load_segments(&self.directory, &self.schema, &self.config).await?;
247        *self.segments.write() = new_segments;
248        Ok(())
249    }
250
251    /// Search across all segments
252    pub async fn search(
253        &self,
254        query: &dyn crate::query::Query,
255        limit: usize,
256    ) -> Result<Vec<crate::query::SearchResult>> {
257        let segments = self.segments.read().clone();
258        let mut all_results = Vec::new();
259
260        for segment in &segments {
261            let results = crate::query::search_segment(segment.as_ref(), query, limit).await?;
262            all_results.extend(results);
263        }
264
265        // Sort by score descending
266        all_results.sort_by(|a, b| {
267            b.score
268                .partial_cmp(&a.score)
269                .unwrap_or(std::cmp::Ordering::Equal)
270        });
271        all_results.truncate(limit);
272
273        Ok(all_results)
274    }
275
276    /// Search and return results with document addresses (no document content)
277    pub async fn search_with_addresses(
278        &self,
279        query: &dyn crate::query::Query,
280        limit: usize,
281    ) -> Result<crate::query::SearchResponse> {
282        let segments = self.segments.read().clone();
283        let mut all_results: Vec<(u128, crate::query::SearchResult)> = Vec::new();
284
285        for segment in &segments {
286            let segment_id = segment.meta().id;
287            let results = crate::query::search_segment(segment.as_ref(), query, limit).await?;
288            for result in results {
289                all_results.push((segment_id, result));
290            }
291        }
292
293        // Sort by score descending
294        all_results.sort_by(|a, b| {
295            b.1.score
296                .partial_cmp(&a.1.score)
297                .unwrap_or(std::cmp::Ordering::Equal)
298        });
299        all_results.truncate(limit);
300
301        let total_hits = all_results.len() as u32;
302        let hits: Vec<crate::query::SearchHit> = all_results
303            .into_iter()
304            .map(|(segment_id, result)| crate::query::SearchHit {
305                address: crate::query::DocAddress::new(segment_id, result.doc_id),
306                score: result.score,
307            })
308            .collect();
309
310        Ok(crate::query::SearchResponse { hits, total_hits })
311    }
312
313    /// Get a document by its unique address (segment_id + local doc_id)
314    pub async fn get_document(
315        &self,
316        address: &crate::query::DocAddress,
317    ) -> Result<Option<Document>> {
318        let segment_id = address
319            .segment_id_u128()
320            .ok_or_else(|| Error::Query(format!("Invalid segment ID: {}", address.segment_id)))?;
321
322        let segments = self.segments.read().clone();
323        for segment in &segments {
324            if segment.meta().id == segment_id {
325                return segment.doc(address.doc_id).await;
326            }
327        }
328
329        Ok(None)
330    }
331
332    /// Get the default fields for this index
333    pub fn default_fields(&self) -> &[crate::Field] {
334        &self.default_fields
335    }
336
337    /// Set the default fields for query parsing
338    pub fn set_default_fields(&mut self, fields: Vec<crate::Field>) {
339        self.default_fields = fields;
340    }
341
342    /// Get the tokenizer registry
343    pub fn tokenizers(&self) -> &Arc<crate::tokenizer::TokenizerRegistry> {
344        &self.tokenizers
345    }
346
347    /// Create a query parser for this index
348    ///
349    /// If the schema contains query router rules, they will be used to route
350    /// queries to specific fields based on regex patterns.
351    pub fn query_parser(&self) -> crate::dsl::QueryLanguageParser {
352        // Check if schema has query routers
353        let query_routers = self.schema.query_routers();
354        if !query_routers.is_empty() {
355            // Try to create a router from the schema's rules
356            if let Ok(router) = crate::dsl::QueryFieldRouter::from_rules(query_routers) {
357                return crate::dsl::QueryLanguageParser::with_router(
358                    Arc::clone(&self.schema),
359                    self.default_fields.clone(),
360                    Arc::clone(&self.tokenizers),
361                    router,
362                );
363            }
364        }
365
366        // Fall back to parser without router
367        crate::dsl::QueryLanguageParser::new(
368            Arc::clone(&self.schema),
369            self.default_fields.clone(),
370            Arc::clone(&self.tokenizers),
371        )
372    }
373
374    /// Parse and search using a query string
375    ///
376    /// Accepts both query language syntax (field:term, AND, OR, NOT, grouping)
377    /// and simple text (tokenized and searched across default fields).
378    /// Returns document addresses (segment_id + doc_id) without document content.
379    pub async fn query(
380        &self,
381        query_str: &str,
382        limit: usize,
383    ) -> Result<crate::query::SearchResponse> {
384        let parser = self.query_parser();
385        let query = parser.parse(query_str).map_err(Error::Query)?;
386        self.search_with_addresses(query.as_ref(), limit).await
387    }
388}
389
390/// Methods for opening index with slice caching
391impl<D: Directory> Index<SliceCachingDirectory<D>> {
392    /// Open an index with slice caching, automatically loading the cache file if present
393    ///
394    /// This wraps the directory in a SliceCachingDirectory and attempts to load
395    /// any existing slice cache file to prefill the cache with hot data.
396    pub async fn open_with_cache(
397        directory: D,
398        config: IndexConfig,
399        cache_max_bytes: usize,
400    ) -> Result<Self> {
401        let caching_dir = SliceCachingDirectory::new(directory, cache_max_bytes);
402
403        // Try to load existing slice cache
404        let cache_path = Path::new(SLICE_CACHE_FILENAME);
405        if let Ok(true) = caching_dir.inner().exists(cache_path).await
406            && let Ok(slice) = caching_dir.inner().open_read(cache_path).await
407            && let Ok(bytes) = slice.read_bytes().await
408        {
409            let _ = caching_dir.deserialize(bytes.as_slice());
410        }
411
412        Self::open(caching_dir, config).await
413    }
414
415    /// Serialize the current slice cache to the index directory
416    ///
417    /// This saves all cached slices to a single file that can be loaded
418    /// on subsequent index opens for faster startup.
419    #[cfg(feature = "native")]
420    pub async fn save_slice_cache(&self) -> Result<()>
421    where
422        D: DirectoryWriter,
423    {
424        let cache_data = self.directory.serialize();
425        let cache_path = Path::new(SLICE_CACHE_FILENAME);
426        self.directory
427            .inner()
428            .write(cache_path, &cache_data)
429            .await?;
430        Ok(())
431    }
432
433    /// Get slice cache statistics
434    pub fn slice_cache_stats(&self) -> crate::directories::SliceCacheStats {
435        self.directory.stats()
436    }
437}
438
439/// Warm up the slice cache by opening an index and performing typical read operations
440///
441/// This function opens an index using a SliceCachingDirectory, performs operations
442/// that would typically be done during search (reading term dictionaries, posting lists),
443/// and then serializes the cache to a file for future use.
444///
445/// The resulting cache file contains all the "hot" data that was read during warmup,
446/// allowing subsequent index opens to prefill the cache and avoid cold-start latency.
447#[cfg(feature = "native")]
448pub async fn warmup_and_save_slice_cache<D: DirectoryWriter>(
449    directory: D,
450    config: IndexConfig,
451    cache_max_bytes: usize,
452) -> Result<()> {
453    let caching_dir = SliceCachingDirectory::new(directory, cache_max_bytes);
454    let index = Index::open(caching_dir, config).await?;
455
456    // Warm up by loading segment metadata and term dictionaries
457    // The SegmentReader::open already reads essential metadata
458    // Additional warmup can be done by iterating terms or doing sample queries
459
460    // Save the cache
461    index.save_slice_cache().await?;
462
463    Ok(())
464}
465
466#[cfg(feature = "native")]
467impl<D: Directory> Clone for Index<D> {
468    fn clone(&self) -> Self {
469        Self {
470            directory: Arc::clone(&self.directory),
471            schema: Arc::clone(&self.schema),
472            config: self.config.clone(),
473            segments: RwLock::new(self.segments.read().clone()),
474            default_fields: self.default_fields.clone(),
475            tokenizers: Arc::clone(&self.tokenizers),
476            thread_pool: Arc::clone(&self.thread_pool),
477        }
478    }
479}
480
481/// Async IndexWriter for adding documents and committing segments
482///
483/// Features:
484/// - Streams documents to disk immediately (no in-memory document storage)
485/// - Uses string interning for terms (reduced allocations)
486/// - Uses hashbrown HashMap (faster than BTreeMap)
487/// - Spills large posting lists to disk (bounded memory)
488/// - Uses memory-mapped files for intermediate data
489#[cfg(feature = "native")]
490pub struct IndexWriter<D: DirectoryWriter> {
491    directory: Arc<D>,
492    schema: Arc<Schema>,
493    config: IndexConfig,
494    builder_config: SegmentBuilderConfig,
495    tokenizers: FxHashMap<Field, BoxedTokenizer>,
496    /// Segment builder
497    builder: AsyncMutex<Option<SegmentBuilder>>,
498    /// List of committed segment IDs (hex strings)
499    segment_ids: AsyncMutex<Vec<String>>,
500}
501
502#[cfg(feature = "native")]
503impl<D: DirectoryWriter> IndexWriter<D> {
504    /// Create a new index in the directory
505    pub async fn create(directory: D, schema: Schema, config: IndexConfig) -> Result<Self> {
506        Self::create_with_config(directory, schema, config, SegmentBuilderConfig::default()).await
507    }
508
509    /// Create a new index with custom builder config
510    pub async fn create_with_config(
511        directory: D,
512        schema: Schema,
513        config: IndexConfig,
514        builder_config: SegmentBuilderConfig,
515    ) -> Result<Self> {
516        let directory = Arc::new(directory);
517        let schema = Arc::new(schema);
518
519        // Write schema
520        let schema_bytes =
521            serde_json::to_vec(&*schema).map_err(|e| Error::Serialization(e.to_string()))?;
522        directory
523            .write(Path::new("schema.json"), &schema_bytes)
524            .await?;
525
526        // Write empty segments list
527        let segments_bytes = serde_json::to_vec(&Vec::<String>::new())
528            .map_err(|e| Error::Serialization(e.to_string()))?;
529        directory
530            .write(Path::new("segments.json"), &segments_bytes)
531            .await?;
532
533        Ok(Self {
534            directory,
535            schema,
536            config,
537            builder_config,
538            tokenizers: FxHashMap::default(),
539            builder: AsyncMutex::new(None),
540            segment_ids: AsyncMutex::new(Vec::new()),
541        })
542    }
543
544    /// Open an existing index for writing
545    pub async fn open(directory: D, config: IndexConfig) -> Result<Self> {
546        Self::open_with_config(directory, config, SegmentBuilderConfig::default()).await
547    }
548
549    /// Open an existing index with custom builder config
550    pub async fn open_with_config(
551        directory: D,
552        config: IndexConfig,
553        builder_config: SegmentBuilderConfig,
554    ) -> Result<Self> {
555        let directory = Arc::new(directory);
556
557        // Read schema
558        let schema_slice = directory.open_read(Path::new("schema.json")).await?;
559        let schema_bytes = schema_slice.read_bytes().await?;
560        let schema: Schema = serde_json::from_slice(schema_bytes.as_slice())
561            .map_err(|e| Error::Serialization(e.to_string()))?;
562        let schema = Arc::new(schema);
563
564        // Read existing segment IDs (hex strings)
565        let segments_slice = directory.open_read(Path::new("segments.json")).await?;
566        let segments_bytes = segments_slice.read_bytes().await?;
567        let segment_ids: Vec<String> = serde_json::from_slice(segments_bytes.as_slice())
568            .map_err(|e| Error::Serialization(e.to_string()))?;
569
570        Ok(Self {
571            directory,
572            schema,
573            config,
574            builder_config,
575            tokenizers: FxHashMap::default(),
576            builder: AsyncMutex::new(None),
577            segment_ids: AsyncMutex::new(segment_ids),
578        })
579    }
580
581    /// Get the schema
582    pub fn schema(&self) -> &Schema {
583        &self.schema
584    }
585
586    /// Set tokenizer for a field
587    pub fn set_tokenizer<T: crate::tokenizer::Tokenizer>(&mut self, field: Field, tokenizer: T) {
588        self.tokenizers.insert(field, Box::new(tokenizer));
589    }
590
591    /// Add a document
592    ///
593    /// Documents are streamed to disk immediately, keeping memory usage bounded.
594    /// When the builder reaches `max_docs_per_segment`, it is committed and a new one starts.
595    pub async fn add_document(&self, doc: Document) -> Result<DocId> {
596        let mut builder_guard = self.builder.lock().await;
597
598        // Initialize builder if needed
599        if builder_guard.is_none() {
600            let mut builder =
601                SegmentBuilder::new((*self.schema).clone(), self.builder_config.clone())?;
602            for (field, tokenizer) in &self.tokenizers {
603                builder.set_tokenizer(*field, tokenizer.clone_box());
604            }
605            *builder_guard = Some(builder);
606        }
607
608        let builder = builder_guard.as_mut().unwrap();
609        let doc_id = builder.add_document(doc)?;
610
611        // Check if we need to commit
612        if builder.num_docs() >= self.config.max_docs_per_segment {
613            let full_builder = builder_guard.take().unwrap();
614            drop(builder_guard); // Release lock before async operation
615            self.commit_builder(full_builder).await?;
616        }
617
618        Ok(doc_id)
619    }
620
621    /// Get current builder statistics for debugging
622    pub async fn get_builder_stats(&self) -> Option<crate::segment::SegmentBuilderStats> {
623        let builder_guard = self.builder.lock().await;
624        builder_guard.as_ref().map(|b| b.stats())
625    }
626
627    /// Commit all pending segments to disk
628    pub async fn commit(&self) -> Result<()> {
629        let mut builder_guard = self.builder.lock().await;
630
631        if let Some(builder) = builder_guard.take()
632            && builder.num_docs() > 0
633        {
634            drop(builder_guard);
635            self.commit_builder(builder).await?;
636        }
637
638        Ok(())
639    }
640
641    async fn commit_builder(&self, builder: SegmentBuilder) -> Result<()> {
642        let segment_id = SegmentId::new();
643        builder.build(self.directory.as_ref(), segment_id).await?;
644
645        // Update segment list
646        let mut segment_ids = self.segment_ids.lock().await;
647        segment_ids.push(segment_id.to_hex());
648
649        let segments_bytes =
650            serde_json::to_vec(&*segment_ids).map_err(|e| Error::Serialization(e.to_string()))?;
651        self.directory
652            .write(Path::new("segments.json"), &segments_bytes)
653            .await?;
654
655        Ok(())
656    }
657
658    /// Merge all segments into one (called explicitly via force_merge)
659    async fn do_merge(&self) -> Result<()> {
660        let segment_ids = self.segment_ids.lock().await;
661
662        if segment_ids.len() < 2 {
663            return Ok(());
664        }
665
666        let ids_to_merge: Vec<String> = segment_ids.clone();
667        drop(segment_ids);
668
669        // Load segment readers
670        let mut readers = Vec::new();
671        let mut doc_offset = 0u32;
672
673        for id_str in &ids_to_merge {
674            let segment_id = SegmentId::from_hex(id_str)
675                .ok_or_else(|| Error::Corruption(format!("Invalid segment ID: {}", id_str)))?;
676            let reader = SegmentReader::open(
677                self.directory.as_ref(),
678                segment_id,
679                Arc::clone(&self.schema),
680                doc_offset,
681                self.config.term_cache_blocks,
682            )
683            .await?;
684            doc_offset += reader.meta().num_docs;
685            readers.push(reader);
686        }
687
688        // Merge into new segment
689        let merger = SegmentMerger::new(Arc::clone(&self.schema));
690        let new_segment_id = SegmentId::new();
691        merger
692            .merge(self.directory.as_ref(), &readers, new_segment_id)
693            .await?;
694
695        // Update segment list
696        let mut segment_ids = self.segment_ids.lock().await;
697        segment_ids.clear();
698        segment_ids.push(new_segment_id.to_hex());
699
700        let segments_bytes =
701            serde_json::to_vec(&*segment_ids).map_err(|e| Error::Serialization(e.to_string()))?;
702        self.directory
703            .write(Path::new("segments.json"), &segments_bytes)
704            .await?;
705
706        // Delete old segments
707        for id_str in ids_to_merge {
708            if let Some(segment_id) = SegmentId::from_hex(&id_str) {
709                let _ = crate::segment::delete_segment(self.directory.as_ref(), segment_id).await;
710            }
711        }
712
713        Ok(())
714    }
715
716    /// Force merge all segments into one
717    pub async fn force_merge(&self) -> Result<()> {
718        // First commit any pending documents
719        self.commit().await?;
720        // Then merge all segments
721        self.do_merge().await
722    }
723}
724
725#[cfg(test)]
726mod tests {
727    use super::*;
728    use crate::directories::RamDirectory;
729    use crate::dsl::SchemaBuilder;
730
731    #[tokio::test]
732    async fn test_index_create_and_search() {
733        let mut schema_builder = SchemaBuilder::default();
734        let title = schema_builder.add_text_field("title", true, true);
735        let body = schema_builder.add_text_field("body", true, true);
736        let schema = schema_builder.build();
737
738        let dir = RamDirectory::new();
739        let config = IndexConfig::default();
740
741        // Create index and add documents
742        let writer = IndexWriter::create(dir.clone(), schema.clone(), config.clone())
743            .await
744            .unwrap();
745
746        let mut doc1 = Document::new();
747        doc1.add_text(title, "Hello World");
748        doc1.add_text(body, "This is the first document");
749        writer.add_document(doc1).await.unwrap();
750
751        let mut doc2 = Document::new();
752        doc2.add_text(title, "Goodbye World");
753        doc2.add_text(body, "This is the second document");
754        writer.add_document(doc2).await.unwrap();
755
756        writer.commit().await.unwrap();
757
758        // Open for reading
759        let index = Index::open(dir, config).await.unwrap();
760        assert_eq!(index.num_docs(), 2);
761
762        // Check postings
763        let postings = index.get_postings(title, b"world").await.unwrap();
764        assert_eq!(postings.len(), 1); // One segment
765        assert_eq!(postings[0].1.doc_count(), 2); // Two docs with "world"
766
767        // Retrieve document
768        let doc = index.doc(0).await.unwrap().unwrap();
769        assert_eq!(doc.get_first(title).unwrap().as_text(), Some("Hello World"));
770    }
771
772    #[tokio::test]
773    async fn test_multiple_segments() {
774        let mut schema_builder = SchemaBuilder::default();
775        let title = schema_builder.add_text_field("title", true, true);
776        let schema = schema_builder.build();
777
778        let dir = RamDirectory::new();
779        let config = IndexConfig {
780            max_docs_per_segment: 5, // Small segments for testing
781            ..Default::default()
782        };
783
784        let writer = IndexWriter::create(dir.clone(), schema.clone(), config.clone())
785            .await
786            .unwrap();
787
788        // Add documents in batches to create multiple segments
789        for batch in 0..3 {
790            for i in 0..5 {
791                let mut doc = Document::new();
792                doc.add_text(title, format!("Document {} batch {}", i, batch));
793                writer.add_document(doc).await.unwrap();
794            }
795            writer.commit().await.unwrap();
796        }
797
798        // Open and check
799        let index = Index::open(dir, config).await.unwrap();
800        assert_eq!(index.num_docs(), 15);
801        assert_eq!(index.segment_readers().len(), 3);
802    }
803
804    #[tokio::test]
805    async fn test_segment_merge() {
806        let mut schema_builder = SchemaBuilder::default();
807        let title = schema_builder.add_text_field("title", true, true);
808        let schema = schema_builder.build();
809
810        let dir = RamDirectory::new();
811        let config = IndexConfig {
812            max_docs_per_segment: 3,
813            ..Default::default()
814        };
815
816        let writer = IndexWriter::create(dir.clone(), schema.clone(), config.clone())
817            .await
818            .unwrap();
819
820        // Create multiple segments
821        for i in 0..9 {
822            let mut doc = Document::new();
823            doc.add_text(title, format!("Document {}", i));
824            writer.add_document(doc).await.unwrap();
825        }
826        writer.commit().await.unwrap();
827
828        // Should have 3 segments
829        let index = Index::open(dir.clone(), config.clone()).await.unwrap();
830        assert_eq!(index.segment_readers().len(), 3);
831
832        // Force merge
833        let writer = IndexWriter::open(dir.clone(), config.clone())
834            .await
835            .unwrap();
836        writer.force_merge().await.unwrap();
837
838        // Should have 1 segment now
839        let index = Index::open(dir, config).await.unwrap();
840        assert_eq!(index.segment_readers().len(), 1);
841        assert_eq!(index.num_docs(), 9);
842
843        // Verify all documents accessible
844        for i in 0..9 {
845            let doc = index.doc(i).await.unwrap().unwrap();
846            assert_eq!(
847                doc.get_first(title).unwrap().as_text(),
848                Some(format!("Document {}", i).as_str())
849            );
850        }
851    }
852
853    #[tokio::test]
854    async fn test_match_query() {
855        let mut schema_builder = SchemaBuilder::default();
856        let title = schema_builder.add_text_field("title", true, true);
857        let body = schema_builder.add_text_field("body", true, true);
858        let schema = schema_builder.build();
859
860        let dir = RamDirectory::new();
861        let config = IndexConfig::default();
862
863        let writer = IndexWriter::create(dir.clone(), schema.clone(), config.clone())
864            .await
865            .unwrap();
866
867        let mut doc1 = Document::new();
868        doc1.add_text(title, "rust programming");
869        doc1.add_text(body, "Learn rust language");
870        writer.add_document(doc1).await.unwrap();
871
872        let mut doc2 = Document::new();
873        doc2.add_text(title, "python programming");
874        doc2.add_text(body, "Learn python language");
875        writer.add_document(doc2).await.unwrap();
876
877        writer.commit().await.unwrap();
878
879        let index = Index::open(dir, config).await.unwrap();
880
881        // Test match query with multiple default fields
882        let results = index.query("rust", 10).await.unwrap();
883        assert_eq!(results.hits.len(), 1);
884
885        // Test match query with multiple tokens
886        let results = index.query("rust programming", 10).await.unwrap();
887        assert!(!results.hits.is_empty());
888
889        // Verify hit has address (segment_id + doc_id)
890        let hit = &results.hits[0];
891        assert!(!hit.address.segment_id.is_empty(), "Should have segment_id");
892
893        // Verify document retrieval by address
894        let doc = index.get_document(&hit.address).await.unwrap().unwrap();
895        assert!(
896            !doc.field_values().is_empty(),
897            "Doc should have field values"
898        );
899
900        // Also verify doc retrieval directly by global doc_id
901        let doc = index.doc(0).await.unwrap().unwrap();
902        assert!(
903            !doc.field_values().is_empty(),
904            "Doc should have field values"
905        );
906    }
907
908    #[tokio::test]
909    async fn test_slice_cache_warmup_and_load() {
910        use crate::directories::SliceCachingDirectory;
911
912        let mut schema_builder = SchemaBuilder::default();
913        let title = schema_builder.add_text_field("title", true, true);
914        let body = schema_builder.add_text_field("body", true, true);
915        let schema = schema_builder.build();
916
917        let dir = RamDirectory::new();
918        let config = IndexConfig::default();
919
920        // Create index with some documents
921        let writer = IndexWriter::create(dir.clone(), schema.clone(), config.clone())
922            .await
923            .unwrap();
924
925        for i in 0..10 {
926            let mut doc = Document::new();
927            doc.add_text(title, format!("Document {} about rust", i));
928            doc.add_text(body, format!("This is body text number {}", i));
929            writer.add_document(doc).await.unwrap();
930        }
931        writer.commit().await.unwrap();
932
933        // Open with slice caching and perform some operations to warm up cache
934        let caching_dir = SliceCachingDirectory::new(dir.clone(), 1024 * 1024);
935        let index = Index::open(caching_dir, config.clone()).await.unwrap();
936
937        // Perform a search to warm up the cache
938        let results = index.query("rust", 10).await.unwrap();
939        assert!(!results.hits.is_empty());
940
941        // Check cache stats - should have cached some data
942        let stats = index.slice_cache_stats();
943        assert!(stats.total_bytes > 0, "Cache should have data after search");
944
945        // Save the cache
946        index.save_slice_cache().await.unwrap();
947
948        // Verify cache file was written
949        assert!(
950            dir.exists(Path::new(super::SLICE_CACHE_FILENAME))
951                .await
952                .unwrap()
953        );
954
955        // Now open with cache loading
956        let index2 = Index::open_with_cache(dir.clone(), config.clone(), 1024 * 1024)
957            .await
958            .unwrap();
959
960        // Cache should be prefilled
961        let stats2 = index2.slice_cache_stats();
962        assert!(
963            stats2.total_bytes > 0,
964            "Cache should be prefilled from file"
965        );
966
967        // Search should still work
968        let results2 = index2.query("rust", 10).await.unwrap();
969        assert_eq!(results.hits.len(), results2.hits.len());
970    }
971
972    #[tokio::test]
973    async fn test_multivalue_field_indexing_and_search() {
974        let mut schema_builder = SchemaBuilder::default();
975        let uris = schema_builder.add_text_field("uris", true, true);
976        let title = schema_builder.add_text_field("title", true, true);
977        let schema = schema_builder.build();
978
979        let dir = RamDirectory::new();
980        let config = IndexConfig::default();
981
982        // Create index and add document with multi-value field
983        let writer = IndexWriter::create(dir.clone(), schema.clone(), config.clone())
984            .await
985            .unwrap();
986
987        let mut doc = Document::new();
988        doc.add_text(uris, "one");
989        doc.add_text(uris, "two");
990        doc.add_text(title, "Test Document");
991        writer.add_document(doc).await.unwrap();
992
993        // Add another document with different uris
994        let mut doc2 = Document::new();
995        doc2.add_text(uris, "three");
996        doc2.add_text(title, "Another Document");
997        writer.add_document(doc2).await.unwrap();
998
999        writer.commit().await.unwrap();
1000
1001        // Open for reading
1002        let index = Index::open(dir, config).await.unwrap();
1003        assert_eq!(index.num_docs(), 2);
1004
1005        // Verify document retrieval preserves all values
1006        let doc = index.doc(0).await.unwrap().unwrap();
1007        let all_uris: Vec<_> = doc.get_all(uris).collect();
1008        assert_eq!(all_uris.len(), 2, "Should have 2 uris values");
1009        assert_eq!(all_uris[0].as_text(), Some("one"));
1010        assert_eq!(all_uris[1].as_text(), Some("two"));
1011
1012        // Verify to_json returns array for multi-value field
1013        let json = doc.to_json(index.schema());
1014        let uris_json = json.get("uris").unwrap();
1015        assert!(uris_json.is_array(), "Multi-value field should be an array");
1016        let uris_arr = uris_json.as_array().unwrap();
1017        assert_eq!(uris_arr.len(), 2);
1018        assert_eq!(uris_arr[0].as_str(), Some("one"));
1019        assert_eq!(uris_arr[1].as_str(), Some("two"));
1020
1021        // Verify both values are searchable
1022        let results = index.query("uris:one", 10).await.unwrap();
1023        assert_eq!(results.hits.len(), 1, "Should find doc with 'one'");
1024        assert_eq!(results.hits[0].address.doc_id, 0);
1025
1026        let results = index.query("uris:two", 10).await.unwrap();
1027        assert_eq!(results.hits.len(), 1, "Should find doc with 'two'");
1028        assert_eq!(results.hits[0].address.doc_id, 0);
1029
1030        let results = index.query("uris:three", 10).await.unwrap();
1031        assert_eq!(results.hits.len(), 1, "Should find doc with 'three'");
1032        assert_eq!(results.hits[0].address.doc_id, 1);
1033
1034        // Verify searching for non-existent value returns no results
1035        let results = index.query("uris:nonexistent", 10).await.unwrap();
1036        assert_eq!(results.hits.len(), 0, "Should not find non-existent value");
1037    }
1038}