mirror of
https://github.com/openai/codex.git
synced 2026-11-10 21:00:47 +00:00
## Description This PR adds a new `historyMode = "legacy" | "paginated"` to `Thread`. This will be stored in `SessionMeta` in the JSONL rollout file and as a new column in the SQLite thread_metadata table, and exposed on `thread/start` and on the `Thread` object in app-server. ## What changed - Added canonical `ThreadHistoryMode` with `legacy` and `paginated`, defaulting old and new SessionMeta to `legacy`. - Carried `history_mode` through core session config, ThreadStore stored metadata, local/in-memory stores, rollout metadata extraction, and the existing SQLite `threads` table. - Added experimental `historyMode` to app-server v2 `Thread` and `thread/start`. - Made paginated stored threads metadata-discoverable but unsupported for legacy full-history reads, `load_history`, live resume, and create paths. - Regenerated app-server schema fixtures and added protocol/state/thread-store/app-server coverage for persistence and fail-closed behavior. ## Compatibility floor Because users may be running various versions of Codex binaries on the same machine (TUI, Codex App, etc.), we will need to establish a compatibility floor for upcoming paginated threads, which will change how thread storage reads and writes work. The overall plan here: ``` Release N: - Add historyMode to SessionMeta / Thread / SQLite metadata. - Teach binaries to understand paginated threads. - If a binary sees `historyMode="paginated"` but does not support the paginated contract, it refuses to resume/mutate the thread. - Default remains `"legacy"`. Release N+1: - First-party clients start opting into paginated threads where appropriate. - Internal dogfood / staged rollout. - Measure old-client usage and paginated-thread unsupported errors. Release N+2: - Only after Release N+ is overwhelmingly deployed, make paginated the default. - Accept that a small tail of N-1-or-older binaries may not understand paginated threads. ``` The important behavior change is fail-closed handling for a binary that encounters a persisted `paginated` thread before it knows how to fully support paginated history. In app-server, if a thread is `paginated`, we will: - allow metadata-only discovery paths like `thread/list` and `thread/read(includeTurns=false)`, so clients can still see the thread and inspect its `historyMode` - reject legacy full-history/live-thread paths like `thread/read(includeTurns=true)` and `thread/resume` with an unsupported JSON-RPC error - avoid silently treating an unknown or future `historyMode` as `legacy` Under the hood, the ThreadStore layer also rejects legacy operations that would need to load or replay the full thread history for a paginated thread. That gives us the behavior we want for Release N: future paginated threads are visible, but this binary fails closed instead of trying to operate on them as if they were legacy threads.
172 lines
6.1 KiB
Rust
172 lines
6.1 KiB
Rust
use super::*;
|
|
use codex_protocol::ThreadId;
|
|
use codex_protocol::protocol::EventMsg;
|
|
use codex_protocol::protocol::RolloutItem;
|
|
use codex_protocol::protocol::RolloutLine;
|
|
use codex_protocol::protocol::SessionMeta;
|
|
use codex_protocol::protocol::SessionMetaLine;
|
|
use codex_protocol::protocol::SessionSource;
|
|
use codex_protocol::protocol::UserMessageEvent;
|
|
use codex_rollout::ARCHIVED_SESSIONS_SUBDIR;
|
|
use codex_rollout::SESSIONS_SUBDIR;
|
|
use pretty_assertions::assert_eq;
|
|
use tempfile::TempDir;
|
|
use tokio::io::AsyncWriteExt;
|
|
|
|
const TEST_TIMESTAMP: &str = "2025-01-01T00-00-00";
|
|
|
|
async fn read_config_toml(codex_home: &Path) -> io::Result<ConfigToml> {
|
|
let contents = tokio::fs::read_to_string(codex_home.join("config.toml")).await?;
|
|
toml::from_str(&contents).map_err(|err| io::Error::new(io::ErrorKind::InvalidData, err))
|
|
}
|
|
|
|
async fn write_session_with_user_event(codex_home: &Path) -> io::Result<()> {
|
|
let thread_id = ThreadId::new();
|
|
let dir = codex_home
|
|
.join(SESSIONS_SUBDIR)
|
|
.join("2025")
|
|
.join("01")
|
|
.join("01");
|
|
write_rollout_with_user_event(&dir, thread_id).await
|
|
}
|
|
|
|
async fn write_archived_session_with_user_event(codex_home: &Path) -> io::Result<()> {
|
|
let thread_id = ThreadId::new();
|
|
let dir = codex_home.join(ARCHIVED_SESSIONS_SUBDIR);
|
|
write_rollout_with_user_event(&dir, thread_id).await
|
|
}
|
|
|
|
async fn write_rollout_with_user_event(dir: &Path, thread_id: ThreadId) -> io::Result<()> {
|
|
tokio::fs::create_dir_all(&dir).await?;
|
|
let file_path = dir.join(format!("rollout-{TEST_TIMESTAMP}-{thread_id}.jsonl"));
|
|
let mut file = tokio::fs::File::create(&file_path).await?;
|
|
|
|
let session_meta = SessionMetaLine {
|
|
meta: SessionMeta {
|
|
session_id: thread_id.into(),
|
|
id: thread_id,
|
|
forked_from_id: None,
|
|
parent_thread_id: None,
|
|
timestamp: TEST_TIMESTAMP.to_string(),
|
|
cwd: std::path::PathBuf::from("."),
|
|
originator: "test_originator".to_string(),
|
|
cli_version: "test_version".to_string(),
|
|
source: SessionSource::Cli,
|
|
thread_source: None,
|
|
agent_path: None,
|
|
agent_nickname: None,
|
|
agent_role: None,
|
|
model_provider: None,
|
|
base_instructions: None,
|
|
dynamic_tools: None,
|
|
selected_capability_roots: Vec::new(),
|
|
memory_mode: None,
|
|
history_mode: Default::default(),
|
|
multi_agent_version: None,
|
|
context_window: None,
|
|
},
|
|
git: None,
|
|
};
|
|
let meta_line = RolloutLine {
|
|
timestamp: TEST_TIMESTAMP.to_string(),
|
|
item: RolloutItem::SessionMeta(session_meta),
|
|
};
|
|
let user_event = RolloutLine {
|
|
timestamp: TEST_TIMESTAMP.to_string(),
|
|
item: RolloutItem::EventMsg(EventMsg::UserMessage(UserMessageEvent {
|
|
client_id: None,
|
|
message: "hello".to_string(),
|
|
images: None,
|
|
local_images: Vec::new(),
|
|
text_elements: Vec::new(),
|
|
..Default::default()
|
|
})),
|
|
};
|
|
|
|
file.write_all(format!("{}\n", serde_json::to_string(&meta_line)?).as_bytes())
|
|
.await?;
|
|
file.write_all(format!("{}\n", serde_json::to_string(&user_event)?).as_bytes())
|
|
.await?;
|
|
Ok(())
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn applies_when_sessions_exist_and_no_personality() -> io::Result<()> {
|
|
let temp = TempDir::new()?;
|
|
write_session_with_user_event(temp.path()).await?;
|
|
|
|
let config_toml = ConfigToml::default();
|
|
let status = maybe_migrate_personality(temp.path(), &config_toml, /*state_db*/ None).await?;
|
|
|
|
assert_eq!(status, PersonalityMigrationStatus::Applied);
|
|
assert!(temp.path().join(PERSONALITY_MIGRATION_FILENAME).exists());
|
|
|
|
let persisted = read_config_toml(temp.path()).await?;
|
|
assert_eq!(persisted.personality, Some(Personality::Pragmatic));
|
|
Ok(())
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn applies_when_only_archived_sessions_exist_and_no_personality() -> io::Result<()> {
|
|
let temp = TempDir::new()?;
|
|
write_archived_session_with_user_event(temp.path()).await?;
|
|
|
|
let config_toml = ConfigToml::default();
|
|
let status = maybe_migrate_personality(temp.path(), &config_toml, /*state_db*/ None).await?;
|
|
|
|
assert_eq!(status, PersonalityMigrationStatus::Applied);
|
|
assert!(temp.path().join(PERSONALITY_MIGRATION_FILENAME).exists());
|
|
|
|
let persisted = read_config_toml(temp.path()).await?;
|
|
assert_eq!(persisted.personality, Some(Personality::Pragmatic));
|
|
Ok(())
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn skips_when_marker_exists() -> io::Result<()> {
|
|
let temp = TempDir::new()?;
|
|
create_marker(&temp.path().join(PERSONALITY_MIGRATION_FILENAME)).await?;
|
|
|
|
let config_toml = ConfigToml::default();
|
|
let status = maybe_migrate_personality(temp.path(), &config_toml, /*state_db*/ None).await?;
|
|
|
|
assert_eq!(status, PersonalityMigrationStatus::SkippedMarker);
|
|
assert!(!temp.path().join("config.toml").exists());
|
|
Ok(())
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn skips_when_personality_explicit() -> io::Result<()> {
|
|
let temp = TempDir::new()?;
|
|
ConfigEditsBuilder::new(temp.path())
|
|
.set_personality(Some(Personality::Friendly))
|
|
.apply()
|
|
.await
|
|
.map_err(|err| io::Error::other(format!("failed to write config: {err}")))?;
|
|
|
|
let config_toml = read_config_toml(temp.path()).await?;
|
|
let status = maybe_migrate_personality(temp.path(), &config_toml, /*state_db*/ None).await?;
|
|
|
|
assert_eq!(
|
|
status,
|
|
PersonalityMigrationStatus::SkippedExplicitPersonality
|
|
);
|
|
assert!(temp.path().join(PERSONALITY_MIGRATION_FILENAME).exists());
|
|
|
|
let persisted = read_config_toml(temp.path()).await?;
|
|
assert_eq!(persisted.personality, Some(Personality::Friendly));
|
|
Ok(())
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn skips_when_no_sessions() -> io::Result<()> {
|
|
let temp = TempDir::new()?;
|
|
let config_toml = ConfigToml::default();
|
|
let status = maybe_migrate_personality(temp.path(), &config_toml, /*state_db*/ None).await?;
|
|
|
|
assert_eq!(status, PersonalityMigrationStatus::SkippedNoSessions);
|
|
assert!(temp.path().join(PERSONALITY_MIGRATION_FILENAME).exists());
|
|
assert!(!temp.path().join("config.toml").exists());
|
|
Ok(())
|
|
}
|