mirror of
https://github.com/pchuan98/codex.git
synced 2026-07-01 00:31:56 +08:00
4033f905c6
## Summary This PR makes SQLite rollout backfill resumable and repeatable instead of one-shot-on-db-create. ## What changed - Added a persisted backfill state table: - state/migrations/0008_backfill_state.sql - Tracks status (pending|running|complete), last_watermark, and last_success_at. - Added backfill state model/types in codex-state: - BackfillState, BackfillStatus (state/src/model/backfill_state.rs) - Added runtime APIs to manage backfill lifecycle/progress: - get_backfill_state - mark_backfill_running - checkpoint_backfill - mark_backfill_complete - Updated core startup behavior: - Backfill now runs whenever state is not Complete (not only when DB file is newly created). - Reworked backfill execution: - Collect rollout files, derive deterministic watermark per path, sort, resume from last_watermark. - Process in batches (BACKFILL_BATCH_SIZE = 200), checkpoint after each batch. - Mark complete with last_success_at at the end. ## Why Previous behavior could leave users permanently partially backfilled if the process exited during initial async backfill. This change allows safe continuation across restarts and avoids restarting from scratch.
475 lines
14 KiB
Rust
475 lines
14 KiB
Rust
use crate::config::Config;
|
|
use crate::features::Feature;
|
|
use crate::rollout::list::Cursor;
|
|
use crate::rollout::list::ThreadSortKey;
|
|
use crate::rollout::metadata;
|
|
use chrono::DateTime;
|
|
use chrono::NaiveDateTime;
|
|
use chrono::Timelike;
|
|
use chrono::Utc;
|
|
use codex_otel::OtelManager;
|
|
use codex_protocol::ThreadId;
|
|
use codex_protocol::dynamic_tools::DynamicToolSpec;
|
|
use codex_protocol::protocol::RolloutItem;
|
|
use codex_protocol::protocol::SessionSource;
|
|
use codex_state::DB_METRIC_COMPARE_ERROR;
|
|
pub use codex_state::LogEntry;
|
|
use codex_state::ThreadMetadataBuilder;
|
|
use serde_json::Value;
|
|
use std::path::Path;
|
|
use std::path::PathBuf;
|
|
use std::sync::Arc;
|
|
use tracing::warn;
|
|
use uuid::Uuid;
|
|
|
|
/// Core-facing handle to the optional SQLite-backed state runtime.
|
|
pub type StateDbHandle = Arc<codex_state::StateRuntime>;
|
|
|
|
/// Initialize the state runtime when the `sqlite` feature flag is enabled. To only be used
|
|
/// inside `core`. The initialization should not be done anywhere else.
|
|
pub(crate) async fn init_if_enabled(
|
|
config: &Config,
|
|
otel: Option<&OtelManager>,
|
|
) -> Option<StateDbHandle> {
|
|
if !config.features.enabled(Feature::Sqlite) {
|
|
return None;
|
|
}
|
|
let runtime = match codex_state::StateRuntime::init(
|
|
config.codex_home.clone(),
|
|
config.model_provider_id.clone(),
|
|
otel.cloned(),
|
|
)
|
|
.await
|
|
{
|
|
Ok(runtime) => runtime,
|
|
Err(err) => {
|
|
warn!(
|
|
"failed to initialize state runtime at {}: {err}",
|
|
config.codex_home.display()
|
|
);
|
|
if let Some(otel) = otel {
|
|
otel.counter("codex.db.init", 1, &[("status", "init_error")]);
|
|
}
|
|
return None;
|
|
}
|
|
};
|
|
let should_backfill = match runtime.get_backfill_state().await {
|
|
Ok(state) => state.status != codex_state::BackfillStatus::Complete,
|
|
Err(err) => {
|
|
warn!(
|
|
"failed to read backfill state at {}: {err}",
|
|
config.codex_home.display()
|
|
);
|
|
true
|
|
}
|
|
};
|
|
if should_backfill {
|
|
let runtime_for_backfill = Arc::clone(&runtime);
|
|
let config_for_backfill = config.clone();
|
|
let otel_for_backfill = otel.cloned();
|
|
tokio::task::spawn(async move {
|
|
metadata::backfill_sessions(
|
|
runtime_for_backfill.as_ref(),
|
|
&config_for_backfill,
|
|
otel_for_backfill.as_ref(),
|
|
)
|
|
.await;
|
|
});
|
|
}
|
|
Some(runtime)
|
|
}
|
|
|
|
/// Get the DB if the feature is enabled and the DB exists.
|
|
pub async fn get_state_db(config: &Config, otel: Option<&OtelManager>) -> Option<StateDbHandle> {
|
|
let state_path = codex_state::state_db_path(config.codex_home.as_path());
|
|
if !config.features.enabled(Feature::Sqlite)
|
|
|| !tokio::fs::try_exists(&state_path).await.unwrap_or(false)
|
|
{
|
|
return None;
|
|
}
|
|
codex_state::StateRuntime::init(
|
|
config.codex_home.clone(),
|
|
config.model_provider_id.clone(),
|
|
otel.cloned(),
|
|
)
|
|
.await
|
|
.ok()
|
|
}
|
|
|
|
/// Open the state runtime when the SQLite file exists, without feature gating.
|
|
///
|
|
/// This is used for parity checks during the SQLite migration phase.
|
|
pub async fn open_if_present(codex_home: &Path, default_provider: &str) -> Option<StateDbHandle> {
|
|
let db_path = codex_state::state_db_path(codex_home);
|
|
if !tokio::fs::try_exists(&db_path).await.unwrap_or(false) {
|
|
return None;
|
|
}
|
|
let runtime = codex_state::StateRuntime::init(
|
|
codex_home.to_path_buf(),
|
|
default_provider.to_string(),
|
|
None,
|
|
)
|
|
.await
|
|
.ok()?;
|
|
Some(runtime)
|
|
}
|
|
|
|
fn cursor_to_anchor(cursor: Option<&Cursor>) -> Option<codex_state::Anchor> {
|
|
let cursor = cursor?;
|
|
let value = serde_json::to_value(cursor).ok()?;
|
|
let cursor_str = value.as_str()?;
|
|
let (ts_str, id_str) = cursor_str.split_once('|')?;
|
|
if id_str.contains('|') {
|
|
return None;
|
|
}
|
|
let id = Uuid::parse_str(id_str).ok()?;
|
|
let ts = if let Ok(naive) = NaiveDateTime::parse_from_str(ts_str, "%Y-%m-%dT%H-%M-%S") {
|
|
DateTime::<Utc>::from_naive_utc_and_offset(naive, Utc)
|
|
} else if let Ok(dt) = DateTime::parse_from_rfc3339(ts_str) {
|
|
dt.with_timezone(&Utc)
|
|
} else {
|
|
return None;
|
|
}
|
|
.with_nanosecond(0)?;
|
|
Some(codex_state::Anchor { ts, id })
|
|
}
|
|
|
|
/// List thread ids from SQLite for parity checks without rollout scanning.
|
|
#[allow(clippy::too_many_arguments)]
|
|
pub async fn list_thread_ids_db(
|
|
context: Option<&codex_state::StateRuntime>,
|
|
codex_home: &Path,
|
|
page_size: usize,
|
|
cursor: Option<&Cursor>,
|
|
sort_key: ThreadSortKey,
|
|
allowed_sources: &[SessionSource],
|
|
model_providers: Option<&[String]>,
|
|
archived_only: bool,
|
|
stage: &str,
|
|
) -> Option<Vec<ThreadId>> {
|
|
let ctx = context?;
|
|
if ctx.codex_home() != codex_home {
|
|
warn!(
|
|
"state db codex_home mismatch: expected {}, got {}",
|
|
ctx.codex_home().display(),
|
|
codex_home.display()
|
|
);
|
|
}
|
|
|
|
let anchor = cursor_to_anchor(cursor);
|
|
let allowed_sources: Vec<String> = allowed_sources
|
|
.iter()
|
|
.map(|value| match serde_json::to_value(value) {
|
|
Ok(Value::String(s)) => s,
|
|
Ok(other) => other.to_string(),
|
|
Err(_) => String::new(),
|
|
})
|
|
.collect();
|
|
let model_providers = model_providers.map(<[String]>::to_vec);
|
|
match ctx
|
|
.list_thread_ids(
|
|
page_size,
|
|
anchor.as_ref(),
|
|
match sort_key {
|
|
ThreadSortKey::CreatedAt => codex_state::SortKey::CreatedAt,
|
|
ThreadSortKey::UpdatedAt => codex_state::SortKey::UpdatedAt,
|
|
},
|
|
allowed_sources.as_slice(),
|
|
model_providers.as_deref(),
|
|
archived_only,
|
|
)
|
|
.await
|
|
{
|
|
Ok(ids) => Some(ids),
|
|
Err(err) => {
|
|
warn!("state db list_thread_ids failed during {stage}: {err}");
|
|
None
|
|
}
|
|
}
|
|
}
|
|
|
|
/// List thread metadata from SQLite without rollout directory traversal.
|
|
#[allow(clippy::too_many_arguments)]
|
|
pub async fn list_threads_db(
|
|
context: Option<&codex_state::StateRuntime>,
|
|
codex_home: &Path,
|
|
page_size: usize,
|
|
cursor: Option<&Cursor>,
|
|
sort_key: ThreadSortKey,
|
|
allowed_sources: &[SessionSource],
|
|
model_providers: Option<&[String]>,
|
|
archived: bool,
|
|
) -> Option<codex_state::ThreadsPage> {
|
|
let ctx = context?;
|
|
if ctx.codex_home() != codex_home {
|
|
warn!(
|
|
"state db codex_home mismatch: expected {}, got {}",
|
|
ctx.codex_home().display(),
|
|
codex_home.display()
|
|
);
|
|
}
|
|
|
|
let anchor = cursor_to_anchor(cursor);
|
|
let allowed_sources: Vec<String> = allowed_sources
|
|
.iter()
|
|
.map(|value| match serde_json::to_value(value) {
|
|
Ok(Value::String(s)) => s,
|
|
Ok(other) => other.to_string(),
|
|
Err(_) => String::new(),
|
|
})
|
|
.collect();
|
|
let model_providers = model_providers.map(<[String]>::to_vec);
|
|
match ctx
|
|
.list_threads(
|
|
page_size,
|
|
anchor.as_ref(),
|
|
match sort_key {
|
|
ThreadSortKey::CreatedAt => codex_state::SortKey::CreatedAt,
|
|
ThreadSortKey::UpdatedAt => codex_state::SortKey::UpdatedAt,
|
|
},
|
|
allowed_sources.as_slice(),
|
|
model_providers.as_deref(),
|
|
archived,
|
|
)
|
|
.await
|
|
{
|
|
Ok(page) => Some(page),
|
|
Err(err) => {
|
|
warn!("state db list_threads failed: {err}");
|
|
None
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Look up the rollout path for a thread id using SQLite.
|
|
pub async fn find_rollout_path_by_id(
|
|
context: Option<&codex_state::StateRuntime>,
|
|
thread_id: ThreadId,
|
|
archived_only: Option<bool>,
|
|
stage: &str,
|
|
) -> Option<PathBuf> {
|
|
let ctx = context?;
|
|
ctx.find_rollout_path_by_id(thread_id, archived_only)
|
|
.await
|
|
.unwrap_or_else(|err| {
|
|
warn!("state db find_rollout_path_by_id failed during {stage}: {err}");
|
|
None
|
|
})
|
|
}
|
|
|
|
/// Get dynamic tools for a thread id using SQLite.
|
|
pub async fn get_dynamic_tools(
|
|
context: Option<&codex_state::StateRuntime>,
|
|
thread_id: ThreadId,
|
|
stage: &str,
|
|
) -> Option<Vec<DynamicToolSpec>> {
|
|
let ctx = context?;
|
|
match ctx.get_dynamic_tools(thread_id).await {
|
|
Ok(tools) => tools,
|
|
Err(err) => {
|
|
warn!("state db get_dynamic_tools failed during {stage}: {err}");
|
|
None
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Persist dynamic tools for a thread id using SQLite, if none exist yet.
|
|
pub async fn persist_dynamic_tools(
|
|
context: Option<&codex_state::StateRuntime>,
|
|
thread_id: ThreadId,
|
|
tools: Option<&[DynamicToolSpec]>,
|
|
stage: &str,
|
|
) {
|
|
let Some(ctx) = context else {
|
|
return;
|
|
};
|
|
if let Err(err) = ctx.persist_dynamic_tools(thread_id, tools).await {
|
|
warn!("state db persist_dynamic_tools failed during {stage}: {err}");
|
|
}
|
|
}
|
|
|
|
/// Get memory summaries for a thread id using SQLite.
|
|
pub async fn get_thread_memory(
|
|
context: Option<&codex_state::StateRuntime>,
|
|
thread_id: ThreadId,
|
|
stage: &str,
|
|
) -> Option<codex_state::ThreadMemory> {
|
|
let ctx = context?;
|
|
match ctx.get_thread_memory(thread_id).await {
|
|
Ok(memory) => memory,
|
|
Err(err) => {
|
|
warn!("state db get_thread_memory failed during {stage}: {err}");
|
|
None
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Upsert memory summaries for a thread id using SQLite.
|
|
pub async fn upsert_thread_memory(
|
|
context: Option<&codex_state::StateRuntime>,
|
|
thread_id: ThreadId,
|
|
trace_summary: &str,
|
|
memory_summary: &str,
|
|
stage: &str,
|
|
) -> Option<codex_state::ThreadMemory> {
|
|
let ctx = context?;
|
|
match ctx
|
|
.upsert_thread_memory(thread_id, trace_summary, memory_summary)
|
|
.await
|
|
{
|
|
Ok(memory) => Some(memory),
|
|
Err(err) => {
|
|
warn!("state db upsert_thread_memory failed during {stage}: {err}");
|
|
None
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Get the last N memories corresponding to a cwd using an exact path match.
|
|
pub async fn get_last_n_thread_memories_for_cwd(
|
|
context: Option<&codex_state::StateRuntime>,
|
|
cwd: &Path,
|
|
n: usize,
|
|
stage: &str,
|
|
) -> Option<Vec<codex_state::ThreadMemory>> {
|
|
let ctx = context?;
|
|
match ctx.get_last_n_thread_memories_for_cwd(cwd, n).await {
|
|
Ok(memories) => Some(memories),
|
|
Err(err) => {
|
|
warn!("state db get_last_n_thread_memories_for_cwd failed during {stage}: {err}");
|
|
None
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Reconcile rollout items into SQLite, falling back to scanning the rollout file.
|
|
pub async fn reconcile_rollout(
|
|
context: Option<&codex_state::StateRuntime>,
|
|
rollout_path: &Path,
|
|
default_provider: &str,
|
|
builder: Option<&ThreadMetadataBuilder>,
|
|
items: &[RolloutItem],
|
|
) {
|
|
let Some(ctx) = context else {
|
|
return;
|
|
};
|
|
if builder.is_some() || !items.is_empty() {
|
|
apply_rollout_items(
|
|
Some(ctx),
|
|
rollout_path,
|
|
default_provider,
|
|
builder,
|
|
items,
|
|
"reconcile_rollout",
|
|
)
|
|
.await;
|
|
return;
|
|
}
|
|
let outcome =
|
|
match metadata::extract_metadata_from_rollout(rollout_path, default_provider, None).await {
|
|
Ok(outcome) => outcome,
|
|
Err(err) => {
|
|
warn!(
|
|
"state db reconcile_rollout extraction failed {}: {err}",
|
|
rollout_path.display()
|
|
);
|
|
return;
|
|
}
|
|
};
|
|
if let Err(err) = ctx.upsert_thread(&outcome.metadata).await {
|
|
warn!(
|
|
"state db reconcile_rollout upsert failed {}: {err}",
|
|
rollout_path.display()
|
|
);
|
|
return;
|
|
}
|
|
if let Ok(meta_line) = crate::rollout::list::read_session_meta_line(rollout_path).await {
|
|
persist_dynamic_tools(
|
|
Some(ctx),
|
|
meta_line.meta.id,
|
|
meta_line.meta.dynamic_tools.as_deref(),
|
|
"reconcile_rollout",
|
|
)
|
|
.await;
|
|
} else {
|
|
warn!(
|
|
"state db reconcile_rollout missing session meta {}",
|
|
rollout_path.display()
|
|
);
|
|
}
|
|
}
|
|
|
|
/// Apply rollout items incrementally to SQLite.
|
|
pub async fn apply_rollout_items(
|
|
context: Option<&codex_state::StateRuntime>,
|
|
rollout_path: &Path,
|
|
_default_provider: &str,
|
|
builder: Option<&ThreadMetadataBuilder>,
|
|
items: &[RolloutItem],
|
|
stage: &str,
|
|
) {
|
|
let Some(ctx) = context else {
|
|
return;
|
|
};
|
|
let mut builder = match builder {
|
|
Some(builder) => builder.clone(),
|
|
None => match metadata::builder_from_items(items, rollout_path) {
|
|
Some(builder) => builder,
|
|
None => {
|
|
warn!(
|
|
"state db apply_rollout_items missing builder during {stage}: {}",
|
|
rollout_path.display()
|
|
);
|
|
record_discrepancy(stage, "missing_builder");
|
|
return;
|
|
}
|
|
},
|
|
};
|
|
builder.rollout_path = rollout_path.to_path_buf();
|
|
if let Err(err) = ctx.apply_rollout_items(&builder, items, None).await {
|
|
warn!(
|
|
"state db apply_rollout_items failed during {stage} for {}: {err}",
|
|
rollout_path.display()
|
|
);
|
|
}
|
|
}
|
|
|
|
/// Record a state discrepancy metric with a stage and reason tag.
|
|
pub fn record_discrepancy(stage: &str, reason: &str) {
|
|
// We access the global metric because the call sites might not have access to the broader
|
|
// OtelManager.
|
|
tracing::warn!("state db record_discrepancy: {stage}, {reason}");
|
|
if let Some(metric) = codex_otel::metrics::global() {
|
|
let _ = metric.counter(
|
|
DB_METRIC_COMPARE_ERROR,
|
|
1,
|
|
&[("stage", stage), ("reason", reason)],
|
|
);
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
use crate::rollout::list::parse_cursor;
|
|
use pretty_assertions::assert_eq;
|
|
|
|
#[test]
|
|
fn cursor_to_anchor_normalizes_timestamp_format() {
|
|
let uuid = Uuid::new_v4();
|
|
let ts_str = "2026-01-27T12-34-56";
|
|
let token = format!("{ts_str}|{uuid}");
|
|
let cursor = parse_cursor(token.as_str()).expect("cursor should parse");
|
|
let anchor = cursor_to_anchor(Some(&cursor)).expect("anchor should parse");
|
|
|
|
let naive =
|
|
NaiveDateTime::parse_from_str(ts_str, "%Y-%m-%dT%H-%M-%S").expect("ts should parse");
|
|
let expected_ts = DateTime::<Utc>::from_naive_utc_and_offset(naive, Utc)
|
|
.with_nanosecond(0)
|
|
.expect("nanosecond");
|
|
|
|
assert_eq!(anchor.id, uuid);
|
|
assert_eq!(anchor.ts, expected_ts);
|
|
}
|
|
}
|