nodedb-lite 0.1.0

Embedded edge client for NodeDB — offline vector search, graph traversal, and CRDT sync
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

// SPDX-License-Identifier: Apache-2.0

//! [`LiteConfig::validate`] — coherence checks for the percentage fields.

use nodedb_types::error::{NodeDbError, NodeDbResult};

use super::defaults::MAX_TOTAL_ENGINE_PERCENT;
use super::types::LiteConfig;

impl LiteConfig {
    /// Validate that percentage fields are coherent.
    ///
    /// Returns an error if:
    /// - Any individual percentage exceeds 100
    /// - The sum of all engine percentages exceeds `MAX_TOTAL_ENGINE_PERCENT`
    pub fn validate(&self) -> NodeDbResult<()> {
        for (name, pct) in [
            ("hnsw_percent", self.hnsw_percent),
            ("csr_percent", self.csr_percent),
            ("loro_percent", self.loro_percent),
            ("query_percent", self.query_percent),
            ("kv_percent", self.kv_percent),
            ("document_percent", self.document_percent),
            ("strict_percent", self.strict_percent),
            ("columnar_percent", self.columnar_percent),
            ("timeseries_percent", self.timeseries_percent),
            ("spatial_percent", self.spatial_percent),
            ("fts_percent", self.fts_percent),
            ("array_percent", self.array_percent),
            ("sparse_percent", self.sparse_percent),
        ] {
            if pct > 100 {
                return Err(NodeDbError::config(format!(
                    "{name} must be 0–100, got {pct}"
                )));
            }
        }

        let total = self
            .hnsw_percent
            .saturating_add(self.csr_percent)
            .saturating_add(self.loro_percent)
            .saturating_add(self.query_percent)
            .saturating_add(self.kv_percent)
            .saturating_add(self.document_percent)
            .saturating_add(self.strict_percent)
            .saturating_add(self.columnar_percent)
            .saturating_add(self.timeseries_percent)
            .saturating_add(self.spatial_percent)
            .saturating_add(self.fts_percent)
            .saturating_add(self.array_percent)
            .saturating_add(self.sparse_percent);

        if total > MAX_TOTAL_ENGINE_PERCENT {
            return Err(NodeDbError::config(format!(
                "sum of engine percentages is {total}%, must not exceed {MAX_TOTAL_ENGINE_PERCENT}% \
                 (at least 1% headroom required)"
            )));
        }

        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn default_config_validates() {
        assert!(LiteConfig::default().validate().is_ok());
    }

    #[test]
    fn validate_rejects_percent_over_100() {
        let cfg = LiteConfig {
            hnsw_percent: 101,
            ..LiteConfig::default()
        };
        assert!(cfg.validate().is_err());
    }

    #[test]
    fn validate_rejects_sum_over_max() {
        let cfg = LiteConfig {
            hnsw_percent: 40,
            csr_percent: 25,
            loro_percent: 25,
            query_percent: 15,
            ..LiteConfig::default()
        };
        // Sum = 105 > 99.
        assert!(cfg.validate().is_err());
    }
}