bones-core 0.23.3

Core data structures, CRDT event model, and projection engine for bones
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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
//! Full projection rebuild from the event log.
//!
//! `bn admin rebuild` drops and recreates the entire `SQLite` DB from the canonical
//! event log, proving the projection is disposable and reproducible.

use std::path::Path;
use std::time::Instant;

use anyhow::{Context, Result};

use crate::db::{open_projection, project};
use crate::event::Event;
use crate::shard::ShardManager;
use std::io;

const DEFAULT_REBUILD_BATCH_SIZE: usize = 4_000;

fn rebuild_batch_size() -> usize {
    std::env::var("BONES_REBUILD_BATCH_SIZE")
        .ok()
        .and_then(|v| v.parse::<usize>().ok())
        .filter(|v| *v > 0)
        .unwrap_or(DEFAULT_REBUILD_BATCH_SIZE)
}

fn configure_rebuild_pragmas(conn: &rusqlite::Connection) -> Result<()> {
    conn.pragma_update(None, "temp_store", "MEMORY")
        .context("PRAGMA temp_store = MEMORY")?;
    conn.pragma_update(None, "cache_size", -131_072_i64)
        .context("PRAGMA cache_size")?;
    conn.pragma_update(None, "mmap_size", 268_435_456_i64)
        .context("PRAGMA mmap_size")?;
    Ok(())
}

// ---------------------------------------------------------------------------
// RebuildReport
// ---------------------------------------------------------------------------

/// Report returned after a full projection rebuild.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct RebuildReport {
    /// Total events replayed from all shards.
    pub event_count: usize,
    /// Total unique items in the rebuilt projection.
    pub item_count: usize,
    /// Wall-clock elapsed time for the rebuild.
    pub elapsed: std::time::Duration,
    /// Number of shard files processed.
    pub shard_count: usize,
    /// Whether FTS5 index was rebuilt.
    pub fts5_rebuilt: bool,
}

// ---------------------------------------------------------------------------
// rebuild
// ---------------------------------------------------------------------------

/// Validate sealed shard manifests, bailing on corruption.
fn check_sealed_shard_integrity(shard_mgr: &ShardManager) -> Result<()> {
    let issues = shard_mgr
        .validate_sealed_shards()
        .map_err(|e| anyhow::anyhow!("sealed shard validation: {e}"))?;
    if !issues.is_empty() {
        for issue in &issues {
            tracing::error!(
                shard = %issue.shard_name,
                problem = %issue.problem,
                "sealed shard integrity check failed"
            );
        }
        anyhow::bail!(
            "sealed shard corrupted: {} (run `bn doctor` to diagnose)",
            issues[0].problem
        );
    }
    Ok(())
}

/// Drop the existing DB and rebuild it from the canonical event log.
///
/// 1. Deletes the existing database file (if any)
/// 2. Creates a fresh schema via `open_projection`
/// 3. Replays all events from `events_dir` shards through the projector
/// 4. FTS5 index is maintained via triggers during projection
/// 5. Updates the projection cursor with the final offset
///
/// # Arguments
///
/// * `events_dir` — Path to `.bones/events/` (the shard directory)
/// * `db_path` — Path to `.bones/bones.db` (the `SQLite` projection file)
///
/// # Errors
///
/// Returns an error if shard reading, event parsing, or projection fails.
pub fn rebuild(events_dir: &Path, db_path: &Path) -> Result<RebuildReport> {
    let start = Instant::now();

    // 1. Delete existing database file
    if db_path.exists() {
        std::fs::remove_file(db_path)
            .with_context(|| format!("remove existing projection db {}", db_path.display()))?;
        // Also remove WAL and SHM files
        let wal_path = db_path.with_extension("db-wal");
        let shm_path = db_path.with_extension("db-shm");
        let _ = std::fs::remove_file(wal_path);
        let _ = std::fs::remove_file(shm_path);
    }

    // 2. Create fresh schema
    let conn = open_projection(db_path).context("create fresh projection database")?;
    configure_rebuild_pragmas(&conn).context("configure rebuild sqlite pragmas")?;
    project::ensure_tracking_table(&conn).context("create tracking table")?;

    // 3. Read and replay all events in streaming batches
    let bones_dir = events_dir.parent().unwrap_or_else(|| Path::new("."));
    let shard_mgr = ShardManager::new(bones_dir);

    let shards = shard_mgr
        .list_shards()
        .map_err(|e| anyhow::anyhow!("list shards: {e}"))?;
    let shard_count = shards.len();

    check_sealed_shard_integrity(&shard_mgr)?;

    // We need a custom loop because EventParser expects Iterator<Item = String>
    // and returns Result<Event, ...>.
    let mut version_checked = false;
    let mut shard_version = crate::event::parser::CURRENT_VERSION;
    let mut line_no = 0;
    let mut total_projected = 0;
    let mut total_duplicates = 0;
    let mut last_event_hash = None;
    let mut total_byte_len = 0;

    let batch_size = rebuild_batch_size();
    let mut current_batch: Vec<Event> = Vec::with_capacity(batch_size);
    let projector = project::Projector::new(&conn);

    let shard_line_iter = shard_mgr.replay_lines()?;

    for line_res in shard_line_iter {
        let (offset, line): (usize, String) =
            line_res.map_err(|e: io::Error| anyhow::anyhow!("read shard line: {e}"))?;
        line_no += 1;
        total_byte_len = offset + line.len();

        if !version_checked && line.trim_start().starts_with("# bones event log v") {
            version_checked = true;
            shard_version = crate::event::parser::detect_version(&line)
                .map_err(|msg| anyhow::anyhow!("version check failed at line {line_no}: {msg}"))?;
            continue;
        }

        match crate::event::parser::parse_line(&line) {
            Ok(crate::event::parser::ParsedLine::Event(event)) => {
                let event = crate::event::migrate_event(*event, shard_version)
                    .map_err(|e| anyhow::anyhow!("migration failed at line {line_no}: {e}"))?;

                last_event_hash = Some(event.event_hash.clone());
                current_batch.push(event);

                if current_batch.len() >= batch_size {
                    let stats = projector
                        .project_batch(&current_batch)
                        .context("project batch during rebuild")?;
                    total_projected += stats.projected;
                    total_duplicates += stats.duplicates;
                    current_batch.clear();
                }
            }
            Ok(
                crate::event::parser::ParsedLine::Comment(_)
                | crate::event::parser::ParsedLine::Blank,
            ) => {}
            Err(crate::event::parser::ParseError::InvalidEventType(raw)) => {
                tracing::warn!(line = line_no, event_type = %raw, "skipping unknown event type");
            }
            Err(e) => anyhow::bail!("parse error at line {line_no}: {e}"),
        }
    }

    // Final batch
    if !current_batch.is_empty() {
        let stats = projector
            .project_batch(&current_batch)
            .context("project final batch during rebuild")?;
        total_projected += stats.projected;
        total_duplicates += stats.duplicates;
    }

    // 5. Update projection cursor
    let byte_offset_i64 = i64::try_from(total_byte_len).unwrap_or(i64::MAX);
    crate::db::query::update_projection_cursor(&conn, byte_offset_i64, last_event_hash.as_deref())
        .context("update projection cursor after rebuild")?;

    // Count unique items
    let item_count: i64 = conn
        .query_row("SELECT COUNT(*) FROM items", [], |row| row.get(0))
        .context("count items after rebuild")?;

    let elapsed = start.elapsed();

    tracing::info!(
        event_count = total_projected,
        duplicates = total_duplicates,
        batch_size,
        item_count,
        shard_count,
        elapsed_ms = elapsed.as_millis(),
        "projection rebuild complete"
    );

    Ok(RebuildReport {
        event_count: total_projected,
        item_count: usize::try_from(item_count).unwrap_or(0),
        elapsed,
        shard_count,
        fts5_rebuilt: true, // FTS5 triggers fire during projection
    })
}

// ---------------------------------------------------------------------------
// Tests
// ---------------------------------------------------------------------------

#[cfg(test)]
mod tests {
    use super::*;
    use crate::event::Event;
    use crate::event::data::*;
    use crate::event::types::EventType;
    use crate::event::writer;
    use crate::model::item::{Kind, Size, Urgency};
    use crate::model::item_id::ItemId;
    use crate::shard::ShardManager;
    use std::collections::BTreeMap;
    use tempfile::TempDir;

    fn setup_bones_dir() -> (TempDir, ShardManager) {
        let dir = TempDir::new().expect("create tempdir");
        let shard_mgr = ShardManager::new(dir.path());
        shard_mgr.ensure_dirs().expect("ensure dirs");
        shard_mgr.init().expect("init shard");
        (dir, shard_mgr)
    }

    fn make_create_event(id: &str, title: &str, ts: i64) -> Event {
        let mut event = Event {
            wall_ts_us: ts,
            agent: "test-agent".into(),
            itc: "itc:AQ".into(),
            parents: vec![],
            event_type: EventType::Create,
            item_id: ItemId::new_unchecked(id),
            data: EventData::Create(CreateData {
                title: title.into(),
                kind: Kind::Task,
                size: Some(Size::M),
                urgency: Urgency::Default,
                labels: vec!["test".into()],
                parent: None,
                causation: None,
                description: Some(format!("Description for {title}")),
                extra: BTreeMap::new(),
            }),
            event_hash: String::new(),
        };
        // Compute hash
        writer::write_event(&mut event).expect("compute hash");
        event
    }

    fn make_move_event(
        id: &str,
        state: crate::model::item::State,
        ts: i64,
        parent_hash: &str,
    ) -> Event {
        let mut event = Event {
            wall_ts_us: ts,
            agent: "test-agent".into(),
            itc: "itc:AQ".into(),
            parents: vec![parent_hash.into()],
            event_type: EventType::Move,
            item_id: ItemId::new_unchecked(id),
            data: EventData::Move(MoveData {
                state,
                reason: None,
                extra: BTreeMap::new(),
            }),
            event_hash: String::new(),
        };
        writer::write_event(&mut event).expect("compute hash");
        event
    }

    fn append_event(shard_mgr: &ShardManager, event: &Event) {
        let line = writer::write_line(event).expect("serialize event");
        let (year, month) = shard_mgr.active_shard().unwrap().unwrap();
        shard_mgr
            .append_raw(year, month, &line)
            .expect("append event");
    }

    #[test]
    fn rebuild_empty_event_log() {
        let (dir, _shard_mgr) = setup_bones_dir();
        let db_path = dir.path().join("bones.db");
        let events_dir = dir.path().join("events");

        let report = rebuild(&events_dir, &db_path).unwrap();
        assert_eq!(report.event_count, 0);
        assert_eq!(report.item_count, 0);
        assert_eq!(report.shard_count, 1); // init creates one shard
        assert!(report.fts5_rebuilt);

        // Verify DB exists and is valid
        let conn = open_projection(&db_path).unwrap();
        let count: i64 = conn
            .query_row("SELECT COUNT(*) FROM items", [], |row| row.get(0))
            .unwrap();
        assert_eq!(count, 0);
    }

    #[test]
    fn rebuild_with_events() {
        let (dir, shard_mgr) = setup_bones_dir();
        let db_path = dir.path().join("bones.db");
        let events_dir = dir.path().join("events");

        // Write events
        let create1 = make_create_event("bn-001", "First item", 1000);
        let create2 = make_create_event("bn-002", "Second item", 1001);
        let mv = make_move_event(
            "bn-001",
            crate::model::item::State::Doing,
            2000,
            &create1.event_hash,
        );

        append_event(&shard_mgr, &create1);
        append_event(&shard_mgr, &create2);
        append_event(&shard_mgr, &mv);

        let report = rebuild(&events_dir, &db_path).unwrap();
        assert_eq!(report.event_count, 3);
        assert_eq!(report.item_count, 2);

        // Verify items
        let conn = open_projection(&db_path).unwrap();
        let item: String = conn
            .query_row(
                "SELECT state FROM items WHERE item_id = 'bn-001'",
                [],
                |row| row.get(0),
            )
            .unwrap();
        assert_eq!(item, "doing");
    }

    #[test]
    fn rebuild_replaces_existing_db() {
        let (dir, shard_mgr) = setup_bones_dir();
        let db_path = dir.path().join("bones.db");
        let events_dir = dir.path().join("events");

        // First rebuild with 1 event
        let create1 = make_create_event("bn-001", "Item 1", 1000);
        append_event(&shard_mgr, &create1);

        let report1 = rebuild(&events_dir, &db_path).unwrap();
        assert_eq!(report1.event_count, 1);
        assert_eq!(report1.item_count, 1);

        // Add another event and rebuild again
        let create2 = make_create_event("bn-002", "Item 2", 1001);
        append_event(&shard_mgr, &create2);

        let report2 = rebuild(&events_dir, &db_path).unwrap();
        assert_eq!(report2.event_count, 2);
        assert_eq!(report2.item_count, 2);
    }

    #[test]
    fn rebuild_is_deterministic() {
        let (dir, shard_mgr) = setup_bones_dir();
        let events_dir = dir.path().join("events");

        let create1 = make_create_event("bn-001", "Deterministic test", 1000);
        let create2 = make_create_event("bn-002", "Another item", 1001);
        append_event(&shard_mgr, &create1);
        append_event(&shard_mgr, &create2);

        // Rebuild twice to different DB paths
        let db_path_a = dir.path().join("bones_a.db");
        let db_path_b = dir.path().join("bones_b.db");

        let report_a = rebuild(&events_dir, &db_path_a).unwrap();
        let report_b = rebuild(&events_dir, &db_path_b).unwrap();

        assert_eq!(report_a.event_count, report_b.event_count);
        assert_eq!(report_a.item_count, report_b.item_count);

        // Verify same items in both
        let conn_a = open_projection(&db_path_a).unwrap();
        let conn_b = open_projection(&db_path_b).unwrap();

        let titles_a: Vec<String> = {
            let mut stmt = conn_a
                .prepare("SELECT title FROM items ORDER BY item_id")
                .unwrap();
            stmt.query_map([], |row| row.get(0))
                .unwrap()
                .map(|r| r.unwrap())
                .collect()
        };

        let titles_b: Vec<String> = {
            let mut stmt = conn_b
                .prepare("SELECT title FROM items ORDER BY item_id")
                .unwrap();
            stmt.query_map([], |row| row.get(0))
                .unwrap()
                .map(|r| r.unwrap())
                .collect()
        };

        assert_eq!(titles_a, titles_b);
    }

    #[test]
    fn rebuild_populates_fts() {
        let (dir, shard_mgr) = setup_bones_dir();
        let db_path = dir.path().join("bones.db");
        let events_dir = dir.path().join("events");

        let create = make_create_event("bn-001", "Authentication timeout fix", 1000);
        append_event(&shard_mgr, &create);

        rebuild(&events_dir, &db_path).unwrap();

        let conn = open_projection(&db_path).unwrap();
        let hits: i64 = conn
            .query_row(
                "SELECT COUNT(*) FROM items_fts WHERE items_fts MATCH 'authentication'",
                [],
                |row| row.get(0),
            )
            .unwrap();
        assert_eq!(hits, 1);
    }

    #[test]
    fn rebuild_updates_projection_cursor() {
        let (dir, shard_mgr) = setup_bones_dir();
        let db_path = dir.path().join("bones.db");
        let events_dir = dir.path().join("events");

        let create = make_create_event("bn-001", "Item", 1000);
        append_event(&shard_mgr, &create);

        rebuild(&events_dir, &db_path).unwrap();

        let conn = open_projection(&db_path).unwrap();
        let (offset, hash) = crate::db::query::get_projection_cursor(&conn).unwrap();
        assert!(offset > 0, "cursor offset should be non-zero after rebuild");
        assert!(hash.is_some(), "cursor hash should be set after rebuild");
    }

    #[test]
    fn rebuild_handles_duplicate_events() {
        let (dir, shard_mgr) = setup_bones_dir();
        let db_path = dir.path().join("bones.db");
        let events_dir = dir.path().join("events");

        // Append same event twice (simulates git merge duplication)
        let create = make_create_event("bn-001", "Item", 1000);
        append_event(&shard_mgr, &create);
        append_event(&shard_mgr, &create);

        let report = rebuild(&events_dir, &db_path).unwrap();
        // Only 1 unique event projected, 1 duplicate skipped
        assert_eq!(report.event_count, 1);
        assert_eq!(report.item_count, 1);
    }

    #[test]
    fn rebuild_with_bd_prefix_events() {
        let (dir, shard_mgr) = setup_bones_dir();
        let db_path = dir.path().join("bones.db");
        let events_dir = dir.path().join("events");

        // Write events with bd- prefix (migrated bead IDs)
        let create1 = make_create_event("bd-9mx", "Parent item", 1000);
        let create2 = make_create_event("bd-4kz", "Child item", 1001);

        append_event(&shard_mgr, &create1);
        append_event(&shard_mgr, &create2);

        let report = rebuild(&events_dir, &db_path).unwrap();
        assert_eq!(
            report.event_count, 2,
            "should project 2 events with bd- prefix"
        );
        assert_eq!(report.item_count, 2, "should have 2 items with bd- prefix");
    }

    #[test]
    fn rebuild_performance_reasonable() {
        let (dir, shard_mgr) = setup_bones_dir();
        let db_path = dir.path().join("bones.db");
        let events_dir = dir.path().join("events");

        // Create 100 items — should be well under 1s
        for i in 0..100_u32 {
            let create = make_create_event(
                &format!("bn-{i:04x}"),
                &format!("Item {i}"),
                i64::from(i) * 1000,
            );
            append_event(&shard_mgr, &create);
        }

        let report = rebuild(&events_dir, &db_path).unwrap();
        assert_eq!(report.event_count, 100);
        assert_eq!(report.item_count, 100);
        assert!(
            report.elapsed.as_millis() < 1000,
            "rebuild of 100 items took {}ms, expected <1000ms",
            report.elapsed.as_millis()
        );
    }
}