use anyhow::Result; use db::{ query, sqlez::{ bindable::{Bind, Column, StaticColumnCount}, domain::Domain, statement::Statement, }, sqlez_macros::sql, }; use fs::MTime; use itertools::Itertools as _; use std::{ path::{Path, PathBuf}, sync::Arc, }; use workspace::{ItemId, WorkspaceDb, WorkspaceId}; #[derive(Clone, Debug, PartialEq, Default)] pub(crate) struct SerializedEditor { pub(crate) abs_path: Option, pub(crate) contents: Option, pub(crate) language: Option, pub(crate) mtime: Option, } impl StaticColumnCount for SerializedEditor { fn column_count() -> usize { 6 } } impl Bind for SerializedEditor { fn bind(&self, statement: &Statement, start_index: i32) -> Result { let start_index = statement.bind(&self.abs_path, start_index)?; let start_index = statement.bind( &self .abs_path .as_ref() .map(|p| p.to_string_lossy().into_owned()), start_index, )?; let start_index = statement.bind(&self.contents, start_index)?; let start_index = statement.bind(&self.language, start_index)?; let start_index = match self .mtime .and_then(|mtime| mtime.to_seconds_and_nanos_for_persistence()) { Some((seconds, nanos)) => { let start_index = statement.bind(&(seconds as i64), start_index)?; statement.bind(&(nanos as i32), start_index)? } None => { let start_index = statement.bind::>(&None, start_index)?; statement.bind::>(&None, start_index)? } }; Ok(start_index) } } impl Column for SerializedEditor { fn column(statement: &mut Statement, start_index: i32) -> Result<(Self, i32)> { let (abs_path, start_index): (Option, i32) = Column::column(statement, start_index)?; let (_abs_path, start_index): (Option, i32) = Column::column(statement, start_index)?; let (contents, start_index): (Option, i32) = Column::column(statement, start_index)?; let (language, start_index): (Option, i32) = Column::column(statement, start_index)?; let (mtime_seconds, start_index): (Option, i32) = Column::column(statement, start_index)?; let (mtime_nanos, start_index): (Option, i32) = Column::column(statement, start_index)?; let mtime = mtime_seconds .zip(mtime_nanos) .map(|(seconds, nanos)| MTime::from_seconds_and_nanos(seconds as u64, nanos as u32)); let editor = Self { abs_path, contents, language, mtime, }; Ok((editor, start_index)) } } pub struct EditorDb(db::sqlez::thread_safe_connection::ThreadSafeConnection); impl Domain for EditorDb { const NAME: &str = stringify!(EditorDb); // Current schema shape using pseudo-rust syntax: // editors( // item_id: usize, // workspace_id: usize, // path: Option, // scroll_top_row: usize, // scroll_vertical_offset: f32, // scroll_horizontal_offset: f32, // contents: Option, // language: Option, // mtime_seconds: Option, // mtime_nanos: Option, // ) // // editor_selections( // item_id: usize, // editor_id: usize, // workspace_id: usize, // start: usize, // end: usize, // ) // // editor_folds( // item_id: usize, // editor_id: usize, // workspace_id: usize, // start: usize, // end: usize, // start_fingerprint: Option, // end_fingerprint: Option, // ) const MIGRATIONS: &[&str] = &[ sql! ( CREATE TABLE editors( item_id INTEGER NOT NULL, workspace_id INTEGER NOT NULL, path BLOB NOT NULL, PRIMARY KEY(item_id, workspace_id), FOREIGN KEY(workspace_id) REFERENCES workspaces(workspace_id) ON DELETE CASCADE ON UPDATE CASCADE ) STRICT; ), sql! ( ALTER TABLE editors ADD COLUMN scroll_top_row INTEGER NOT NULL DEFAULT 0; ALTER TABLE editors ADD COLUMN scroll_horizontal_offset REAL NOT NULL DEFAULT 0; ALTER TABLE editors ADD COLUMN scroll_vertical_offset REAL NOT NULL DEFAULT 0; ), sql! ( // Since sqlite3 doesn't support ALTER COLUMN, we create a new // table, move the data over, drop the old table, rename new table. CREATE TABLE new_editors_tmp ( item_id INTEGER NOT NULL, workspace_id INTEGER NOT NULL, path BLOB, // <-- No longer "NOT NULL" scroll_top_row INTEGER NOT NULL DEFAULT 0, scroll_horizontal_offset REAL NOT NULL DEFAULT 0, scroll_vertical_offset REAL NOT NULL DEFAULT 0, contents TEXT, // New language TEXT, // New PRIMARY KEY(item_id, workspace_id), FOREIGN KEY(workspace_id) REFERENCES workspaces(workspace_id) ON DELETE CASCADE ON UPDATE CASCADE ) STRICT; INSERT INTO new_editors_tmp(item_id, workspace_id, path, scroll_top_row, scroll_horizontal_offset, scroll_vertical_offset) SELECT item_id, workspace_id, path, scroll_top_row, scroll_horizontal_offset, scroll_vertical_offset FROM editors; DROP TABLE editors; ALTER TABLE new_editors_tmp RENAME TO editors; ), sql! ( ALTER TABLE editors ADD COLUMN mtime_seconds INTEGER DEFAULT NULL; ALTER TABLE editors ADD COLUMN mtime_nanos INTEGER DEFAULT NULL; ), sql! ( CREATE TABLE editor_selections ( item_id INTEGER NOT NULL, editor_id INTEGER NOT NULL, workspace_id INTEGER NOT NULL, start INTEGER NOT NULL, end INTEGER NOT NULL, PRIMARY KEY(item_id), FOREIGN KEY(editor_id, workspace_id) REFERENCES editors(item_id, workspace_id) ON DELETE CASCADE ) STRICT; ), sql! ( ALTER TABLE editors ADD COLUMN buffer_path TEXT; UPDATE editors SET buffer_path = CAST(path AS TEXT); ), sql! ( CREATE TABLE editor_folds ( item_id INTEGER NOT NULL, editor_id INTEGER NOT NULL, workspace_id INTEGER NOT NULL, start INTEGER NOT NULL, end INTEGER NOT NULL, PRIMARY KEY(item_id), FOREIGN KEY(editor_id, workspace_id) REFERENCES editors(item_id, workspace_id) ON DELETE CASCADE ) STRICT; ), sql! ( ALTER TABLE editor_folds ADD COLUMN start_fingerprint TEXT; ALTER TABLE editor_folds ADD COLUMN end_fingerprint TEXT; ), // File-level fold persistence: store folds by file path instead of editor_id. // This allows folds to survive tab close and workspace cleanup. // Follows the breakpoints pattern in workspace/src/persistence.rs. sql! ( CREATE TABLE file_folds ( workspace_id INTEGER NOT NULL, path TEXT NOT NULL, start INTEGER NOT NULL, end INTEGER NOT NULL, start_fingerprint TEXT, end_fingerprint TEXT, FOREIGN KEY(workspace_id) REFERENCES workspaces(workspace_id) ON DELETE CASCADE ON UPDATE CASCADE, PRIMARY KEY(workspace_id, path, start) ); ), ]; } db::static_connection!(EditorDb, [WorkspaceDb]); // https://www.sqlite.org/limits.html // > <..> the maximum value of a host parameter number is SQLITE_MAX_VARIABLE_NUMBER, // > which defaults to <..> 32766 for SQLite versions after 3.32.0. const MAX_QUERY_PLACEHOLDERS: usize = 32000; impl EditorDb { query! { pub fn get_serialized_editor(item_id: ItemId, workspace_id: WorkspaceId) -> Result> { SELECT path, buffer_path, contents, language, mtime_seconds, mtime_nanos FROM editors WHERE item_id = ? AND workspace_id = ? } } query! { pub async fn save_serialized_editor(item_id: ItemId, workspace_id: WorkspaceId, serialized_editor: SerializedEditor) -> Result<()> { INSERT INTO editors (item_id, workspace_id, path, buffer_path, contents, language, mtime_seconds, mtime_nanos) VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8) ON CONFLICT DO UPDATE SET item_id = ?1, workspace_id = ?2, path = ?3, buffer_path = ?4, contents = ?5, language = ?6, mtime_seconds = ?7, mtime_nanos = ?8 } } // Returns the scroll top row, and offset query! { pub fn get_scroll_position(item_id: ItemId, workspace_id: WorkspaceId) -> Result> { SELECT scroll_top_row, scroll_horizontal_offset, scroll_vertical_offset FROM editors WHERE item_id = ? AND workspace_id = ? } } query! { pub async fn save_scroll_position( item_id: ItemId, workspace_id: WorkspaceId, top_row: u32, vertical_offset: f64, horizontal_offset: f64 ) -> Result<()> { UPDATE OR IGNORE editors SET scroll_top_row = ?3, scroll_horizontal_offset = ?4, scroll_vertical_offset = ?5 WHERE item_id = ?1 AND workspace_id = ?2 } } query! { pub fn get_editor_selections( editor_id: ItemId, workspace_id: WorkspaceId ) -> Result> { SELECT start, end FROM editor_selections WHERE editor_id = ?1 AND workspace_id = ?2 } } query! { pub fn get_editor_folds( editor_id: ItemId, workspace_id: WorkspaceId ) -> Result, Option)>> { SELECT start, end, start_fingerprint, end_fingerprint FROM editor_folds WHERE editor_id = ?1 AND workspace_id = ?2 } } query! { pub fn get_file_folds( workspace_id: WorkspaceId, path: &Path ) -> Result, Option)>> { SELECT start, end, start_fingerprint, end_fingerprint FROM file_folds WHERE workspace_id = ?1 AND path = ?2 ORDER BY start } } pub async fn save_editor_selections( &self, editor_id: ItemId, workspace_id: WorkspaceId, selections: Vec<(usize, usize)>, ) -> Result<()> { log::debug!("Saving selections for editor {editor_id} in workspace {workspace_id:?}"); let mut first_selection; let mut last_selection = 0_usize; for (count, placeholders) in std::iter::once("(?1, ?2, ?, ?)") .cycle() .take(selections.len()) .chunks(MAX_QUERY_PLACEHOLDERS / 4) .into_iter() .map(|chunk| { let mut count = 0; let placeholders = chunk .inspect(|_| { count += 1; }) .join(", "); (count, placeholders) }) .collect::>() { first_selection = last_selection; last_selection = last_selection + count; let query = format!( r#" DELETE FROM editor_selections WHERE editor_id = ?1 AND workspace_id = ?2; INSERT OR IGNORE INTO editor_selections (editor_id, workspace_id, start, end) VALUES {placeholders}; "# ); let selections = selections[first_selection..last_selection].to_vec(); self.write(move |conn| { let mut statement = Statement::prepare(conn, query)?; statement.bind(&editor_id, 1)?; let mut next_index = statement.bind(&workspace_id, 2)?; for (start, end) in selections { next_index = statement.bind(&start, next_index)?; next_index = statement.bind(&end, next_index)?; } statement.exec() }) .await?; } Ok(()) } pub async fn save_file_folds( &self, workspace_id: WorkspaceId, path: Arc, folds: Vec<(usize, usize, String, String)>, ) -> Result<()> { log::debug!("Saving folds for file {path:?} in workspace {workspace_id:?}"); self.write(move |conn| { // Clear existing folds for this file conn.exec_bound(sql!( DELETE FROM file_folds WHERE workspace_id = ?1 AND path = ?2; ))?((workspace_id, path.as_ref()))?; // Insert each fold (matches breakpoints pattern) for (start, end, start_fp, end_fp) in folds { conn.exec_bound(sql!( INSERT INTO file_folds (workspace_id, path, start, end, start_fingerprint, end_fingerprint) VALUES (?1, ?2, ?3, ?4, ?5, ?6); ))?((workspace_id, path.as_ref(), start, end, start_fp, end_fp))?; } Ok(()) }) .await } pub async fn delete_file_folds( &self, workspace_id: WorkspaceId, path: Arc, ) -> Result<()> { self.write(move |conn| { conn.exec_bound(sql!( DELETE FROM file_folds WHERE workspace_id = ?1 AND path = ?2; ))?((workspace_id, path.as_ref())) }) .await } } #[cfg(test)] mod tests { use super::*; #[gpui::test] async fn test_save_and_get_serialized_editor(cx: &mut gpui::TestAppContext) { let db = cx.update(|cx| workspace::WorkspaceDb::global(cx)); let workspace_id = db.next_id().await.unwrap(); let editor_db = cx.update(|cx| EditorDb::global(cx)); let serialized_editor = SerializedEditor { abs_path: Some(PathBuf::from("testing.txt")), contents: None, language: None, mtime: None, }; editor_db .save_serialized_editor(1234, workspace_id, serialized_editor.clone()) .await .unwrap(); let have = editor_db .get_serialized_editor(1234, workspace_id) .unwrap() .unwrap(); assert_eq!(have, serialized_editor); // Now update contents and language let serialized_editor = SerializedEditor { abs_path: Some(PathBuf::from("testing.txt")), contents: Some("Test".to_owned()), language: Some("Go".to_owned()), mtime: None, }; editor_db .save_serialized_editor(1234, workspace_id, serialized_editor.clone()) .await .unwrap(); let have = editor_db .get_serialized_editor(1234, workspace_id) .unwrap() .unwrap(); assert_eq!(have, serialized_editor); // Now set all the fields to NULL let serialized_editor = SerializedEditor { abs_path: None, contents: None, language: None, mtime: None, }; editor_db .save_serialized_editor(1234, workspace_id, serialized_editor.clone()) .await .unwrap(); let have = editor_db .get_serialized_editor(1234, workspace_id) .unwrap() .unwrap(); assert_eq!(have, serialized_editor); // Storing and retrieving mtime let serialized_editor = SerializedEditor { abs_path: None, contents: None, language: None, mtime: Some(MTime::from_seconds_and_nanos(100, 42)), }; editor_db .save_serialized_editor(1234, workspace_id, serialized_editor.clone()) .await .unwrap(); let have = editor_db .get_serialized_editor(1234, workspace_id) .unwrap() .unwrap(); assert_eq!(have, serialized_editor); } // NOTE: The fingerprint search logic (finding content at new offsets when file // is modified externally) is in editor.rs:restore_from_db and requires a full // Editor context to test. Manual testing procedure: // 1. Open a file, fold some sections, close Zed // 2. Add text at the START of the file externally (shifts all offsets) // 3. Reopen Zed - folds should be restored at their NEW correct positions // The search uses contains_str_at() to find fingerprints in the buffer. #[gpui::test] async fn test_save_and_get_file_folds(cx: &mut gpui::TestAppContext) { let db = cx.update(|cx| workspace::WorkspaceDb::global(cx)); let workspace_id = db.next_id().await.unwrap(); let editor_db = cx.update(|cx| EditorDb::global(cx)); // file_folds table uses path as key (no FK to editors table) let file_path: Arc = Arc::from(Path::new("/tmp/test_file_folds.rs")); // Save folds with fingerprints let folds = vec![ ( 100, 200, "fn main() {".to_string(), "} // end main".to_string(), ), ( 300, 400, "struct Foo {".to_string(), "} // end Foo".to_string(), ), ]; editor_db .save_file_folds(workspace_id, file_path.clone(), folds.clone()) .await .unwrap(); // Retrieve and verify fingerprints are preserved let retrieved = editor_db.get_file_folds(workspace_id, &file_path).unwrap(); assert_eq!(retrieved.len(), 2); assert_eq!( retrieved[0], ( 100, 200, Some("fn main() {".to_string()), Some("} // end main".to_string()) ) ); assert_eq!( retrieved[1], ( 300, 400, Some("struct Foo {".to_string()), Some("} // end Foo".to_string()) ) ); // Test overwrite: saving new folds replaces old ones let new_folds = vec![( 500, 600, "impl Bar {".to_string(), "} // end impl".to_string(), )]; editor_db .save_file_folds(workspace_id, file_path.clone(), new_folds) .await .unwrap(); let retrieved = editor_db.get_file_folds(workspace_id, &file_path).unwrap(); assert_eq!(retrieved.len(), 1); assert_eq!( retrieved[0], ( 500, 600, Some("impl Bar {".to_string()), Some("} // end impl".to_string()) ) ); // Test delete editor_db .delete_file_folds(workspace_id, file_path.clone()) .await .unwrap(); let retrieved = editor_db.get_file_folds(workspace_id, &file_path).unwrap(); assert!(retrieved.is_empty()); // Test multiple files don't interfere let file_path_a: Arc = Arc::from(Path::new("/tmp/file_a.rs")); let file_path_b: Arc = Arc::from(Path::new("/tmp/file_b.rs")); let folds_a = vec![(10, 20, "a_start".to_string(), "a_end".to_string())]; let folds_b = vec![(30, 40, "b_start".to_string(), "b_end".to_string())]; editor_db .save_file_folds(workspace_id, file_path_a.clone(), folds_a) .await .unwrap(); editor_db .save_file_folds(workspace_id, file_path_b.clone(), folds_b) .await .unwrap(); let retrieved_a = editor_db .get_file_folds(workspace_id, &file_path_a) .unwrap(); let retrieved_b = editor_db .get_file_folds(workspace_id, &file_path_b) .unwrap(); assert_eq!(retrieved_a.len(), 1); assert_eq!(retrieved_b.len(), 1); assert_eq!(retrieved_a[0].0, 10); // file_a's fold assert_eq!(retrieved_b[0].0, 30); // file_b's fold } }