hayson-engine 0.17.0

Storage engine for hayson document databases — the embeddable core behind hayson-server, hayson-cli and hayson-browser
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

//! `verify` from outside the crate: it reports damage as findings and never fails on it.

use std::fs::{self, OpenOptions};
use std::io::Write;
use std::path::Path;

use hayson_engine::database::{verify, Database, Severity, VerifyOptions};
use serde_json::json;
use tempfile::TempDir;

fn seeded() -> TempDir {
    let dir = TempDir::new().unwrap();
    let mut database = Database::open(dir.path()).unwrap();
    database
        .create_table(
            "users",
            json!({
                "schemaVersion": 1,
                "table": "users",
                "primaryKey": "id",
                "fields": { "id": { "type": "string" }, "name": { "type": "string" } },
            }),
        )
        .unwrap();
    let users = database.table_mut("users").unwrap();
    users.put(&json!({ "id": "u1", "name": "Ania" }), false).unwrap();
    users.put(&json!({ "id": "u2", "name": "Bartek" }), false).unwrap();
    database.close().unwrap();
    dir
}

fn codes(dir: &Path) -> Vec<&'static str> {
    verify(dir, &VerifyOptions::default())
        .problems
        .iter()
        .map(|p| p.code)
        .collect()
}

fn append(path: &Path, bytes: &[u8]) {
    OpenOptions::new()
        .append(true)
        .open(path)
        .unwrap()
        .write_all(bytes)
        .unwrap();
}

#[test]
fn a_healthy_database_is_clean() {
    let dir = seeded();
    let report = verify(dir.path(), &VerifyOptions::default());
    assert!(report.is_clean(), "{:?}", report.problems);
    assert_eq!(report.tables_checked, 1);
    assert_eq!(report.log_lines_checked, 2);
}

#[test]
fn a_missing_directory_is_a_finding() {
    let dir = TempDir::new().unwrap();
    assert_eq!(codes(&dir.path().join("nope")), ["directory-missing"]);
}

#[test]
fn an_empty_directory_only_warns() {
    let dir = TempDir::new().unwrap();
    let report = verify(dir.path(), &VerifyOptions::default());
    assert_eq!(report.problems.len(), 1);
    assert_eq!(report.problems[0].code, "catalog-missing");
    assert_eq!(report.problems[0].severity, Severity::Warning);
}

#[test]
fn logs_without_a_catalog_are_an_error() {
    let dir = seeded();
    fs::remove_file(dir.path().join("hayson.json")).unwrap();
    let report = verify(dir.path(), &VerifyOptions::default());
    assert_eq!(report.problems[0].code, "catalog-missing");
    assert_eq!(report.problems[0].severity, Severity::Error);
}

#[test]
fn a_damaged_catalog_is_a_finding_not_a_crash() {
    let dir = seeded();
    fs::write(dir.path().join("hayson.json"), "{ not json").unwrap();
    assert_eq!(codes(dir.path()), ["catalog-invalid-json"]);
    fs::write(dir.path().join("hayson.json"), "[1,2]").unwrap();
    assert_eq!(codes(dir.path()), ["catalog-invalid"]);
    fs::write(dir.path().join("hayson.json"), [0xff, 0xfe]).unwrap();
    assert_eq!(codes(dir.path()), ["catalog-unreadable"]);
}

#[test]
fn a_corrupt_log_line_names_its_offset() {
    let dir = seeded();
    let log = dir.path().join("users.jsonl");
    let before = fs::metadata(&log).unwrap().len();
    append(&log, b"{broken\n");
    let report = verify(dir.path(), &VerifyOptions::default());
    let problem = &report.problems[0];
    assert_eq!(problem.code, "log-corrupt-line");
    assert_eq!(problem.table.as_deref(), Some("users"));
    assert_eq!(problem.offset, Some(before));
}

#[test]
fn invalid_utf8_in_a_log_is_a_finding() {
    let dir = seeded();
    append(&dir.path().join("users.jsonl"), &[0xff, 0xfe, b'\n']);
    assert_eq!(codes(dir.path()), ["log-corrupt-line"]);
}

#[test]
fn an_unfinished_tail_is_only_a_warning() {
    let dir = seeded();
    append(&dir.path().join("users.jsonl"), b"{\"_k\":\"u3\"");
    let report = verify(dir.path(), &VerifyOptions::default());
    assert_eq!(report.problems.len(), 1);
    assert_eq!(report.problems[0].code, "log-truncated-tail");
    assert_eq!(report.problems[0].severity, Severity::Warning);
    assert!(!report.has_errors());
}

#[test]
fn a_log_the_catalog_does_not_declare_is_reported() {
    let dir = seeded();
    fs::write(dir.path().join("ghost.jsonl"), "").unwrap();
    assert_eq!(codes(dir.path()), ["log-undeclared"]);
}

#[test]
fn verify_changes_nothing_on_disk() {
    let dir = seeded();
    append(&dir.path().join("users.jsonl"), b"{\"_k\":\"u3\"");
    let snapshot = |p: &Path| {
        let mut files: Vec<_> = fs::read_dir(p)
            .unwrap()
            .map(|e| e.unwrap().path())
            .map(|path| (path.clone(), fs::read(&path).unwrap_or_default()))
            .collect();
        files.sort();
        files
    };
    let before = snapshot(dir.path());
    verify(dir.path(), &VerifyOptions::default());
    assert_eq!(snapshot(dir.path()), before);
}