silk-graph 0.4.0

Merkle-CRDT graph engine for distributed, conflict-free knowledge graphs
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
"""R-08: Epoch Compaction — compress the oplog into a checkpoint.

Tests verifying that compact() creates a checkpoint entry,
replaces the oplog, and preserves the full graph state.
"""

import pytest

import json
from silk import GraphStore

ONTOLOGY = {
    "node_types": {
        "entity": {
            "properties": {
                "status": {"value_type": "string"}
            }
        }
    },
    "edge_types": {
        "LINKS": {
            "source_types": ["entity"],
            "target_types": ["entity"],
            "properties": {}
        }
    }
}


def _store(instance_id="test"):
    return GraphStore(instance_id, ONTOLOGY)


# -- Basic compaction --


def test_compact_returns_hash():
    """compact() returns a hex hash string."""
    store = _store()
    store.add_node("n1", "entity", "Node 1")
    h = store.compact()
    assert isinstance(h, str)
    assert len(h) == 64


def test_compact_reduces_oplog():
    """After compaction, oplog has exactly 1 entry (the checkpoint)."""
    store = _store()
    store.add_node("n1", "entity", "A")
    store.add_node("n2", "entity", "B")
    store.add_node("n3", "entity", "C")
    store.add_edge("e1", "LINKS", "n1", "n2")

    before = store.len()
    assert before >= 5  # genesis + 3 nodes + 1 edge

    store.compact()
    assert store.len() == 1  # just the checkpoint


def test_compact_preserves_nodes():
    """All live nodes survive compaction."""
    store = _store()
    store.add_node("n1", "entity", "A", {"status": "active"})
    store.add_node("n2", "entity", "B", {"status": "idle"})

    store.compact()

    assert store.get_node("n1") is not None
    assert store.get_node("n1")["properties"]["status"] == "active"
    assert store.get_node("n2") is not None
    assert store.get_node("n2")["properties"]["status"] == "idle"


def test_compact_preserves_edges():
    """All live edges survive compaction."""
    store = _store()
    store.add_node("n1", "entity", "A")
    store.add_node("n2", "entity", "B")
    store.add_edge("e1", "LINKS", "n1", "n2")

    store.compact()

    assert store.get_edge("e1") is not None
    assert store.get_edge("e1")["source_id"] == "n1"
    assert store.get_edge("e1")["target_id"] == "n2"


def test_compact_tombstoned_nodes_excluded():
    """Removed nodes are not in the checkpoint."""
    store = _store()
    store.add_node("n1", "entity", "Keep")
    store.add_node("n2", "entity", "Remove")
    store.remove_node("n2")

    store.compact()

    assert store.get_node("n1") is not None
    assert store.get_node("n2") is None
    assert len(store.all_nodes()) == 1


# -- Writing after compaction --


def test_write_after_compact():
    """New writes work after compaction."""
    store = _store()
    store.add_node("n1", "entity", "Before")
    store.compact()

    store.add_node("n2", "entity", "After")
    assert store.get_node("n1") is not None
    assert store.get_node("n2") is not None
    assert store.len() == 2  # checkpoint + new entry


def test_multiple_compactions():
    """Multiple compactions work correctly."""
    store = _store()
    store.add_node("n1", "entity", "A")
    store.compact()

    store.add_node("n2", "entity", "B")
    store.compact()

    store.add_node("n3", "entity", "C")
    store.compact()

    assert store.len() == 1
    assert len(store.all_nodes()) == 3


# -- Sync after compaction --


def test_snapshot_after_compact():
    """Snapshot from a compacted store works for bootstrapping."""
    store_a = _store("a")
    store_a.add_node("n1", "entity", "A")
    store_a.add_node("n2", "entity", "B")
    store_a.compact()

    snap = store_a.snapshot()
    store_b = GraphStore.from_snapshot("b", snap)

    assert store_b.get_node("n1") is not None
    assert store_b.get_node("n2") is not None


def test_sync_after_compact():
    """Sync works between compacted and non-compacted stores."""
    store_a = _store("a")
    store_b = _store("b")

    store_a.add_node("n1", "entity", "From A")
    store_a.compact()

    # Sync A→B via snapshot (compacted store can't do delta to a fresh peer)
    snap = store_a.snapshot()
    store_b = GraphStore.from_snapshot("b", snap)

    assert store_b.get_node("n1") is not None


# -- Ontology evolution + compaction --


def test_compact_preserves_ontology_extensions():
    """Ontology extensions survive compaction."""
    store = _store()
    store.extend_ontology({
        "node_types": {"service": {"properties": {}}}
    })
    store.add_node("svc-1", "service", "API")

    store.compact()

    assert store.get_node("svc-1") is not None
    # Can still create service nodes (ontology preserved)
    store.add_node("svc-2", "service", "Web")
    assert store.get_node("svc-2") is not None


# -- Query after compaction --


def test_query_builder_after_compact():
    """Query builder works on compacted stores."""
    from silk import Query

    store = _store()
    store.add_node("n1", "entity", "A", {"status": "active"})
    store.add_node("n2", "entity", "B", {"status": "idle"})
    store.compact()

    active = Query(store).nodes("entity").where(status="active").collect()
    assert len(active) == 1
    assert active[0]["node_id"] == "n1"


# -- Persistence --


def test_compact_persistent_store(tmp_path):
    """Compaction works with persistent (redb) stores."""
    path = str(tmp_path / "test.redb")
    store = GraphStore("test", ONTOLOGY, path=path)
    store.add_node("n1", "entity", "Persistent")
    store.add_node("n2", "entity", "Also persistent")

    before = store.len()
    store.compact()
    assert store.len() == 1
    del store

    # Reopen
    store2 = GraphStore.open(path)
    assert store2.get_node("n1") is not None
    assert store2.get_node("n2") is not None
    assert store2.len() == 1


# -- Reopen after compaction with extended ontology --
#
# Compaction folds ExtendOntology entries into the checkpoint's inner
# DefineOntology. Replay must apply that ontology or every extension-typed
# entity fails validation and quarantines — a reopened store materializes
# without them (observed in production: near-empty graph after reopen).


EXTENSION = {"node_types": {"signal": {"properties": {}}}}


def _compacted_extended_store(path):
    store = GraphStore("test", ONTOLOGY, path=path)
    store.extend_ontology(EXTENSION)
    store.add_node("n1", "entity", "Base-typed")
    store.add_node("s1", "signal", "Extension-typed")
    store.compact()
    return store


def test_ctor_reopen_compacted_preserves_extension_nodes(tmp_path):
    """Constructor reopen (declared = base ontology) keeps extension-typed nodes."""
    path = str(tmp_path / "ctor.redb")
    store = _compacted_extended_store(path)
    del store

    store2 = GraphStore("test", ONTOLOGY, path=path)
    assert store2.get_node("n1") is not None
    assert store2.get_node("s1") is not None
    assert len(store2.all_nodes()) == 2


def test_open_reopen_compacted_preserves_extension_nodes(tmp_path):
    """GraphStore.open parity: same store, same result."""
    path = str(tmp_path / "open.redb")
    store = _compacted_extended_store(path)
    del store

    store2 = GraphStore.open(path)
    assert store2.get_node("n1") is not None
    assert store2.get_node("s1") is not None
    assert len(store2.all_nodes()) == 2


def test_ctor_reopen_compacted_ontology_is_merged(tmp_path):
    """After reopen, the checkpoint's merged ontology is in effect:
    extension types accept new writes and further extensions still work."""
    path = str(tmp_path / "merged.redb")
    store = _compacted_extended_store(path)
    del store

    store2 = GraphStore("test", ONTOLOGY, path=path)
    store2.add_node("s2", "signal", "New extension-typed write")
    assert store2.get_node("s2") is not None

    store2.extend_ontology({"node_types": {"verdict": {"properties": {}}}})
    store2.add_node("v1", "verdict", "Post-reopen extension")
    assert store2.get_node("v1") is not None


# Bug 14b: build_checkpoint_ops emits AddNode with EMPTY properties (EXP-02:
# per-property LWW clocks ride in separate UpdateProperty ops). Replay must
# not validate those synthetic ops — a required property fails against the
# empty map and quarantines the node, losing it plus all its property ops.

REQ_ONTOLOGY = {
    "node_types": {
        "entity": {
            "properties": {"name": {"value_type": "string", "required": True}}
        },
        "host": {
            "properties": {},
            "subtypes": {
                "server": {
                    "properties": {"role": {"value_type": "string", "required": True}}
                }
            },
        },
    },
    "edge_types": {},
}


def _compacted_required_store(path):
    store = GraphStore("test", REQ_ONTOLOGY, path=path)
    store.add_node("n1", "entity", "Required prop", {"name": "x"})
    store.add_node("h1", "host", "Subtyped required", {"role": "db"}, subtype="server")
    store.compact()
    return store


def _assert_required_nodes(store):
    n = store.get_node("n1")
    assert n is not None, "required-property node lost"
    assert n["properties"]["name"] == "x"
    h = store.get_node("h1")
    assert h is not None, "subtyped required-property node lost"
    assert h["subtype"] == "server"
    assert h["properties"]["role"] == "db"


def test_ctor_reopen_compacted_preserves_required_property_nodes(tmp_path):
    """Bug 14b via the constructor path."""
    path = str(tmp_path / "req-ctor.redb")
    store = _compacted_required_store(path)
    del store
    _assert_required_nodes(GraphStore("test", REQ_ONTOLOGY, path=path))


def test_open_reopen_compacted_preserves_required_property_nodes(tmp_path):
    """Bug 14b via GraphStore.open — unlike Bug 14, both open paths are hit."""
    path = str(tmp_path / "req-open.redb")
    store = _compacted_required_store(path)
    del store
    _assert_required_nodes(GraphStore.open(path))


def test_compact_in_place_preserves_required_property_nodes(tmp_path):
    """Rebuild after a post-compaction sync replays the checkpoint in-process."""
    path = str(tmp_path / "req-live.redb")
    store = _compacted_required_store(path)
    _assert_required_nodes(store)
    store.extend_ontology({"node_types": {"note": {"properties": {}}}})
    _assert_required_nodes(store)


def test_sync_checkpoint_bootstrap_preserves_extension_nodes(tmp_path):
    """A checkpoint arriving via sync materializes extension-typed nodes
    on a peer whose declared ontology is only the base."""
    path = str(tmp_path / "sync-src.redb")
    store_a = _compacted_extended_store(path)
    store_b = GraphStore("peer-b", ONTOLOGY)

    offer_b = store_b.generate_sync_offer()
    payload = store_a.receive_sync_offer(offer_b)
    store_b.merge_sync_payload(payload)

    assert store_b.get_node("n1") is not None
    assert store_b.get_node("s1") is not None


# -- Disk reclamation (file size) --


def _bloat(store, n=500):
    """Write and remove n nodes to grow the store file."""
    filler = "x" * 200
    for i in range(n):
        store.add_node(f"debris-{i}", "entity", f"Debris {i}", {"status": filler})
    for i in range(n):
        store.remove_node(f"debris-{i}")


def test_compact_default_leaves_file_at_high_water_mark(tmp_path):
    """Default compact() folds the oplog but does NOT shrink the file."""
    import os

    path = str(tmp_path / "hwm.redb")
    store = GraphStore("test", ONTOLOGY, path=path)
    store.add_node("keep", "entity", "Keep")
    _bloat(store)

    size_before = os.path.getsize(path)
    store.compact()
    assert store.len() == 1

    assert os.path.getsize(path) >= size_before


def test_compact_reclaim_disk_shrinks_file(tmp_path):
    """compact(reclaim_disk=True) shrinks the file below high-water mark."""
    import os

    path = str(tmp_path / "reclaim.redb")
    store = GraphStore("test", ONTOLOGY, path=path)
    store.add_node("keep", "entity", "Keep")
    _bloat(store)

    size_before = os.path.getsize(path)
    store.compact(reclaim_disk=True)
    assert store.len() == 1

    assert os.path.getsize(path) < size_before / 2


def test_compact_reclaim_disk_preserves_data(tmp_path):
    """Store reopens correctly after disk reclamation."""
    path = str(tmp_path / "reopen.redb")
    store = GraphStore("test", ONTOLOGY, path=path)
    store.add_node("keep", "entity", "Keep", {"status": "active"})
    _bloat(store, n=50)
    store.compact(reclaim_disk=True)
    del store

    store2 = GraphStore.open(path)
    assert store2.get_node("keep")["properties"]["status"] == "active"
    assert store2.get_node("debris-0") is None
    assert store2.len() == 1


def test_compact_reclaim_disk_inmemory_noop():
    """reclaim_disk on an in-memory store is a no-op, not an error."""
    store = _store()
    store.add_node("n1", "entity", "Node")
    store.compact(reclaim_disk=True)
    assert store.len() == 1


# -- create_checkpoint (inspection) --


def test_create_checkpoint_returns_bytes():
    """create_checkpoint returns entry bytes without modifying the store."""
    store = _store()
    store.add_node("n1", "entity", "Node")

    before = store.len()
    checkpoint_bytes = store.create_checkpoint()

    assert isinstance(checkpoint_bytes, bytes)
    assert len(checkpoint_bytes) > 0
    assert store.len() == before  # store unchanged


# -- Compaction safety (P3) --


def test_compact_safe_no_peers():
    """No registered peers → compaction is trivially safe."""
    store = _store()
    store.add_node("n1", "entity", "Node")
    safe, reasons = store.verify_compaction_safe()
    assert safe
    assert reasons == []
    # compact() should succeed
    store.compact()
    assert store.len() == 1


def test_compact_unsafe_with_unsynced_peer():
    """Registered peer that hasn't synced → compaction is unsafe."""
    store = _store()
    store.add_node("n1", "entity", "Node")
    store.register_peer("remote-1", "tcp://remote:7701")
    # remote-1 has never synced (last_seen_ms = 0)
    safe, reasons = store.verify_compaction_safe()
    assert not safe
    assert len(reasons) == 1
    assert "remote-1" in reasons[0]
    assert "never synced" in reasons[0]


def test_compact_rejects_when_unsafe():
    """compact(safe=True) raises when peers haven't synced."""
    store = _store()
    store.add_node("n1", "entity", "Node")
    store.register_peer("remote-1", "tcp://remote:7701")
    with pytest.raises(RuntimeError, match="compaction is unsafe"):
        store.compact()  # safe=True by default


def test_compact_force_bypasses_safety():
    """compact(safe=False) compacts even with unsynced peers."""
    store = _store()
    store.add_node("n1", "entity", "Node")
    store.register_peer("remote-1", "tcp://remote:7701")
    # Force compaction despite unsynced peer
    store.compact(safe=False)
    assert store.len() == 1


def test_compact_safe_after_sync():
    """After recording sync with all peers, compaction is safe."""
    store = _store()
    store.add_node("n1", "entity", "Node")
    store.register_peer("remote-1", "tcp://remote:7701")

    # Record sync — peer is now up to date
    store.record_sync("remote-1")

    safe, reasons = store.verify_compaction_safe()
    assert safe
    assert reasons == []
    store.compact()
    assert store.len() == 1


def test_compact_unsafe_partial_sync():
    """Some peers synced, some haven't → unsafe."""
    store = _store()
    store.add_node("n1", "entity", "Node")
    store.register_peer("peer-a", "tcp://a:7701")
    store.register_peer("peer-b", "tcp://b:7701")

    store.record_sync("peer-a")
    # peer-b hasn't synced

    safe, reasons = store.verify_compaction_safe()
    assert not safe
    assert len(reasons) == 1
    assert "peer-b" in reasons[0]