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;
36/// Digest-verified audit packs for sessions.
37pub mod pack;
38pub mod progress;
39pub mod query;
40pub mod retention;
41
42pub use error::SessionStoreError;
43pub use event_log::{
44    DEFAULT_MAX_EVENTS, EvictionSummaryHook, SessionEventLog, SessionManifest, TurnIndex, TurnIndexEntry,
45};
46pub use migration::{MigrationReport, migrate_legacy};
47pub use pack::{
48    AUDIT_PACK_SCHEMA_VERSION, AuditPackEntry, AuditVerification, SessionAuditPack, audit_pack_path, create_audit_pack,
49    read_audit_pack, verify_audit_pack, write_audit_pack,
50};
51pub use progress::{
52    GoalClassifierVerdict, GoalEvent, GoalHistoryEntry, GoalOrchestration, GoalPauseReason, GoalPhase, GoalStatus,
53    GoalTracker, Milestone, MilestoneStatus, ProgressLedger, load_progress, progress_path, save_progress,
54};
55pub use query::{
56    FactRecord, MemorySearchResult, SessionMemoryView, SessionSummary, query_facts, recent_sessions, search_memory,
57    session_memory_facts, write_session_memory_view,
58};
59pub use retention::{
60    RETENTION_PIN_FILE, RetentionPolicy, apply_retention, apply_retention_preserving, evict_zero_turn_completed_store,
61    gc_legacy, mark_abandoned_active_sessions, pin_session_retention, retention_pinned_session_ids,
62    session_retention_pinned, unpin_session_retention,
63};
64
65use std::path::{Path, PathBuf};
66
67/// Directory (relative to the workspace) holding all per-session stores.
68const SESSIONS_DIR: &str = ".vtcode/sessions";
69
70/// Sub-directory inside a session holding regenerated views.
71const DERIVED_DIR: &str = "derived";
72
73/// Schema version for the on-disk session store layout.
74const SESSION_STORE_SCHEMA_VERSION: u32 = 1;
75
76/// Resolve the sessions root directory for a workspace.
77#[must_use]
78pub(crate) fn sessions_root(workspace: &Path) -> PathBuf {
79    workspace.join(SESSIONS_DIR)
80}
81
82/// Resolve the directory for a single session.
83#[must_use]
84pub(crate) fn session_dir(workspace: &Path, session_id: &str) -> PathBuf {
85    sessions_root(workspace).join(sanitize_id(session_id))
86}
87
88/// Return the canonical directory for a session.
89///
90/// Derived exporters and diagnostics must live beneath this directory so the
91/// session store remains the single persistence root for interactive and exec
92/// sessions.
93#[must_use]
94pub fn session_directory(workspace: &Path, session_id: &str) -> PathBuf {
95    session_dir(workspace, session_id)
96}
97
98/// Open (creating if necessary) the event log for a session.
99///
100/// This is the canonical entry point for recording a session's events. Multiple
101/// handles opened for the same session share an `Arc`-backed file and state,
102/// allowing concurrent `append` calls from the runloop's event sink to use one
103/// coordinated turn index.
104pub fn open(workspace: &Path, session_id: &str, max_events: usize) -> Result<SessionEventLog, SessionStoreError> {
105    SessionEventLog::open(workspace, session_id, max_events)
106}
107
108/// Open a session log with a callback that persists summaries before cap
109/// eviction. A callback failure leaves the canonical event log unchanged.
110pub fn open_with_eviction_summary(
111    workspace: &Path,
112    session_id: &str,
113    max_events: usize,
114    eviction_summary_hook: EvictionSummaryHook,
115) -> Result<SessionEventLog, SessionStoreError> {
116    SessionEventLog::open_with_eviction_summary(workspace, session_id, max_events, eviction_summary_hook)
117}
118
119/// Ensure a session-store directory exists with private permissions.
120pub(crate) fn ensure_private_directory(path: &Path) -> Result<(), SessionStoreError> {
121    vtcode_commons::VtCodePaths::ensure_user_dir(path).map_err(|error| SessionStoreError::CreateDir {
122        path: path.to_path_buf(),
123        source: std::io::Error::other(error),
124    })?;
125
126    #[cfg(unix)]
127    {
128        use std::os::unix::fs::PermissionsExt;
129
130        std::fs::set_permissions(path, std::fs::Permissions::from_mode(0o700))
131            .map_err(|error| SessionStoreError::io(path.to_path_buf(), error))?;
132    }
133
134    Ok(())
135}
136
137/// Sanitize a session id so it is safe to use as a directory name.
138fn sanitize_id(id: &str) -> String {
139    let mut out = String::with_capacity(id.len());
140    for c in id.chars() {
141        if c.is_ascii_alphanumeric() || c == '-' || c == '_' || c == '.' {
142            out.push(c);
143        } else {
144            out.push('_');
145        }
146    }
147    // Strip leading dots to avoid creating hidden directories.
148    let out = out.trim_start_matches('.').to_string();
149    if out.is_empty() { "session".to_string() } else { out }
150}
151
152#[cfg(test)]
153mod tests;
vtcode_memory/lib.rs

vtcode_memory/
lib.rs
