vtcode_memory/
lib.rs

1#![allow(
2    dead_code,
3    unused_imports,
4    reason = "Intentional compatibility, platform, or test-only suppression."
5)]
6#![expect(
7    unused_results,
8    clippy::let_underscore_must_use,
9    clippy::cast_possible_truncation,
10    clippy::cast_possible_wrap,
11    clippy::string_slice,
12    reason = "The memory store uses compact persisted counters, bounded timestamp conversions, and side-effect-only index maintenance."
13)]
14//! Unified per-session state store for VT Code.
15//!
16//! This crate is the single source of truth for an agent session's state,
17//! context, and history. Each session is persisted under
18//! `.vtcode/sessions/<session_id>/` as:
19//!
20//! - `events.jsonl` — the canonical append-only [`ThreadEvent`](vtcode_exec_events::ThreadEvent)
21//!   log (schema-versioned). Everything else is derived from this.
22//! - `manifest.json` — session metadata and counters.
23//! - `index/turns.json` — byte-offset index enabling O(1) turn reconstruction.
24//! - `derived/` — regenerated views (`trajectory.jsonl`, `memory.json`, …).
25//!
26//! The store is intentionally append-only and off the agent's hot path: the
27//! live conversation stays in memory and is never reloaded from disk into
28//! context. Reads happen only for revert, compaction, analytics, and
29//! long-term-learning queries.
30
31pub mod error;
32pub mod event_log;
33/// Manifest and turn-index persistence helpers.
34pub mod manifest;
35pub mod migration;
36pub mod progress;
37pub mod query;
38pub mod retention;
39
40pub use error::SessionStoreError;
41pub use event_log::{
42    DEFAULT_MAX_EVENTS, EvictionSummaryHook, SessionEventLog, SessionManifest, TurnIndex, TurnIndexEntry,
43};
44pub use migration::{MigrationReport, migrate_legacy};
45pub use progress::{
46    GoalClassifierVerdict, GoalEvent, GoalHistoryEntry, GoalOrchestration, GoalPauseReason, GoalPhase, GoalStatus,
47    GoalTracker, Milestone, MilestoneStatus, ProgressLedger, load_progress, progress_path, save_progress,
48};
49pub use query::{FactRecord, MemorySearchResult, SessionSummary, query_facts, recent_sessions, search_memory};
50pub use retention::{RetentionPolicy, apply_retention, apply_retention_preserving, gc_legacy};
51
52use std::path::{Path, PathBuf};
53
54/// Directory (relative to the workspace) holding all per-session stores.
55const SESSIONS_DIR: &str = ".vtcode/sessions";
56
57/// Sub-directory inside a session holding regenerated views.
58const DERIVED_DIR: &str = "derived";
59
60/// Schema version for the on-disk session store layout.
61const SESSION_STORE_SCHEMA_VERSION: u32 = 1;
62
63/// Resolve the sessions root directory for a workspace.
64#[must_use]
65pub(crate) fn sessions_root(workspace: &Path) -> PathBuf {
66    workspace.join(SESSIONS_DIR)
67}
68
69/// Resolve the directory for a single session.
70#[must_use]
71pub(crate) fn session_dir(workspace: &Path, session_id: &str) -> PathBuf {
72    sessions_root(workspace).join(sanitize_id(session_id))
73}
74
75/// Return the canonical directory for a session.
76///
77/// Derived exporters and diagnostics must live beneath this directory so the
78/// session store remains the single persistence root for interactive and exec
79/// sessions.
80#[must_use]
81pub fn session_directory(workspace: &Path, session_id: &str) -> PathBuf {
82    session_dir(workspace, session_id)
83}
84
85/// Open (creating if necessary) the event log for a session.
86///
87/// This is the canonical entry point for recording a session's events. Multiple
88/// handles opened for the same session share an `Arc`-backed file and state,
89/// allowing concurrent `append` calls from the runloop's event sink to use one
90/// coordinated turn index.
91pub fn open(workspace: &Path, session_id: &str, max_events: usize) -> Result<SessionEventLog, SessionStoreError> {
92    SessionEventLog::open(workspace, session_id, max_events)
93}
94
95/// Open a session log with a callback that persists summaries before cap
96/// eviction. A callback failure leaves the canonical event log unchanged.
97pub fn open_with_eviction_summary(
98    workspace: &Path,
99    session_id: &str,
100    max_events: usize,
101    eviction_summary_hook: EvictionSummaryHook,
102) -> Result<SessionEventLog, SessionStoreError> {
103    SessionEventLog::open_with_eviction_summary(workspace, session_id, max_events, eviction_summary_hook)
104}
105
106/// Ensure a session-store directory exists with private permissions.
107pub(crate) fn ensure_private_directory(path: &Path) -> Result<(), SessionStoreError> {
108    vtcode_commons::VtCodePaths::ensure_user_dir(path).map_err(|error| SessionStoreError::CreateDir {
109        path: path.to_path_buf(),
110        source: std::io::Error::other(error),
111    })?;
112
113    #[cfg(unix)]
114    {
115        use std::os::unix::fs::PermissionsExt;
116
117        std::fs::set_permissions(path, std::fs::Permissions::from_mode(0o700))
118            .map_err(|error| SessionStoreError::io(path.to_path_buf(), error))?;
119    }
120
121    Ok(())
122}
123
124/// Sanitize a session id so it is safe to use as a directory name.
125fn sanitize_id(id: &str) -> String {
126    let mut out = String::with_capacity(id.len());
127    for c in id.chars() {
128        if c.is_ascii_alphanumeric() || c == '-' || c == '_' || c == '.' {
129            out.push(c);
130        } else {
131            out.push('_');
132        }
133    }
134    // Strip leading dots to avoid creating hidden directories.
135    let out = out.trim_start_matches('.').to_string();
136    if out.is_empty() { "session".to_string() } else { out }
137}
138
139#[cfg(test)]
140mod tests;
vtcode_memory/lib.rs

vtcode_memory/
lib.rs
