remem-ai 0.6.49

Local-first coding agent memory for Claude Code and OpenAI Codex
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
use axum::{
    extract::{Query, State},
    http::StatusCode,
    response::IntoResponse,
    Json,
};

use crate::memory::service;

use super::super::helpers::{
    error_response, memories_to_items_with_conn, open_request_db, staleness_error_response,
};
use super::super::types::{
    DbState, MemoryItem, Meta, MultiHopInfo, RawHitItem, SearchParams, SearchResponse,
};

pub(in crate::api) fn search_request_from_params(params: SearchParams) -> service::SearchRequest {
    let limit = params.limit.unwrap_or(20).min(100);
    let offset = params.offset.unwrap_or(0).max(0);

    service::SearchRequest {
        query: params.query,
        project: params.project,
        memory_type: params.memory_type,
        limit,
        offset,
        include_stale: params
            .include_stale
            .unwrap_or_else(service::default_include_stale),
        include_suppressed: params
            .include_suppressed
            .unwrap_or_else(service::default_include_suppressed),
        branch: params.branch,
        multi_hop: params.multi_hop.unwrap_or(false),
        explain: params.explain.unwrap_or(false),
    }
}

pub(in crate::api) async fn handle_search(
    State(_state): State<DbState>,
    Query(params): Query<SearchParams>,
) -> impl IntoResponse {
    if params.explain.unwrap_or(false)
        && params
            .query
            .as_deref()
            .is_none_or(|query| query.trim().is_empty())
    {
        return error_response(
            StatusCode::BAD_REQUEST,
            "invalid_search_request",
            "explain requires a non-empty query; set query or explain=false",
        )
        .into_response();
    }

    if params.multi_hop.unwrap_or(false) && params.explain.unwrap_or(false) {
        return error_response(
            StatusCode::BAD_REQUEST,
            "invalid_search_request",
            "explain is not supported with multi_hop search yet; set multi_hop=false or explain=false",
        )
        .into_response();
    }

    let conn = match open_request_db() {
        Ok(conn) => conn,
        Err(response) => return response,
    };
    let req = search_request_from_params(params);
    let limit = req.limit;
    let offset = req.offset;

    const RAW_PREVIEW_CHARS: usize = 300;

    match service::search_memories_with_explain_details(&conn, &req) {
        Ok(detailed) => {
            let results = detailed.result;
            let count = results.memories.len();
            let items: Vec<MemoryItem> = match memories_to_items_with_conn(&conn, &results.memories)
            {
                Ok(items) => items,
                Err(err) => return staleness_error_response(&err).into_response(),
            };
            let raw_hits: Vec<RawHitItem> = results
                .raw_hits
                .into_iter()
                .map(|msg| RawHitItem {
                    id: msg.id,
                    session_id: msg.session_id,
                    project: msg.project,
                    role: msg.role,
                    preview: msg.content.chars().take(RAW_PREVIEW_CHARS).collect(),
                    source: msg.source,
                    branch: msg.branch,
                    created_at_epoch: msg.created_at_epoch,
                })
                .collect();
            Json(SearchResponse {
                data: items,
                meta: Meta {
                    count,
                    has_more: results.has_more,
                    limit,
                    offset,
                },
                multi_hop: results.multi_hop.map(|meta| MultiHopInfo {
                    hops: meta.hops,
                    entities_discovered: meta.entities_discovered,
                }),
                raw_hits,
                raw_hits_error: results.raw_error,
                explain: detailed.explain_details,
            })
            .into_response()
        }
        Err(err) if err.to_string().contains("source-anchor staleness") => {
            staleness_error_response(&err).into_response()
        }
        Err(err) => error_response(
            StatusCode::INTERNAL_SERVER_ERROR,
            "search_failed",
            &err.to_string(),
        )
        .into_response(),
    }
}

#[cfg(test)]
mod tests {
    use anyhow::{Context, Result};
    use axum::{
        body::to_bytes,
        extract::{Query, State},
        response::IntoResponse,
    };
    use serde_json::Value;

    use super::*;
    use crate::db::test_support::ScopedTestDataDir;
    use crate::memory;
    use crate::memory::raw_archive::{insert_raw_message, ROLE_USER, SOURCE_HOOK};

    fn base_search_params(explain: Option<bool>) -> SearchParams {
        SearchParams {
            query: Some("aurora".to_string()),
            project: Some("/repo".to_string()),
            memory_type: None,
            limit: Some(5),
            offset: Some(0),
            include_stale: Some(true),
            include_suppressed: None,
            branch: None,
            multi_hop: Some(false),
            explain,
        }
    }

    fn multi_hop_explain_params() -> SearchParams {
        SearchParams {
            multi_hop: Some(true),
            explain: Some(true),
            ..base_search_params(None)
        }
    }

    #[test]
    fn search_request_from_params_keeps_explain_default_false() {
        let request = search_request_from_params(base_search_params(None));

        assert!(!request.explain);
    }

    #[test]
    fn search_request_from_params_passes_explain_true() {
        let request = search_request_from_params(base_search_params(Some(true)));

        assert!(request.explain);
    }

    #[tokio::test]
    async fn handle_search_emits_explain_only_when_requested() -> Result<()> {
        let _dir = ScopedTestDataDir::new("api-search-explain");
        let conn = crate::db::open_db()?;
        let memory_id = memory::insert_memory(
            &conn,
            Some("session-1"),
            "/repo",
            Some("aurora-contract"),
            "Aurora contract decision",
            "The aurora recall contract keeps search compact before expansion.",
            "decision",
            None,
        )?;
        drop(conn);

        let default_response = handle_search(State(DbState), Query(base_search_params(None)))
            .await
            .into_response();
        let default_body = to_bytes(default_response.into_body(), usize::MAX).await?;
        let default_json: Value = serde_json::from_slice(&default_body)?;
        assert!(default_json.get("explain").is_none());
        assert_eq!(default_json["data"][0]["id"], memory_id);
        assert_eq!(default_json["data"][0]["staleness"]["status"], "active");
        assert_eq!(
            default_json["data"][0]["staleness"]["source_anchor"],
            "untracked"
        );

        let explain_response = handle_search(State(DbState), Query(base_search_params(Some(true))))
            .await
            .into_response();
        let explain_body = to_bytes(explain_response.into_body(), usize::MAX).await?;
        let explain_json: Value = serde_json::from_slice(&explain_body)?;

        assert_eq!(explain_json["data"][0]["id"], memory_id);
        assert_eq!(explain_json["data"][0]["staleness"]["status"], "active");
        assert_eq!(
            explain_json["data"][0]["staleness"]["source_anchor"],
            "untracked"
        );
        assert_eq!(explain_json["explain"]["query"], "aurora");
        assert_eq!(
            explain_json["explain"]["results"][0]["memory_id"],
            memory_id
        );
        assert_eq!(
            explain_json["explain"]["results"][0]["staleness"]["status"],
            "active"
        );
        let explain_result = &explain_json["explain"]["results"][0];
        let final_score = explain_result["final_score"]
            .as_f64()
            .expect("explain final_score should be numeric");
        let fusion_score = explain_result["fusion_score"]
            .as_f64()
            .expect("REST explain should serialize fusion_score");
        let post_fusion_score_factor = explain_result["post_fusion_score_factor"]
            .as_f64()
            .expect("REST explain should serialize post_fusion_score_factor");
        assert!((final_score - fusion_score * post_fusion_score_factor).abs() < 1e-12);
        let breakdown = &explain_json["explain"]["contribution_breakdowns"][0];
        assert_eq!(breakdown["memory_id"], memory_id);
        for contribution in breakdown["contributions"]
            .as_array()
            .context("REST contribution breakdowns should be an array")?
        {
            let weight = contribution["weight"].as_f64().context("weight")?;
            let reciprocal_rank = contribution["reciprocal_rank"]
                .as_f64()
                .context("reciprocal_rank")?;
            let normalized_signal = contribution
                .get("normalized_signal")
                .and_then(Value::as_f64)
                .unwrap_or(0.0);
            let total = contribution["total_score"].as_f64().context("total")?;
            assert!((total - weight * reciprocal_rank * (1.0 + normalized_signal)).abs() < 1e-12);
        }
        Ok(())
    }

    #[tokio::test]
    async fn handle_search_exposes_raw_fallback_failure() -> Result<()> {
        let _dir = ScopedTestDataDir::new("api-search-raw-fallback-error");
        let conn = crate::db::open_db()?;
        conn.execute("DROP TABLE raw_messages_fts", [])?;
        drop(conn);

        let response = handle_search(State(DbState), Query(base_search_params(None)))
            .await
            .into_response();
        assert_eq!(response.status(), StatusCode::OK);
        let body = to_bytes(response.into_body(), usize::MAX).await?;
        let json: Value = serde_json::from_slice(&body)?;

        assert_eq!(json["data"].as_array().map(Vec::len), Some(0));
        assert_eq!(json.get("raw_hits"), None);
        assert!(json["raw_hits_error"]
            .as_str()
            .is_some_and(|error| error.contains("raw archive fallback failed")));
        Ok(())
    }

    #[tokio::test]
    async fn handle_search_keeps_legacy_raw_hit_preview_contract() -> Result<()> {
        let _dir = ScopedTestDataDir::new("api-search-legacy-raw-preview");
        let conn = crate::db::open_db()?;
        let legacy_preview = "aurora LEGACY_RAW_PREVIEW_SENTINEL";
        insert_raw_message(
            &conn,
            "legacy-session",
            "/repo",
            ROLE_USER,
            legacy_preview,
            SOURCE_HOOK,
            None,
            None,
        )?;
        drop(conn);

        let response = handle_search(State(DbState), Query(base_search_params(None)))
            .await
            .into_response();
        assert_eq!(response.status(), StatusCode::OK);
        let body = to_bytes(response.into_body(), usize::MAX).await?;
        let json: Value = serde_json::from_slice(&body)?;

        assert_eq!(json["raw_hits"][0]["preview"], legacy_preview);
        assert_eq!(json["raw_hits"][0]["source"], SOURCE_HOOK);
        Ok(())
    }

    #[tokio::test]
    async fn handle_search_fails_when_source_anchor_label_fails() -> Result<()> {
        let _dir = ScopedTestDataDir::new("api-search-staleness-source-error");
        let conn = crate::db::open_db()?;
        let memory_id = memory::insert_memory(
            &conn,
            Some("session-search-bad-staleness"),
            "/repo",
            None,
            "aurora bad staleness",
            "aurora bad source-anchor fixture",
            "decision",
            None,
        )?;
        conn.execute(
            "UPDATE memories SET files = '[not-json' WHERE id = ?1",
            [memory_id],
        )?;
        drop(conn);

        let response = handle_search(State(DbState), Query(base_search_params(None)))
            .await
            .into_response();
        assert_eq!(response.status(), StatusCode::INTERNAL_SERVER_ERROR);
        let body = to_bytes(response.into_body(), usize::MAX).await?;
        let json: Value = serde_json::from_slice(&body)?;

        assert_eq!(json["error"]["code"], "staleness_source_anchor_failed");

        let explain_response = handle_search(State(DbState), Query(base_search_params(Some(true))))
            .await
            .into_response();
        assert_eq!(explain_response.status(), StatusCode::INTERNAL_SERVER_ERROR);
        let explain_body = to_bytes(explain_response.into_body(), usize::MAX).await?;
        let explain_json: Value = serde_json::from_slice(&explain_body)?;
        assert_eq!(
            explain_json["error"]["code"],
            "staleness_source_anchor_failed"
        );
        Ok(())
    }

    #[tokio::test]
    async fn handle_search_rejects_multi_hop_explain() -> Result<()> {
        let _dir = ScopedTestDataDir::new("api-search-explain-multi-hop");

        let response = handle_search(State(DbState), Query(multi_hop_explain_params()))
            .await
            .into_response();
        assert_eq!(response.status(), StatusCode::BAD_REQUEST);
        let body = to_bytes(response.into_body(), usize::MAX).await?;
        let json: Value = serde_json::from_slice(&body)?;

        assert_eq!(json["error"]["code"], "invalid_search_request");
        assert!(
            json["error"]["message"]
                .as_str()
                .unwrap_or_default()
                .contains("multi_hop"),
            "{}",
            json
        );
        Ok(())
    }

    #[tokio::test]
    async fn handle_search_rejects_explain_without_query() -> Result<()> {
        for query in [None, Some("")] {
            let mut params = base_search_params(Some(true));
            params.query = query.map(str::to_string);

            let response = handle_search(State(DbState), Query(params))
                .await
                .into_response();
            assert_eq!(response.status(), StatusCode::BAD_REQUEST);
            let body = to_bytes(response.into_body(), usize::MAX).await?;
            let json: Value = serde_json::from_slice(&body)?;

            assert_eq!(json["error"]["code"], "invalid_search_request");
            assert!(
                json["error"]["message"]
                    .as_str()
                    .unwrap_or_default()
                    .contains("non-empty query"),
                "{}",
                json
            );
        }
        Ok(())
    }
}