aedb 0.3.1

Embedded Rust storage engine with transactional commits, WAL durability, and snapshot-consistent reads
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

use std::collections::BTreeMap;
use std::fs;
use std::path::{Path, PathBuf};

const DEFAULT_SOURCE_LINE_BUDGET: usize = 1_500;

#[test]
fn source_files_stay_within_reviewable_line_budgets() {
    let root = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
    let budgets = large_file_budgets();
    let mut violations = Vec::new();

    for path in collect_rust_sources(&root.join("src")) {
        let rel = path.strip_prefix(&root).expect("source path under root");
        let rel_key = rel.to_string_lossy().replace('\\', "/");
        let line_count = fs::read_to_string(&path)
            .expect("read source")
            .lines()
            .count();
        let budget = budgets
            .get(rel_key.as_str())
            .copied()
            .unwrap_or(DEFAULT_SOURCE_LINE_BUDGET);
        if line_count > budget {
            violations.push(format!("{rel_key}: {line_count} lines > budget {budget}"));
        }
    }

    assert!(
        violations.is_empty(),
        "source files exceeded reviewability budgets; split the file or add a documented budget in tests/source_shape.rs:\n{}",
        violations.join("\n")
    );
}

#[test]
fn readme_stays_product_focused() {
    let root = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
    let readme = fs::read_to_string(root.join("README.md")).expect("read README");
    let banned_terms = [
        "casino",
        "financial-grade",
        "bank-grade",
        "battle-tested",
        "enterprise-grade",
        "production-ready",
    ];

    for term in banned_terms {
        assert!(
            !readme.to_ascii_lowercase().contains(term),
            "README should stay storage-engine focused and avoid `{term}`"
        );
    }
}

#[test]
fn source_modules_do_not_use_parent_or_crate_glob_imports() {
    let root = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
    let mut violations = Vec::new();

    for path in collect_rust_sources(&root.join("src")) {
        let source = fs::read_to_string(&path).expect("read source");
        for (line_number, line) in source.lines().enumerate() {
            if matches!(line.trim(), "use super::*;" | "use crate::*;") {
                let rel = path
                    .strip_prefix(&root)
                    .expect("source path under root")
                    .to_string_lossy()
                    .replace('\\', "/");
                violations.push(format!("{}:{}", rel, line_number + 1));
            }
        }
    }

    assert!(
        violations.is_empty(),
        "source modules should import explicit dependencies instead of parent globs:\n{}",
        violations.join("\n")
    );
}

#[test]
fn source_modules_do_not_use_wildcard_reexports() {
    let root = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
    let mut violations = Vec::new();

    for path in collect_rust_sources(&root.join("src")) {
        let source = fs::read_to_string(&path).expect("read source");
        for (line_number, line) in source.lines().enumerate() {
            let trimmed = line.trim();
            if (trimmed.starts_with("pub use ") || trimmed.starts_with("pub(crate) use "))
                && trimmed.ends_with("::*;")
            {
                let rel = path
                    .strip_prefix(&root)
                    .expect("source path under root")
                    .to_string_lossy()
                    .replace('\\', "/");
                violations.push(format!("{}:{}", rel, line_number + 1));
            }
        }
    }

    assert!(
        violations.is_empty(),
        "source modules should re-export explicit items instead of wildcard exports:\n{}",
        violations.join("\n")
    );
}

#[test]
fn implementation_modules_keep_tests_in_dedicated_files() {
    let root = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
    let mut violations = Vec::new();

    for path in collect_rust_sources(&root.join("src")) {
        if is_dedicated_test_source(&path) {
            continue;
        }
        let source = fs::read_to_string(&path).expect("read source");
        let lines: Vec<_> = source.lines().collect();
        for (line_index, pair) in lines.windows(2).enumerate() {
            if pair[0].trim() == "#[cfg(test)]" && pair[1].trim() == "mod tests {" {
                let rel = path
                    .strip_prefix(&root)
                    .expect("source path under root")
                    .to_string_lossy()
                    .replace('\\', "/");
                violations.push(format!("{}:{}", rel, line_index + 1));
            }
        }
    }

    assert!(
        violations.is_empty(),
        "implementation modules should move inline test bodies into dedicated test files:\n{}",
        violations.join("\n")
    );
}

fn large_file_budgets() -> BTreeMap<&'static str, usize> {
    BTreeMap::from([
        // Central commit engine internals. Split only along scheduler/apply/replay-safe boundaries.
        // +index posting eviction step in the pre-WAL spill cascade.
        // Async-index/KV-projection refresh moved to internals/projections.rs (budget lowered).
        ("src/commit/executor/internals.rs", 5_100),
        ("src/commit/executor/tests.rs", 4_300),
        // +tier-aware secondary-index maintenance (tombstoning, cold-tier unique/FK checks).
        // System-table schema bootstrap moved to apply/system_schema.rs, foreign-key
        // enforcement to apply/foreign_keys.rs (budget lowered).
        ("src/commit/apply.rs", 3_300),
        // Row-spill support (StoredRow + spill_table_rows + materialize helpers) plus the
        // secondary-index cold tier (eviction, re-inline, composite-key helpers).
        // +`# Panics` docs steering the convenience KV reads to their `try_` twins.
        ("src/storage/keyspace.rs", 4_100),
        // Cold-tier eviction/re-inline + tier-read coverage for rows, KV, and indexes.
        ("src/storage/keyspace/tests.rs", 1_700),
        // Reactive processor support types moved to reactive_support.rs (budget lowered).
        ("src/lib.rs", 3_650),
        ("src/catalog/mod.rs", 2_150),
        // Permission checks moved to validation/permissions.rs (budget lowered).
        ("src/commit/validation.rs", 2_150),
        ("src/order_book.rs", 2_200),
        ("src/commit/executor/mod.rs", 1_900),
        ("src/lib_tests/auth.rs", 4_400),
        ("src/api/order_book_api.rs", 1_610),
        ("src/api/kv_api.rs", 1_550),
        ("src/api/reactive_processors.rs", 1_520),
        ("src/lib_tests/kv_api.rs", 1_650),
        // Helper facades should stay thin. Add narrowly named modules instead of rebuilding catch-alls.
        ("src/lib_helpers.rs", 55),
        // Query executor test coverage is split by behavior; keep the shared fixture module small.
        // Bumped for the expanded query-engine tests (joins/DISTINCT/computed projections).
        ("src/query/executor/tests.rs", 500),
    ])
}

fn collect_rust_sources(dir: &Path) -> Vec<PathBuf> {
    let mut out = Vec::new();
    collect_rust_sources_inner(dir, &mut out);
    out
}

fn collect_rust_sources_inner(dir: &Path, out: &mut Vec<PathBuf>) {
    for entry in fs::read_dir(dir).expect("read source dir") {
        let entry = entry.expect("read source entry");
        let path = entry.path();
        if path.is_dir() {
            collect_rust_sources_inner(&path, out);
        } else if path.extension().is_some_and(|ext| ext == "rs") {
            out.push(path);
        }
    }
}

fn is_dedicated_test_source(path: &Path) -> bool {
    path.file_name()
        .and_then(|name| name.to_str())
        .is_some_and(|name| name == "tests.rs" || name.ends_with("_tests.rs"))
}