engram-memory 0.6.0

Core binary and shared infrastructure for Engram memory system
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
use std::sync::{Arc, Mutex, RwLock};

use serde_json::json;

use engram_core::config::Config;
use engram_core::dispatch;
use engram_core::indexes::IndexSet;
use engram_core::server::ServerState;
use engram_core::train_handler::{TrainerMessage, parse_trainer_output};
use engram_embeddings::Embedder;
use engram_llm_client::{EmbeddingProvider, TextGenerator};
use engram_router::Router;
use engram_storage::Database;

fn build_deterministic_state() -> Arc<ServerState> {
    let database = Database::in_memory().expect("in-memory database");
    let mut config = Config::default();
    config.embedding.provider = "deterministic".into();
    let indexes = IndexSet::new(|| config.build_hnsw_params()).expect("index set");
    let embedder = Embedder::new(0);
    let router = Router::new(0.1, 0.15);
    let embedding_provider: Arc<dyn EmbeddingProvider + Send + Sync> = Arc::from(
        config
            .build_embedding_provider()
            .expect("embedding provider"),
    );
    let text_generator: Option<Arc<dyn TextGenerator + Send + Sync>> =
        config.build_text_generator().ok().map(Arc::from);
    Arc::new(ServerState {
        database: Mutex::new(database),
        indexes: RwLock::new(indexes),
        embedder,
        router: Mutex::new(router),
        config,
        database_path: String::new(),
        embedding_provider,
        text_generator,
    })
}

fn insert_test_memory(state: &Arc<ServerState>, id: &str, memory_type: &str) {
    let memory = engram_storage::Memory {
        id: id.to_string(),
        memory_type: memory_type.to_string(),
        context: "test context".to_string(),
        action: "test action".to_string(),
        result: "test result".to_string(),
        score: 0.0,
        embedding_context: None,
        embedding_action: None,
        embedding_result: None,
        indexed: false,
        tags: None,
        project: None,
        parent_id: None,
        source_ids: None,
        insight_type: None,
        created_at: "2025-01-01T00:00:00Z".to_string(),
        updated_at: "2025-01-01T00:00:00Z".to_string(),
        used_count: 0,
        last_used_at: None,
        superseded_by: None,
    };
    let database = state.database.lock().unwrap();
    database.insert_memory(&memory).expect("insert memory");
}

fn make_insight(id: &str, context: &str) -> engram_storage::Memory {
    engram_storage::Memory {
        id: id.to_string(),
        memory_type: "insight".to_string(),
        context: context.to_string(),
        action: "insight action".to_string(),
        result: "insight result".to_string(),
        score: 0.0,
        embedding_context: None,
        embedding_action: None,
        embedding_result: None,
        indexed: false,
        tags: None,
        project: None,
        parent_id: None,
        source_ids: None,
        insight_type: Some("cluster".to_string()),
        created_at: "2025-01-01T00:00:00Z".to_string(),
        updated_at: "2025-01-01T00:00:00Z".to_string(),
        used_count: 0,
        last_used_at: None,
        superseded_by: None,
    }
}

fn insight_ids(state: &Arc<ServerState>) -> Vec<String> {
    let database = state.database.lock().unwrap();
    let mut statement = database
        .connection()
        .prepare("SELECT id FROM memories WHERE memory_type = 'insight' ORDER BY id")
        .expect("prepare");
    let rows = statement
        .query_map([], |row| row.get::<_, String>(0))
        .expect("query");
    rows.map(|row| row.expect("row")).collect()
}

// Full-replace idempotency: re-running the trainer write with the SAME insight
// payload must leave the insight count flat (not doubled). A second, different
// payload must fully replace the first (old gone, new present). This guards the
// switch from append-only bulk_insert_memories to the full-replace replace_insights.
#[tokio::test]
async fn replace_insights_is_idempotent_and_full_replace() {
    let state = build_deterministic_state();
    let first_batch = vec![
        make_insight("ins-a", "alpha"),
        make_insight("ins-b", "beta"),
    ];

    {
        let database = state.database.lock().unwrap();
        let count = database
            .replace_insights(&first_batch)
            .expect("first replace");
        assert_eq!(count, 2, "first replace inserts both insights");
    }
    assert_eq!(insight_ids(&state), vec!["ins-a", "ins-b"]);

    {
        let database = state.database.lock().unwrap();
        database
            .replace_insights(&first_batch)
            .expect("idempotent replace");
    }
    assert_eq!(
        insight_ids(&state),
        vec!["ins-a", "ins-b"],
        "re-replacing the same payload must keep the count flat, not double it"
    );

    let second_batch = vec![make_insight("ins-c", "gamma")];
    {
        let database = state.database.lock().unwrap();
        database
            .replace_insights(&second_batch)
            .expect("replacing replace");
    }
    assert_eq!(
        insight_ids(&state),
        vec!["ins-c"],
        "a different payload must fully replace: old insights gone, new present"
    );
}

#[tokio::test]
async fn train_list_empty() {
    let state = build_deterministic_state();
    let result = dispatch::route("memory_train_list", &state, json!({})).await;
    let data = result.expect("list should succeed");
    assert_eq!(data["count"], 0);
    assert!(data["insights"].as_array().expect("array").is_empty());
}

#[tokio::test]
async fn train_list_returns_insights_only() {
    let state = build_deterministic_state();
    insert_test_memory(&state, "decision-001", "decision");
    insert_test_memory(&state, "insight-001", "insight");
    insert_test_memory(&state, "pattern-001", "pattern");

    let result = dispatch::route("memory_train_list", &state, json!({})).await;
    let data = result.expect("list should succeed");
    assert_eq!(data["count"], 1);
    let insights = data["insights"].as_array().expect("array");
    assert_eq!(insights.len(), 1);
    assert_eq!(insights[0]["id"], "insight-001");
}

#[tokio::test]
async fn train_delete_nonexistent() {
    let state = build_deterministic_state();
    let result = dispatch::route(
        "memory_train_delete",
        &state,
        json!({"id": "nonexistent-id"}),
    )
    .await;
    let error = result.expect_err("delete nonexistent should fail");
    assert!(error.to_string().contains("not found"));
}

#[tokio::test]
async fn train_delete_non_insight() {
    let state = build_deterministic_state();
    insert_test_memory(&state, "decision-001", "decision");

    let result =
        dispatch::route("memory_train_delete", &state, json!({"id": "decision-001"})).await;
    let error = result.expect_err("delete non-insight should fail");
    assert!(error.to_string().contains("not an insight"));
}

#[tokio::test]
async fn train_delete_success() {
    let state = build_deterministic_state();
    insert_test_memory(&state, "insight-del-001", "insight");

    let result = dispatch::route(
        "memory_train_delete",
        &state,
        json!({"id": "insight-del-001"}),
    )
    .await;
    let data = result.expect("delete should succeed");
    assert_eq!(data["deleted"], "insight-del-001");

    let database = state.database.lock().unwrap();
    let get_result = database.get_memory("insight-del-001");
    assert!(get_result.is_err(), "memory should be gone after delete");
}

#[tokio::test]
async fn train_generate_missing_binary() {
    let mut config = Config::default();
    config.embedding.provider = "deterministic".into();
    config.trainer.trainer_binary = "nonexistent-engram-trainer-binary".into();
    let database = Database::in_memory().expect("in-memory database");
    let indexes = IndexSet::new(|| config.build_hnsw_params()).expect("index set");
    let embedding_provider: Arc<dyn EmbeddingProvider + Send + Sync> = Arc::from(
        config
            .build_embedding_provider()
            .expect("embedding provider"),
    );
    let text_generator: Option<Arc<dyn TextGenerator + Send + Sync>> =
        config.build_text_generator().ok().map(Arc::from);
    let state = Arc::new(ServerState {
        database: Mutex::new(database),
        indexes: RwLock::new(indexes),
        embedder: Embedder::new(0),
        router: Mutex::new(Router::new(0.1, 0.15)),
        config,
        database_path: String::new(),
        embedding_provider,
        text_generator,
    });
    let result = dispatch::route("memory_train_generate", &state, json!({})).await;
    let error = result.expect_err("generate with missing binary should fail");
    assert!(error.to_string().contains("[6013] trainer failed:"));
}

#[test]
fn parse_trainer_message_insight() {
    let line = r#"{"type":"insight","id":"ins-001","context":"pattern found","action":"use caching","result":"improved latency","insight_type":"optimization","tags":"perf,cache","source_ids":"mem-1,mem-2"}"#;
    let message: TrainerMessage = serde_json::from_str(line).expect("parse insight");
    match message {
        TrainerMessage::Insight {
            id,
            context,
            action,
            result,
            insight_type,
            tags,
            source_ids,
        } => {
            assert_eq!(id, "ins-001");
            assert_eq!(context, "pattern found");
            assert_eq!(action, "use caching");
            assert_eq!(result, "improved latency");
            assert_eq!(insight_type, "optimization");
            assert_eq!(tags.as_deref(), Some("perf,cache"));
            assert_eq!(source_ids.as_deref(), Some("mem-1,mem-2"));
        }
        other => panic!("expected Insight, got: {other:?}"),
    }
}

#[test]
fn parse_trainer_message_complete() {
    let line = r#"{"type":"complete","insights_generated":5,"duration_secs":12.5}"#;
    let message: TrainerMessage = serde_json::from_str(line).expect("parse complete");
    match message {
        TrainerMessage::Complete {
            insights_generated,
            duration_secs,
        } => {
            assert_eq!(insights_generated, 5);
            assert!((duration_secs - 12.5).abs() < 0.01);
        }
        other => panic!("expected Complete, got: {other:?}"),
    }
}

#[test]
fn parse_trainer_message_malformed() {
    let line = r#"{"not_valid_json_for_protocol": true}"#;
    let result: Result<TrainerMessage, _> = serde_json::from_str(line);
    assert!(result.is_err(), "malformed message should fail to parse");
}

#[test]
fn parse_trainer_message_progress() {
    let line = r#"{"type":"progress","stage":"analyzing","percent":42.5}"#;
    let message: TrainerMessage = serde_json::from_str(line).expect("parse progress");
    match message {
        TrainerMessage::Progress { stage, percent } => {
            assert_eq!(stage, "analyzing");
            assert!((percent - 42.5).abs() < 0.01);
        }
        other => panic!("expected Progress, got: {other:?}"),
    }
}

#[test]
fn parse_trainer_message_recommendation() {
    let line = r#"{"type":"recommendation","target_id":"mem-1","action":"archive","reasoning":"low usage"}"#;
    let message: TrainerMessage = serde_json::from_str(line).expect("parse recommendation");
    match message {
        TrainerMessage::Recommendation {
            target_id,
            action,
            reasoning,
        } => {
            assert_eq!(target_id, "mem-1");
            assert_eq!(action, "archive");
            assert_eq!(reasoning, "low usage");
        }
        other => panic!("expected Recommendation, got: {other:?}"),
    }
}

#[test]
fn parse_trainer_message_metric() {
    let line = r#"{"type":"metric","name":"memory_coverage","value":0.85}"#;
    let message: TrainerMessage = serde_json::from_str(line).expect("parse metric");
    match message {
        TrainerMessage::Metric { name, value } => {
            assert_eq!(name, "memory_coverage");
            assert!((value - 0.85).abs() < 0.01);
        }
        other => panic!("expected Metric, got: {other:?}"),
    }
}

#[test]
fn parse_trainer_message_artifact() {
    let line = r#"{"type":"artifact","path":"/models/v1.bin","size_bytes":1024}"#;
    let message: TrainerMessage = serde_json::from_str(line).expect("parse artifact");
    match message {
        TrainerMessage::Artifact { path, size_bytes } => {
            assert_eq!(path, "/models/v1.bin");
            assert_eq!(size_bytes, 1024);
        }
        other => panic!("expected Artifact, got: {other:?}"),
    }
}

#[tokio::test]
async fn train_delete_missing_params() {
    let state = build_deterministic_state();
    let result = dispatch::route("memory_train_delete", &state, json!({})).await;
    let error = result.expect_err("delete with missing params should fail");
    assert!(error.to_string().contains("dispatch error"));
}

#[test]
fn parse_trainer_message_insight_minimal() {
    let line = r#"{"type":"insight","id":"ins-002","context":"ctx","action":"act","result":"res","insight_type":"general"}"#;
    let message: TrainerMessage = serde_json::from_str(line).expect("parse minimal insight");
    match message {
        TrainerMessage::Insight {
            id,
            tags,
            source_ids,
            ..
        } => {
            assert_eq!(id, "ins-002");
            assert!(tags.is_none());
            assert!(source_ids.is_none());
        }
        other => panic!("expected Insight, got: {other:?}"),
    }
}

#[test]
fn parse_trainer_output_empty() {
    let messages = parse_trainer_output("").expect("empty input should succeed");
    assert!(messages.is_empty());
}

#[test]
fn parse_trainer_output_malformed_line() {
    let input = concat!(
        r#"{"type":"progress","stage":"start","percent":0.0}"#,
        "\n",
        r#"{"broken json"#,
        "\n",
        r#"{"type":"complete","insights_generated":1,"duration_secs":1.0}"#,
    );
    let error = parse_trainer_output(input).expect_err("malformed line should fail");
    assert!(error.to_string().contains("[6015]"));
    assert!(error.to_string().contains("line 2"));
}

#[test]
fn parse_trainer_output_multiple_messages() {
    let input = concat!(
        r#"{"type":"progress","stage":"analyzing","percent":50.0}"#,
        "\n",
        r#"{"type":"insight","id":"ins-100","context":"c","action":"a","result":"r","insight_type":"pattern"}"#,
        "\n",
        r#"{"type":"complete","insights_generated":1,"duration_secs":2.5}"#,
    );
    let messages = parse_trainer_output(input).expect("valid multi-line should parse");
    assert_eq!(messages.len(), 3);
    assert!(matches!(&messages[0], TrainerMessage::Progress { .. }));
    assert!(matches!(&messages[1], TrainerMessage::Insight { .. }));
    assert!(matches!(&messages[2], TrainerMessage::Complete { .. }));
}