ocserve 0.3.1

ocserve binary: serve, import, doctor, bench
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

//! ocserve library surface: boot self-checks (SRE §1) exposed for tests.
#![cfg_attr(not(test), forbid(unsafe_code))]

use anyhow::{Context, Result};

pub fn boot_checks(data_dir: &std::path::Path) -> Result<()> {
    use ocserve_store::pragma;
    // 1. version gate
    pragma::assert_version_ok().context("sqlite version gate")?;
    // 2. data dir writable
    let probe = data_dir.join(".boot-probe");
    std::fs::write(&probe, b"ok")
        .with_context(|| format!("write probe in {}", data_dir.display()))?;
    let _ = std::fs::remove_file(&probe);
    // 3. disk headroom > 2x WAL limit (64MB journal limit)
    match stat_free_bytes(data_dir) {
        Ok(free) if free < 128 * 1024 * 1024 => {
            anyhow::bail!("only {free} bytes free; need >128 MB (2x WAL limit)");
        }
        Ok(free) => tracing::debug!("disk headroom {free} bytes"),
        Err(e) => tracing::warn!("disk headroom check skipped: {e:#}"), // loud, not silent
    }
    // 4. open/create DB and run schema migration (creates pragmas profile)
    let db = ocserve_store::writer::db_path(data_dir);
    let conn = pragma::open_writer(&db).context("open/create database")?;
    ocserve_store::schema::migrate(&conn).context("schema migrate")?;
    // 4.5 ring bound enforced at boot (STORAGE §4; AGENTS §2.3)
    let pruned = ocserve_store::enforce_event_retention(&conn).context("event retention")?;
    if pruned > 0 {
        tracing::info!("event retention at boot: {pruned} rows pruned");
    }
    // 5. FTS roundtrip on the real DB (catches broken builds — M0 finding)
    conn.execute_batch(
        "CREATE VIRTUAL TABLE temp.boot_fts_probe USING fts5(x, tokenize='trigram');
         INSERT INTO temp.boot_fts_probe VALUES ('boot fts probe');
         SELECT count(*) FROM temp.boot_fts_probe WHERE boot_fts_probe MATCH '\"ts prob\"';
         DROP TABLE temp.boot_fts_probe;",
    )
    .context("FTS5 roundtrip (broken FTS build?)")?;
    tracing::info!("boot checks OK");
    Ok(())
}

pub fn stat_free_bytes(p: &std::path::Path) -> Result<u64> {
    // Boot path only (not hot): shell out to `df -k`; avoids a libc dependency.
    let out = std::process::Command::new("df").arg("-k").arg(p).output()?;
    let text = String::from_utf8_lossy(&out.stdout);
    let line = text.lines().nth(1).context("df output")?;
    let avail: u64 = line
        .split_whitespace()
        .nth(3)
        .context("df avail column")?
        .parse()
        .context("df avail parse")?;
    Ok(avail * 1024)
}