modelvault-core 0.16.0

Core engine for ModelVault — application-focused embedded storage with model schemas, validation, and migrations.
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

use std::borrow::Cow;

use modelvault_core::error::SchemaError;
use modelvault_core::schema::{FieldDef, FieldPath, IndexDef, IndexKind, Type};
use modelvault_core::{CollectionId, Database, DbError};

fn field(name: &str, ty: Type) -> FieldDef {
    FieldDef {
        path: FieldPath(vec![Cow::Owned(name.to_string())]),
        ty,
        constraints: vec![],
    }
}

#[test]
fn schema_update_allows_add_optional_field() {
    let mut db = Database::open_in_memory().unwrap();
    db.register_collection("t", vec![field("id", Type::Int64)], "id")
        .unwrap();
    let cid = CollectionId(1);
    let next = db
        .register_schema_version(
            cid,
            vec![
                field("id", Type::Int64),
                field("note", Type::Optional(Box::new(Type::String))),
            ],
        )
        .unwrap();
    assert_eq!(next.0, 2);
}

#[test]
fn schema_update_rejects_add_required_field_without_migration() {
    let mut db = Database::open_in_memory().unwrap();
    db.register_collection("t", vec![field("id", Type::Int64)], "id")
        .unwrap();
    let cid = CollectionId(1);
    let err =
        db.register_schema_version(cid, vec![field("id", Type::Int64), field("x", Type::Int64)]);
    assert!(matches!(
        err,
        Err(DbError::Schema(SchemaError::MigrationRequired { .. }))
    ));
}

#[test]
fn schema_update_rejects_type_change_and_field_removal() {
    let mut db = Database::open_in_memory().unwrap();
    db.register_collection(
        "t",
        vec![field("id", Type::Int64), field("x", Type::Int64)],
        "id",
    )
    .unwrap();
    let cid = CollectionId(1);

    let err = db.register_schema_version(cid, vec![field("id", Type::Int64)]);
    assert!(matches!(
        err,
        Err(DbError::Schema(
            SchemaError::IncompatibleSchemaChange { .. }
        ))
    ));

    let err2 = db.register_schema_version(
        cid,
        vec![field("id", Type::Int64), field("x", Type::String)],
    );
    assert!(matches!(
        err2,
        Err(DbError::Schema(
            SchemaError::IncompatibleSchemaChange { .. }
        ))
    ));
}

#[test]
fn schema_update_allows_add_enum_variant_but_rejects_removal() {
    let mut db = Database::open_in_memory().unwrap();
    db.register_collection(
        "t",
        vec![
            field("id", Type::Int64),
            field("status", Type::Enum(vec!["open".into()])),
        ],
        "id",
    )
    .unwrap();
    let cid = CollectionId(1);

    db.register_schema_version(
        cid,
        vec![
            field("id", Type::Int64),
            field("status", Type::Enum(vec!["open".into(), "closed".into()])),
        ],
    )
    .unwrap();

    let err = db.register_schema_version(
        cid,
        vec![
            field("id", Type::Int64),
            field("status", Type::Enum(vec!["open".into()])),
        ],
    );
    assert!(matches!(
        err,
        Err(DbError::Schema(
            SchemaError::IncompatibleSchemaChange { .. }
        ))
    ));
}

#[test]
fn schema_update_index_additions_are_classified() {
    let mut db = Database::open_in_memory().unwrap();
    db.register_collection(
        "t",
        vec![field("id", Type::Int64), field("tag", Type::String)],
        "id",
    )
    .unwrap();
    let cid = CollectionId(1);

    // Non-unique index add is allowed.
    db.register_schema_version_with_indexes(
        cid,
        vec![field("id", Type::Int64), field("tag", Type::String)],
        vec![IndexDef {
            name: "tag_idx".to_string(),
            path: FieldPath(vec![Cow::Owned("tag".to_string())]),
            kind: IndexKind::NonUnique,
        }],
    )
    .unwrap();

    // Unique index add requires migration.
    let err = db.register_schema_version_with_indexes(
        cid,
        vec![field("id", Type::Int64), field("tag", Type::String)],
        vec![IndexDef {
            name: "tag_u".to_string(),
            path: FieldPath(vec![Cow::Owned("tag".to_string())]),
            kind: IndexKind::Unique,
        }],
    );
    assert!(matches!(
        err,
        Err(DbError::Schema(SchemaError::MigrationRequired { .. }))
    ));
}