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
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
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
use super::instructions::MigrationFn;
use super::migration::{Migration, MigrationStep};
use crate::collection::Document;
use crate::common::{repository_name, AuthService, Fields};
use crate::errors::{ErrorKind, NitriteError, NitriteResult};
use crate::migration::commands::{Command, MigrationCommand};
use crate::migration::InstructionType;
use crate::nitrite::Nitrite;
use crate::store::Metadata;
use crate::Value;
use crate::STORE_INFO;
use std::sync::Arc;

/// Manages database migrations including version tracking and execution
pub struct MigrationManager {
    nitrite: Nitrite,
}

impl MigrationManager {
    pub fn new(nitrite: Nitrite) -> Self {
        MigrationManager { nitrite }
    }

    /// Executes migration if needed by finding and executing migration path
    pub fn do_migrate(&self) -> NitriteResult<()> {
        // Check if migration is needed
        if !self.is_migration_needed()? {
            return Ok(());
        }

        let current_version = self.nitrite.database_metadata()?.schema_version;
        let target_version = self.nitrite.config().schema_version();

        // Find migration path
        let migration_path = self.find_migration_path(current_version, target_version)?;
        let has_valid_path = !migration_path.is_empty();

        if !has_valid_path {
            let _ = self.nitrite.close();
            return Err(NitriteError::new(
                &format!(
                    "No valid migration path found from version {} to {}",
                    current_version, target_version
                ),
                ErrorKind::MigrationError,
            ));
        }

        // Execute migration path
        self.execute_migration_path(&migration_path)?;
        Ok(())
    }

    /// Checks if migration is needed
    fn is_migration_needed(&self) -> NitriteResult<bool> {
        let existing_version = self.nitrite.database_metadata()?.schema_version;
        let incoming_version = self.nitrite.config().schema_version();

        Ok(existing_version != incoming_version)
    }

    /// Finds a migration path from start to end version
    fn find_migration_path(&self, start: u32, end: u32) -> NitriteResult<Vec<Arc<Migration>>> {
        if start == end {
            return Ok(Vec::new());
        }

        {
            let this = &self;
            let upgrade = end > start;
            let mut result: Vec<Arc<Migration>> = Vec::new();
            let mut current = start;

            loop {
                // Direction-aware loop termination
                if if upgrade {
                    current >= end
                } else {
                    current <= end
                } {
                    break;
                }

                let migrations = this.nitrite.config().migrations();
                let target_node = match migrations.get(&current) {
                    Some(node) => node,
                    None => return Ok(vec![]),
                };

                // Find the best migration target based on direction
                let target = if upgrade {
                    // For upgrades: find largest target that doesn't exceed end
                    target_node
                        .keys()
                        .filter(|&&t| t > current && t <= end)
                        .max()
                        .copied()
                } else {
                    // For downgrades: find smallest target that doesn't go below end
                    target_node
                        .keys()
                        .filter(|&&t| t < current && t >= end)
                        .min()
                        .copied()
                };

                let target = match target {
                    Some(t) => t,
                    None => return Ok(vec![]),
                };

                let migration = target_node.get(&target).ok_or_else(|| {
                    NitriteError::new(
                        &format!("Migration from version {} to {} not found", current, target),
                        ErrorKind::MigrationError,
                    )
                })?;

                result.push(Arc::new(migration.clone()));
                current = target;
            }

            Ok(result)
        }
    }

    /// Executes a sequence of migrations
    fn execute_migration_path(&self, path: &[Arc<Migration>]) -> NitriteResult<()> {
        for migration in path {
            self.execute_migration_steps(migration)?;
        }

        let mut meta_data = self.nitrite.database_metadata()?;
        meta_data.schema_version = self.nitrite.config().schema_version();

        // Update schema version in metadata
        let store = self.nitrite.store();
        let store_info = store.open_map(STORE_INFO)?;
        store_info.put(
            Value::from(STORE_INFO),
            Value::Document(meta_data.get_info()),
        )?;

        Ok(())
    }

    /// Executes all steps in a migration
    fn execute_migration_steps(&self, migration: &Migration) -> NitriteResult<()> {
        // Use steps() to trigger lazy execution of the migration closure
        let steps = migration.steps()?;

        for step in steps {
            self.execute_step(&step)?;
        }

        Ok(())
    }

    /// Executes a single migration step
    fn execute_step(&self, step: &MigrationStep) -> NitriteResult<()> {
        let command = match step.instruction_type {
            // Database level
            InstructionType::AddUser => {
                let (username, password) = step.arguments.as_double::<String, String>()?;

                MigrationCommand::Custom {
                    collection_name: "".to_string(),
                    command: Box::new(move |nitrite: Nitrite| -> NitriteResult<()> {
                        let auth_service = AuthService::new(nitrite.store().clone());
                        auth_service.add_update_password(&username, "", &password, false)?;
                        Ok(())
                    }),
                }
            }
            InstructionType::ChangePassword => {
                let (username, old_pw, new_pw) =
                    step.arguments.as_triple::<String, String, String>()?;

                MigrationCommand::Custom {
                    collection_name: "".to_string(),
                    command: Box::new(move |nitrite: Nitrite| -> NitriteResult<()> {
                        let auth_service = AuthService::new(nitrite.store().clone());
                        auth_service.add_update_password(&username, &old_pw, &new_pw, true)?;
                        Ok(())
                    }),
                }
            }
            InstructionType::DropCollection => {
                let collection_name = step.arguments.as_single::<String>()?;
                MigrationCommand::Drop { collection_name }
            }
            InstructionType::DropRepository => {
                let arg_count = step.arguments.arg_count();

                if arg_count == 2 {
                    let (entity_name, key) = step.arguments.as_double::<String, String>()?;
                    let collection_name = repository_name(&entity_name, Some(&key))?;
                    MigrationCommand::Drop { collection_name }
                } else if arg_count == 1 {
                    let entity_name = step.arguments.as_single::<String>()?;
                    let collection_name = repository_name(&entity_name, None)?;
                    MigrationCommand::Drop { collection_name }
                } else {
                    return Err(NitriteError::new(
                        "Invalid arguments for DropRepository",
                        ErrorKind::ValidationError,
                    ));
                }
            }
            InstructionType::CustomInstruction => {
                let fn_wrapper = step.arguments.as_single::<MigrationFn>()?;
                MigrationCommand::Custom {
                    collection_name: "".to_string(),
                    command: Box::new(move |nitrite: Nitrite| -> NitriteResult<()> {
                        fn_wrapper.call_custom_instruction(nitrite)
                    }),
                }
            }

            // Collection level
            InstructionType::CollectionRename => {
                let new_name = step.arguments.as_single::<String>()?;
                let old_name = step.collection_name.as_ref().ok_or_else(|| {
                    NitriteError::new(
                        "Collection name required for Rename",
                        ErrorKind::ValidationError,
                    )
                })?;

                MigrationCommand::Rename {
                    collection_name: old_name.to_string(),
                    new_name,
                    is_repository: false,
                }
            }
            InstructionType::AddField => {
                let collection_name = step.collection_name.as_ref().ok_or_else(|| {
                    NitriteError::new(
                        "Collection name required for AddField",
                        ErrorKind::ValidationError,
                    )
                })?;

                // AddField can be called with single (field_name only) or double (field_name + default_value)
                if let Ok((field_name, default_value)) =
                    step.arguments.as_double::<String, crate::Value>()
                {
                    MigrationCommand::AddField {
                        collection_name: collection_name.to_string(),
                        field_name,
                        default_value: Some(default_value),
                        generator: None,
                    }
                } else if let Ok((field_name, generator_fn)) =
                    step.arguments.as_double::<String, MigrationFn>()
                {
                    let generator: Arc<dyn Fn(Document) -> NitriteResult<Value> + Send + Sync> =
                        Arc::new(move |doc| generator_fn.call_field_generator(doc));
                    MigrationCommand::AddField {
                        collection_name: collection_name.to_string(),
                        field_name,
                        default_value: None,
                        generator: Some(generator),
                    }
                } else {
                    // Field without default value
                    let field_name = step.arguments.as_single::<String>()?;
                    MigrationCommand::AddField {
                        collection_name: collection_name.to_string(),
                        field_name,
                        default_value: None,
                        generator: None,
                    }
                }
            }
            InstructionType::RenameField => {
                let collection_name = step.collection_name.as_ref().ok_or_else(|| {
                    NitriteError::new(
                        "Collection name required for RenameField",
                        ErrorKind::ValidationError,
                    )
                })?;
                let (old_name, new_name) = step.arguments.as_double::<String, String>()?;
                MigrationCommand::RenameField {
                    collection_name: collection_name.to_string(),
                    old_field_name: old_name,
                    new_field_name: new_name,
                }
            }
            InstructionType::DeleteField => {
                let collection_name = step.collection_name.as_ref().ok_or_else(|| {
                    NitriteError::new(
                        "Collection name required for DeleteField",
                        ErrorKind::ValidationError,
                    )
                })?;
                let field_name = step.arguments.as_single::<String>()?;
                MigrationCommand::DeleteField {
                    collection_name: collection_name.to_string(),
                    field_name,
                }
            }
            InstructionType::DropIndex => {
                let collection_name = step.collection_name.as_ref().ok_or_else(|| {
                    NitriteError::new(
                        "Collection name required for DropIndex",
                        ErrorKind::ValidationError,
                    )
                })?;

                let field_names = step.arguments.as_single::<Vec<String>>()?;
                let fields = Fields::with_names(
                    field_names
                        .iter()
                        .map(|s| s.as_str())
                        .collect::<Vec<&str>>(),
                )?;
                MigrationCommand::DropIndex {
                    collection_name: collection_name.to_string(),
                    fields: Some(fields),
                }
            }
            InstructionType::DropAllIndices => {
                let collection_name = step.collection_name.as_ref().ok_or_else(|| {
                    NitriteError::new(
                        "Collection name required for DropAllIndices",
                        ErrorKind::ValidationError,
                    )
                })?;

                MigrationCommand::DropIndex {
                    collection_name: collection_name.to_string(),
                    fields: None,
                }
            }
            InstructionType::CreateIndex => {
                let collection_name = step.collection_name.as_ref().ok_or_else(|| {
                    NitriteError::new(
                        "Collection name required for CreateIndex",
                        ErrorKind::ValidationError,
                    )
                })?;

                let (index_type, field_names) =
                    step.arguments.as_double::<String, Vec<String>>()?;
                let fields = Fields::with_names(
                    field_names
                        .iter()
                        .map(|s| s.as_str())
                        .collect::<Vec<&str>>(),
                )?;

                MigrationCommand::CreateIndex {
                    collection_name: collection_name.to_string(),
                    fields,
                    index_type,
                }
            }
            // Repository level
            InstructionType::RepositoryRename => {
                let entity_name = step.entity_name.as_ref().ok_or_else(|| {
                    NitriteError::new(
                        "Entity name required for RepositoryRename",
                        ErrorKind::ValidationError,
                    )
                })?;
                let key = step.key.as_deref();
                let collection_name = repository_name(entity_name, key)?;

                let (new_entity_name, new_key) =
                    step.arguments.as_double::<String, Option<String>>()?;
                let new_collection_name = repository_name(&new_entity_name, new_key.as_deref())?;
                MigrationCommand::Rename {
                    collection_name,
                    new_name: new_collection_name,
                    is_repository: true,
                }
            }
            InstructionType::RepositoryAddField => {
                // RepositoryAddField can be called with single (field_name only) or double (field_name + default_value)
                let entity_name = step.entity_name.as_ref().ok_or_else(|| {
                    NitriteError::new(
                        "Entity name required for RepositoryAddField",
                        ErrorKind::ValidationError,
                    )
                })?;
                let collection_name = repository_name(entity_name, step.key.as_deref())?;

                if let Ok((field_name, default_value)) =
                    step.arguments.as_double::<String, crate::Value>()
                {
                    MigrationCommand::AddField {
                        collection_name,
                        field_name,
                        default_value: Some(default_value),
                        generator: None,
                    }
                } else if let Ok((field_name, generator_fn)) =
                    step.arguments.as_double::<String, MigrationFn>()
                {
                    let generator: Arc<dyn Fn(Document) -> NitriteResult<Value> + Send + Sync> =
                        Arc::new(move |doc| generator_fn.call_field_generator(doc));
                    MigrationCommand::AddField {
                        collection_name,
                        field_name,
                        default_value: None,
                        generator: Some(generator),
                    }
                } else {
                    // Field without default value
                    let field_name = step.arguments.as_single::<String>()?;
                    MigrationCommand::AddField {
                        collection_name,
                        field_name,
                        default_value: None,
                        generator: None,
                    }
                }
            }
            InstructionType::RepositoryRenameField => {
                let (old_name, new_name) = step.arguments.as_double::<String, String>()?;
                let entity_name = step.entity_name.as_ref().ok_or_else(|| {
                    NitriteError::new(
                        "Entity name required for RepositoryRenameField",
                        ErrorKind::ValidationError,
                    )
                })?;
                let collection_name = repository_name(entity_name, step.key.as_deref())?;

                MigrationCommand::RenameField {
                    collection_name,
                    old_field_name: old_name,
                    new_field_name: new_name,
                }
            }
            InstructionType::RepositoryDeleteField => {
                let field_name = step.arguments.as_single::<String>()?;
                let entity_name = step.entity_name.as_ref().ok_or_else(|| {
                    NitriteError::new(
                        "Entity name required for RepositoryDeleteField",
                        ErrorKind::ValidationError,
                    )
                })?;
                let collection_name = repository_name(entity_name, step.key.as_deref())?;

                MigrationCommand::DeleteField {
                    collection_name,
                    field_name,
                }
            }
            InstructionType::RepositoryChangeDataType => {
                // RepositoryChangeDataType stores field_name and converter function in Double variant
                let entity_name = step.entity_name.as_ref().ok_or_else(|| {
                    NitriteError::new(
                        "Entity name required for RepositoryChangeDataType",
                        ErrorKind::ValidationError,
                    )
                })?;
                let collection_name = repository_name(entity_name, step.key.as_deref())?;

                let (field_name, converter_fn) =
                    step.arguments.as_double::<String, MigrationFn>()?;
                let converter: Arc<dyn Fn(Value) -> NitriteResult<Value> + Send + Sync> =
                    Arc::new(move |v| converter_fn.call_value_converter(v));
                MigrationCommand::ChangeDataType {
                    collection_name,
                    field_name,
                    converter,
                }
            }
            InstructionType::RepositoryChangeIdField => {
                let (old_field_names, new_field_names) =
                    step.arguments.as_double::<Vec<String>, Vec<String>>()?;
                let entity_name = step.entity_name.as_ref().ok_or_else(|| {
                    NitriteError::new(
                        "Entity name required for RepositoryChangeIdField",
                        ErrorKind::ValidationError,
                    )
                })?;
                let collection_name = repository_name(entity_name, step.key.as_deref())?;

                let old_field = Fields::with_names(
                    old_field_names
                        .iter()
                        .map(|s| s.as_str())
                        .collect::<Vec<&str>>(),
                )?;
                let new_field = Fields::with_names(
                    new_field_names
                        .iter()
                        .map(|s| s.as_str())
                        .collect::<Vec<&str>>(),
                )?;

                MigrationCommand::ChangeIdField {
                    collection_name,
                    old_id_field: old_field,
                    new_id_field: new_field,
                }
            }
            InstructionType::RepositoryDropIndex => {
                let args = step.arguments.as_single::<Vec<String>>()?;
                let entity_name = step.entity_name.as_ref().ok_or_else(|| {
                    NitriteError::new(
                        "Entity name required for RepositoryDropIndex",
                        ErrorKind::ValidationError,
                    )
                })?;
                let collection_name = repository_name(entity_name, step.key.as_deref())?;

                MigrationCommand::DropIndex {
                    collection_name,
                    fields: Some(Fields::with_names(
                        args.iter().map(|s| s.as_str()).collect::<Vec<&str>>(),
                    )?),
                }
            }
            InstructionType::RepositoryDropAllIndices => {
                let entity_name = step.entity_name.as_ref().ok_or_else(|| {
                    NitriteError::new(
                        "Entity name required for RepositoryDropAllIndices",
                        ErrorKind::ValidationError,
                    )
                })?;
                let collection_name = repository_name(entity_name, step.key.as_deref())?;

                MigrationCommand::DropIndex {
                    collection_name,
                    fields: None,
                }
            }
            InstructionType::RepositoryCreateIndex => {
                let (index_type, field_names) =
                    step.arguments.as_double::<String, Vec<String>>()?;
                let entity_name = step.entity_name.as_ref().ok_or_else(|| {
                    NitriteError::new(
                        "Entity name required for RepositoryCreateIndex",
                        ErrorKind::ValidationError,
                    )
                })?;
                let collection_name = repository_name(entity_name, step.key.as_deref())?;

                MigrationCommand::CreateIndex {
                    collection_name,
                    fields: Fields::with_names(
                        field_names
                            .iter()
                            .map(|s| s.as_str())
                            .collect::<Vec<&str>>(),
                    )?,
                    index_type,
                }
            }
        };

        command.execute(self.nitrite.clone())?;
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::errors::{ErrorKind, NitriteResult};
    use crate::migration::Migration;
    use crate::nitrite::Nitrite;
    use std::sync::{Arc, Mutex};

    // ==================== Helper Functions ====================

    /// Creates a no-op migration that does nothing
    fn noop_migration(from: u32, to: u32) -> Migration {
        Migration::new(from, to, |_instruction_set| Ok(()))
    }

    /// Creates a migration that tracks execution via a shared tracker
    fn tracked_migration(
        from: u32,
        to: u32,
        label: &str,
        tracker: Arc<Mutex<Vec<String>>>,
    ) -> Migration {
        let label = label.to_string();
        Migration::new(from, to, move |instruction_set| {
            // Simply add a step to the instruction set that will push the label when executed
            let mut database_builder = instruction_set.for_database();
            let tracker_clone = tracker.clone();
            let label_clone = label.clone();
            database_builder.custom_instruction(move |_nitrite| {
                tracker_clone.lock().unwrap().push(label_clone.clone());
                Ok(())
            });
            Ok(())
        })
    }

    /// Sets up a MigrationManager with given migrations and schema versions
    fn setup_manager(
        config_schema_version: u32,
        migrations: Vec<Migration>,
    ) -> NitriteResult<(MigrationManager, Nitrite)> {
        let mut builder = Nitrite::builder().schema_version(config_schema_version);

        // Add migrations to the builder before initialization
        for migration in migrations {
            builder = builder.add_migration(migration);
        }

        let nitrite = builder.open_or_create(None, None)?;
        let manager = MigrationManager::new(nitrite.clone());
        Ok((manager, nitrite))
    }

    // ==================== MigrationManager::new() Tests ====================

    #[test]
    fn test_new_creates_manager_with_nitrite() -> NitriteResult<()> {
        let nitrite = Nitrite::builder().open_or_create(None, None)?;
        let manager = MigrationManager::new(nitrite.clone());
        // Manager should hold reference to nitrite
        let _ = manager.nitrite.config().schema_version();
        nitrite.close()?;
        Ok(())
    }

    // ==================== is_migration_needed() Tests ====================

    #[test]
    fn test_is_migration_needed_false_when_versions_match() -> NitriteResult<()> {
        let nitrite = Nitrite::builder()
            .schema_version(1)
            .open_or_create(None, None)?;
        let manager = MigrationManager::new(nitrite.clone());

        // Database metadata version equals config version
        let metadata = nitrite.database_metadata()?;
        let config_version = nitrite.config().schema_version();

        if metadata.schema_version == config_version {
            assert!(!manager.is_migration_needed()?);
        }
        nitrite.close()?;
        Ok(())
    }

    // ==================== find_migration_path() Tests ====================

    #[test]
    fn test_find_migration_path_same_version_returns_empty() -> NitriteResult<()> {
        let (manager, nitrite) = setup_manager(1, vec![])?;
        let path = manager.find_migration_path(5, 5)?;
        assert!(path.is_empty());
        nitrite.close()?;
        Ok(())
    }

    #[test]
    fn test_find_migration_path_upgrade_single_step() -> NitriteResult<()> {
        let migrations = vec![noop_migration(1, 2)];
        let (manager, nitrite) = setup_manager(2, migrations)?;

        let path = manager.find_migration_path(1, 2)?;
        assert_eq!(path.len(), 1);
        assert_eq!(path[0].from_version(), 1);
        assert_eq!(path[0].to_version(), 2);
        nitrite.close()?;
        Ok(())
    }

    #[test]
    fn test_find_migration_path_upgrade_multi_step() -> NitriteResult<()> {
        let migrations = vec![
            noop_migration(1, 2),
            noop_migration(2, 3),
            noop_migration(3, 4),
        ];
        let (manager, nitrite) = setup_manager(4, migrations)?;

        let path = manager.find_migration_path(1, 4)?;
        assert_eq!(path.len(), 3);
        assert_eq!(path[0].from_version(), 1);
        assert_eq!(path[2].to_version(), 4);
        nitrite.close()?;
        Ok(())
    }

    #[test]
    fn test_find_migration_path_downgrade_single_step() -> NitriteResult<()> {
        let migrations = vec![noop_migration(2, 1)];
        let (manager, nitrite) = setup_manager(1, migrations)?;

        let path = manager.find_migration_path(2, 1)?;
        assert_eq!(path.len(), 1);
        assert_eq!(path[0].from_version(), 2);
        assert_eq!(path[0].to_version(), 1);
        nitrite.close()?;
        Ok(())
    }

    #[test]
    fn test_find_migration_path_downgrade_multi_step() -> NitriteResult<()> {
        let migrations = vec![
            noop_migration(4, 3),
            noop_migration(3, 2),
            noop_migration(2, 1),
        ];
        let (manager, nitrite) = setup_manager(1, migrations)?;

        let path = manager.find_migration_path(4, 1)?;
        assert_eq!(path.len(), 3);
        assert_eq!(path[0].from_version(), 4);
        assert_eq!(path[2].to_version(), 1);
        nitrite.close()?;
        Ok(())
    }

    #[test]
    fn test_find_migration_path_no_route_returns_empty() -> NitriteResult<()> {
        let migrations = vec![noop_migration(1, 2)];
        let (manager, nitrite) = setup_manager(5, migrations)?;

        // No migration from 3 to 5
        let path = manager.find_migration_path(3, 5)?;
        assert!(path.is_empty());
        nitrite.close()?;
        Ok(())
    }

    #[test]
    fn test_find_migration_path_partial_route_returns_empty() -> NitriteResult<()> {
        let migrations = vec![
            noop_migration(1, 2),
            // Gap: no migration from 2 to 3
            noop_migration(3, 4),
        ];
        let (manager, nitrite) = setup_manager(4, migrations)?;

        // Cannot reach 4 from 1 due to gap at 2->3
        let path = manager.find_migration_path(1, 4)?;
        assert!(path.is_empty());
        nitrite.close()?;
        Ok(())
    }

    #[test]
    fn test_find_migration_path_chooses_optimal_upgrade() -> NitriteResult<()> {
        // Two paths: 1->2->3 or 1->3 directly
        let migrations = vec![
            noop_migration(1, 2),
            noop_migration(2, 3),
            noop_migration(1, 3), // Direct jump
        ];
        let (manager, nitrite) = setup_manager(3, migrations)?;

        let path = manager.find_migration_path(1, 3)?;
        // Should prefer direct jump (1->3)
        assert_eq!(path.len(), 1);
        assert_eq!(path[0].from_version(), 1);
        assert_eq!(path[0].to_version(), 3);
        nitrite.close()?;
        Ok(())
    }

    // ==================== execute_migration_path() Tests ====================

    #[test]
    fn test_execute_migration_path_empty_succeeds() -> NitriteResult<()> {
        let (manager, nitrite) = setup_manager(1, vec![])?;
        let result = manager.execute_migration_path(&[]);
        assert!(result.is_ok());
        nitrite.close()?;
        Ok(())
    }

    #[test]
    fn test_execute_migration_path_updates_schema_version() -> NitriteResult<()> {
        let migrations = vec![noop_migration(1, 2)];
        let (manager, nitrite) = setup_manager(2, migrations.clone())?;

        let path: Vec<Arc<Migration>> = migrations.into_iter().map(Arc::new).collect();
        manager.execute_migration_path(&path)?;

        // Schema version should be updated to config version
        let store = nitrite.store();
        let store_info = store.open_map(STORE_INFO)?;
        if let Some(Value::Document(doc)) = store_info.get(&Value::from(STORE_INFO))? {
            let version_val = doc.get("schema_version")?;
            let version = version_val.as_u32().unwrap_or(&0);
            assert_eq!(*version, 2);
        }
        nitrite.close()?;
        Ok(())
    }

    // ==================== execute_migration_steps() Tests ====================

    #[test]
    fn test_execute_migration_steps_runs_all_steps() -> NitriteResult<()> {
        let tracker = Arc::new(Mutex::new(Vec::new()));
        let migration = tracked_migration(1, 2, "test_step", tracker.clone());

        let (manager, nitrite) = setup_manager(2, vec![])?;

        // execute_migration_steps should trigger the migration closure and run steps
        manager.execute_migration_steps(&migration)?;

        let executed = tracker.lock().unwrap();
        assert_eq!(executed.len(), 1);
        assert_eq!(executed[0], "test_step");
        nitrite.close()?;
        Ok(())
    }

    // ==================== do_migrate() Tests ====================

    #[test]
    fn test_do_migrate_skips_when_not_needed() -> NitriteResult<()> {
        let nitrite = Nitrite::builder()
            .schema_version(1)
            .open_or_create(None, None)?;
        let manager = MigrationManager::new(nitrite.clone());

        // If versions match, should return Ok without doing anything
        let result = manager.do_migrate();
        assert!(result.is_ok());
        nitrite.close()?;
        Ok(())
    }

    #[test]
    fn test_do_migrate_error_when_no_path() -> NitriteResult<()> {
        // Create nitrite with version 1, then try to migrate to version 5 without migrations
        let nitrite = Nitrite::builder()
            .schema_version(5)
            .open_or_create(None, None)?;

        let manager = MigrationManager::new(nitrite.clone());

        // Check if migration is needed
        let metadata = nitrite.database_metadata()?;
        let config_version = nitrite.config().schema_version();

        if metadata.schema_version != config_version {
            let result = manager.do_migrate();
            assert!(result.is_err());
            if let Err(e) = result {
                assert_eq!(e.kind(), &ErrorKind::MigrationError);
            }
        }
        Ok(())
    }

    // ==================== Migration Direction Tests ====================

    #[test]
    fn test_upgrade_direction_detection() -> NitriteResult<()> {
        let migrations = vec![noop_migration(1, 2)];
        let (manager, nitrite) = setup_manager(2, migrations)?;

        // 1 -> 2 is upgrade
        let path = manager.find_migration_path(1, 2)?;
        assert_eq!(path.len(), 1);
        nitrite.close()?;
        Ok(())
    }

    #[test]
    fn test_downgrade_direction_detection() -> NitriteResult<()> {
        let migrations = vec![noop_migration(2, 1)];
        let (manager, nitrite) = setup_manager(1, migrations)?;

        // 2 -> 1 is downgrade
        let path = manager.find_migration_path(2, 1)?;
        assert_eq!(path.len(), 1);
        nitrite.close()?;
        Ok(())
    }

    // ==================== Edge Cases ====================

    #[test]
    fn test_migration_with_zero_version() -> NitriteResult<()> {
        let migrations = vec![noop_migration(0, 1)];
        let (manager, nitrite) = setup_manager(1, migrations)?;

        let path = manager.find_migration_path(0, 1)?;
        assert_eq!(path.len(), 1);
        nitrite.close()?;
        Ok(())
    }

    #[test]
    fn test_migration_large_version_numbers() -> NitriteResult<()> {
        let migrations = vec![noop_migration(1000, 1001)];
        let (manager, nitrite) = setup_manager(1001, migrations)?;

        let path = manager.find_migration_path(1000, 1001)?;
        assert_eq!(path.len(), 1);
        nitrite.close()?;
        Ok(())
    }

    #[test]
    fn test_multiple_migrations_from_same_version() -> NitriteResult<()> {
        // Multiple targets from version 1
        let migrations = vec![
            noop_migration(1, 2),
            noop_migration(1, 3),
            noop_migration(1, 5),
        ];
        let (manager, nitrite) = setup_manager(5, migrations)?;

        // Should choose 1->5 as optimal path to 5
        let path = manager.find_migration_path(1, 5)?;
        assert_eq!(path.len(), 1);
        assert_eq!(path[0].to_version(), 5);
        nitrite.close()?;
        Ok(())
    }

    #[test]
    fn test_chained_migrations_execute_in_order() -> NitriteResult<()> {
        let tracker = Arc::new(Mutex::new(Vec::new()));
        let migrations = vec![
            tracked_migration(1, 2, "step_1_2", tracker.clone()),
            tracked_migration(2, 3, "step_2_3", tracker.clone()),
        ];

        let (manager, nitrite) = setup_manager(3, migrations.clone())?;

        let path: Vec<Arc<Migration>> = migrations.into_iter().map(Arc::new).collect();
        manager.execute_migration_path(&path)?;

        let executed = tracker.lock().unwrap();
        assert_eq!(executed.len(), 2);
        assert_eq!(executed[0], "step_1_2");
        assert_eq!(executed[1], "step_2_3");
        nitrite.close()?;
        Ok(())
    }
}