hashtree-cli 0.2.45

Hashtree daemon and CLI - content-addressed storage with P2P 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
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
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
//! Integration tests for storage limit and LRU eviction
//!
//! Tests:
//! - Quota enforcement (eviction when over limit)
//! - Priority protection (pinned trees never evicted)
//! - Tree-level LRU (oldest low-priority evicted first)
//! - Shared blobs (blob in 2 trees, evict one, blob remains)
//!
//! Run with: cargo test --package hashtree-cli --test eviction -- --nocapture

use hashtree_cli::storage::{HashtreeStore, PRIORITY_FOLLOWED, PRIORITY_OTHER, PRIORITY_OWN};
use hashtree_config::StorageBackend;
use hashtree_core::from_hex;
use std::thread;
use std::time::Duration;
use tempfile::TempDir;

/// Create a store with a small max size for testing
fn test_store(max_size_bytes: u64) -> (HashtreeStore, TempDir) {
    let temp_dir = TempDir::new().expect("Failed to create temp dir");
    let store = HashtreeStore::with_options_and_backend(
        temp_dir.path(),
        None,
        max_size_bytes,
        true,
        &StorageBackend::Fs,
    )
    .expect("Failed to create store");
    (store, temp_dir)
}

/// Helper: Add a blob and get its hash as bytes
fn add_blob(store: &HashtreeStore, data: &[u8]) -> [u8; 32] {
    let hash_hex = store.put_blob(data).expect("Failed to put blob");
    from_hex(&hash_hex).expect("Invalid hash")
}

fn used_bytes(store: &HashtreeStore) -> u64 {
    store
        .router()
        .stats()
        .expect("Failed to read stats")
        .total_bytes
}

#[test]
fn test_tree_indexing() {
    let (store, _tmp) = test_store(1024 * 1024 * 1024); // 1GB

    // Add a blob
    let data = b"Hello, world!";
    let hash = add_blob(&store, data);

    // Index it as a tree (single blob tree)
    store
        .index_tree(
            &hash,
            "test_owner",
            Some("test_tree"),
            PRIORITY_FOLLOWED,
            None,
        )
        .expect("Failed to index tree");

    // Verify it's indexed
    let meta = store.get_tree_meta(&hash).expect("Failed to get meta");
    assert!(meta.is_some(), "Tree should be indexed");

    let meta = meta.unwrap();
    assert_eq!(meta.owner, "test_owner");
    assert_eq!(meta.name, Some("test_tree".to_string()));
    assert_eq!(meta.priority, PRIORITY_FOLLOWED);
    assert!(meta.total_size > 0, "Should have tracked size");
}

#[test]
fn test_list_indexed_trees() {
    let (store, _tmp) = test_store(1024 * 1024 * 1024);

    // Add and index multiple blobs as trees
    let data1 = b"Tree 1 content";
    let hash1 = add_blob(&store, data1);
    store
        .index_tree(&hash1, "owner1", Some("tree1"), PRIORITY_OWN, None)
        .expect("Failed to index tree 1");

    // Small delay to ensure different synced_at
    thread::sleep(Duration::from_millis(10));

    let data2 = b"Tree 2 content";
    let hash2 = add_blob(&store, data2);
    store
        .index_tree(&hash2, "owner2", Some("tree2"), PRIORITY_FOLLOWED, None)
        .expect("Failed to index tree 2");

    // List trees
    let trees = store.list_indexed_trees().expect("Failed to list trees");
    assert_eq!(trees.len(), 2, "Should have 2 indexed trees");

    // Verify both are present
    let hashes: Vec<[u8; 32]> = trees.iter().map(|(h, _)| *h).collect();
    assert!(hashes.contains(&hash1));
    assert!(hashes.contains(&hash2));
}

#[test]
fn test_tracked_size() {
    let (store, _tmp) = test_store(1024 * 1024 * 1024);

    // Initial tracked size should be 0
    let initial = store.tracked_size().expect("Failed to get tracked size");
    assert_eq!(initial, 0, "Initial tracked size should be 0");

    // Add and index a blob
    let data = vec![0u8; 1000]; // 1KB
    let hash = add_blob(&store, &data);
    store
        .index_tree(&hash, "owner", None, PRIORITY_OTHER, None)
        .expect("Failed to index tree");

    // Tracked size should now include this blob
    let tracked = store.tracked_size().expect("Failed to get tracked size");
    assert_eq!(tracked, 1000, "Tracked size should be 1000 bytes");
}

#[test]
fn test_storage_by_priority() {
    let (store, _tmp) = test_store(1024 * 1024 * 1024);

    // Add blobs with different priorities
    let data_own = vec![0u8; 500];
    let hash_own = add_blob(&store, &data_own);
    store
        .index_tree(&hash_own, "me", Some("own"), PRIORITY_OWN, None)
        .unwrap();

    let data_followed = vec![1u8; 300];
    let hash_followed = add_blob(&store, &data_followed);
    store
        .index_tree(
            &hash_followed,
            "friend",
            Some("followed"),
            PRIORITY_FOLLOWED,
            None,
        )
        .unwrap();

    let data_other = vec![2u8; 200];
    let hash_other = add_blob(&store, &data_other);
    store
        .index_tree(&hash_other, "random", Some("other"), PRIORITY_OTHER, None)
        .unwrap();

    // Check breakdown
    let by_priority = store
        .storage_by_priority()
        .expect("Failed to get by priority");
    assert_eq!(by_priority.own, 500, "Own should be 500 bytes");
    assert_eq!(by_priority.followed, 300, "Followed should be 300 bytes");
    assert_eq!(by_priority.other, 200, "Other should be 200 bytes");
}

#[test]
fn test_eviction_under_limit() {
    let (store, _tmp) = test_store(10000); // 10KB limit

    // Add a small blob (under limit)
    let data = vec![0u8; 100];
    let hash = add_blob(&store, &data);
    store
        .index_tree(&hash, "owner", None, PRIORITY_OTHER, None)
        .unwrap();

    // Eviction should do nothing
    let freed = store.evict_if_needed().expect("Eviction failed");
    assert_eq!(freed, 0, "Should not evict when under limit");

    // Blob should still exist
    assert!(store.blob_exists(&hash).unwrap(), "Blob should still exist");
}

#[test]
fn durable_blob_write_rejects_when_owned_blobs_fill_limit() {
    let (store, _tmp) = test_store(500);

    let first = vec![1u8; 300];
    let owner = [7u8; 32];
    let first_hash = from_hex(
        &store
            .put_owned_blob(&first, &owner)
            .expect("first owned blob"),
    )
    .expect("first hash");

    let second = vec![2u8; 300];
    let second_hash = hashtree_core::sha256(&second);
    let error = store
        .put_owned_blob(&second, &owner)
        .expect_err("owned durable data should not be displaced by a new durable blob");

    assert!(
        error.to_string().contains("storage limit"),
        "unexpected error: {error}"
    );
    assert!(store.blob_exists(&first_hash).expect("first remains"));
    assert!(!store.blob_exists(&second_hash).expect("second rejected"));
    assert!(used_bytes(&store) <= 500);
}

#[test]
fn test_eviction_over_limit() {
    let (store, _tmp) = test_store(500); // 500 byte limit

    // Add blobs that exceed the limit
    let data1 = vec![1u8; 200];
    let hash1 = add_blob(&store, &data1);
    store
        .index_tree(&hash1, "owner1", Some("tree1"), PRIORITY_OTHER, None)
        .unwrap();

    thread::sleep(Duration::from_millis(10));

    let data2 = vec![2u8; 200];
    let hash2 = add_blob(&store, &data2);
    store
        .index_tree(&hash2, "owner2", Some("tree2"), PRIORITY_OTHER, None)
        .unwrap();

    thread::sleep(Duration::from_millis(10));

    let data3 = vec![3u8; 200];
    let hash3 = add_blob(&store, &data3);
    store
        .index_tree(&hash3, "owner3", Some("tree3"), PRIORITY_OTHER, None)
        .unwrap();

    // Total is 600 bytes, limit is 500, should evict oldest
    let freed = store.evict_if_needed().expect("Eviction failed");
    assert!(freed > 0, "Should have evicted something");

    // Oldest (tree1) should be evicted
    let meta1 = store.get_tree_meta(&hash1).unwrap();
    assert!(meta1.is_none(), "Oldest tree should be evicted");

    // Newer trees should remain
    let meta2 = store.get_tree_meta(&hash2).unwrap();
    let meta3 = store.get_tree_meta(&hash3).unwrap();
    // At least one of the newer ones should remain
    assert!(
        meta2.is_some() || meta3.is_some(),
        "Newer trees should remain"
    );
}

#[test]
fn test_pinned_tree_protection() {
    let (store, _tmp) = test_store(300); // Small limit

    // Add pinned tree (protected)
    let data_pinned = vec![0u8; 200];
    let hash_pinned = add_blob(&store, &data_pinned);
    store
        .index_tree(&hash_pinned, "me", Some("pinned"), PRIORITY_OWN, None)
        .unwrap();
    store.pin(&hash_pinned).expect("Failed to pin");

    // Add other tree (evictable)
    let data_other = vec![1u8; 200];
    let hash_other = add_blob(&store, &data_other);
    store
        .index_tree(&hash_other, "random", Some("other"), PRIORITY_OTHER, None)
        .unwrap();

    // Total is 400 bytes, limit is 300
    let freed = store.evict_if_needed().expect("Eviction failed");

    // Pinned tree should NOT be evicted
    let meta_pinned = store.get_tree_meta(&hash_pinned).unwrap();
    assert!(
        meta_pinned.is_some(),
        "Pinned tree should be protected from eviction"
    );

    // Other tree should be evicted
    let meta_other = store.get_tree_meta(&hash_other).unwrap();
    assert!(meta_other.is_none(), "Other tree should be evicted");

    assert!(freed > 0, "Should have freed space by evicting other tree");
}

#[test]
fn test_own_tree_can_be_evicted() {
    let (store, _tmp) = test_store(300); // Small limit

    // Add own tree (NOT pinned - can be evicted as last resort)
    let data_own = vec![0u8; 200];
    let hash_own = add_blob(&store, &data_own);
    store
        .index_tree(&hash_own, "me", Some("own"), PRIORITY_OWN, None)
        .unwrap();

    // Add another own tree to push over limit
    let data_own2 = vec![1u8; 200];
    let hash_own2 = add_blob(&store, &data_own2);
    store
        .index_tree(&hash_own2, "me", Some("own2"), PRIORITY_OWN, None)
        .unwrap();

    // Total is 400 bytes, limit is 300
    // Both are own trees, oldest should be evicted
    let freed = store.evict_if_needed().expect("Eviction failed");

    assert!(
        freed > 0,
        "Should have evicted own tree when no other option"
    );
}

#[test]
fn test_priority_order_eviction() {
    let (store, _tmp) = test_store(400); // Limit

    // Add trees with different priorities
    // Add from oldest to newest

    let data_other = vec![0u8; 150];
    let hash_other = add_blob(&store, &data_other);
    store
        .index_tree(&hash_other, "random", Some("other"), PRIORITY_OTHER, None)
        .unwrap();

    thread::sleep(Duration::from_millis(10));

    let data_followed = vec![1u8; 150];
    let hash_followed = add_blob(&store, &data_followed);
    store
        .index_tree(
            &hash_followed,
            "friend",
            Some("followed"),
            PRIORITY_FOLLOWED,
            None,
        )
        .unwrap();

    thread::sleep(Duration::from_millis(10));

    // Pin the own tree so it's protected
    let data_own = vec![2u8; 150];
    let hash_own = add_blob(&store, &data_own);
    store
        .index_tree(&hash_own, "me", Some("own"), PRIORITY_OWN, None)
        .unwrap();
    store.pin(&hash_own).expect("Failed to pin");

    // Total is 450 bytes, limit is 400
    // Should evict lowest priority first (other)
    let freed = store.evict_if_needed().expect("Eviction failed");

    // Other (lowest priority) should be evicted first
    let meta_other = store.get_tree_meta(&hash_other).unwrap();
    assert!(
        meta_other.is_none(),
        "Other tree (lowest priority) should be evicted first"
    );

    // Followed should remain (higher priority than other)
    let _meta_followed = store.get_tree_meta(&hash_followed).unwrap();
    // Note: If still over quota, followed might also be evicted
    // But pinned should never be evicted
    let meta_own = store.get_tree_meta(&hash_own).unwrap();
    assert!(meta_own.is_some(), "Pinned tree should never be evicted");

    assert!(freed > 0, "Should have freed space");
}

#[test]
fn test_unindex_tree() {
    let (store, _tmp) = test_store(1024 * 1024 * 1024);

    // Add and index a blob
    let data = vec![0u8; 500];
    let hash = add_blob(&store, &data);
    store
        .index_tree(&hash, "owner", Some("test"), PRIORITY_OTHER, None)
        .unwrap();

    // Verify it exists
    assert!(store.get_tree_meta(&hash).unwrap().is_some());
    assert!(store.blob_exists(&hash).unwrap());

    // Unindex it
    let freed = store.unindex_tree(&hash).expect("Unindex failed");
    assert!(freed > 0, "Should have freed bytes");

    // Tree meta should be gone
    assert!(store.get_tree_meta(&hash).unwrap().is_none());

    // Blob should also be deleted (orphaned)
    assert!(
        !store.blob_exists(&hash).unwrap(),
        "Orphaned blob should be deleted"
    );
}

#[test]
fn test_max_size_bytes_accessor() {
    let (store, _tmp) = test_store(12345678);
    assert_eq!(
        store.max_size_bytes(),
        12345678,
        "max_size_bytes should return configured value"
    );
}

#[test]
fn test_orphan_eviction_first() {
    let (store, _tmp) = test_store(500); // Small limit

    // Add an orphan blob (not indexed as part of any tree)
    let orphan_data = vec![0u8; 200];
    let orphan_hash = add_blob(&store, &orphan_data);

    // Add an indexed tree
    let tree_data = vec![1u8; 200];
    let tree_hash = add_blob(&store, &tree_data);
    store
        .index_tree(&tree_hash, "owner", Some("tree"), PRIORITY_OTHER, None)
        .unwrap();

    // Add another blob to push over limit
    let extra_data = vec![2u8; 200];
    let _extra_hash = add_blob(&store, &extra_data);

    // Total is 600 bytes, limit is 500
    // Orphan should be evicted first before any trees
    let freed = store.evict_if_needed().expect("Eviction failed");
    assert!(freed > 0, "Should have freed space");

    // Orphan blob should be gone
    assert!(
        !store.blob_exists(&orphan_hash).unwrap(),
        "Orphan blob should be evicted first"
    );

    // Indexed tree should still exist (orphan eviction was enough)
    let meta = store.get_tree_meta(&tree_hash).unwrap();
    assert!(
        meta.is_some(),
        "Indexed tree should remain after orphan eviction"
    );
}

#[test]
fn test_pinned_not_evicted_as_orphan() {
    let (store, _tmp) = test_store(300); // Small limit

    // Add a pinned blob (not in any tree but pinned)
    let pinned_data = vec![0u8; 200];
    let pinned_hash = add_blob(&store, &pinned_data);
    store.pin(&pinned_hash).expect("Failed to pin");

    // Add another blob to push over limit
    let extra_data = vec![1u8; 200];
    let _extra_hash = add_blob(&store, &extra_data);

    // Total is 400 bytes, limit is 300
    // But pinned blob should NOT be evicted
    let _ = store.evict_if_needed();

    // Pinned blob should still exist
    assert!(
        store.blob_exists(&pinned_hash).unwrap(),
        "Pinned blob should not be evicted"
    );
}

#[test]
fn test_ref_key_replaces_old_version() {
    let (store, _tmp) = test_store(1024 * 1024 * 1024);

    // Add first version of a tree
    let data1 = vec![0u8; 100];
    let hash1 = add_blob(&store, &data1);
    store
        .index_tree(
            &hash1,
            "owner",
            Some("test"),
            PRIORITY_OWN,
            Some("owner/test"),
        )
        .unwrap();

    // Verify it exists
    assert!(store.get_tree_meta(&hash1).unwrap().is_some());

    // Add second version with same ref_key
    let data2 = vec![1u8; 100];
    let hash2 = add_blob(&store, &data2);
    store
        .index_tree(
            &hash2,
            "owner",
            Some("test"),
            PRIORITY_OWN,
            Some("owner/test"),
        )
        .unwrap();

    // First version should be unindexed
    assert!(
        store.get_tree_meta(&hash1).unwrap().is_none(),
        "Old version should be unindexed"
    );

    // Second version should exist
    assert!(
        store.get_tree_meta(&hash2).unwrap().is_some(),
        "New version should be indexed"
    );
}

#[test]
fn test_put_cached_blob_evicts_disposable_orphans() {
    let (store, _tmp) = test_store(250);

    let protected_hash = add_blob(&store, &vec![9u8; 100]);
    store
        .index_tree(
            &protected_hash,
            "owner",
            Some("protected"),
            PRIORITY_OTHER,
            None,
        )
        .unwrap();

    let disposable_hash = add_blob(&store, &vec![1u8; 100]);
    assert!(store.blob_exists(&disposable_hash).unwrap());

    let cached_hash = from_hex(&store.put_cached_blob(&vec![2u8; 100]).unwrap()).unwrap();

    assert!(
        store.blob_exists(&protected_hash).unwrap(),
        "Indexed tree blob should be protected from cache eviction"
    );
    assert!(
        !store.blob_exists(&disposable_hash).unwrap(),
        "Disposable orphan should be evicted to make room"
    );
    assert!(
        store.blob_exists(&cached_hash).unwrap(),
        "New cached blob should be stored"
    );
    assert!(
        used_bytes(&store) <= store.max_size_bytes(),
        "Cache write should keep usage within limit"
    );
}

#[test]
fn test_put_cached_blob_preserves_owned_blossom_blob() {
    let (store, _tmp) = test_store(250);

    let owned_hash = add_blob(&store, &vec![7u8; 100]);
    store
        .set_blob_owner(&owned_hash, &[42u8; 32])
        .expect("Failed to set owner");

    let disposable_hash = add_blob(&store, &vec![1u8; 100]);
    let cached_hash = from_hex(&store.put_cached_blob(&vec![2u8; 100]).unwrap()).unwrap();

    assert!(
        store.blob_exists(&owned_hash).unwrap(),
        "Owned Blossom blob should not be evicted by cache cleanup"
    );
    assert!(
        !store.blob_exists(&disposable_hash).unwrap(),
        "Unowned orphan should be evicted first"
    );
    assert!(store.blob_exists(&cached_hash).unwrap());
    assert!(used_bytes(&store) <= store.max_size_bytes());
}