do-memory-core 0.1.30

Core episodic learning system for AI agents with pattern extraction, reward scoring, and dual storage backend
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
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
//! Integration tests for step batching functionality
//!
//! Tests verify the complete batching workflow including:
//! - Auto-flush on size threshold
//! - Auto-flush on time threshold
//! - Manual flush
//! - Episode completion flushes steps
//! - Batching disabled (immediate persistence)
//! - Concurrent episodes with separate buffers
//! - Performance improvements from batching
//! - Data integrity and ordering

mod common;

use common::{ContextBuilder, create_success_step, setup_memory_with_config};
use do_memory_core::{
    BatchConfig, ExecutionStep, MemoryConfig, TaskContext, TaskOutcome, TaskType,
};
use std::time::{Duration, Instant};
use tokio::time::sleep;

/// Test auto-flush when buffer reaches `max_batch_size`
#[tokio::test]
async fn test_step_buffering_with_auto_flush_on_size() -> anyhow::Result<()> {
    // Arrange: Configure batch size of 10 steps
    let config = MemoryConfig {
        batch_config: Some(BatchConfig {
            max_batch_size: 10,
            flush_interval_ms: 60000, // Very long interval so only size triggers
            auto_flush: true,
        }),
        quality_threshold: 0.0, // Zero threshold for test episodes
        ..Default::default()
    };
    let memory = setup_memory_with_config(config);

    let context = ContextBuilder::new("step-batching-test")
        .language("rust")
        .build();

    let episode_id = memory
        .start_episode(
            "Test size-based auto-flush".to_string(),
            context,
            TaskType::Testing,
        )
        .await;

    // Act: Log 9 steps - should not trigger flush
    for i in 1..=9 {
        let step = create_success_step(i, "test_tool", &format!("Action {i}"));
        memory.log_step(episode_id, step).await;
    }

    // Assert: Steps not yet persisted (still in buffer)
    let episode = memory.get_episode(episode_id).await?;
    assert_eq!(
        episode.steps.len(),
        0,
        "Steps should still be buffered, not persisted"
    );

    // Act: Log 10th step - should trigger auto-flush
    let step = create_success_step(10, "test_tool", "Action 10");
    memory.log_step(episode_id, step).await;

    // Assert: All 10 steps should now be persisted
    let episode = memory.get_episode(episode_id).await?;
    assert_eq!(
        episode.steps.len(),
        10,
        "All 10 steps should be flushed and persisted"
    );

    // Verify ordering preserved
    for i in 0..10 {
        assert_eq!(
            episode.steps[i].step_number,
            i + 1,
            "Step ordering should be preserved"
        );
    }

    Ok(())
}

/// Test auto-flush when time threshold is exceeded
#[tokio::test]
async fn test_step_buffering_with_auto_flush_on_time() -> anyhow::Result<()> {
    // Arrange: Configure very short flush interval (100ms)
    let config = MemoryConfig {
        batch_config: Some(BatchConfig {
            max_batch_size: 1000,   // Very large so only time triggers
            flush_interval_ms: 100, // Short interval for test
            auto_flush: true,
        }),
        quality_threshold: 0.0, // Zero threshold for test episodes
        ..Default::default()
    };
    let memory = setup_memory_with_config(config);

    let context = ContextBuilder::new("time-flush-test")
        .language("rust")
        .build();

    let episode_id = memory
        .start_episode(
            "Test time-based auto-flush".to_string(),
            context,
            TaskType::Testing,
        )
        .await;

    // Act: Log 3 steps quickly
    for i in 1..=3 {
        let step = create_success_step(i, "test_tool", &format!("Action {i}"));
        memory.log_step(episode_id, step).await;
    }

    // Assert: Steps not yet persisted
    let episode = memory.get_episode(episode_id).await?;
    assert_eq!(
        episode.steps.len(),
        0,
        "Steps should still be buffered initially"
    );

    // Act: Wait for time threshold (100ms + buffer)
    sleep(Duration::from_millis(150)).await;

    // Log one more step - this should trigger time-based flush of all buffered steps
    let step = create_success_step(4, "test_tool", "Action 4");
    memory.log_step(episode_id, step).await;

    // Assert: All 4 steps should now be persisted
    let episode = memory.get_episode(episode_id).await?;
    assert_eq!(
        episode.steps.len(),
        4,
        "All steps should be flushed due to time threshold"
    );

    Ok(())
}

/// Test manual flush via `flush_steps()`
#[tokio::test]
async fn test_manual_flush() -> anyhow::Result<()> {
    // Arrange: Configure large batch size and long interval (no auto-flush)
    let config = MemoryConfig {
        batch_config: Some(BatchConfig {
            max_batch_size: 100,
            flush_interval_ms: 60000,
            auto_flush: true,
        }),
        quality_threshold: 0.0, // Zero threshold for test episodes
        ..Default::default()
    };
    let memory = setup_memory_with_config(config);

    let context = ContextBuilder::new("manual-flush-test")
        .language("rust")
        .build();

    let episode_id = memory
        .start_episode("Test manual flush".to_string(), context, TaskType::Testing)
        .await;

    // Act: Log several steps
    for i in 1..=5 {
        let step = create_success_step(i, "test_tool", &format!("Action {i}"));
        memory.log_step(episode_id, step).await;
    }

    // Assert: Steps not yet persisted
    let episode = memory.get_episode(episode_id).await?;
    assert_eq!(episode.steps.len(), 0, "Steps should still be buffered");

    // Act: Manually flush
    memory.flush_steps(episode_id).await?;

    // Assert: All steps now persisted
    let episode = memory.get_episode(episode_id).await?;
    assert_eq!(episode.steps.len(), 5, "All steps should be flushed");

    // Verify buffer is cleared - log another step
    let step = create_success_step(6, "test_tool", "Action 6");
    memory.log_step(episode_id, step).await;

    // This step should still be buffered
    let episode = memory.get_episode(episode_id).await?;
    assert_eq!(episode.steps.len(), 5, "New step should be in fresh buffer");

    // Flush again to verify
    memory.flush_steps(episode_id).await?;
    let episode = memory.get_episode(episode_id).await?;
    assert_eq!(
        episode.steps.len(),
        6,
        "Second flush should persist new step"
    );

    Ok(())
}

/// Test that `complete_episode` flushes buffered steps
#[tokio::test]
async fn test_complete_episode_flushes_steps() -> anyhow::Result<()> {
    // Arrange: Configure large batch to prevent auto-flush
    let config = MemoryConfig {
        batch_config: Some(BatchConfig {
            max_batch_size: 100,
            flush_interval_ms: 60000,
            auto_flush: true,
        }),
        quality_threshold: 0.0, // Zero threshold for test episodes
        ..Default::default()
    };
    let memory = setup_memory_with_config(config);

    let context = ContextBuilder::new("complete-flush-test")
        .language("rust")
        .build();

    let episode_id = memory
        .start_episode(
            "Test completion flushes steps".to_string(),
            context,
            TaskType::Testing,
        )
        .await;

    // Act: Log buffered steps
    for i in 1..=8 {
        let step = create_success_step(i, "test_tool", &format!("Action {i}"));
        memory.log_step(episode_id, step).await;
    }

    // Verify steps are buffered (not persisted yet)
    let episode = memory.get_episode(episode_id).await?;
    assert_eq!(episode.steps.len(), 0, "Steps should be buffered");

    // Act: Complete episode
    memory
        .complete_episode(
            episode_id,
            TaskOutcome::Success {
                verdict: "Task completed".to_string(),
                artifacts: vec![],
            },
        )
        .await?;

    // Assert: All steps flushed before completion
    let completed_episode = memory.get_episode(episode_id).await?;
    assert!(
        completed_episode.is_complete(),
        "Episode should be complete"
    );
    assert_eq!(
        completed_episode.steps.len(),
        8,
        "All buffered steps should be flushed on completion"
    );

    // Verify reward and reflection are present (episode fully analyzed)
    assert!(
        completed_episode.reward.is_some(),
        "Completed episode should have reward"
    );
    assert!(
        completed_episode.reflection.is_some(),
        "Completed episode should have reflection"
    );

    Ok(())
}

/// Test batching disabled (`batch_config`: None) - immediate persistence
#[tokio::test]
async fn test_batching_disabled() -> anyhow::Result<()> {
    // Arrange: Create memory with batching disabled
    let config = MemoryConfig {
        batch_config: None,     // No batching
        quality_threshold: 0.0, // Zero threshold for test episodes
        ..Default::default()
    };
    let memory = setup_memory_with_config(config);

    let context = ContextBuilder::new("no-batch-test")
        .language("rust")
        .build();

    let episode_id = memory
        .start_episode(
            "Test immediate persistence".to_string(),
            context,
            TaskType::Testing,
        )
        .await;

    // Act & Assert: Each step should be persisted immediately
    for i in 1..=5 {
        let step = create_success_step(i, "test_tool", &format!("Action {i}"));
        memory.log_step(episode_id, step).await;

        // Verify immediate persistence
        let episode = memory.get_episode(episode_id).await?;
        assert_eq!(
            episode.steps.len(),
            i,
            "Step {i} should be immediately persisted"
        );
    }

    Ok(())
}

/// Test concurrent episodes maintain separate buffers
#[tokio::test]
async fn test_multiple_episodes_concurrent_buffering() -> anyhow::Result<()> {
    // Arrange: Configure batching
    let config = MemoryConfig {
        batch_config: Some(BatchConfig {
            max_batch_size: 20,
            flush_interval_ms: 5000,
            auto_flush: true,
        }),
        quality_threshold: 0.0, // Zero threshold for test episodes
        ..Default::default()
    };
    let memory = setup_memory_with_config(config);

    // Create multiple episodes concurrently
    let mut episode_ids = Vec::new();
    for i in 0..3 {
        let context = ContextBuilder::new(format!("concurrent-test-{i}"))
            .language("rust")
            .build();

        let episode_id = memory
            .start_episode(format!("Concurrent task {i}"), context, TaskType::Testing)
            .await;
        episode_ids.push(episode_id);
    }

    // Act: Log different number of steps to each episode
    for (idx, episode_id) in episode_ids.iter().enumerate() {
        let step_count = (idx + 1) * 3; // 3, 6, 9 steps
        for step_num in 1..=step_count {
            let step = create_success_step(
                step_num,
                "test_tool",
                &format!("Episode {idx} Step {step_num}"),
            );
            memory.log_step(*episode_id, step).await;
        }
    }

    // Assert: Steps are buffered (not persisted yet)
    for episode_id in &episode_ids {
        let episode = memory.get_episode(*episode_id).await?;
        assert_eq!(
            episode.steps.len(),
            0,
            "Steps should be buffered for episode {episode_id}"
        );
    }

    // Act: Flush all episodes
    for episode_id in &episode_ids {
        memory.flush_steps(*episode_id).await?;
    }

    // Assert: Each episode has correct number of steps (isolation verified)
    for (idx, episode_id) in episode_ids.iter().enumerate() {
        let episode = memory.get_episode(*episode_id).await?;
        let expected_steps = (idx + 1) * 3;
        assert_eq!(
            episode.steps.len(),
            expected_steps,
            "Episode {} should have {} steps (got {})",
            idx,
            expected_steps,
            episode.steps.len()
        );

        // Verify step ordering for this episode
        for (step_idx, step) in episode.steps.iter().enumerate() {
            assert_eq!(
                step.step_number,
                step_idx + 1,
                "Step ordering should be preserved"
            );
        }
    }

    Ok(())
}

/// Benchmark-style test to verify batching reduces operations
#[tokio::test]
#[allow(clippy::cast_precision_loss)]
async fn test_batching_performance_improvement() -> anyhow::Result<()> {
    let step_count = 100;

    // Test 1: Without batching (immediate persistence)
    let config_no_batch = MemoryConfig {
        batch_config: None,
        quality_threshold: 0.0, // Zero threshold for test episodes
        ..Default::default()
    };
    let memory_no_batch = setup_memory_with_config(config_no_batch);

    let context1 = ContextBuilder::new("perf-no-batch")
        .language("rust")
        .build();

    let episode_id1 = memory_no_batch
        .start_episode(
            "Performance test - no batching".to_string(),
            context1,
            TaskType::Testing,
        )
        .await;

    let start_no_batch = Instant::now();
    for i in 1..=step_count {
        let step = ExecutionStep::new(i, "tool".to_string(), format!("Action {i}"));
        memory_no_batch.log_step(episode_id1, step).await;
    }
    let duration_no_batch = start_no_batch.elapsed();

    // Test 2: With batching
    let config_batch = MemoryConfig {
        batch_config: Some(BatchConfig {
            max_batch_size: 50,
            flush_interval_ms: 60000,
            auto_flush: true,
        }),
        quality_threshold: 0.0, // Zero threshold for test episodes
        ..Default::default()
    };
    let memory_batch = setup_memory_with_config(config_batch);

    let context2 = ContextBuilder::new("perf-batch").language("rust").build();

    let episode_id2 = memory_batch
        .start_episode(
            "Performance test - with batching".to_string(),
            context2,
            TaskType::Testing,
        )
        .await;

    let start_batch = Instant::now();
    for i in 1..=step_count {
        let step = ExecutionStep::new(i, "tool".to_string(), format!("Action {i}"));
        memory_batch.log_step(episode_id2, step).await;
    }
    // Flush buffered steps
    memory_batch.flush_steps(episode_id2).await?;
    let duration_batch = start_batch.elapsed();

    // Assert: Verify both completed successfully with same data
    let episode1 = memory_no_batch.get_episode(episode_id1).await?;
    let episode2 = memory_batch.get_episode(episode_id2).await?;

    assert_eq!(
        episode1.steps.len(),
        step_count,
        "No-batch should have all steps"
    );
    assert_eq!(
        episode2.steps.len(),
        step_count,
        "Batch should have all steps"
    );

    // Print performance comparison (informational)
    println!("\n=== Performance Comparison ===");
    println!("Without batching: {duration_no_batch:?} ({step_count} steps)");
    println!("With batching:    {duration_batch:?} ({step_count} steps)");
    println!(
        "Speedup:          {:.2}x",
        // Clippy: Precision loss acceptable for speedup calculation in test
        duration_no_batch.as_micros() as f64 / duration_batch.as_micros() as f64
    );

    // Note: We don't assert performance improvement as CI environments vary
    // But in local testing, batching should show improvement

    Ok(())
}

/// Test data integrity - no data loss during multiple flushes
#[tokio::test]
async fn test_no_data_loss_on_flush() -> anyhow::Result<()> {
    // Arrange: Configure small batch size for frequent flushes
    let config = MemoryConfig {
        batch_config: Some(BatchConfig {
            max_batch_size: 5,
            flush_interval_ms: 60000,
            auto_flush: true,
        }),
        quality_threshold: 0.0, // Zero threshold for test episodes
        ..Default::default()
    };
    let memory = setup_memory_with_config(config);

    let context = ContextBuilder::new("data-integrity-test")
        .language("rust")
        .build();

    let episode_id = memory
        .start_episode(
            "Test data integrity".to_string(),
            context,
            TaskType::Testing,
        )
        .await;

    // Act: Log many steps (will trigger multiple auto-flushes)
    let total_steps = 27; // Will flush at 5, 10, 15, 20, 25, then 2 remain
    for i in 1..=total_steps {
        let step = create_success_step(i, "test_tool", &format!("Action {i}"));
        memory.log_step(episode_id, step).await;
    }

    // Manual flush to get remaining steps
    memory.flush_steps(episode_id).await?;

    // Assert: All steps preserved
    let episode = memory.get_episode(episode_id).await?;
    assert_eq!(
        episode.steps.len(),
        total_steps,
        "All steps should be preserved across multiple flushes"
    );

    // Verify ordering maintained
    for (idx, step) in episode.steps.iter().enumerate() {
        assert_eq!(
            step.step_number,
            idx + 1,
            "Step numbering should be sequential"
        );
        assert_eq!(
            step.action,
            format!("Action {}", idx + 1),
            "Step content should match"
        );
    }

    Ok(())
}

/// Test edge case: flush with empty buffer
#[tokio::test]
async fn test_flush_empty_buffer() -> anyhow::Result<()> {
    // Arrange
    let config = MemoryConfig {
        batch_config: Some(BatchConfig::default()),
        quality_threshold: 0.0, // Zero threshold for test episodes
        ..Default::default()
    };
    let memory = setup_memory_with_config(config);

    let context = TaskContext::default();
    let episode_id = memory
        .start_episode("Test empty flush".to_string(), context, TaskType::Testing)
        .await;

    // Act: Flush with no steps logged
    memory.flush_steps(episode_id).await?;

    // Assert: Should succeed with no errors
    let episode = memory.get_episode(episode_id).await?;
    assert_eq!(episode.steps.len(), 0, "Should have no steps");

    Ok(())
}

/// Test edge case: flush non-existent episode
#[tokio::test]
async fn test_flush_nonexistent_episode() -> anyhow::Result<()> {
    // Arrange
    let config = MemoryConfig {
        batch_config: Some(BatchConfig::default()),
        quality_threshold: 0.0, // Zero threshold for test episodes
        ..Default::default()
    };
    let memory = setup_memory_with_config(config);

    let fake_id = uuid::Uuid::new_v4();

    // Act: Flush non-existent episode
    let result = memory.flush_steps(fake_id).await;

    // Assert: Should succeed (no-op for non-existent buffer)
    assert!(
        result.is_ok(),
        "Flushing non-existent episode should not error"
    );

    Ok(())
}

/// Test buffer behavior with `auto_flush` disabled
#[tokio::test]
async fn test_manual_flush_only_mode() -> anyhow::Result<()> {
    // Arrange: Configure manual-only flushing
    let config = MemoryConfig {
        batch_config: Some(BatchConfig {
            max_batch_size: 10,
            flush_interval_ms: 1000,
            auto_flush: false, // Manual only
        }),
        quality_threshold: 0.0, // Zero threshold for test episodes
        ..Default::default()
    };
    let memory = setup_memory_with_config(config);

    let context = ContextBuilder::new("manual-only-test")
        .language("rust")
        .build();

    let episode_id = memory
        .start_episode(
            "Test manual-only mode".to_string(),
            context,
            TaskType::Testing,
        )
        .await;

    // Act: Log many steps (exceeding batch size and wait time)
    for i in 1..=15 {
        let step = create_success_step(i, "test_tool", &format!("Action {i}"));
        memory.log_step(episode_id, step).await;
    }

    // Wait for potential time-based flush
    sleep(Duration::from_millis(1200)).await;

    // Log one more to check if time triggered anything
    let step = create_success_step(16, "test_tool", "Action 16");
    memory.log_step(episode_id, step).await;

    // Assert: No auto-flush should have occurred
    let episode = memory.get_episode(episode_id).await?;
    assert_eq!(
        episode.steps.len(),
        0,
        "With auto_flush=false, no steps should be auto-flushed"
    );

    // Act: Manual flush
    memory.flush_steps(episode_id).await?;

    // Assert: Now all steps should be persisted
    let episode = memory.get_episode(episode_id).await?;
    assert_eq!(
        episode.steps.len(),
        16,
        "Manual flush should persist all buffered steps"
    );

    Ok(())
}

/// Test preset configurations work correctly
#[tokio::test]
async fn test_batch_config_presets() -> anyhow::Result<()> {
    // Test high_frequency preset
    let high_freq = BatchConfig::high_frequency();
    assert_eq!(high_freq.max_batch_size, 20);
    assert_eq!(high_freq.flush_interval_ms, 2000);
    assert!(high_freq.auto_flush);

    // Test low_frequency preset
    let low_freq = BatchConfig::low_frequency();
    assert_eq!(low_freq.max_batch_size, 100);
    assert_eq!(low_freq.flush_interval_ms, 10000);
    assert!(low_freq.auto_flush);

    // Test manual_only preset
    let manual = BatchConfig::manual_only();
    assert_eq!(manual.max_batch_size, usize::MAX);
    assert!(!manual.auto_flush);

    // Verify high_frequency actually flushes more often
    let config = MemoryConfig {
        batch_config: Some(BatchConfig::high_frequency()),
        quality_threshold: 0.0, // Zero threshold for test episodes
        ..Default::default()
    };
    let memory = setup_memory_with_config(config);

    let context = TaskContext::default();
    let episode_id = memory
        .start_episode("Test preset".to_string(), context, TaskType::Testing)
        .await;

    // Log exactly 20 steps (should trigger flush)
    for i in 1..=20 {
        let step = ExecutionStep::new(i, "tool".to_string(), format!("Action {i}"));
        memory.log_step(episode_id, step).await;
    }

    // Should auto-flush at 20
    let episode = memory.get_episode(episode_id).await?;
    assert_eq!(
        episode.steps.len(),
        20,
        "High frequency preset should auto-flush at 20 steps"
    );

    Ok(())
}