topodb-json 0.0.8

JSON conversion layer for the TopoDB agent-memory engine
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
//! plan_remember against a real (temp) engine Db. Every plan's `ops` are
//! submitted through `db.submit` exactly as a front end would.

use topodb::{Db, PropValue, Scope};
use topodb_json::{
    content_hash, default_spec, plan_remember, scopes_to_scope_set, ComposeError, RememberRequest,
    MEMORY_SUPERSEDED_AT_PROP,
};

fn fresh_db(dir: &tempfile::TempDir) -> Db {
    Db::open_with(dir.path().join("t.redb"), default_spec()).unwrap()
}

fn req(content: &str, entities: &[&str]) -> RememberRequest {
    RememberRequest {
        content: content.into(),
        entities: entities.iter().map(|s| s.to_string()).collect(),
        edge_type: None,
        supersedes: vec![],
        props: None,
    }
}

fn lookup() -> topodb::ScopeSet {
    scopes_to_scope_set(&[Scope::Shared])
}

#[test]
fn fresh_remember_plans_memory_entities_and_links() {
    let dir = tempfile::tempdir().unwrap();
    let db = fresh_db(&dir);
    let plan = plan_remember(
        &db,
        Scope::Shared,
        &lookup(),
        1_000,
        &req("ada wrote it", &["ada"]),
    )
    .unwrap();
    assert!(!plan.deduplicated);
    assert_eq!(plan.entities.len(), 1);
    assert!(plan.entities[0].created);
    assert_eq!(plan.edge_ids.len(), 1);
    assert_eq!(plan.new_entities.len(), 1);
    assert_eq!(plan.new_memory.as_deref(), Some("ada wrote it"));
    db.submit(plan.ops).unwrap();
    // The memory node exists with content + content_hash.
    let node = db.node(&lookup(), plan.memory_id).expect("memory node");
    assert_eq!(node.props["content"], PropValue::Str("ada wrote it".into()));
    assert!(node.props.contains_key("content_hash"));
}

#[test]
fn identical_remember_dedups_to_a_noop() {
    let dir = tempfile::tempdir().unwrap();
    let db = fresh_db(&dir);
    let first = plan_remember(
        &db,
        Scope::Shared,
        &lookup(),
        1_000,
        &req("ada wrote it", &["ada"]),
    )
    .unwrap();
    db.submit(first.ops).unwrap();
    let second = plan_remember(
        &db,
        Scope::Shared,
        &lookup(),
        2_000,
        &req("ada  wrote it", &["ada"]),
    )
    .unwrap();
    assert!(
        second.deduplicated,
        "whitespace-normalized content must dedup"
    );
    assert_eq!(second.memory_id, first.memory_id);
    assert!(
        second.ops.is_empty(),
        "dedup hit with same entity must plan no writes"
    );
    assert_eq!(
        second.edge_ids, first.edge_ids,
        "existing edge id is echoed"
    );
    assert!(second.new_memory.is_none());
}

#[test]
fn entity_is_reused_across_composes() {
    let dir = tempfile::tempdir().unwrap();
    let db = fresh_db(&dir);
    let first = plan_remember(
        &db,
        Scope::Shared,
        &lookup(),
        1_000,
        &req("fact one", &["vega"]),
    )
    .unwrap();
    db.submit(first.ops).unwrap();
    let second = plan_remember(
        &db,
        Scope::Shared,
        &lookup(),
        2_000,
        &req("fact two", &["vega"]),
    )
    .unwrap();
    assert!(
        !second.entities[0].created,
        "same-name entity must be found, not recreated"
    );
    assert_eq!(second.entities[0].id, first.entities[0].id);
    db.submit(second.ops).unwrap();
}

#[test]
fn in_call_name_variants_collapse_to_one_entity() {
    let dir = tempfile::tempdir().unwrap();
    let db = fresh_db(&dir);
    let plan = plan_remember(
        &db,
        Scope::Shared,
        &lookup(),
        1_000,
        &req("a fact", &["Ada Lovelace", " ada   lovelace "]),
    )
    .unwrap();
    assert_eq!(plan.entities.len(), 1);
    assert_eq!(plan.entities[0].name, "Ada Lovelace", "first spelling wins");
    assert_eq!(plan.edge_ids.len(), 1);
}

#[test]
fn supersedes_stamps_and_is_idempotent() {
    let dir = tempfile::tempdir().unwrap();
    let db = fresh_db(&dir);
    let old = plan_remember(
        &db,
        Scope::Shared,
        &lookup(),
        1_000,
        &req("db is postgres", &["vega"]),
    )
    .unwrap();
    db.submit(old.ops).unwrap();
    let mut new_req = req("db is sqlite", &["vega"]);
    new_req.supersedes = vec![old.memory_id.to_string()];
    let new = plan_remember(&db, Scope::Shared, &lookup(), 5_000, &new_req).unwrap();
    assert_eq!(new.superseded, vec![old.memory_id.to_string()]);
    db.submit(new.ops).unwrap();
    let node = db.node(&lookup(), old.memory_id).unwrap();
    assert_eq!(node.props[MEMORY_SUPERSEDED_AT_PROP], PropValue::Int(5_000));
    // Re-superseding the same id is a no-op, not a re-stamp.
    let mut again = req("db is sqlite v2", &["vega"]);
    again.supersedes = vec![old.memory_id.to_string()];
    let plan = plan_remember(&db, Scope::Shared, &lookup(), 9_000, &again).unwrap();
    assert!(plan.superseded.is_empty());
    db.submit(plan.ops).unwrap();
    let node = db.node(&lookup(), old.memory_id).unwrap();
    assert_eq!(node.props[MEMORY_SUPERSEDED_AT_PROP], PropValue::Int(5_000));
}

#[test]
fn foreign_or_non_memory_supersedes_id_is_invalid_and_writes_nothing() {
    let dir = tempfile::tempdir().unwrap();
    let db = fresh_db(&dir);
    let seeded = plan_remember(
        &db,
        Scope::Shared,
        &lookup(),
        1_000,
        &req("a fact", &["vega"]),
    )
    .unwrap();
    let entity_id = seeded.entities[0].id;
    db.submit(seeded.ops).unwrap();
    let seq_before = db.current_seq().unwrap();
    // Unknown id.
    let mut r = req("newer fact", &["vega"]);
    r.supersedes = vec![topodb::NodeId::new().to_string()];
    assert!(matches!(
        plan_remember(&db, Scope::Shared, &lookup(), 2_000, &r),
        Err(ComposeError::Invalid(_))
    ));
    // An Entity, not a Memory.
    let mut r = req("newer fact", &["vega"]);
    r.supersedes = vec![entity_id.to_string()];
    match plan_remember(&db, Scope::Shared, &lookup(), 2_000, &r) {
        Err(ComposeError::Invalid(msg)) => assert!(msg.contains("not a Memory"), "{msg}"),
        other => panic!("expected Invalid, got {:?}", other.map(|p| p.memory_id)),
    }
    assert_eq!(
        db.current_seq().unwrap(),
        seq_before,
        "a rejected plan must write nothing"
    );
}

#[test]
fn empty_entities_and_blank_names_are_invalid() {
    let dir = tempfile::tempdir().unwrap();
    let db = fresh_db(&dir);
    assert!(matches!(
        plan_remember(&db, Scope::Shared, &lookup(), 1_000, &req("x", &[])),
        Err(ComposeError::Invalid(_))
    ));
    assert!(matches!(
        plan_remember(&db, Scope::Shared, &lookup(), 1_000, &req("x", &["  "])),
        Err(ComposeError::Invalid(_))
    ));
}

#[test]
fn edge_type_is_normalized() {
    let dir = tempfile::tempdir().unwrap();
    let db = fresh_db(&dir);
    let mut r = req("a fact", &["vega"]);
    r.edge_type = Some("Works At".into());
    let plan = plan_remember(&db, Scope::Shared, &lookup(), 1_000, &r).unwrap();
    let has_normalized = plan.ops.iter().any(|op| {
        matches!(
            op, topodb::Op::CreateEdge { ty, .. } if *ty == "works_at"
        )
    });
    assert!(has_normalized, "edge type must normalize to works_at");
}

#[test]
fn content_hash_is_whitespace_stable_and_case_sensitive() {
    assert_eq!(content_hash("a  b"), content_hash(" a b "));
    assert_ne!(content_hash("a b"), content_hash("A b"));
}

#[test]
fn validate_rejects_empty_entities() {
    let r = RememberRequest {
        content: "x".into(),
        entities: vec![],
        edge_type: None,
        supersedes: vec![],
        props: None,
    };
    let err = r.validate().unwrap_err();
    assert!(err.contains("entities must contain"), "{err}");
}

#[test]
fn self_supersede_mints_fresh_not_dedup() {
    let dir = tempfile::tempdir().unwrap();
    let db = fresh_db(&dir);
    // First: remember X with entity "vega"
    let first = plan_remember(
        &db,
        Scope::Shared,
        &lookup(),
        1_000,
        &req("the fact", &["vega"]),
    )
    .unwrap();
    assert!(!first.deduplicated);
    let old_id = first.memory_id;
    db.submit(first.ops).unwrap();

    // Second: remember the SAME content with supersedes=[old id] and entity "mira"
    let mut second_req = req("the fact", &["mira"]);
    second_req.supersedes = vec![old_id.to_string()];
    let second = plan_remember(&db, Scope::Shared, &lookup(), 2_000, &second_req).unwrap();

    // Must NOT deduplicate (fresh node, not reuse old)
    assert!(
        !second.deduplicated,
        "remembering X with supersedes=[id of live X] must mint fresh, not dedup"
    );
    // Fresh memory_id must differ from the old one
    assert_ne!(
        second.memory_id, old_id,
        "self-supersede must create a new memory node"
    );
    // Must mark the old one as superseded
    assert_eq!(
        second.superseded,
        vec![old_id.to_string()],
        "old id must be in superseded list"
    );

    // Submit and verify: old node has superseded_at, fresh node exists
    db.submit(second.ops).unwrap();
    let old_node = db.node(&lookup(), old_id).unwrap();
    assert_eq!(
        old_node.props[MEMORY_SUPERSEDED_AT_PROP],
        PropValue::Int(2_000),
        "old node must have superseded_at timestamp"
    );
    // Check old node has no open out-edges (all should be closed)
    let old_edges = db.edges_from(&lookup(), old_id, None, None, true).unwrap();
    assert!(
        old_edges.is_empty(),
        "old node should have no open out-edges after supersede"
    );

    let fresh_node = db.node(&lookup(), second.memory_id).unwrap();
    assert_eq!(
        fresh_node.props["content"],
        PropValue::Str("the fact".into()),
        "fresh node must have the content"
    );
    // Verify the fresh node has an edge to mira
    let fresh_edges = db
        .edges_from(&lookup(), second.memory_id, None, Some("about"), true)
        .unwrap();
    assert_eq!(fresh_edges.len(), 1, "fresh node must have edge to mira");
}

#[test]
fn validate_rejects_blank_entity_names() {
    let r = RememberRequest {
        content: "x".into(),
        entities: vec!["  ".into()],
        edge_type: None,
        supersedes: vec![],
        props: None,
    };
    let err = r.validate().unwrap_err();
    assert!(err.contains("entity names must be non-empty"), "{err}");
}

#[test]
fn validate_normalizes_default_edge_type() {
    let r = RememberRequest {
        content: "x".into(),
        entities: vec!["one".into()],
        edge_type: None,
        supersedes: vec![],
        props: None,
    };
    let ty = r.validate().unwrap();
    assert_eq!(ty, "about");
}

#[test]
fn validate_succeeds_with_valid_entity() {
    let r = RememberRequest {
        content: "x".into(),
        entities: vec!["one".into()],
        edge_type: None,
        supersedes: vec![],
        props: None,
    };
    assert_eq!(r.validate().unwrap(), "about");
}

#[test]
fn superseded_content_does_not_dedup_and_mints_a_fresh_memory() {
    let dir = tempfile::tempdir().unwrap();
    let db = fresh_db(&dir);
    let old = plan_remember(
        &db,
        Scope::Shared,
        &lookup(),
        1_000,
        &req("db is postgres", &["vega"]),
    )
    .unwrap();
    db.submit(old.ops).unwrap();
    let mut sup = req("db is sqlite", &["vega"]);
    sup.supersedes = vec![old.memory_id.to_string()];
    db.submit(
        plan_remember(&db, Scope::Shared, &lookup(), 2_000, &sup)
            .unwrap()
            .ops,
    )
    .unwrap();
    // Re-remember the retired content: must NOT dedup to the tombstone.
    let again = plan_remember(
        &db,
        Scope::Shared,
        &lookup(),
        3_000,
        &req("db is postgres", &["vega"]),
    )
    .unwrap();
    assert!(!again.deduplicated, "superseded content must not dedup");
    assert_ne!(
        again.memory_id, old.memory_id,
        "fresh live memory, not the tombstone"
    );
    db.submit(again.ops).unwrap();
    // Tombstone untouched; new node has no stamp.
    let tomb = db.node(&lookup(), old.memory_id).unwrap();
    assert_eq!(tomb.props[MEMORY_SUPERSEDED_AT_PROP], PropValue::Int(2_000));
    let fresh = db.node(&lookup(), again.memory_id).unwrap();
    assert!(!fresh.props.contains_key(MEMORY_SUPERSEDED_AT_PROP));
}

#[test]
fn alias_name_resolves_to_canonical_entity() {
    use topodb_json::{ALIAS_EDGE_TYPE, ALIAS_LABEL, ALIAS_NAME_PROP};
    let dir = tempfile::tempdir().unwrap();
    let db = fresh_db(&dir);
    let seeded = plan_remember(
        &db,
        Scope::Shared,
        &lookup(),
        1_000,
        &req("vega exists", &["vega"]),
    )
    .unwrap();
    let canonical = seeded.entities[0].id;
    db.submit(seeded.ops).unwrap();
    // Seed an Alias node + alias_of edge via raw ops.
    let alias_id = topodb::NodeId::new();
    let mut props = topodb::Props::new();
    props.insert(
        ALIAS_NAME_PROP.into(),
        PropValue::Str("the vega project".into()),
    );
    db.submit(vec![
        topodb::Op::CreateNode {
            id: alias_id,
            scope: Scope::Shared,
            label: ALIAS_LABEL.into(),
            props,
        },
        topodb::Op::CreateEdge {
            id: topodb::EdgeId::new(),
            scope: Scope::Shared,
            ty: ALIAS_EDGE_TYPE.into(),
            from: alias_id,
            to: canonical,
            props: topodb::Props::new(),
            valid_from: None,
        },
    ])
    .unwrap();
    // Remember via the ALIAS name: must resolve to the canonical entity.
    let plan = plan_remember(
        &db,
        Scope::Shared,
        &lookup(),
        2_000,
        &req("a fact", &["the vega project"]),
    )
    .unwrap();
    assert!(
        !plan.entities[0].created,
        "alias must resolve, not mint a duplicate"
    );
    assert_eq!(plan.entities[0].id, canonical);
    assert_eq!(plan.edge_ids.len(), 1);
}

#[test]
fn memory_props_rejects_reserved_keys_and_stamps_hash() {
    use topodb_json::memory_props;
    for key in ["content_hash", "superseded_at"] {
        let extra = serde_json::json!({ key: "boom" });
        let err = memory_props("a fact", Some(&extra)).unwrap_err();
        assert!(err.contains(key), "error must name the reserved key: {err}");
        assert!(err.contains("maintained by the engine write path"), "{err}");
    }
    // `content` collision still rejected via merge_required_prop.
    assert!(memory_props("a fact", Some(&serde_json::json!({"content": "x"}))).is_err());
    // Happy path: content + stamped hash + extra key.
    let props = memory_props("a fact", Some(&serde_json::json!({"source": "chat"}))).unwrap();
    assert_eq!(props["content"], PropValue::Str("a fact".into()));
    assert_eq!(
        props["content_hash"],
        PropValue::Str(content_hash("a fact"))
    );
    assert_eq!(props["source"], PropValue::Str("chat".into()));
}