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
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
//! BDD-style regression tests to prevent system degradation
//!
//! Tests verify that the memory system maintains quality and compatibility over time.
//!
//! ## Test Coverage
//! - Pattern extraction accuracy and type coverage
//! - Retrieval performance and quality with large datasets
//! - API and data structure backward compatibility
//! - Bug regression prevention (duplicate patterns, idempotency, edge cases)

mod common;

use common::{create_test_step, setup_test_memory, test_context};
use do_memory_core::{
    ComplexityLevel, ExecutionResult, ExecutionStep, Pattern, TaskContext, TaskOutcome, TaskType,
    memory::SelfLearningMemory,
};
use std::time::{Duration, Instant};
use uuid::Uuid;

/// Load or create historical test episodes
fn load_historical_test_episodes() -> Vec<Episode> {
    // In a real implementation, these would be loaded from a fixture file
    // For now, we create standard test cases
    vec![
        create_error_recovery_episode(),
        create_tool_sequence_episode(),
        create_optimization_episode(),
    ]
}

/// Create an episode with error recovery pattern
fn create_error_recovery_episode() -> Episode {
    use do_memory_core::episode::Episode;

    let context = TaskContext {
        language: Some("rust".to_string()),
        domain: "error-handling".to_string(),
        tags: vec!["retry".to_string()],
        ..Default::default()
    };

    let mut episode = Episode::new(
        "Implement retry logic".to_string(),
        context,
        TaskType::CodeGeneration,
    );

    // First attempt fails
    let mut error_step = ExecutionStep::new(
        1,
        "initial_attempt".to_string(),
        "Try operation".to_string(),
    );
    error_step.result = Some(ExecutionResult::Error {
        message: "Connection timeout".to_string(),
    });
    episode.add_step(error_step);

    // Retry succeeds
    let mut retry_step = ExecutionStep::new(
        2,
        "retry_handler".to_string(),
        "Retry with backoff".to_string(),
    );
    retry_step.result = Some(ExecutionResult::Success {
        output: "Success".to_string(),
    });
    episode.add_step(retry_step);

    episode.complete(TaskOutcome::Success {
        verdict: "Retry worked".to_string(),
        artifacts: vec![],
    });

    episode
}

/// Create episode with tool sequence pattern
fn create_tool_sequence_episode() -> Episode {
    use do_memory_core::episode::Episode;

    let context = TaskContext {
        language: Some("rust".to_string()),
        domain: "code-generation".to_string(),
        tags: vec!["sequential".to_string()],
        ..Default::default()
    };

    let mut episode = Episode::new(
        "Build API endpoint".to_string(),
        context,
        TaskType::CodeGeneration,
    );

    // Sequential tool usage
    let tools = ["analyzer", "designer", "builder", "tester"];
    for (i, tool) in tools.iter().enumerate() {
        let mut step = ExecutionStep::new(i + 1, (*tool).to_string(), format!("{tool} step"));
        step.result = Some(ExecutionResult::Success {
            output: "Done".to_string(),
        });
        episode.add_step(step);
    }

    episode.complete(TaskOutcome::Success {
        verdict: "API built".to_string(),
        artifacts: vec!["api.rs".to_string()],
    });

    episode
}

/// Create episode with optimization pattern
fn create_optimization_episode() -> Episode {
    use do_memory_core::episode::Episode;

    let context = TaskContext {
        language: Some("rust".to_string()),
        domain: "performance".to_string(),
        tags: vec!["optimization".to_string()],
        ..Default::default()
    };

    let mut episode = Episode::new("Optimize query".to_string(), context, TaskType::Refactoring);

    // Initial slow performance
    let mut slow_step = ExecutionStep::new(1, "profiler".to_string(), "Profile code".to_string());
    slow_step.latency_ms = 1000; // Slow
    slow_step.result = Some(ExecutionResult::Success {
        output: "Found bottleneck".to_string(),
    });
    episode.add_step(slow_step);

    // After optimization
    let mut fast_step =
        ExecutionStep::new(2, "optimizer".to_string(), "Apply optimization".to_string());
    fast_step.latency_ms = 100; // Fast
    fast_step.result = Some(ExecutionResult::Success {
        output: "Optimized".to_string(),
    });
    episode.add_step(fast_step);

    episode.complete(TaskOutcome::Success {
        verdict: "10x faster".to_string(),
        artifacts: vec![],
    });

    episode
}

/// Load reference patterns (known good patterns)
fn load_reference_patterns() -> Vec<Pattern> {
    use chrono::Duration;
    use do_memory_core::PatternEffectiveness;

    vec![
        Pattern::ErrorRecovery {
            id: Uuid::new_v4(),
            context: TaskContext::default(),
            error_type: "timeout".to_string(),
            recovery_steps: vec!["retry_with_backoff".to_string()],
            success_rate: 0.9,
            effectiveness: PatternEffectiveness::default(),
        },
        Pattern::ToolSequence {
            id: Uuid::new_v4(),
            context: TaskContext::default(),
            tools: vec![
                "analyzer".to_string(),
                "designer".to_string(),
                "builder".to_string(),
                "tester".to_string(),
            ],
            success_rate: 0.85,
            avg_latency: Duration::milliseconds(60000),
            occurrence_count: 10,
            effectiveness: PatternEffectiveness::default(),
        },
    ]
}

/// Calculate pattern similarity/accuracy
#[allow(clippy::cast_precision_loss)]
fn calculate_pattern_similarity(extracted: &[Pattern], reference: &[Pattern]) -> f32 {
    if reference.is_empty() {
        return 0.0;
    }

    let mut matches = 0;

    for ref_pattern in reference {
        for ext_pattern in extracted {
            if patterns_match(ref_pattern, ext_pattern) {
                matches += 1;
                break;
            }
        }
    }

    matches as f32 / reference.len() as f32
}

/// Check if two patterns match (same type and similar properties)
fn patterns_match(p1: &Pattern, p2: &Pattern) -> bool {
    match (p1, p2) {
        (
            Pattern::ErrorRecovery { error_type: e1, .. },
            Pattern::ErrorRecovery { error_type: e2, .. },
        ) => e1.contains(e2) || e2.contains(e1),
        (Pattern::ToolSequence { tools: t1, .. }, Pattern::ToolSequence { tools: t2, .. }) => {
            // Check if tool sequences are similar
            if t1.len() != t2.len() {
                return false;
            }
            t1.iter().zip(t2.iter()).filter(|(a, b)| a == b).count() >= t1.len() * 2 / 3
        }
        _ => false,
    }
}

/// Load standard test queries for retrieval performance
fn load_standard_test_queries() -> Vec<TestQuery> {
    vec![
        TestQuery {
            text: "implement authentication".to_string(),
            context: TaskContext {
                domain: "web-api".to_string(),
                ..Default::default()
            },
        },
        TestQuery {
            text: "handle errors".to_string(),
            context: TaskContext {
                domain: "error-handling".to_string(),
                ..Default::default()
            },
        },
        TestQuery {
            text: "optimize performance".to_string(),
            context: TaskContext {
                domain: "performance".to_string(),
                ..Default::default()
            },
        },
        TestQuery {
            text: "write tests".to_string(),
            context: TaskContext {
                domain: "testing".to_string(),
                ..Default::default()
            },
        },
        TestQuery {
            text: "refactor code".to_string(),
            context: TaskContext {
                domain: "refactoring".to_string(),
                ..Default::default()
            },
        },
    ]
}

struct TestQuery {
    text: String,
    context: TaskContext,
}

use do_memory_core::episode::Episode;

/// Setup memory with 10K episodes for performance testing
async fn setup_memory_with_10k_episodes() -> SelfLearningMemory {
    let memory = setup_test_memory();

    for i in 0..10000 {
        if i % 1000 == 0 {
            println!("Loading test episodes: {i}/10000");
        }

        let context = TaskContext {
            domain: format!("domain_{}", i % 10),
            complexity: match i % 3 {
                0 => ComplexityLevel::Simple,
                1 => ComplexityLevel::Moderate,
                _ => ComplexityLevel::Complex,
            },
            ..Default::default()
        };

        let episode_id = memory
            .start_episode(format!("Task {i}"), context, TaskType::CodeGeneration)
            .await;

        memory
            .complete_episode(
                episode_id,
                TaskOutcome::Success {
                    verdict: "Done".to_string(),
                    artifacts: vec![],
                },
            )
            .await
            .unwrap();
    }

    memory
}

// ============================================================================
// Pattern Extraction Regression
// ============================================================================

/// Pattern extraction accuracy regression test
///
/// Note: This test is non-deterministic due to probabilistic nature of pattern extraction.
/// It may fail intermittently when pattern extraction accuracy fluctuates.
/// Enable with: cargo test --package memory-core --test regression -- --ignored
/// Tracking: See ADR-027 for strategy on non-deterministic tests
#[tokio::test]
#[ignore = "Non-deterministic pattern extraction - may fail intermittently"]
async fn should_maintain_pattern_extraction_accuracy_over_time() {
    // Given: Historical test episodes with known patterns
    let test_episodes = load_historical_test_episodes();
    let memory = setup_test_memory();

    // When: Storing episodes and extracting patterns
    for episode in &test_episodes {
        let episode_id = memory
            .start_episode(
                episode.task_description.clone(),
                episode.context.clone(),
                episode.task_type,
            )
            .await;

        for step in &episode.steps {
            memory.log_step(episode_id, step.clone()).await;
        }

        if let Some(outcome) = &episode.outcome {
            memory
                .complete_episode(episode_id, outcome.clone())
                .await
                .unwrap();
        }
    }

    let reference_patterns = load_reference_patterns();

    let patterns = memory
        .retrieve_relevant_patterns(&TaskContext::default(), 10)
        .await;

    // Then: Pattern extraction accuracy should meet minimum threshold
    let accuracy = calculate_pattern_similarity(&patterns, &reference_patterns);

    println!(
        "Pattern extraction accuracy: {:.1}% ({} extracted, {} expected)",
        accuracy * 100.0,
        patterns.len(),
        reference_patterns.len()
    );

    assert!(
        accuracy > 0.5,
        "Pattern extraction accuracy degraded to {:.1}%",
        accuracy * 100.0
    );
}

#[tokio::test]
async fn should_extract_all_pattern_types_correctly() {
    // Given: Memory system and an episode that should produce ErrorRecovery pattern
    let memory = setup_test_memory();

    let episode_id = memory
        .start_episode(
            "Error handling".to_string(),
            TaskContext {
                domain: "error-handling".to_string(),
                ..Default::default()
            },
            TaskType::CodeGeneration,
        )
        .await;

    // When: Logging an error followed by successful recovery
    let mut error_step = ExecutionStep::new(1, "attempt".to_string(), "Try".to_string());
    error_step.result = Some(ExecutionResult::Error {
        message: "Failed".to_string(),
    });
    memory.log_step(episode_id, error_step).await;

    let mut success_step = ExecutionStep::new(2, "retry".to_string(), "Retry".to_string());
    success_step.result = Some(ExecutionResult::Success {
        output: "Success".to_string(),
    });
    memory.log_step(episode_id, success_step).await;

    memory
        .complete_episode(
            episode_id,
            TaskOutcome::Success {
                verdict: "Recovered".to_string(),
                artifacts: vec![],
            },
        )
        .await
        .unwrap();

    // Then: Pattern should be extracted from error recovery episode
    let completed = memory.get_episode(episode_id).await.unwrap();

    assert!(
        !completed.patterns.is_empty(),
        "No patterns extracted from error recovery episode"
    );
}

// ============================================================================
// Retrieval Performance Regression
// ============================================================================

#[tokio::test]
#[ignore = "Long-running performance test - run with --include-ignored for full validation"]
async fn should_maintain_fast_retrieval_with_large_dataset() {
    // Given: Memory system with 10K episodes and standard test queries
    let memory = setup_memory_with_10k_episodes().await;
    let test_queries = load_standard_test_queries();

    // When: Executing retrieval queries
    let mut total_time = Duration::from_millis(0);

    for query in &test_queries {
        let start = Instant::now();
        let _ = memory
            .retrieve_relevant_context(query.text.clone(), query.context.clone(), 10)
            .await;
        total_time += start.elapsed();
    }

    let avg_time = total_time
        / u32::try_from(test_queries.len()).expect("test_queries length should fit in u32");

    println!("Average retrieval time with 10K episodes: {avg_time:?}");

    // Then: Average retrieval time should remain under 100ms
    assert!(
        avg_time.as_millis() < 100,
        "Average retrieval time degraded to {}ms",
        avg_time.as_millis()
    );
}

#[tokio::test]
async fn should_retrieve_relevant_episodes_by_domain() {
    // Given: Memory with episodes in two different domains
    let memory = setup_test_memory();

    // Given: 10 web-api episodes with authentication tag
    for i in 0..10 {
        let context = TaskContext {
            domain: "web-api".to_string(),
            tags: vec!["authentication".to_string()],
            ..Default::default()
        };

        let episode_id = memory
            .start_episode(format!("Auth task {i}"), context, TaskType::CodeGeneration)
            .await;

        memory
            .complete_episode(
                episode_id,
                TaskOutcome::Success {
                    verdict: "Done".to_string(),
                    artifacts: vec![],
                },
            )
            .await
            .unwrap();
    }

    // Given: 10 data-processing episodes with batch tag
    for i in 0..10 {
        let context = TaskContext {
            domain: "data-processing".to_string(),
            tags: vec!["batch".to_string()],
            ..Default::default()
        };

        let episode_id = memory
            .start_episode(format!("Batch task {i}"), context, TaskType::CodeGeneration)
            .await;

        memory
            .complete_episode(
                episode_id,
                TaskOutcome::Success {
                    verdict: "Done".to_string(),
                    artifacts: vec![],
                },
            )
            .await
            .unwrap();
    }

    // When: Querying for web-api domain authentication
    let context = TaskContext {
        domain: "web-api".to_string(),
        ..Default::default()
    };

    let results = memory
        .retrieve_relevant_context("authentication".to_string(), context, 10)
        .await;

    // Then: Should return results
    assert!(!results.is_empty());

    // Then: At least 50% of results should match the queried domain
    let web_api_count = results
        .iter()
        .filter(|e| e.context.domain == "web-api")
        .count();

    #[allow(clippy::cast_precision_loss)]
    {
        assert!(
            web_api_count as f64 / results.len() as f64 >= 0.5,
            "Retrieval quality degraded - only {}/{} results matched domain",
            web_api_count,
            results.len()
        );
    }
}

// ============================================================================
// API Compatibility Regression
// ============================================================================

#[tokio::test]
async fn should_maintain_backward_compatible_public_api() {
    // Given: Memory system instance
    let memory = setup_test_memory();

    // When/Then: All public API methods should be available and functional

    // Then: start_episode should work
    let episode_id = memory
        .start_episode("test".to_string(), test_context(), TaskType::Testing)
        .await;

    // Then: log_step should work
    let step = create_test_step(1);
    memory.log_step(episode_id, step).await;

    // Then: complete_episode should work
    let completed = memory
        .complete_episode(
            episode_id,
            TaskOutcome::Success {
                verdict: "test".to_string(),
                artifacts: vec![],
            },
        )
        .await;
    assert!(completed.is_ok());

    // Then: retrieve_relevant_context should work
    let results = memory
        .retrieve_relevant_context("test".to_string(), test_context(), 10)
        .await;
    assert!(results.is_empty() || !results.is_empty());

    // Then: get_episode should work
    let episode = memory.get_episode(episode_id).await;
    assert!(episode.is_ok());

    // Then: get_stats should work
    let (_total, _completed, _patterns) = memory.get_stats().await;

    // Then: retrieve_relevant_patterns should work
    let _patterns = memory.retrieve_relevant_patterns(&test_context(), 10).await;
}

#[tokio::test]
async fn should_maintain_data_structure_compatibility() {
    // Given: Memory system and test episode
    let memory = setup_test_memory();

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

    let episode = memory.get_episode(episode_id).await.unwrap();

    // When/Then: Episode structure should have all expected fields
    let _ = episode.episode_id;
    let _ = episode.task_type;
    let _ = episode.task_description;
    let _ = episode.context;
    let _ = episode.start_time;
    let _ = episode.end_time;
    let _ = episode.steps;
    let _ = episode.outcome;
    let _ = episode.reward;
    let _ = episode.reflection;
    let _ = episode.patterns;
    let _ = episode.metadata;

    // Then: Episode methods should be available
    assert!(!episode.is_complete());
    let _ = episode.duration();
    let _ = episode.successful_steps_count();
    let _ = episode.failed_steps_count();

    // When/Then: ExecutionStep structure should have all expected fields
    let step = create_test_step(1);

    let _ = step.step_number;
    let _ = step.timestamp;
    let _ = step.tool;
    let _ = step.action;
    let _ = step.parameters;
    let _ = step.result;
    let _ = step.latency_ms;
    let _ = step.tokens_used;
    let _ = step.metadata;

    // Then: ExecutionStep methods should be available
    let _ = step.is_success();

    // When/Then: TaskContext structure should have all expected fields
    let context = test_context();

    let _ = context.language;
    let _ = context.framework;
    let _ = context.complexity;
    let _ = context.domain;
    let _ = context.tags;
}

// ============================================================================
// Bug Regression Tests
// ============================================================================

#[tokio::test]
async fn should_prevent_previously_fixed_bugs_from_recurring() {
    // Bug 1: No duplicate pattern IDs

    // Given: Memory system with completed episode containing patterns
    let memory1 = setup_test_memory();

    let episode_id = memory1
        .start_episode("Test".to_string(), test_context(), TaskType::CodeGeneration)
        .await;

    for i in 1..=5 {
        memory1.log_step(episode_id, create_test_step(i)).await;
    }

    memory1
        .complete_episode(
            episode_id,
            TaskOutcome::Success {
                verdict: "Done".to_string(),
                artifacts: vec![],
            },
        )
        .await
        .unwrap();

    // When/Then: Checking for duplicate pattern IDs
    let completed = memory1.get_episode(episode_id).await.unwrap();

    let mut seen = std::collections::HashSet::new();
    for pattern_id in &completed.patterns {
        assert!(
            seen.insert(*pattern_id),
            "Duplicate pattern ID found: {pattern_id}"
        );
    }

    // Bug 2: Episode completion is idempotent

    // Given: Memory system and completed episode
    let memory2 = setup_test_memory();

    let episode_id2 = memory2
        .start_episode("Test".to_string(), test_context(), TaskType::Testing)
        .await;

    let outcome = TaskOutcome::Success {
        verdict: "Done".to_string(),
        artifacts: vec![],
    };

    // When: Completing episode twice
    let result1 = memory2.complete_episode(episode_id2, outcome.clone()).await;
    assert!(result1.is_ok());

    let result2 = memory2.complete_episode(episode_id2, outcome).await;

    // Then: Should either succeed idempotently or return error (not panic)
    assert!(result1.is_ok() || result2.is_err());

    // Bug 3: Can complete episode with no steps

    // Given: Memory system and episode without steps
    let memory3 = setup_test_memory();

    let episode_id3 = memory3
        .start_episode("Test".to_string(), test_context(), TaskType::Testing)
        .await;

    // When: Completing episode without adding any steps
    let result = memory3
        .complete_episode(
            episode_id3,
            TaskOutcome::Success {
                verdict: "Done".to_string(),
                artifacts: vec![],
            },
        )
        .await;

    // Then: Should succeed and episode should be complete with 0 steps
    assert!(result.is_ok());

    let episode = memory3.get_episode(episode_id3).await.unwrap();
    assert!(episode.is_complete());
    assert_eq!(episode.steps.len(), 0);
}

// Note: Concurrent step logging test is covered in learning_cycle.rs

// ============================================================================
// Performance Regression
// ============================================================================

#[tokio::test]
async fn should_maintain_baseline_episode_creation_performance() {
    // Given: Memory system and performance baseline
    let memory = setup_test_memory();

    let start = Instant::now();

    // When: Creating 100 episodes with 3 steps each
    for i in 0..100 {
        let episode_id = memory
            .start_episode(
                format!("Task {i}"),
                test_context(),
                TaskType::CodeGeneration,
            )
            .await;

        for j in 1..=3 {
            memory.log_step(episode_id, create_test_step(j)).await;
        }

        memory
            .complete_episode(
                episode_id,
                TaskOutcome::Success {
                    verdict: "Done".to_string(),
                    artifacts: vec![],
                },
            )
            .await
            .unwrap();
    }

    let elapsed = start.elapsed();

    println!(
        "100 episodes with 3 steps each: {:?} ({:.2} eps/sec)",
        elapsed,
        100.0 / elapsed.as_secs_f32()
    );

    // Then: Should complete in reasonable time (< 5 seconds)
    assert!(
        elapsed.as_secs() < 5,
        "Performance degraded: took {}ms for 100 episodes",
        elapsed.as_millis()
    );
}