nitrite 0.4.0

An embedded NoSQL document database for Rust with collections, repositories, indexing, and ACID transactions
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
use crate::{
    common::{LockHandle, LockRegistry}, create_unique_filter, errors::{ErrorKind, NitriteError, NitriteResult}, filter::{is_all_filter, Filter}, nitrite_config::NitriteConfig, store::{NitriteMap, NitriteMapProvider, NitriteStore, NitriteStoreProvider}, AttributeAware, EventAware, Fields, NitriteEventBus, PersistentCollection, Processor
};
use std::sync::atomic::{AtomicBool, Ordering};

use super::{operation::CollectionOperations, NitriteCollectionProvider, UpdateOptions};

pub(crate) struct DefaultNitriteCollection {
    collection_name: String,
    nitrite_map: NitriteMap,
    store: NitriteStore,
    operations: CollectionOperations,
    dropped: AtomicBool,
    lock_handle: LockHandle,
}

impl DefaultNitriteCollection {
    pub fn new(
        collection_name: &str,
        nitrite_map: NitriteMap,
        nitrite_config: NitriteConfig,
        lock_handle: LockHandle,
    ) -> NitriteResult<Self> {
        let store = nitrite_config.nitrite_store()?;
        let event_bus = NitriteEventBus::new();

        let operations = CollectionOperations::new(
            collection_name,
            nitrite_map.clone(),
            nitrite_config.clone(),
            event_bus,
        )?;

        Ok(Self {
            collection_name: collection_name.to_string(),
            nitrite_map: nitrite_map.clone(),
            store: store.clone(),
            operations,
            dropped: AtomicBool::from(false),
            lock_handle,
        })
    }

    fn ensure_opened(&self) -> NitriteResult<()> {
        // Check dropped state first (cheapest check)
        if self.dropped.load(Ordering::Relaxed) {
            log::error!("Collection '{}' is dropped and cannot be accessed", self.collection_name);
            return Err(NitriteError::new(
                &format!("Collection '{}' is dropped and cannot be accessed", self.collection_name),
                ErrorKind::InvalidOperation,
            ));
        }

        // Check store state
        if self.store.is_closed()? {
            log::error!("Store is closed; cannot access collection '{}'", self.collection_name);
            return Err(NitriteError::new(
                "Nitrite store is closed. Close all collections and reopen the database to continue operations",
                ErrorKind::InvalidOperation,
            ));
        }

        // Check map state only if necessary
        let map_closed = self.nitrite_map.is_closed()?;
        if map_closed {
            log::error!("NitriteMap for collection '{}' is closed", self.collection_name);
            return Err(NitriteError::new(
                &format!("Collection '{}' underlying map is closed and cannot be accessed", self.collection_name),
                ErrorKind::InvalidOperation,
            ));
        }

        let map_dropped = self.nitrite_map.is_dropped()?;
        if map_dropped {
            log::error!("NitriteMap for collection '{}' is dropped", self.collection_name);
            return Err(NitriteError::new(
                &format!("Collection '{}' underlying map is dropped; cannot perform further operations", self.collection_name),
                ErrorKind::InvalidOperation,
            ));
        }

        Ok(())
    }
}

impl EventAware for DefaultNitriteCollection {
    fn subscribe(
        &self,
        handler: super::CollectionEventListener,
    ) -> NitriteResult<Option<crate::SubscriberRef>> {
        let _guard = self.lock_handle.write();
        self.ensure_opened()?;
        self.operations.subscribe(handler)
    }

    fn unsubscribe(&self, subscriber: crate::SubscriberRef) -> NitriteResult<()> {
        let _guard = self.lock_handle.write();
        self.ensure_opened()?;
        self.operations.unsubscribe(subscriber)
    }
}

impl AttributeAware for DefaultNitriteCollection {
    fn attributes(&self) -> NitriteResult<Option<crate::Attributes>> {
        let _guard = self.lock_handle.read();
        self.ensure_opened()?;
        self.operations.attributes()
    }

    fn set_attributes(&self, attributes: crate::Attributes) -> NitriteResult<()> {
        let _guard = self.lock_handle.write();
        self.ensure_opened()?;
        self.operations.set_attributes(attributes)
    }
}

impl PersistentCollection for DefaultNitriteCollection {
    fn add_processor(&self, processor: Processor) -> NitriteResult<()> {
        let _guard = self.lock_handle.write();
        self.ensure_opened()?;
        self.operations.add_processor(processor);
        Ok(())
    }

    fn create_index(
        &self,
        field_names: Vec<&str>,
        index_options: &crate::index::IndexOptions,
    ) -> NitriteResult<()> {
        let _guard = self.lock_handle.write();
        self.ensure_opened()?;
        let fields = Fields::with_names(field_names)?;
        self.operations
            .create_index(&fields, &index_options.index_type())
    }

    fn rebuild_index(&self, field_names: Vec<&str>) -> NitriteResult<()> {
        let _guard = self.lock_handle.write();
        self.ensure_opened()?;
        let fields = Fields::with_names(field_names)?;
        let index_descriptor = self.operations.find_index(&fields)?;

        let index_descriptor = match index_descriptor {
            Some(descriptor) => descriptor,
            None => {
                log::error!("Index not found for fields {}", fields);
                return Err(NitriteError::new(
                    "Index not found",
                    ErrorKind::IndexingError,
                ));
            }
        };

        if self.operations.is_indexing(&fields)? {
            log::error!("Indexing is in progress for fields {}", fields);
            return Err(NitriteError::new(
                "Indexing is in progress",
                ErrorKind::IndexingError,
            ));
        }

        self.operations.rebuild_index(&index_descriptor)
    }

    fn list_indexes(&self) -> NitriteResult<Vec<crate::index::IndexDescriptor>> {
        let _guard = self.lock_handle.read();
        self.ensure_opened()?;
        self.operations.list_indexes()
    }

    fn has_index(&self, field_names: Vec<&str>) -> NitriteResult<bool> {
        let _guard = self.lock_handle.read();
        self.ensure_opened()?;
        let fields = Fields::with_names(field_names)?;
        self.operations.has_index(&fields)
    }

    fn is_indexing(&self, field_names: Vec<&str>) -> NitriteResult<bool> {
        let _guard = self.lock_handle.read();
        self.ensure_opened()?;
        let fields = Fields::with_names(field_names)?;
        self.operations.is_indexing(&fields)
    }

    fn drop_index(&self, field_names: Vec<&str>) -> NitriteResult<()> {
        let _guard = self.lock_handle.write();
        self.ensure_opened()?;
        let fields = Fields::with_names(field_names)?;
        self.operations.drop_index(&fields)
    }

    fn drop_all_indexes(&self) -> NitriteResult<()> {
        let _guard = self.lock_handle.write();
        self.ensure_opened()?;
        self.operations.drop_all_indexes()
    }

    fn clear(&self) -> NitriteResult<()> {
        let _guard = self.lock_handle.write();
        self.ensure_opened()?;
        self.operations.clear()
    }

    fn dispose(&self) -> NitriteResult<()> {
        let _guard = self.lock_handle.write();
        self.ensure_opened()?;
        self.operations.dispose()?;
        self.dropped.store(true, Ordering::Relaxed);
        Ok(())
    }

    fn is_dropped(&self) -> NitriteResult<bool> {
        let _guard = self.lock_handle.read();
        Ok(self.dropped.load(Ordering::Relaxed) || self.nitrite_map.is_dropped()?)
    }

    fn is_open(&self) -> NitriteResult<bool> {
        let _guard = self.lock_handle.read();
        Ok(!self.store.is_closed()?
            && !self.dropped.load(Ordering::Relaxed)
            && !self.nitrite_map.is_dropped()?
            && !self.nitrite_map.is_closed()?
            && !self.nitrite_map.is_dropped()?)
    }

    fn size(&self) -> NitriteResult<u64> {
        let _guard = self.lock_handle.read();
        self.ensure_opened()?;
        self.operations.size()
    }

    fn close(&self) -> NitriteResult<()> {
        let _guard = self.lock_handle.write();
        self.operations.close()?;
        Ok(())
    }

    fn store(&self) -> NitriteResult<NitriteStore> {
        let _guard = self.lock_handle.read();
        self.ensure_opened()?;
        Ok(self.store.clone())
    }
}

impl NitriteCollectionProvider for DefaultNitriteCollection {
    fn insert(
        &self,
        document: super::Document,
    ) -> NitriteResult<super::operation::WriteResult> {
        let _guard = self.lock_handle.write();
        self.ensure_opened()?;
        self.operations.insert(document)
    }

    fn insert_many(
        &self,
        documents: Vec<super::Document>,
    ) -> NitriteResult<super::operation::WriteResult> {
        let _guard = self.lock_handle.write();
        self.ensure_opened()?;
        self.operations.insert_batch(documents)
    }

    fn update_with_options(
        &self,
        filter: Filter,
        update: &super::Document,
        update_options: &UpdateOptions,
    ) -> NitriteResult<super::operation::WriteResult> {
        let _guard = self.lock_handle.write();
        self.ensure_opened()?;
        self.operations.update(filter, update, update_options)
    }

    fn update_one(
        &self,
        document: &super::Document,
        insert_if_absent: bool,
    ) -> NitriteResult<super::operation::WriteResult> {
        let mut document = document.clone();
        
        // create_unique_filter creates a new id in the document if it does not have one
        // so it can't be called before checking if the document has an id
        
        if insert_if_absent {
            let filter = create_unique_filter(&mut document)?;
            self.update_with_options(filter, &document, &UpdateOptions::new(true, false))
        } else if document.has_id() {
            let filter = create_unique_filter(&mut document)?;
            self.update_with_options(filter, &document, &UpdateOptions::new(false, false))
        } else {
            log::error!("Document does not have id");
            Err(NitriteError::new(
                "Document does not have id",
                ErrorKind::NotIdentifiable,
            ))
        }
    }

    fn update_by_id(
        &self,
        id: &super::NitriteId,
        update: &super::Document,
        insert_if_absent: bool,
    ) -> NitriteResult<super::operation::WriteResult> {
        let _guard = self.lock_handle.write();
        self.ensure_opened()?;
        self.operations.update_by_id(id, update, insert_if_absent)
    }

    fn remove(
        &self,
        filter: Filter,
        just_once: bool,
    ) -> NitriteResult<super::operation::WriteResult> {
        if is_all_filter(&filter) && just_once {
            log::error!("Cannot remove all documents with just once as true");
            return Err(NitriteError::new(
                "Cannot remove all documents with just once as true",
                ErrorKind::InvalidOperation,
            ));
        }
        
        let _guard = self.lock_handle.write();
        self.ensure_opened()?;
        self.operations.remove(filter, just_once)
    }

    fn remove_one(
        &self,
        document: &super::Document,
    ) -> NitriteResult<super::operation::WriteResult> {
        let _guard = self.lock_handle.write();
        if document.has_id() {
            self.ensure_opened()?;
            self.operations.remove_document(document)
        } else {
            log::error!("Document does not have id");
            Err(NitriteError::new(
                "Document does not have id",
                ErrorKind::NotIdentifiable,
            ))
        }
    }

    fn find(&self, filter: Filter) -> NitriteResult<crate::DocumentCursor> {
        let _guard = self.lock_handle.read();
        self.ensure_opened()?;
        self.operations.find(filter, &super::FindOptions::new())
    }

    fn find_with_options(
        &self,
        filter: Filter,
        find_options: &super::FindOptions,
    ) -> NitriteResult<crate::DocumentCursor> {
        let _guard = self.lock_handle.read();
        self.ensure_opened()?;
        self.operations.find(filter, find_options)
    }

    fn get_by_id(&self, id: &super::NitriteId) -> NitriteResult<Option<super::Document>> {
        let _guard = self.lock_handle.read();
        self.ensure_opened()?;
        self.operations.get_by_id(id)
    }

    fn name(&self) -> String {
        self.collection_name.clone()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::collection::{CollectionEventListener, Document, FindOptions, NitriteId};
    use crate::common::ProcessorProvider;
    use crate::filter::field;
    use crate::index::{unique_index, IndexOptions};
    use crate::nitrite_config::NitriteConfig;

    fn setup_collection() -> DefaultNitriteCollection {
        let nitrite_config = NitriteConfig::default();
        nitrite_config.auto_configure().expect("Failed to auto configure");
        nitrite_config.initialize().expect("Failed to initialize");
        let store = nitrite_config.nitrite_store().expect("Failed to get store");
        let nitrite_map = store.open_map("test_collection").expect("Failed to open map");
        let lock_registry = LockRegistry::default();
        let lock_handle = lock_registry.get_lock("test_collection");
        DefaultNitriteCollection::new("test_collection", nitrite_map, nitrite_config, lock_handle).expect("Failed to create collection")
    }

    #[test]
    fn test_new() {
        let collection = setup_collection();
        assert_eq!(collection.name(), "test_collection");
    }

    #[test]
    fn test_ensure_opened() {
        let collection = setup_collection();
        assert!(collection.ensure_opened().is_ok());
    }

    #[test]
    fn test_subscribe() {
        let collection = setup_collection();
        let handler = |_| {Ok(())};
        let listener = CollectionEventListener::new(handler);
        let result = collection.subscribe(listener);
        assert!(result.is_ok());
    }

    #[test]
    fn test_unsubscribe() {
        let collection = setup_collection();
        let handler = |_| {Ok(())};
        let listener = CollectionEventListener::new(handler);
        let subscriber = collection.subscribe(listener).unwrap();
        let result = collection.unsubscribe(subscriber.unwrap());
        assert!(result.is_ok());
    }

    #[test]
    fn test_attributes() {
        let collection = setup_collection();
        let result = collection.attributes();
        assert!(result.is_ok());
    }

    #[test]
    fn test_set_attributes() {
        let collection = setup_collection();
        let attributes = crate::Attributes::new();
        let result = collection.set_attributes(attributes);
        assert!(result.is_ok());
    }

    #[test]
    fn test_add_processor() {
        let collection = setup_collection();
        let processor = Processor::new(TestProcessor);
        let result = collection.add_processor(processor);
        assert!(result.is_ok());
    }

    #[test]
    fn test_create_index() {
        let collection = setup_collection();
        let result = collection.create_index(vec!["field1"], &IndexOptions::default());
        assert!(result.is_ok());
    }

    #[test]
    fn test_rebuild_index() {
        let collection = setup_collection();
        collection.create_index(vec!["field1"], &IndexOptions::default()).expect("Failed to create index");
        let result = collection.rebuild_index(vec!["field1"]);
        assert!(result.is_ok());
    }

    #[test]
    fn test_list_indexes() {
        let collection = setup_collection();
        let result = collection.list_indexes();
        assert!(result.is_ok());
    }

    #[test]
    fn test_has_index() {
        let collection = setup_collection();
        let result = collection.has_index(vec!["field1"]);
        assert!(result.is_ok());
    }

    #[test]
    fn test_is_indexing() {
        let collection = setup_collection();
        let result = collection.is_indexing(vec!["field1"]);
        assert!(result.is_ok());
    }

    #[test]
    fn test_drop_index() {
        let collection = setup_collection();
        let result = collection.drop_index(vec!["field1"]);
        assert!(result.is_ok());
    }

    #[test]
    fn test_drop_all_indexes() {
        let collection = setup_collection();
        let result = collection.drop_all_indexes();
        assert!(result.is_ok());
    }

    #[test]
    fn test_clear() {
        let collection = setup_collection();
        let result = collection.clear();
        assert!(result.is_ok());
    }

    #[test]
    fn test_destroy() {
        let collection = setup_collection();
        let result = collection.dispose();
        assert!(result.is_ok());
    }

    #[test]
    fn test_is_dropped() {
        let collection = setup_collection();
        let result = collection.is_dropped();
        assert!(result.is_ok());
    }

    #[test]
    fn test_is_open() {
        let collection = setup_collection();
        let result = collection.is_open();
        assert!(result.is_ok());
    }

    #[test]
    fn test_size() {
        let collection = setup_collection();
        let result = collection.size();
        assert!(result.is_ok());
    }

    #[test]
    fn test_close() {
        let collection = setup_collection();
        let result = collection.close();
        assert!(result.is_ok());
    }

    #[test]
    fn test_store() {
        let collection = setup_collection();
        let result = collection.store();
        assert!(result.is_ok());
    }

    #[test]
    fn test_insert() {
        let collection = setup_collection();
        let document = Document::new();
        let result = collection.insert(document);
        assert!(result.is_ok());
    }

    #[test]
    fn test_insert_batch() {
        let collection = setup_collection();
        let documents = vec![Document::new(), Document::new()];
        let result = collection.insert_many(documents);
        assert!(result.is_ok());
    }

    #[test]
    fn test_update() {
        let collection = setup_collection();
        let filter = field("field1").eq("value1");
        let document = Document::new();
        let update_options = UpdateOptions::default();
        let result = collection.update_with_options(filter, &document, &update_options);
        assert!(result.is_ok());
    }

    #[test]
    fn test_update_one() {
        let collection = setup_collection();
        let document = Document::new();
        let result = collection.update_one(&document, true);
        assert!(result.is_ok());
    }

    #[test]
    fn test_remove() {
        let collection = setup_collection();
        let filter = field("field1").eq("value1");
        let result = collection.remove(filter, true);
        assert!(result.is_ok());
    }

    #[test]
    fn test_remove_document() {
        let collection = setup_collection();
        let mut document = Document::new();
        let _ = document.id();
        let result = collection.remove_one(&document);
        assert!(result.is_ok());
    }

    #[test]
    fn test_find() {
        let collection = setup_collection();
        let filter = field("field1").eq("value1");
        let result = collection.find(filter);
        assert!(result.is_ok());
    }

    #[test]
    fn test_find_options() {
        let collection = setup_collection();
        let filter = field("field1").eq("value1");
        let find_options = FindOptions::default();
        let result = collection.find_with_options(filter, &find_options);
        assert!(result.is_ok());
    }

    #[test]
    fn test_get_by_id() {
        let collection = setup_collection();
        let id = NitriteId::new();
        let result = collection.get_by_id(&id);
        assert!(result.is_ok());
    }

    #[test]
    fn test_ensure_opened_early_exit() {
        let collection = setup_collection();
        
        // Test that ensure_opened exits fast for opened collection
        let start = std::time::Instant::now();
        for _ in 0..1000 {
            let _ = collection.ensure_opened();
        }
        let elapsed = start.elapsed();
        
        println!("1000 ensure_opened calls: {:?}", elapsed);
        // Should be very fast with atomic load
        assert!(elapsed.as_millis() < 100);
    }

    #[test]
    fn test_ensure_opened_after_drop() {
        let collection = setup_collection();
        let _ = collection.dispose();
        
        // After dropping, ensure_opened should fail fast
        let result = collection.ensure_opened();
        assert!(result.is_err());
    }

    #[test]
    fn test_multiple_operations_efficiency() {
        let collection = setup_collection();
        let mut documents = vec![];
        
        for i in 0..10 {
            let mut doc = Document::new();
            let _ = doc.put("index", i);
            documents.push(doc);
        }
        
        let start = std::time::Instant::now();
        let _ = collection.insert_many(documents);
        let elapsed = start.elapsed();
        
        println!("Batch insert 10 docs: {:?}", elapsed);
        assert!(elapsed.as_millis() < 200);
    }

    #[test]
    fn test_index_insert() {
        let collection = setup_collection();
        collection.create_index(vec!["field1"], &unique_index()).expect("Failed to create index");
        
        let mut documents = vec![];
        for i in 0..10 {
            let mut doc = Document::new();
            let _ = doc.put("field1", format!("value{}", i));
            documents.push(doc);
        }
        
        let start = std::time::Instant::now();
        let _ = collection.insert_many(documents);
        let elapsed = start.elapsed();
        
        println!("Insert 10 indexed docs: {:?}", elapsed);
        assert!(elapsed.as_millis() < 300);
    }
    
    struct TestProcessor;
    
    impl ProcessorProvider for TestProcessor {
        fn name(&self) -> String {
            "TestProcessor".to_string()
        }

        fn process_before_write(&self, doc: Document) -> NitriteResult<Document> {
            let mut doc = doc.clone();
            doc.put("processed", true)?;
            Ok(doc)
        }

        fn process_after_read(&self, doc: Document) -> NitriteResult<Document> {
            let mut doc = doc.clone();
            doc.remove("processed")?;
            Ok(doc)
        }
    }
}