crabmate 0.4.0

Rust AI agent: OpenAI-compatible chat/completions, function calling, HTTP serve, ops CLI
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
//! Web `conversation_id` 持久化:可选 **SQLite**(进程重启后续聊);未配置路径时仍用内存 `HashMap`(`web::app_state`)。

use std::path::Path;
use std::time::{SystemTime, UNIX_EPOCH};

use rusqlite::{Connection, OptionalExtension, params};
use serde_json::json;

use crate::types::Message;

const TABLE: &str = "crabmate_conversations";

/// Web 会话保存结果(内存与 SQLite 共用)。
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum SaveConversationOutcome {
    Saved,
    Conflict,
}

/// 与内存态 `app_state` 一致:24h TTL、最多条数(仅 SQLite 路径下 `prune` 使用)。
pub const CONVERSATION_STORE_TTL_SECS: u64 = 24 * 3600;
pub const CONVERSATION_STORE_MAX_ENTRIES: usize = 512;

fn now_unix() -> i64 {
    SystemTime::now()
        .duration_since(UNIX_EPOCH)
        .unwrap_or_default()
        .as_secs() as i64
}

/// 建表(幂等)。
pub fn migrate(conn: &Connection) -> Result<(), rusqlite::Error> {
    conn.execute_batch(&format!(
        r#"
        CREATE TABLE IF NOT EXISTS {TABLE} (
            id TEXT NOT NULL PRIMARY KEY,
            messages_json TEXT NOT NULL,
            revision INTEGER NOT NULL,
            updated_at_unix INTEGER NOT NULL
        );
        CREATE INDEX IF NOT EXISTS idx_{TABLE}_updated ON {TABLE}(updated_at_unix);
        "#
    ))?;
    ensure_active_agent_role_column(conn)?;
    ensure_active_session_mode_column(conn)?;
    Ok(())
}

fn ensure_active_agent_role_column(conn: &Connection) -> Result<(), rusqlite::Error> {
    ensure_text_column(conn, "active_agent_role")
}

fn ensure_active_session_mode_column(conn: &Connection) -> Result<(), rusqlite::Error> {
    ensure_text_column(conn, "active_session_mode")
}

fn ensure_text_column(conn: &Connection, column: &str) -> Result<(), rusqlite::Error> {
    let mut stmt = conn.prepare(&format!("PRAGMA table_info({TABLE})"))?;
    let mut has = false;
    let mut rows = stmt.query([])?;
    while let Some(row) = rows.next()? {
        let name: String = row.get(1)?;
        if name == column {
            has = true;
            break;
        }
    }
    if !has {
        conn.execute(
            &format!("ALTER TABLE {TABLE} ADD COLUMN {column} TEXT NOT NULL DEFAULT ''"),
            [],
        )?;
    }
    Ok(())
}

/// 打开库文件并迁移(父目录不存在则创建)。
pub fn open_file(path: &Path) -> Result<Connection, Box<dyn std::error::Error + Send + Sync>> {
    if let Some(parent) = path.parent() {
        std::fs::create_dir_all(parent)
            .map_err(|e| format!("无法创建会话库目录 {}: {}", parent.display(), e))?;
    }
    let conn = Connection::open(path)
        .map_err(|e| format!("无法打开会话 SQLite {}: {}", path.display(), e))?;
    migrate(&conn).map_err(|e| format!("会话库 schema 初始化失败 {}: {}", path.display(), e))?;
    Ok(conn)
}

fn messages_to_json(messages: &[Message]) -> Result<String, serde_json::Error> {
    serde_json::to_string(&json!({ "version": 1, "messages": messages }))
}

fn messages_from_json(s: &str) -> Result<Vec<Message>, String> {
    let v: serde_json::Value =
        serde_json::from_str(s).map_err(|e| format!("会话 messages_json 解析失败: {e}"))?;
    let arr = v
        .get("messages")
        .and_then(|m| m.as_array())
        .ok_or_else(|| "会话 JSON 缺少 messages 数组".to_string())?;
    let mut out = Vec::with_capacity(arr.len());
    for item in arr {
        let m: Message = serde_json::from_value(item.clone())
            .map_err(|e| format!("单条消息反序列化失败: {e}"))?;
        out.push(m);
    }
    Ok(out)
}

/// 读取会话;不存在、或超过 TTL 视为无(并删除过期行)。
/// 返回:`(messages, revision, active_agent_role, active_session_mode)`;后两列空串视为未设置。
#[allow(clippy::type_complexity)]
pub fn load(
    conn: &Connection,
    id: &str,
    ttl_secs: u64,
) -> Result<Option<(Vec<Message>, u64, String, String)>, rusqlite::Error> {
    let now = now_unix();
    let row: Option<(String, i64, i64, String, String)> = conn
        .query_row(
            &format!(
                "SELECT messages_json, revision, updated_at_unix, active_agent_role, active_session_mode FROM {TABLE} WHERE id = ?1"
            ),
            params![id],
            |r| Ok((r.get(0)?, r.get(1)?, r.get(2)?, r.get(3)?, r.get(4)?)),
        )
        .optional()?;
    let Some((json, revision, updated, active_role, active_mode)) = row else {
        return Ok(None);
    };
    load_row_after_fetch(
        conn,
        id,
        ttl_secs,
        now,
        json,
        revision,
        updated,
        active_role,
        active_mode,
    )
}

#[allow(clippy::too_many_arguments, clippy::type_complexity)]
fn load_row_after_fetch(
    conn: &Connection,
    id: &str,
    ttl_secs: u64,
    now: i64,
    json: String,
    revision: i64,
    updated: i64,
    active_role: String,
    active_mode: String,
) -> Result<Option<(Vec<Message>, u64, String, String)>, rusqlite::Error> {
    if ttl_secs > 0 && now.saturating_sub(updated) > ttl_secs as i64 {
        conn.execute(&format!("DELETE FROM {TABLE} WHERE id = ?1"), params![id])?;
        return Ok(None);
    }
    let messages = match messages_from_json(&json) {
        Ok(m) => m,
        Err(e) => {
            log::warn!(
                target: "crabmate",
                "会话 {} 消息 JSON 损坏,已删除该行 error={}",
                id,
                e
            );
            conn.execute(&format!("DELETE FROM {TABLE} WHERE id = ?1"), params![id])?;
            return Ok(None);
        }
    };
    let rev = u64::try_from(revision).unwrap_or(0);
    conn.execute(
        &format!("UPDATE {TABLE} SET updated_at_unix = ?1 WHERE id = ?2"),
        params![now, id],
    )?;
    Ok(Some((messages, rev, active_role, active_mode)))
}

/// 与 `AppState::save_conversation_messages_if_revision` 语义一致。
pub fn save_if_revision(
    conn: &Connection,
    id: &str,
    messages: Vec<Message>,
    active_agent_role: Option<&str>,
    active_session_mode: Option<&str>,
    expected_revision: Option<u64>,
) -> Result<SaveConversationOutcome, rusqlite::Error> {
    let now = now_unix();
    let active_col = active_agent_role
        .map(str::trim)
        .filter(|s| !s.is_empty())
        .unwrap_or("");
    let mode_col = active_session_mode
        .map(str::trim)
        .filter(|s| !s.is_empty())
        .unwrap_or("");
    let json = match messages_to_json(&messages) {
        Ok(j) => j,
        Err(e) => {
            log::error!(
                target: "crabmate",
                "会话 {} 序列化失败(不应发生): {}",
                id,
                e
            );
            return Ok(SaveConversationOutcome::Conflict);
        }
    };

    if let Some(exp) = expected_revision {
        let n = conn.execute(
            &format!(
                "UPDATE {TABLE} SET messages_json = ?1, active_agent_role = ?2, active_session_mode = ?3, revision = revision + 1, updated_at_unix = ?4 WHERE id = ?5 AND revision = ?6"
            ),
            params![json, active_col, mode_col, now, id, exp as i64],
        )?;
        if n == 0 {
            return Ok(SaveConversationOutcome::Conflict);
        }
    } else {
        let exists: i64 = conn.query_row(
            &format!("SELECT COUNT(*) FROM {TABLE} WHERE id = ?1"),
            params![id],
            |r| r.get(0),
        )?;
        if exists > 0 {
            return Ok(SaveConversationOutcome::Conflict);
        }
        conn.execute(
            &format!(
                "INSERT INTO {TABLE} (id, messages_json, active_agent_role, active_session_mode, revision, updated_at_unix) VALUES (?1, ?2, ?3, ?4, 1, ?5)"
            ),
            params![id, json, active_col, mode_col, now],
        )?;
    }
    prune(
        conn,
        CONVERSATION_STORE_TTL_SECS,
        CONVERSATION_STORE_MAX_ENTRIES,
    )?;
    Ok(SaveConversationOutcome::Saved)
}

/// 按 id 删除一行(E2E 夹具 `replace` 等;不存在时静默成功)。
pub fn delete_by_id(conn: &Connection, id: &str) -> Result<(), rusqlite::Error> {
    conn.execute(&format!("DELETE FROM {TABLE} WHERE id = ?1"), params![id])?;
    Ok(())
}

/// 删除过期行并按条数淘汰最旧记录。
pub fn prune(conn: &Connection, ttl_secs: u64, max_entries: usize) -> Result<(), rusqlite::Error> {
    let now = now_unix();
    if ttl_secs > 0 {
        let cutoff = now - ttl_secs as i64;
        conn.execute(
            &format!("DELETE FROM {TABLE} WHERE updated_at_unix < ?1"),
            params![cutoff],
        )?;
    }
    if max_entries == 0 {
        return Ok(());
    }
    let count: i64 = conn.query_row(&format!("SELECT COUNT(*) FROM {TABLE}"), [], |r| r.get(0))?;
    if count <= max_entries as i64 {
        return Ok(());
    }
    let to_drop = count - max_entries as i64;
    conn.execute(
        &format!(
            "DELETE FROM {TABLE} WHERE id IN (SELECT id FROM {TABLE} ORDER BY updated_at_unix ASC LIMIT ?1)"
        ),
        params![to_drop],
    )?;
    Ok(())
}

/// 当前库中的会话条数。
pub fn count(conn: &Connection) -> Result<usize, rusqlite::Error> {
    let n: i64 = conn.query_row(&format!("SELECT COUNT(*) FROM {TABLE}"), [], |r| r.get(0))?;
    Ok(n as usize)
}

/// 与 Web `normalize_client_conversation_id` 字符集一致。
pub const CONVERSATION_ID_MAX_LEN: usize = 128;

fn load_messages_at_revision(
    conn: &Connection,
    id: &str,
    expected_revision: u64,
    corrupt_log: &'static str,
) -> Result<Option<Vec<Message>>, rusqlite::Error> {
    let row: Option<(String, i64)> = conn
        .query_row(
            &format!("SELECT messages_json, revision FROM {TABLE} WHERE id = ?1"),
            params![id],
            |r| Ok((r.get(0)?, r.get(1)?)),
        )
        .optional()?;
    let Some((json, revision)) = row else {
        return Ok(None);
    };
    let rev = u64::try_from(revision).unwrap_or(0);
    if rev != expected_revision {
        return Ok(None);
    }
    match messages_from_json(&json) {
        Ok(m) => Ok(Some(m)),
        Err(e) => {
            log::warn!(
                target: "crabmate",
                "{} id={} error={}",
                corrupt_log,
                id,
                e
            );
            Ok(None)
        }
    }
}

fn persist_messages_bump_revision(
    conn: &Connection,
    id: &str,
    expected_revision: u64,
    messages: &[Message],
    serialize_fail_log: &'static str,
) -> Result<SaveConversationOutcome, rusqlite::Error> {
    let new_json = match messages_to_json(messages) {
        Ok(j) => j,
        Err(e) => {
            log::error!(
                target: "crabmate",
                "{} id={} error={}",
                serialize_fail_log,
                id,
                e
            );
            return Ok(SaveConversationOutcome::Conflict);
        }
    };
    let now = now_unix();
    let n = conn.execute(
        &format!(
            "UPDATE {TABLE} SET messages_json = ?1, revision = revision + 1, updated_at_unix = ?2 WHERE id = ?3 AND revision = ?4"
        ),
        params![new_json, now, id, expected_revision as i64],
    )?;
    if n == 0 {
        return Ok(SaveConversationOutcome::Conflict);
    }
    prune(
        conn,
        CONVERSATION_STORE_TTL_SECS,
        CONVERSATION_STORE_MAX_ENTRIES,
    )?;
    Ok(SaveConversationOutcome::Saved)
}

fn update_messages_json_if_revision(
    conn: &Connection,
    id: &str,
    expected_revision: u64,
    corrupt_log: &'static str,
    serialize_fail_log: &'static str,
    mut mutate: impl FnMut(&mut Vec<Message>) -> bool,
) -> Result<SaveConversationOutcome, rusqlite::Error> {
    let Some(mut messages) = load_messages_at_revision(conn, id, expected_revision, corrupt_log)?
    else {
        return Ok(SaveConversationOutcome::Conflict);
    };
    if !mutate(&mut messages) {
        return Ok(SaveConversationOutcome::Saved);
    }
    persist_messages_bump_revision(conn, id, expected_revision, &messages, serialize_fail_log)
}

/// 截断到「第 `ordinal` 条用户消息」之前(`ordinal` 为 0-based:0 表示删掉从首条用户起的尾部,仅保留 system 等)。
/// 计数不含长期记忆 / 变更集 / 首轮工作区画像等注入条(见 [`crate::types::user_message_counts_for_branch_truncation`])。
pub fn truncate_before_user_ordinal_if_revision(
    conn: &Connection,
    id: &str,
    user_ordinal: usize,
    expected_revision: u64,
) -> Result<SaveConversationOutcome, rusqlite::Error> {
    update_messages_json_if_revision(
        conn,
        id,
        expected_revision,
        "truncate_before_user 会话 JSON 损坏",
        "truncate_before_user 序列化失败",
        |messages| {
            let mut u = 0usize;
            let mut cut = messages.len();
            for (i, m) in messages.iter().enumerate() {
                if crate::types::user_message_counts_for_branch_truncation(m) {
                    if u == user_ordinal {
                        cut = i;
                        break;
                    }
                    u += 1;
                }
            }
            if cut >= messages.len() {
                return false;
            }
            messages.truncate(cut);
            true
        },
    )
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::types::{Message, message_content_as_str};

    #[test]
    fn truncate_before_user_ordinal_skips_first_turn_workspace_injection() {
        let conn = Connection::open_in_memory().unwrap();
        migrate(&conn).unwrap();
        let msgs = vec![
            Message::system_only("s".to_string()),
            Message::user_first_turn_workspace_context("ctx".to_string()),
            Message::user_only("hi".to_string()),
        ];
        assert_eq!(
            save_if_revision(&conn, "c1", msgs, None, None, None).unwrap(),
            SaveConversationOutcome::Saved
        );
        let loaded = load(&conn, "c1", 3600).unwrap().expect("exists");
        assert_eq!(loaded.0.len(), 3);
        assert_eq!(
            truncate_before_user_ordinal_if_revision(&conn, "c1", 0, loaded.1).unwrap(),
            SaveConversationOutcome::Saved
        );
        let after = load(&conn, "c1", 3600).unwrap().expect("exists");
        assert_eq!(after.0.len(), 2);
        assert_eq!(after.0[0].role, "system");
        assert_eq!(message_content_as_str(&after.0[1].content), Some("ctx"));
        assert_eq!(
            after.0[1].name.as_deref(),
            Some(crate::types::CRABMATE_FIRST_TURN_WORKSPACE_CONTEXT_NAME)
        );
    }

    #[test]
    fn save_load_roundtrip() {
        let conn = Connection::open_in_memory().unwrap();
        migrate(&conn).unwrap();
        let msgs = vec![
            Message::system_only("s".to_string()),
            Message::user_only("hi".to_string()),
        ];
        assert_eq!(
            save_if_revision(&conn, "c1", msgs.clone(), None, None, None).unwrap(),
            SaveConversationOutcome::Saved
        );
        let loaded = load(&conn, "c1", 3600).unwrap().expect("exists");
        assert_eq!(loaded.1, 1);
        assert_eq!(loaded.0.len(), 2);
        assert_eq!(
            save_if_revision(&conn, "c1", msgs.clone(), None, None, Some(1)).unwrap(),
            SaveConversationOutcome::Saved
        );
        let loaded2 = load(&conn, "c1", 3600).unwrap().expect("exists");
        assert_eq!(loaded2.1, 2);
    }

    #[test]
    fn save_load_active_agent_role_roundtrip() {
        let conn = Connection::open_in_memory().unwrap();
        migrate(&conn).unwrap();
        let msgs = vec![Message::system_only("s".to_string())];
        assert_eq!(
            save_if_revision(&conn, "c1", msgs.clone(), None, None, None).unwrap(),
            SaveConversationOutcome::Saved
        );
        let loaded = load(&conn, "c1", 3600).unwrap().expect("exists");
        assert_eq!(loaded.2, "");

        assert_eq!(
            save_if_revision(&conn, "c1", msgs.clone(), Some("reviewer"), None, Some(1)).unwrap(),
            SaveConversationOutcome::Saved
        );
        let loaded2 = load(&conn, "c1", 3600).unwrap().expect("exists");
        assert_eq!(loaded2.2, "reviewer");

        assert_eq!(
            save_if_revision(&conn, "c1", msgs.clone(), None, None, Some(2)).unwrap(),
            SaveConversationOutcome::Saved
        );
        let loaded3 = load(&conn, "c1", 3600).unwrap().expect("exists");
        assert_eq!(loaded3.2, "");
    }

    #[test]
    fn save_load_active_session_mode_roundtrip() {
        let conn = Connection::open_in_memory().unwrap();
        migrate(&conn).unwrap();
        let msgs = vec![Message::system_only("s".to_string())];
        assert_eq!(
            save_if_revision(&conn, "c1", msgs.clone(), None, Some("ask"), None).unwrap(),
            SaveConversationOutcome::Saved
        );
        let loaded = load(&conn, "c1", 3600).unwrap().expect("exists");
        assert_eq!(loaded.3, "ask");

        assert_eq!(
            save_if_revision(&conn, "c1", msgs.clone(), None, Some("plan"), Some(1)).unwrap(),
            SaveConversationOutcome::Saved
        );
        let loaded2 = load(&conn, "c1", 3600).unwrap().expect("exists");
        assert_eq!(loaded2.3, "plan");

        assert_eq!(
            save_if_revision(&conn, "c1", msgs.clone(), None, None, Some(2)).unwrap(),
            SaveConversationOutcome::Saved
        );
        let loaded3 = load(&conn, "c1", 3600).unwrap().expect("exists");
        assert_eq!(loaded3.3, "");
    }
}