spool-memory 0.2.3

Local-first developer memory system — persistent, structured knowledge for AI coding tools
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
use crate::config::ProjectConfig;
use crate::domain::{
    CandidateNote, LifecycleCandidate, MatchedModule, MatchedProject, MatchedScene, MemoryRecord,
    MemoryScope, Note, RouteInput, ScoredNote,
};
use crate::engine::scorer;
use std::collections::HashSet;

/// Score multiplier applied to relation-expanded candidates (1-hop).
/// A 30% penalty means expanded items retain 70% of their original score.
const HOP_PENALTY: f64 = 0.7;

/// Score multiplier applied to cross-project (user/agent/team scope) lifecycle
/// candidates when a project is matched. Ensures project-scoped memories are
/// preferred over global ones when both are relevant.
const CROSS_PROJECT_PENALTY: f64 = 0.6;

/// RRF constant (k=60 is standard in literature).
#[cfg(feature = "bm25")]
const RRF_K: f64 = 60.0;

#[cfg(all(feature = "embedding", not(feature = "bm25")))]
const RRF_K: f64 = 60.0;

pub fn select_scored_notes(
    project_config: Option<&ProjectConfig>,
    project: Option<&MatchedProject>,
    modules: &[MatchedModule],
    scenes: &[MatchedScene],
    notes: &[Note],
    input: &RouteInput,
    limit: usize,
) -> Vec<ScoredNote> {
    let mut scored_notes: Vec<ScoredNote> = notes
        .iter()
        .filter_map(|note| {
            let (score, reasons, score_breakdown, confidence) =
                scorer::score_note(project_config, project, modules, scenes, note, input);
            if score <= 0 {
                return None;
            }
            Some(ScoredNote {
                note: note.clone(),
                score,
                reasons,
                score_breakdown,
                confidence,
                excerpt: note.excerpt_for_input(input, 220),
            })
        })
        .collect();

    scored_notes.sort_by(|left, right| {
        right
            .score
            .cmp(&left.score)
            .then_with(|| left.note.relative_path.cmp(&right.note.relative_path))
    });

    // Initial top-K selection
    let initial: Vec<ScoredNote> = scored_notes.iter().take(limit).cloned().collect();

    // Relation expansion: collect wikilinks and related_memory from selected notes
    let selected_paths: HashSet<String> = initial
        .iter()
        .map(|s| s.note.relative_path.clone())
        .collect();
    let mut expand_targets: HashSet<String> = HashSet::new();
    for scored in &initial {
        // Wikilinks from note content
        for link in &scored.note.wikilinks {
            expand_targets.insert(link.to_lowercase());
        }
        // related_memory frontmatter (may contain wikilink-style references)
        if let Some(related) = scored.note.frontmatter.get("related_memory")
            && let Some(arr) = related.as_array()
        {
            for item in arr {
                if let Some(s) = item.as_str() {
                    let cleaned = s.trim_start_matches("[[").trim_end_matches("]]");
                    expand_targets.insert(cleaned.to_lowercase());
                }
            }
        }
    }

    // Find related notes from the full scored pool that aren't already selected
    let mut expanded = initial;
    if !expand_targets.is_empty() {
        for scored in &scored_notes {
            if selected_paths.contains(&scored.note.relative_path) {
                continue;
            }
            let title_lc = scored.note.title.to_lowercase();
            let path_lc = scored.note.relative_path.to_lowercase();
            let is_related = expand_targets.iter().any(|target| {
                title_lc.contains(target) || path_lc.contains(target) || target.contains(&title_lc)
            });
            if is_related {
                let penalized_score = ((scored.score as f64) * HOP_PENALTY) as i32;
                if penalized_score > 0 {
                    let mut expanded_note = scored.clone();
                    expanded_note.score = penalized_score;
                    expanded_note.reasons.push(format!(
                        "relation-expanded (1-hop, {:.0}% penalty)",
                        (1.0 - HOP_PENALTY) * 100.0
                    ));
                    expanded.push(expanded_note);
                }
            }
        }
    }

    // Re-sort and re-truncate
    expanded.sort_by(|left, right| {
        right
            .score
            .cmp(&left.score)
            .then_with(|| left.note.relative_path.cmp(&right.note.relative_path))
    });
    expanded.truncate(limit);
    expanded
}

pub fn select_candidates(
    project_config: Option<&ProjectConfig>,
    project: Option<&MatchedProject>,
    modules: &[MatchedModule],
    scenes: &[MatchedScene],
    notes: &[Note],
    input: &RouteInput,
    limit: usize,
) -> Vec<CandidateNote> {
    select_scored_notes(
        project_config,
        project,
        modules,
        scenes,
        notes,
        input,
        limit,
    )
    .into_iter()
    .map(CandidateNote::from)
    .collect()
}

/// 从 lifecycle ledger 的 `(record_id, record)` 列表里打分 + 过滤 + 截断,产出 top-N lifecycle 候选。
///
/// `excluded_record_ids` 用于去重:已经被 canonical vault note 覆盖的 record_id 不再作为
/// lifecycle candidate 返回,避免同一条记忆在 context 里双计(note 一次 + lifecycle candidate 一次)。
///
/// `reference_map` 提供 staleness 信息,传 `None` 跳过 staleness 惩罚。
///
/// After initial top-K selection, performs 1-hop relation expansion via `related_records`
/// fields. Expanded candidates receive a 30% score penalty and are merged into the result
/// before final truncation. Records that didn't score on their own but are referenced by
/// a top-K record receive a base score derived from the referencing record's score.
pub fn select_lifecycle_candidates(
    project: Option<&MatchedProject>,
    records: &[(String, MemoryRecord)],
    input: &RouteInput,
    limit: usize,
    excluded_record_ids: &HashSet<String>,
    reference_map: Option<&crate::reference_tracker::ReferenceMap>,
) -> Vec<LifecycleCandidate> {
    if limit == 0 {
        return Vec::new();
    }
    let mut candidates: Vec<LifecycleCandidate> = records
        .iter()
        .filter(|(record_id, _)| !excluded_record_ids.contains(record_id))
        .filter_map(|(record_id, record)| {
            scorer::score_lifecycle_candidate(
                project,
                record_id,
                record,
                input,
                reference_map,
                Some(records),
            )
        })
        .collect();

    // Project-first: when a project is matched, apply a penalty to cross-project
    // (user/agent/team scope) candidates so project-scoped memories are preferred.
    if project.is_some() {
        for candidate in &mut candidates {
            if matches!(
                candidate.scope,
                MemoryScope::User | MemoryScope::Agent | MemoryScope::Team
            ) {
                let penalized = ((candidate.score as f64) * CROSS_PROJECT_PENALTY) as i32;
                if penalized != candidate.score {
                    candidate.score = penalized;
                    candidate.reasons.push(format!(
                        "cross-project penalty ({:.0}%)",
                        (1.0 - CROSS_PROJECT_PENALTY) * 100.0
                    ));
                }
            }
        }
    }

    candidates.sort_by(|left, right| {
        right
            .score
            .cmp(&left.score)
            .then_with(|| left.record_id.cmp(&right.record_id))
    });

    // Initial top-K selection
    let initial: Vec<LifecycleCandidate> = candidates.iter().take(limit).cloned().collect();

    // Relation expansion: collect related_records from selected candidates
    let selected_ids: HashSet<String> = initial.iter().map(|c| c.record_id.clone()).collect();
    let candidate_ids: HashSet<String> = candidates.iter().map(|c| c.record_id.clone()).collect();
    let mut expand_targets: HashSet<String> = HashSet::new();
    for candidate in &initial {
        if let Some((_, record)) = records.iter().find(|(id, _)| id == &candidate.record_id) {
            for related_id in &record.related_records {
                if !selected_ids.contains(related_id) && !excluded_record_ids.contains(related_id) {
                    expand_targets.insert(related_id.clone());
                }
            }
        }
    }

    // Find related candidates: from scored pool OR from raw records (for items that scored 0)
    let mut expanded = initial;
    if !expand_targets.is_empty() {
        for target_id in &expand_targets {
            // First check if it's in the scored candidates pool
            if let Some(candidate) = candidates.iter().find(|c| &c.record_id == target_id) {
                let penalized_score = ((candidate.score as f64) * HOP_PENALTY) as i32;
                if penalized_score > 0 {
                    let mut expanded_candidate = candidate.clone();
                    expanded_candidate.score = penalized_score;
                    expanded_candidate.reasons.push(format!(
                        "relation-expanded (1-hop, {:.0}% penalty)",
                        (1.0 - HOP_PENALTY) * 100.0
                    ));
                    expanded.push(expanded_candidate);
                }
            } else if !candidate_ids.contains(target_id) {
                // Record scored 0 on its own but is referenced by a top record.
                // Create a minimal candidate with a relation-based score.
                if let Some((_, record)) = records.iter().find(|(id, _)| id == target_id) {
                    // Use the referencing record's score * HOP_PENALTY as base
                    let referrer_score = expanded
                        .iter()
                        .filter(|c| {
                            records
                                .iter()
                                .find(|(id, _)| id == &c.record_id)
                                .map(|(_, r)| r.related_records.contains(target_id))
                                .unwrap_or(false)
                        })
                        .map(|c| c.score)
                        .max()
                        .unwrap_or(0);
                    let penalized_score = ((referrer_score as f64) * HOP_PENALTY) as i32;
                    if penalized_score > 0 {
                        let confidence = crate::domain::ConfidenceTier::Medium;
                        expanded.push(LifecycleCandidate {
                            record_id: target_id.clone(),
                            title: record.title.clone(),
                            summary: record.summary.clone(),
                            memory_type: record.memory_type.clone(),
                            scope: record.scope,
                            state: record.state,
                            score: penalized_score,
                            reasons: vec![format!(
                                "relation-expanded (1-hop, {:.0}% penalty, no direct score)",
                                (1.0 - HOP_PENALTY) * 100.0
                            )],
                            project_id: record.project_id.clone(),
                            confidence,
                            contradicts: Vec::new(),
                        });
                    }
                }
            }
        }
    }

    // Re-sort and re-truncate
    expanded.sort_by(|left, right| {
        right
            .score
            .cmp(&left.score)
            .then_with(|| left.record_id.cmp(&right.record_id))
    });
    expanded.truncate(limit);
    expanded
}

/// 从 scored notes 里提取 frontmatter `record_id` 作为 lifecycle candidate 的排除集。
pub fn excluded_record_ids_from_scored(scored: &[ScoredNote]) -> HashSet<String> {
    scored
        .iter()
        .filter_map(|s| {
            s.note
                .frontmatter
                .get("record_id")
                .and_then(|v| v.as_str())
                .map(ToString::to_string)
        })
        .collect()
}

/// 当 knowledge (wiki 综合页) 记录处于 accepted / canonical 状态时,其 `related_records`
/// 里列出的源碎片视为被综合页吸收,不应再作为独立 lifecycle candidate 返回。
///
/// 同时包含显式 `supersedes` 字段指向的被替代记录。
///
/// Karpathy LLM Wiki 的 "compiled 页优先于源碎片" 语义在此落地。
pub fn superseded_record_ids(records: &[(String, MemoryRecord)]) -> HashSet<String> {
    use crate::domain::MemoryLifecycleState;

    let mut superseded: HashSet<String> = HashSet::new();
    for (_record_id, record) in records {
        if !matches!(
            record.state,
            MemoryLifecycleState::Accepted | MemoryLifecycleState::Canonical
        ) {
            continue;
        }
        if record.memory_type == "knowledge" {
            for source_id in &record.related_records {
                superseded.insert(source_id.clone());
            }
        }
        if let Some(ref replaces) = record.supersedes {
            superseded.insert(replaces.clone());
        }
    }
    superseded
}

/// BM25-fused lifecycle candidate selection. When the `bm25` feature is enabled
/// and an index path is provided, this function runs BM25 search and fuses the
/// results with the structured scoring using Reciprocal Rank Fusion (RRF).
///
/// If BM25 is not available (feature disabled, index missing, or search fails),
/// falls back to the standard `select_lifecycle_candidates` behavior.
#[cfg(feature = "bm25")]
pub fn select_lifecycle_candidates_with_bm25(
    project: Option<&MatchedProject>,
    records: &[(String, MemoryRecord)],
    input: &RouteInput,
    limit: usize,
    excluded_record_ids: &HashSet<String>,
    reference_map: Option<&crate::reference_tracker::ReferenceMap>,
    bm25_index_path: Option<&std::path::Path>,
) -> Vec<LifecycleCandidate> {
    let structured_candidates = select_lifecycle_candidates(
        project,
        records,
        input,
        limit * 2,
        excluded_record_ids,
        reference_map,
    );

    let Some(index_path) = bm25_index_path else {
        let mut result = structured_candidates;
        result.truncate(limit);
        return result;
    };

    if !index_path.exists() {
        let mut result = structured_candidates;
        result.truncate(limit);
        return result;
    }

    let bm25_results = match crate::engine::bm25::Bm25Index::open_or_create(index_path) {
        Ok(idx) => idx.search(&input.task, limit * 2).unwrap_or_default(),
        Err(_) => {
            let mut result = structured_candidates;
            result.truncate(limit);
            return result;
        }
    };

    if bm25_results.is_empty() {
        let mut result = structured_candidates;
        result.truncate(limit);
        return result;
    }

    // Build RRF scores
    let mut rrf_scores: std::collections::HashMap<String, f64> = std::collections::HashMap::new();

    // Structured ranking contribution
    for (rank, candidate) in structured_candidates.iter().enumerate() {
        let rrf_score = 1.0 / (RRF_K + (rank as f64) + 1.0);
        *rrf_scores.entry(candidate.record_id.clone()).or_default() += rrf_score;
    }

    // BM25 ranking contribution
    for (rank, (record_id, _score)) in bm25_results.iter().enumerate() {
        if excluded_record_ids.contains(record_id) {
            continue;
        }
        let rrf_score = 1.0 / (RRF_K + (rank as f64) + 1.0);
        *rrf_scores.entry(record_id.clone()).or_default() += rrf_score;
    }

    // Re-rank candidates by RRF score
    let mut fused: Vec<LifecycleCandidate> = structured_candidates
        .into_iter()
        .map(|mut c| {
            let rrf = rrf_scores.get(&c.record_id).copied().unwrap_or(0.0);
            // Convert RRF to an integer score (scale by 1000 for precision)
            c.score = (rrf * 1000.0) as i32;
            c.reasons
                .push(format!("RRF fused score (bm25+structured): {:.4}", rrf));
            c
        })
        .collect();

    // Add BM25-only hits that weren't in the structured results
    let structured_ids: HashSet<String> = fused.iter().map(|c| c.record_id.clone()).collect();
    for (record_id, _bm25_score) in &bm25_results {
        if structured_ids.contains(record_id) || excluded_record_ids.contains(record_id) {
            continue;
        }
        if let Some((_, record)) = records.iter().find(|(id, _)| id == record_id) {
            let rrf = rrf_scores.get(record_id).copied().unwrap_or(0.0);
            let score = (rrf * 1000.0) as i32;
            if score > 0 {
                fused.push(LifecycleCandidate {
                    record_id: record_id.clone(),
                    title: record.title.clone(),
                    summary: record.summary.clone(),
                    memory_type: record.memory_type.clone(),
                    scope: record.scope,
                    state: record.state,
                    score,
                    reasons: vec![format!("BM25-only hit, RRF score: {:.4}", rrf)],
                    project_id: record.project_id.clone(),
                    confidence: crate::domain::ConfidenceTier::Medium,
                    contradicts: Vec::new(),
                });
            }
        }
    }

    fused.sort_by(|left, right| {
        right
            .score
            .cmp(&left.score)
            .then_with(|| left.record_id.cmp(&right.record_id))
    });
    fused.truncate(limit);
    fused
}

/// Three-way RRF fusion: structured + BM25 + embedding.
/// Falls back gracefully when any signal is unavailable.
#[cfg(feature = "embedding")]
pub fn select_lifecycle_candidates_fused(
    project: Option<&MatchedProject>,
    records: &[(String, MemoryRecord)],
    input: &RouteInput,
    limit: usize,
    excluded_record_ids: &HashSet<String>,
    reference_map: Option<&crate::reference_tracker::ReferenceMap>,
    #[cfg(feature = "bm25")] bm25_index_path: Option<&std::path::Path>,
    embedding_results: &[(String, f32)],
) -> Vec<LifecycleCandidate> {
    let structured_candidates = select_lifecycle_candidates(
        project,
        records,
        input,
        limit * 2,
        excluded_record_ids,
        reference_map,
    );

    #[cfg(feature = "bm25")]
    let bm25_results: Vec<(String, f32)> = bm25_index_path
        .filter(|p| p.exists())
        .and_then(|p| crate::engine::bm25::Bm25Index::open_or_create(p).ok())
        .and_then(|idx| idx.search(&input.task, limit * 2).ok())
        .unwrap_or_default();

    #[cfg(not(feature = "bm25"))]
    let bm25_results: Vec<(String, f32)> = Vec::new();

    let has_bm25 = !bm25_results.is_empty();
    let has_embedding = !embedding_results.is_empty();

    if !has_bm25 && !has_embedding {
        let mut result = structured_candidates;
        result.truncate(limit);
        return result;
    }

    let mut rrf_scores: std::collections::HashMap<String, f64> = std::collections::HashMap::new();

    for (rank, candidate) in structured_candidates.iter().enumerate() {
        let rrf_score = 1.0 / (RRF_K + (rank as f64) + 1.0);
        *rrf_scores.entry(candidate.record_id.clone()).or_default() += rrf_score;
    }

    for (rank, (record_id, _)) in bm25_results.iter().enumerate() {
        if excluded_record_ids.contains(record_id) {
            continue;
        }
        let rrf_score = 1.0 / (RRF_K + (rank as f64) + 1.0);
        *rrf_scores.entry(record_id.clone()).or_default() += rrf_score;
    }

    for (rank, (record_id, _)) in embedding_results.iter().enumerate() {
        if excluded_record_ids.contains(record_id) {
            continue;
        }
        let rrf_score = 1.0 / (RRF_K + (rank as f64) + 1.0);
        *rrf_scores.entry(record_id.clone()).or_default() += rrf_score;
    }

    let mut fused: Vec<LifecycleCandidate> = structured_candidates
        .into_iter()
        .map(|mut c| {
            let rrf = rrf_scores.get(&c.record_id).copied().unwrap_or(0.0);
            c.score = (rrf * 1000.0) as i32;
            let signals: Vec<&str> = [
                Some("structured"),
                if has_bm25 { Some("bm25") } else { None },
                if has_embedding {
                    Some("embedding")
                } else {
                    None
                },
            ]
            .into_iter()
            .flatten()
            .collect();
            c.reasons
                .push(format!("RRF fused ({}): {:.4}", signals.join("+"), rrf));
            c
        })
        .collect();

    let structured_ids: HashSet<String> = fused.iter().map(|c| c.record_id.clone()).collect();

    let extra_ids: HashSet<String> = bm25_results
        .iter()
        .chain(embedding_results.iter())
        .map(|(id, _)| id.clone())
        .filter(|id| !structured_ids.contains(id) && !excluded_record_ids.contains(id))
        .collect();

    for record_id in &extra_ids {
        if let Some((_, record)) = records.iter().find(|(id, _)| id == record_id) {
            let rrf = rrf_scores.get(record_id).copied().unwrap_or(0.0);
            let score = (rrf * 1000.0) as i32;
            if score > 0 {
                fused.push(LifecycleCandidate {
                    record_id: record_id.clone(),
                    title: record.title.clone(),
                    summary: record.summary.clone(),
                    memory_type: record.memory_type.clone(),
                    scope: record.scope,
                    state: record.state,
                    score,
                    reasons: vec![format!("RRF extra hit: {:.4}", rrf)],
                    project_id: record.project_id.clone(),
                    confidence: crate::domain::ConfidenceTier::Medium,
                    contradicts: Vec::new(),
                });
            }
        }
    }

    fused.sort_by(|left, right| {
        right
            .score
            .cmp(&left.score)
            .then_with(|| left.record_id.cmp(&right.record_id))
    });
    fused.truncate(limit);
    fused
}

#[cfg(test)]
mod tests;