Skip to main content

fresh/
workspace.rs

1//! Workspace persistence for per-project editor state
2//!
3//! Saves and restores:
4//! - Split layout and open files
5//! - Cursor and scroll positions per split per file
6//! - File explorer state
7//! - Search/replace history and options
8//! - Bookmarks
9//!
10//! ## Storage
11//!
12//! Workspaces are stored in `$XDG_DATA_HOME/fresh/workspaces/{encoded_path}.json`
13//! where `{encoded_path}` is the working directory path with:
14//! - Path separators (`/`) replaced with underscores (`_`)
15//! - Special characters percent-encoded as `%XX`
16//!
17//! Example: `/home/user/my project` becomes `home_user_my%20project.json`
18//!
19//! The encoding is fully reversible using `decode_filename_to_path()`.
20//!
21//! ## Crash Resistance
22//!
23//! Uses atomic writes: write to temp file, then rename.
24//! This ensures the workspace file is never left in a corrupted state.
25
26use serde::{Deserialize, Serialize};
27use std::collections::HashMap;
28use std::io::{self, Write};
29use std::path::{Path, PathBuf};
30use std::time::{SystemTime, UNIX_EPOCH};
31
32use crate::input::input_history::get_data_dir;
33
34/// Current workspace file format version
35pub const WORKSPACE_VERSION: u32 = 1;
36
37/// Current per-file workspace version
38pub const FILE_WORKSPACE_VERSION: u32 = 1;
39
40/// Persisted workspace state for a working directory
41#[derive(Debug, Clone, Serialize, Deserialize)]
42pub struct Workspace {
43    /// Schema version for future migrations
44    pub version: u32,
45
46    /// Working directory this workspace belongs to (for validation)
47    pub working_dir: PathBuf,
48
49    /// Split layout tree
50    pub split_layout: SerializedSplitNode,
51
52    /// Active split ID
53    pub active_split_id: usize,
54
55    /// Per-split view states (keyed by split_id)
56    pub split_states: HashMap<usize, SerializedSplitViewState>,
57
58    /// Editor config overrides (toggles that differ from defaults)
59    #[serde(default)]
60    pub config_overrides: WorkspaceConfigOverrides,
61
62    /// File explorer state
63    pub file_explorer: FileExplorerState,
64
65    /// Input histories (search, replace, command palette, etc.)
66    #[serde(default)]
67    pub histories: WorkspaceHistories,
68
69    /// Search options (persist across searches within workspace)
70    #[serde(default)]
71    pub search_options: SearchOptions,
72
73    /// Bookmarks (character key -> file position)
74    #[serde(default)]
75    pub bookmarks: HashMap<char, SerializedBookmark>,
76
77    /// Open terminal workspaces (for restoration)
78    #[serde(default)]
79    pub terminals: Vec<SerializedTerminalWorkspace>,
80
81    /// External files open in the workspace (files outside working_dir)
82    /// These are stored as absolute paths since they can't be made relative
83    #[serde(default)]
84    pub external_files: Vec<PathBuf>,
85
86    /// Files that were read-only at save time; re-applied on restore.
87    /// Relative to `working_dir` when possible, otherwise absolute.
88    #[serde(default, skip_serializing_if = "Vec::is_empty")]
89    pub read_only_files: Vec<PathBuf>,
90
91    /// Unnamed buffers that should be restored from recovery files
92    #[serde(default, skip_serializing_if = "Vec::is_empty")]
93    pub unnamed_buffers: Vec<UnnamedBufferRef>,
94
95    /// Plugin-managed global state, isolated per plugin name.
96    /// Persisted across sessions so plugins can store non-buffer-specific state.
97    /// TODO: Need to think about plugin isolation / namespacing strategy for these APIs.
98    #[serde(default, skip_serializing_if = "HashMap::is_empty")]
99    pub plugin_global_state: HashMap<String, HashMap<String, serde_json::Value>>,
100
101    /// Timestamp when workspace was saved (Unix epoch seconds)
102    pub saved_at: u64,
103}
104
105/// Reference to a persisted unnamed buffer (content stored in recovery files)
106#[derive(Debug, Clone, Serialize, Deserialize)]
107pub struct UnnamedBufferRef {
108    /// Stable recovery ID used to locate the recovery file
109    pub recovery_id: String,
110    /// Display name shown in tabs (e.g., "Untitled-1")
111    pub display_name: String,
112}
113
114/// Serializable split layout (mirrors SplitNode but with file paths instead of buffer IDs)
115#[derive(Debug, Clone, Serialize, Deserialize)]
116pub enum SerializedSplitNode {
117    Leaf {
118        /// File path relative to working_dir (None for scratch buffers)
119        file_path: Option<PathBuf>,
120        split_id: usize,
121        /// Optional label set by plugins (e.g., "claude-sidebar")
122        #[serde(default, skip_serializing_if = "Option::is_none")]
123        label: Option<String>,
124        /// Recovery ID for unnamed buffers (when file_path is None)
125        #[serde(default, skip_serializing_if = "Option::is_none")]
126        unnamed_recovery_id: Option<String>,
127        /// Role tag (e.g. UtilityDock). Mirrors `SplitNode::Leaf::role`.
128        #[serde(default, skip_serializing_if = "Option::is_none")]
129        role: Option<crate::view::split::SplitRole>,
130    },
131    Terminal {
132        terminal_index: usize,
133        split_id: usize,
134        /// Optional label set by plugins
135        #[serde(default, skip_serializing_if = "Option::is_none")]
136        label: Option<String>,
137        /// Role tag — terminals can also be the dock occupant.
138        #[serde(default, skip_serializing_if = "Option::is_none")]
139        role: Option<crate::view::split::SplitRole>,
140    },
141    Split {
142        direction: SerializedSplitDirection,
143        first: Box<Self>,
144        second: Box<Self>,
145        ratio: f32,
146        split_id: usize,
147    },
148}
149
150#[derive(Debug, Clone, Copy, Serialize, Deserialize)]
151pub enum SerializedSplitDirection {
152    Horizontal,
153    Vertical,
154}
155
156/// Per-split view state
157#[derive(Debug, Clone, Serialize, Deserialize)]
158pub struct SerializedSplitViewState {
159    /// Open tabs in tab order (files or terminals)
160    #[serde(default)]
161    pub open_tabs: Vec<SerializedTabRef>,
162
163    /// Active tab index in open_tabs (if present)
164    #[serde(default)]
165    pub active_tab_index: Option<usize>,
166
167    /// Open files in tab order (paths relative to working_dir)
168    /// Deprecated; retained for backward compatibility.
169    #[serde(default)]
170    pub open_files: Vec<PathBuf>,
171
172    /// Active file index in open_files
173    #[serde(default)]
174    pub active_file_index: usize,
175
176    /// Per-file cursor and scroll state
177    #[serde(default)]
178    pub file_states: HashMap<PathBuf, SerializedFileState>,
179
180    /// Tab scroll offset
181    #[serde(default)]
182    pub tab_scroll_offset: usize,
183
184    /// View mode
185    #[serde(default)]
186    pub view_mode: SerializedViewMode,
187
188    /// Compose width if in compose mode
189    #[serde(default)]
190    pub compose_width: Option<u16>,
191}
192
193/// Per-file state within a split
194#[derive(Debug, Clone, Serialize, Deserialize)]
195pub struct SerializedFileState {
196    /// Primary cursor position (byte offset)
197    pub cursor: SerializedCursor,
198
199    /// Additional cursors for multi-cursor
200    #[serde(default)]
201    pub additional_cursors: Vec<SerializedCursor>,
202
203    /// Scroll position (byte offset)
204    pub scroll: SerializedScroll,
205
206    /// View mode for this buffer in this split
207    #[serde(default)]
208    pub view_mode: SerializedViewMode,
209
210    /// Compose width for this buffer in this split
211    #[serde(default)]
212    pub compose_width: Option<u16>,
213
214    /// Plugin-managed state (arbitrary key-value pairs, persisted across sessions)
215    #[serde(default, skip_serializing_if = "HashMap::is_empty")]
216    pub plugin_state: HashMap<String, serde_json::Value>,
217
218    /// Collapsed folding ranges for this buffer/view
219    #[serde(default, skip_serializing_if = "Vec::is_empty")]
220    pub folds: Vec<SerializedFoldRange>,
221}
222
223/// Line-based folded range for persistence
224#[derive(Debug, Clone, Serialize, Deserialize)]
225pub struct SerializedFoldRange {
226    /// Header line number (visible line that owns the fold)
227    pub header_line: usize,
228    /// Last hidden line number (inclusive)
229    pub end_line: usize,
230    /// Optional placeholder text for the fold
231    #[serde(default)]
232    pub placeholder: Option<String>,
233    /// Text of the header line at save time. Used on restore to detect
234    /// whether the file was edited externally between sessions (issue #1568):
235    /// if the text at `header_line` no longer matches, we search nearby
236    /// lines for it and fall back to dropping the fold rather than
237    /// re-attaching it to unrelated content.
238    ///
239    /// `Option` for backward compatibility with older session files that
240    /// didn't record the text.
241    #[serde(default)]
242    pub header_text: Option<String>,
243}
244
245#[derive(Debug, Clone, Serialize, Deserialize)]
246pub struct SerializedCursor {
247    /// Cursor position as byte offset from start of file
248    pub position: usize,
249    /// Selection anchor as byte offset (if selection active)
250    #[serde(default)]
251    pub anchor: Option<usize>,
252    /// Sticky column for vertical movement (character column)
253    #[serde(default)]
254    pub sticky_column: usize,
255}
256
257#[derive(Debug, Clone, Serialize, Deserialize)]
258pub struct SerializedScroll {
259    /// Top visible position as byte offset
260    pub top_byte: usize,
261    /// Virtual line offset within the top line (for wrapped lines)
262    #[serde(default)]
263    pub top_view_line_offset: usize,
264    /// Left column offset (for horizontal scroll)
265    #[serde(default)]
266    pub left_column: usize,
267}
268
269#[derive(Debug, Clone, Copy, Default, Serialize, Deserialize)]
270pub enum SerializedViewMode {
271    #[default]
272    Source,
273    /// Page view (document-style layout with centering and concealment).
274    /// Accepts "Compose" for backward compatibility with saved workspaces.
275    #[serde(alias = "Compose")]
276    PageView,
277}
278
279/// Config overrides that differ from base config
280#[derive(Debug, Clone, Default, Serialize, Deserialize)]
281pub struct WorkspaceConfigOverrides {
282    #[serde(default, skip_serializing_if = "Option::is_none")]
283    pub line_numbers: Option<bool>,
284    #[serde(default, skip_serializing_if = "Option::is_none")]
285    pub relative_line_numbers: Option<bool>,
286    #[serde(default, skip_serializing_if = "Option::is_none")]
287    pub line_wrap: Option<bool>,
288    #[serde(default, skip_serializing_if = "Option::is_none")]
289    pub syntax_highlighting: Option<bool>,
290    #[serde(default, skip_serializing_if = "Option::is_none")]
291    pub enable_inlay_hints: Option<bool>,
292    #[serde(default, skip_serializing_if = "Option::is_none")]
293    pub mouse_enabled: Option<bool>,
294    /// Legacy: menu bar visibility was once stored as a per-workspace
295    /// override here. It is now a global preference (`editor.show_menu_bar`),
296    /// so this field is no longer written and is ignored on restore. Kept
297    /// only for serde compatibility with workspaces saved by older builds.
298    /// See issue #1156.
299    #[serde(default, skip_serializing_if = "Option::is_none")]
300    pub menu_bar_hidden: Option<bool>,
301}
302
303#[derive(Debug, Clone, Serialize, Deserialize)]
304pub struct FileExplorerState {
305    pub visible: bool,
306    /// File explorer width. See [`crate::config::ExplorerWidth`] for
307    /// the accepted wire formats (percent string, column string, legacy
308    /// numeric forms). The `width_percent` alias preserves read
309    /// compatibility with workspace files written by earlier versions.
310    #[serde(
311        alias = "width_percent",
312        default = "crate::config::default_explorer_width_value"
313    )]
314    pub width: crate::config::ExplorerWidth,
315    /// File explorer side placement
316    #[serde(default)]
317    pub side: crate::config::FileExplorerSide,
318    /// Expanded directories (relative paths)
319    #[serde(default)]
320    pub expanded_dirs: Vec<PathBuf>,
321    /// Scroll offset
322    #[serde(default)]
323    pub scroll_offset: usize,
324    /// Show hidden files (fixes #569)
325    #[serde(default)]
326    pub show_hidden: bool,
327    /// Show gitignored files (fixes #569)
328    #[serde(default)]
329    pub show_gitignored: bool,
330}
331
332impl Default for FileExplorerState {
333    fn default() -> Self {
334        Self {
335            visible: false,
336            width: crate::config::default_explorer_width_value(),
337            side: crate::config::FileExplorerSide::Left,
338            expanded_dirs: Vec::new(),
339            scroll_offset: 0,
340            show_hidden: false,
341            show_gitignored: false,
342        }
343    }
344}
345
346/// Per-workspace input histories
347#[derive(Debug, Clone, Default, Serialize, Deserialize)]
348pub struct WorkspaceHistories {
349    #[serde(default, skip_serializing_if = "Vec::is_empty")]
350    pub search: Vec<String>,
351    #[serde(default, skip_serializing_if = "Vec::is_empty")]
352    pub replace: Vec<String>,
353    #[serde(default, skip_serializing_if = "Vec::is_empty")]
354    pub command_palette: Vec<String>,
355    #[serde(default, skip_serializing_if = "Vec::is_empty")]
356    pub goto_line: Vec<String>,
357    #[serde(default, skip_serializing_if = "Vec::is_empty")]
358    pub open_file: Vec<String>,
359}
360
361/// Search options that persist across searches within a workspace
362#[derive(Debug, Clone, Default, Serialize, Deserialize)]
363pub struct SearchOptions {
364    #[serde(default)]
365    pub case_sensitive: bool,
366    #[serde(default)]
367    pub whole_word: bool,
368    #[serde(default)]
369    pub use_regex: bool,
370    #[serde(default)]
371    pub confirm_each: bool,
372}
373
374/// Serialized bookmark (file path + byte offset)
375#[derive(Debug, Clone, Serialize, Deserialize)]
376pub struct SerializedBookmark {
377    /// File path (relative to working_dir)
378    pub file_path: PathBuf,
379    /// Byte offset position in the file
380    pub position: usize,
381}
382
383/// Reference to an open tab (file path, terminal index, or unnamed buffer)
384#[derive(Debug, Clone, Serialize, Deserialize)]
385pub enum SerializedTabRef {
386    File(PathBuf),
387    Terminal(usize),
388    /// An unnamed buffer identified by its recovery ID
389    Unnamed(String),
390}
391
392/// Persisted metadata for a terminal workspace
393#[derive(Debug, Clone, Serialize, Deserialize)]
394pub struct SerializedTerminalWorkspace {
395    pub terminal_index: usize,
396    pub cwd: Option<PathBuf>,
397    pub shell: String,
398    pub cols: u16,
399    pub rows: u16,
400    pub log_path: PathBuf,
401    pub backing_path: PathBuf,
402}
403
404// ============================================================================
405// Global file state persistence (per-file, not per-project)
406// ============================================================================
407
408/// Individual file state stored in its own file
409///
410/// Each source file's scroll/cursor state is stored in a separate JSON file
411/// at `$XDG_DATA_HOME/fresh/file_states/{encoded_path}.json`.
412/// This allows concurrent editors to safely update different files without
413/// conflicts.
414#[derive(Debug, Clone, Serialize, Deserialize)]
415pub struct PersistedFileState {
416    /// Schema version for future migrations
417    pub version: u32,
418
419    /// The file state (cursor, scroll, etc.)
420    pub state: SerializedFileState,
421
422    /// Timestamp when last saved (Unix epoch seconds)
423    pub saved_at: u64,
424}
425
426impl PersistedFileState {
427    fn new(state: SerializedFileState) -> Self {
428        Self {
429            version: FILE_WORKSPACE_VERSION,
430            state,
431            saved_at: SystemTime::now()
432                .duration_since(UNIX_EPOCH)
433                .unwrap_or_default()
434                .as_secs(),
435        }
436    }
437}
438
439/// Per-file workspace storage for scroll/cursor positions
440///
441/// Unlike project workspaces which store file states relative to a working directory,
442/// this stores file states by absolute path so they persist across projects.
443/// This means opening the same file from different projects (or without a project)
444/// will restore the same scroll/cursor position.
445///
446/// Each file's state is stored in a separate JSON file at
447/// `$XDG_DATA_HOME/fresh/file_states/{encoded_path}.json` to avoid conflicts
448/// between concurrent editors. States are loaded lazily when opening files
449/// and saved immediately when closing files or saving the workspace.
450pub struct PersistedFileWorkspace;
451
452impl PersistedFileWorkspace {
453    /// Get the directory for file state files
454    fn states_dir() -> io::Result<PathBuf> {
455        Ok(get_data_dir()?.join("file_states"))
456    }
457
458    /// Get the state file path for a source file
459    fn state_file_path(source_path: &Path) -> io::Result<PathBuf> {
460        let canonical = source_path
461            .canonicalize()
462            .unwrap_or_else(|_| source_path.to_path_buf());
463        let filename = format!("{}.json", encode_path_for_filename(&canonical));
464        Ok(Self::states_dir()?.join(filename))
465    }
466
467    /// Load the state for a file by its absolute path (from disk)
468    pub fn load(path: &Path) -> Option<SerializedFileState> {
469        let state_path = match Self::state_file_path(path) {
470            Ok(p) => p,
471            Err(_) => return None,
472        };
473
474        if !state_path.exists() {
475            return None;
476        }
477
478        let content = match std::fs::read_to_string(&state_path) {
479            Ok(c) => c,
480            Err(_) => return None,
481        };
482
483        let persisted: PersistedFileState = match serde_json::from_str(&content) {
484            Ok(p) => p,
485            Err(_) => return None,
486        };
487
488        // Check version compatibility
489        if persisted.version > FILE_WORKSPACE_VERSION {
490            return None;
491        }
492
493        Some(persisted.state)
494    }
495
496    /// Save the state for a file by its absolute path (to disk, atomic write)
497    pub fn save(path: &Path, state: SerializedFileState) {
498        let state_path = match Self::state_file_path(path) {
499            Ok(p) => p,
500            Err(e) => {
501                tracing::warn!("Failed to get state path for {:?}: {}", path, e);
502                return;
503            }
504        };
505
506        // Ensure directory exists
507        if let Some(parent) = state_path.parent() {
508            if let Err(e) = std::fs::create_dir_all(parent) {
509                tracing::warn!("Failed to create state dir: {}", e);
510                return;
511            }
512        }
513
514        let persisted = PersistedFileState::new(state);
515        let content = match serde_json::to_string_pretty(&persisted) {
516            Ok(c) => c,
517            Err(e) => {
518                tracing::warn!("Failed to serialize file state: {}", e);
519                return;
520            }
521        };
522
523        // Write atomically: temp file + rename
524        let temp_path = state_path.with_extension("json.tmp");
525
526        let write_result = (|| -> io::Result<()> {
527            let mut file = std::fs::File::create(&temp_path)?;
528            file.write_all(content.as_bytes())?;
529            file.sync_all()?;
530            std::fs::rename(&temp_path, &state_path)?;
531            Ok(())
532        })();
533
534        if let Err(e) = write_result {
535            tracing::warn!("Failed to save file state for {:?}: {}", path, e);
536        } else {
537            tracing::trace!("File state saved for {:?}", path);
538        }
539    }
540}
541
542// ============================================================================
543// Workspace file management
544// ============================================================================
545
546/// Get the workspaces directory
547pub fn get_workspaces_dir() -> io::Result<PathBuf> {
548    Ok(get_data_dir()?.join("workspaces"))
549}
550
551/// Encode a path into a filesystem-safe filename using percent encoding
552///
553/// Keeps alphanumeric chars, `-`, `.`, `_` as-is.
554/// Replaces `/` with `_` for readability.
555/// Percent-encodes other special characters as %XX.
556///
557/// Example: `/home/user/my project` -> `home_user_my%20project`
558pub fn encode_path_for_filename(path: &Path) -> String {
559    let path_str = path.to_string_lossy();
560    let mut result = String::with_capacity(path_str.len() * 2);
561
562    for c in path_str.chars() {
563        match c {
564            // Path separators become underscores for readability
565            '/' | '\\' => result.push('_'),
566            // Safe chars pass through
567            c if c.is_ascii_alphanumeric() => result.push(c),
568            '-' | '.' => result.push(c),
569            // Underscore needs special handling to avoid collision with /
570            '_' => result.push_str("%5F"),
571            // Everything else gets percent-encoded
572            c => {
573                for byte in c.to_string().as_bytes() {
574                    result.push_str(&format!("%{:02X}", byte));
575                }
576            }
577        }
578    }
579
580    // Remove leading underscores (from leading /)
581    let result = result.trim_start_matches('_').to_string();
582
583    // Collapse multiple underscores
584    let mut final_result = String::with_capacity(result.len());
585    let mut last_was_underscore = false;
586    for c in result.chars() {
587        if c == '_' {
588            if !last_was_underscore {
589                final_result.push(c);
590            }
591            last_was_underscore = true;
592        } else {
593            final_result.push(c);
594            last_was_underscore = false;
595        }
596    }
597
598    if final_result.is_empty() {
599        final_result = "root".to_string();
600    }
601
602    final_result
603}
604
605/// Decode a filename back to the original path (for debugging/tooling)
606#[allow(dead_code)]
607pub fn decode_filename_to_path(encoded: &str) -> Option<PathBuf> {
608    if encoded == "root" {
609        return Some(PathBuf::from("/"));
610    }
611
612    let mut result = String::with_capacity(encoded.len() + 1);
613    // Re-add leading slash that was stripped during encoding
614    result.push('/');
615
616    let mut chars = encoded.chars().peekable();
617
618    while let Some(c) = chars.next() {
619        if c == '%' {
620            // Read two hex digits
621            let hex: String = chars.by_ref().take(2).collect();
622            if hex.len() == 2 {
623                if let Ok(byte) = u8::from_str_radix(&hex, 16) {
624                    result.push(byte as char);
625                }
626            }
627        } else if c == '_' {
628            result.push('/');
629        } else {
630            result.push(c);
631        }
632    }
633
634    Some(PathBuf::from(result))
635}
636
637/// Get the workspace file path for a working directory
638pub fn get_workspace_path(working_dir: &Path) -> io::Result<PathBuf> {
639    let canonical = working_dir
640        .canonicalize()
641        .unwrap_or_else(|_| working_dir.to_path_buf());
642    let filename = format!("{}.json", encode_path_for_filename(&canonical));
643    Ok(get_workspaces_dir()?.join(filename))
644}
645
646/// Get the session-workspaces directory
647pub fn get_session_workspaces_dir() -> io::Result<PathBuf> {
648    Ok(get_data_dir()?.join("session-workspaces"))
649}
650
651/// Get the workspace file path for a named session
652pub fn get_session_workspace_path(session_name: &str) -> io::Result<PathBuf> {
653    let dir = get_session_workspaces_dir()?;
654    std::fs::create_dir_all(&dir)?;
655    // Sanitize session name for filesystem safety
656    let safe_name: String = session_name
657        .chars()
658        .map(|c| {
659            if c.is_alphanumeric() || c == '-' || c == '_' || c == '.' {
660                c
661            } else {
662                '_'
663            }
664        })
665        .collect();
666    Ok(dir.join(format!("{}.json", safe_name)))
667}
668
669/// Workspace error types
670#[derive(Debug)]
671pub enum WorkspaceError {
672    Io(anyhow::Error),
673    Json(serde_json::Error),
674    WorkdirMismatch { expected: PathBuf, found: PathBuf },
675    VersionTooNew { version: u32, max_supported: u32 },
676}
677
678impl std::fmt::Display for WorkspaceError {
679    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
680        match self {
681            Self::Io(e) => write!(f, "Workspace error: {}", e),
682            Self::Json(e) => write!(f, "JSON error: {}", e),
683            Self::WorkdirMismatch { expected, found } => {
684                write!(
685                    f,
686                    "Working directory mismatch: expected {:?}, found {:?}",
687                    expected, found
688                )
689            }
690            WorkspaceError::VersionTooNew {
691                version,
692                max_supported,
693            } => {
694                write!(
695                    f,
696                    "Workspace version {} is newer than supported (max: {})",
697                    version, max_supported
698                )
699            }
700        }
701    }
702}
703
704impl std::error::Error for WorkspaceError {
705    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
706        match self {
707            Self::Io(e) => e.source(),
708            Self::Json(e) => Some(e),
709            _ => None,
710        }
711    }
712}
713
714impl From<io::Error> for WorkspaceError {
715    fn from(e: io::Error) -> Self {
716        WorkspaceError::Io(e.into())
717    }
718}
719
720impl From<anyhow::Error> for WorkspaceError {
721    fn from(e: anyhow::Error) -> Self {
722        WorkspaceError::Io(e)
723    }
724}
725
726impl From<serde_json::Error> for WorkspaceError {
727    fn from(e: serde_json::Error) -> Self {
728        WorkspaceError::Json(e)
729    }
730}
731
732impl Workspace {
733    /// Load workspace for a working directory (if exists)
734    pub fn load(working_dir: &Path) -> Result<Option<Workspace>, WorkspaceError> {
735        let path = get_workspace_path(working_dir)?;
736        tracing::debug!("Looking for workspace at {:?}", path);
737
738        if !path.exists() {
739            tracing::debug!("Workspace file does not exist");
740            return Ok(None);
741        }
742
743        tracing::debug!("Loading workspace from {:?}", path);
744        let content = std::fs::read_to_string(&path)?;
745        let workspace: Workspace = serde_json::from_str(&content)?;
746
747        tracing::debug!(
748            "Loaded workspace: version={}, split_states={}, active_split={}",
749            workspace.version,
750            workspace.split_states.len(),
751            workspace.active_split_id
752        );
753
754        // Validate working_dir matches (canonicalize both for comparison)
755        let expected = working_dir
756            .canonicalize()
757            .unwrap_or_else(|_| working_dir.to_path_buf());
758        let found = workspace
759            .working_dir
760            .canonicalize()
761            .unwrap_or_else(|_| workspace.working_dir.clone());
762
763        if expected != found {
764            tracing::warn!(
765                "Workspace working_dir mismatch: expected {:?}, found {:?}",
766                expected,
767                found
768            );
769            return Err(WorkspaceError::WorkdirMismatch { expected, found });
770        }
771
772        // Check version compatibility
773        if workspace.version > WORKSPACE_VERSION {
774            tracing::warn!(
775                "Workspace version {} is newer than supported {}",
776                workspace.version,
777                WORKSPACE_VERSION
778            );
779            return Err(WorkspaceError::VersionTooNew {
780                version: workspace.version,
781                max_supported: WORKSPACE_VERSION,
782            });
783        }
784
785        Ok(Some(workspace))
786    }
787
788    /// `true` when this workspace snapshot doesn't reference any
789    /// real buffer content — every split's open_tabs is empty, and
790    /// there are no terminals, no unnamed buffers, and no external
791    /// files. Virtual buffers (Dashboard, plugin scratch buffers)
792    /// are stripped during serialisation, so a Dashboard-only quit
793    /// produces a snapshot that looks identical to a truly empty
794    /// one. Used by `save_workspace` to refuse to clobber a real
795    /// on-disk workspace with such a snapshot.
796    pub fn has_no_real_content(&self) -> bool {
797        self.terminals.is_empty()
798            && self.external_files.is_empty()
799            && self.unnamed_buffers.is_empty()
800            && self.split_states.values().all(|s| s.open_tabs.is_empty())
801    }
802
803    /// Save workspace to file using atomic write (temp file + rename)
804    ///
805    /// This ensures the workspace file is never left in a corrupted state:
806    /// 1. Write to a temporary file in the same directory
807    /// 2. Sync to disk (fsync)
808    /// 3. Atomically rename to the final path
809    pub fn save(&self) -> Result<(), WorkspaceError> {
810        let path = get_workspace_path(&self.working_dir)?;
811        tracing::debug!("Saving workspace to {:?}", path);
812
813        // Ensure directory exists
814        if let Some(parent) = path.parent() {
815            std::fs::create_dir_all(parent)?;
816        }
817
818        // Serialize to JSON
819        let content = serde_json::to_string_pretty(self)?;
820        tracing::trace!("Workspace JSON size: {} bytes", content.len());
821
822        // Write atomically: temp file + rename
823        let temp_path = path.with_extension("json.tmp");
824
825        // Write to temp file
826        {
827            let mut file = std::fs::File::create(&temp_path)?;
828            file.write_all(content.as_bytes())?;
829            file.sync_all()?; // Ensure data is on disk before rename
830        }
831
832        // Atomic rename
833        std::fs::rename(&temp_path, &path)?;
834        tracing::info!("Workspace saved to {:?}", path);
835
836        Ok(())
837    }
838
839    /// Load workspace for a named session (if exists)
840    pub fn load_session(
841        session_name: &str,
842        working_dir: &Path,
843    ) -> Result<Option<Workspace>, WorkspaceError> {
844        let path = get_session_workspace_path(session_name)?;
845        tracing::debug!("Looking for session workspace at {:?}", path);
846
847        if !path.exists() {
848            return Ok(None);
849        }
850
851        let content = std::fs::read_to_string(&path)?;
852        let workspace: Workspace = serde_json::from_str(&content)?;
853
854        // For session workspaces, skip working_dir validation — the session
855        // always restores its own workspace regardless of CWD.
856        if workspace.version > WORKSPACE_VERSION {
857            return Err(WorkspaceError::VersionTooNew {
858                version: workspace.version,
859                max_supported: WORKSPACE_VERSION,
860            });
861        }
862
863        // If working_dir changed, log but still load (session owns its layout)
864        let found = workspace
865            .working_dir
866            .canonicalize()
867            .unwrap_or_else(|_| workspace.working_dir.clone());
868        let expected = working_dir
869            .canonicalize()
870            .unwrap_or_else(|_| working_dir.to_path_buf());
871        if expected != found {
872            tracing::info!(
873                "Session '{}' workspace was saved from {:?}, now loading from {:?}",
874                session_name,
875                found,
876                expected
877            );
878        }
879
880        Ok(Some(workspace))
881    }
882
883    /// Save workspace for a named session using atomic write
884    pub fn save_session(&self, session_name: &str) -> Result<(), WorkspaceError> {
885        let path = get_session_workspace_path(session_name)?;
886        tracing::debug!("Saving session workspace to {:?}", path);
887
888        if let Some(parent) = path.parent() {
889            std::fs::create_dir_all(parent)?;
890        }
891
892        let content = serde_json::to_string_pretty(self)?;
893        let temp_path = path.with_extension("json.tmp");
894        {
895            let mut file = std::fs::File::create(&temp_path)?;
896            file.write_all(content.as_bytes())?;
897            file.sync_all()?;
898        }
899        std::fs::rename(&temp_path, &path)?;
900        tracing::info!("Session workspace saved to {:?}", path);
901        Ok(())
902    }
903
904    /// Delete workspace for a working directory
905    pub fn delete(working_dir: &Path) -> Result<(), WorkspaceError> {
906        let path = get_workspace_path(working_dir)?;
907        if path.exists() {
908            std::fs::remove_file(path)?;
909        }
910        Ok(())
911    }
912
913    /// Create a new workspace with current timestamp
914    pub fn new(working_dir: PathBuf) -> Self {
915        Self {
916            version: WORKSPACE_VERSION,
917            working_dir,
918            split_layout: SerializedSplitNode::Leaf {
919                file_path: None,
920                split_id: 0,
921                label: None,
922                unnamed_recovery_id: None,
923                role: None,
924            },
925            active_split_id: 0,
926            split_states: HashMap::new(),
927            config_overrides: WorkspaceConfigOverrides::default(),
928            file_explorer: FileExplorerState::default(),
929            histories: WorkspaceHistories::default(),
930            search_options: SearchOptions::default(),
931            bookmarks: HashMap::new(),
932            terminals: Vec::new(),
933            external_files: Vec::new(),
934            read_only_files: Vec::new(),
935            unnamed_buffers: Vec::new(),
936            plugin_global_state: HashMap::new(),
937            saved_at: SystemTime::now()
938                .duration_since(UNIX_EPOCH)
939                .unwrap_or_default()
940                .as_secs(),
941        }
942    }
943
944    /// Update the saved_at timestamp to now
945    pub fn touch(&mut self) {
946        self.saved_at = SystemTime::now()
947            .duration_since(UNIX_EPOCH)
948            .unwrap_or_default()
949            .as_secs();
950    }
951}
952
953#[cfg(test)]
954mod tests {
955    use super::*;
956
957    #[test]
958    fn test_workspace_path_percent_encoding() {
959        // Test basic path encoding - readable with underscores for separators
960        let encoded = encode_path_for_filename(Path::new("/home/user/project"));
961        assert_eq!(encoded, "home_user_project");
962        assert!(!encoded.contains('/')); // No slashes in encoded output
963
964        // Round-trip: encode then decode should give original path
965        let decoded = decode_filename_to_path(&encoded).unwrap();
966        assert_eq!(decoded, PathBuf::from("/home/user/project"));
967
968        // Different paths should give different encodings
969        let path1 = get_workspace_path(Path::new("/home/user/project")).unwrap();
970        let path2 = get_workspace_path(Path::new("/home/user/other")).unwrap();
971        assert_ne!(path1, path2);
972
973        // Same path should give same encoding
974        let path1_again = get_workspace_path(Path::new("/home/user/project")).unwrap();
975        assert_eq!(path1, path1_again);
976
977        // Filename should end with .json and be readable
978        let filename = path1.file_name().unwrap().to_str().unwrap();
979        assert!(filename.ends_with(".json"));
980        assert!(filename.starts_with("home_user_project"));
981    }
982
983    #[test]
984    fn test_percent_encoding_edge_cases() {
985        // Path with dashes (should pass through)
986        let encoded = encode_path_for_filename(Path::new("/home/user/my-project"));
987        assert_eq!(encoded, "home_user_my-project");
988
989        // Path with spaces (percent-encoded)
990        let encoded = encode_path_for_filename(Path::new("/home/user/my project"));
991        assert_eq!(encoded, "home_user_my%20project");
992        let decoded = decode_filename_to_path(&encoded).unwrap();
993        assert_eq!(decoded, PathBuf::from("/home/user/my project"));
994
995        // Path with underscores (percent-encoded to avoid collision with /)
996        let encoded = encode_path_for_filename(Path::new("/home/user/my_project"));
997        assert_eq!(encoded, "home_user_my%5Fproject");
998        let decoded = decode_filename_to_path(&encoded).unwrap();
999        assert_eq!(decoded, PathBuf::from("/home/user/my_project"));
1000
1001        // Root path
1002        let encoded = encode_path_for_filename(Path::new("/"));
1003        assert_eq!(encoded, "root");
1004    }
1005
1006    #[test]
1007    fn test_workspace_serialization() {
1008        let workspace = Workspace::new(PathBuf::from("/home/user/test"));
1009        let json = serde_json::to_string(&workspace).unwrap();
1010        let restored: Workspace = serde_json::from_str(&json).unwrap();
1011
1012        assert_eq!(workspace.version, restored.version);
1013        assert_eq!(workspace.working_dir, restored.working_dir);
1014    }
1015
1016    #[test]
1017    fn test_workspace_config_overrides_skip_none() {
1018        let overrides = WorkspaceConfigOverrides::default();
1019        let json = serde_json::to_string(&overrides).unwrap();
1020
1021        // Empty overrides should serialize to empty object
1022        assert_eq!(json, "{}");
1023    }
1024
1025    #[test]
1026    fn test_workspace_config_overrides_with_values() {
1027        let overrides = WorkspaceConfigOverrides {
1028            line_wrap: Some(false),
1029            ..Default::default()
1030        };
1031        let json = serde_json::to_string(&overrides).unwrap();
1032
1033        assert!(json.contains("line_wrap"));
1034        assert!(!json.contains("line_numbers")); // None values skipped
1035    }
1036
1037    #[test]
1038    fn test_split_layout_serialization() {
1039        // Create a nested split layout
1040        let layout = SerializedSplitNode::Split {
1041            direction: SerializedSplitDirection::Vertical,
1042            first: Box::new(SerializedSplitNode::Leaf {
1043                file_path: Some(PathBuf::from("src/main.rs")),
1044                split_id: 1,
1045                label: None,
1046                unnamed_recovery_id: None,
1047                role: None,
1048            }),
1049            second: Box::new(SerializedSplitNode::Leaf {
1050                file_path: Some(PathBuf::from("src/lib.rs")),
1051                split_id: 2,
1052                label: None,
1053                unnamed_recovery_id: None,
1054                role: None,
1055            }),
1056            ratio: 0.5,
1057            split_id: 0,
1058        };
1059
1060        let json = serde_json::to_string(&layout).unwrap();
1061        let restored: SerializedSplitNode = serde_json::from_str(&json).unwrap();
1062
1063        // Verify the restored layout matches
1064        match restored {
1065            SerializedSplitNode::Split {
1066                direction,
1067                ratio,
1068                split_id,
1069                ..
1070            } => {
1071                assert!(matches!(direction, SerializedSplitDirection::Vertical));
1072                assert_eq!(ratio, 0.5);
1073                assert_eq!(split_id, 0);
1074            }
1075            _ => panic!("Expected Split node"),
1076        }
1077    }
1078
1079    #[test]
1080    fn test_file_state_serialization() {
1081        let file_state = SerializedFileState {
1082            cursor: SerializedCursor {
1083                position: 1234,
1084                anchor: Some(1000),
1085                sticky_column: 15,
1086            },
1087            additional_cursors: vec![SerializedCursor {
1088                position: 5000,
1089                anchor: None,
1090                sticky_column: 0,
1091            }],
1092            scroll: SerializedScroll {
1093                top_byte: 500,
1094                top_view_line_offset: 2,
1095                left_column: 10,
1096            },
1097            view_mode: SerializedViewMode::Source,
1098            compose_width: None,
1099            plugin_state: HashMap::new(),
1100            folds: Vec::new(),
1101        };
1102
1103        let json = serde_json::to_string(&file_state).unwrap();
1104        let restored: SerializedFileState = serde_json::from_str(&json).unwrap();
1105
1106        assert_eq!(restored.cursor.position, 1234);
1107        assert_eq!(restored.cursor.anchor, Some(1000));
1108        assert_eq!(restored.cursor.sticky_column, 15);
1109        assert_eq!(restored.additional_cursors.len(), 1);
1110        assert_eq!(restored.scroll.top_byte, 500);
1111        assert_eq!(restored.scroll.left_column, 10);
1112    }
1113
1114    #[test]
1115    fn test_bookmark_serialization() {
1116        let mut bookmarks = HashMap::new();
1117        bookmarks.insert(
1118            'a',
1119            SerializedBookmark {
1120                file_path: PathBuf::from("src/main.rs"),
1121                position: 1234,
1122            },
1123        );
1124        bookmarks.insert(
1125            'b',
1126            SerializedBookmark {
1127                file_path: PathBuf::from("src/lib.rs"),
1128                position: 5678,
1129            },
1130        );
1131
1132        let json = serde_json::to_string(&bookmarks).unwrap();
1133        let restored: HashMap<char, SerializedBookmark> = serde_json::from_str(&json).unwrap();
1134
1135        assert_eq!(restored.len(), 2);
1136        assert_eq!(restored.get(&'a').unwrap().position, 1234);
1137        assert_eq!(
1138            restored.get(&'b').unwrap().file_path,
1139            PathBuf::from("src/lib.rs")
1140        );
1141    }
1142
1143    #[test]
1144    fn test_search_options_serialization() {
1145        let options = SearchOptions {
1146            case_sensitive: true,
1147            whole_word: true,
1148            use_regex: false,
1149            confirm_each: true,
1150        };
1151
1152        let json = serde_json::to_string(&options).unwrap();
1153        let restored: SearchOptions = serde_json::from_str(&json).unwrap();
1154
1155        assert!(restored.case_sensitive);
1156        assert!(restored.whole_word);
1157        assert!(!restored.use_regex);
1158        assert!(restored.confirm_each);
1159    }
1160
1161    #[test]
1162    fn test_full_workspace_round_trip() {
1163        let mut workspace = Workspace::new(PathBuf::from("/home/user/myproject"));
1164
1165        // Configure split layout
1166        workspace.split_layout = SerializedSplitNode::Split {
1167            direction: SerializedSplitDirection::Horizontal,
1168            first: Box::new(SerializedSplitNode::Leaf {
1169                file_path: Some(PathBuf::from("README.md")),
1170                split_id: 1,
1171                label: None,
1172                unnamed_recovery_id: None,
1173                role: None,
1174            }),
1175            second: Box::new(SerializedSplitNode::Leaf {
1176                file_path: Some(PathBuf::from("Cargo.toml")),
1177                split_id: 2,
1178                label: None,
1179                unnamed_recovery_id: None,
1180                role: None,
1181            }),
1182            ratio: 0.6,
1183            split_id: 0,
1184        };
1185        workspace.active_split_id = 1;
1186
1187        // Add split state
1188        workspace.split_states.insert(
1189            1,
1190            SerializedSplitViewState {
1191                open_tabs: vec![
1192                    SerializedTabRef::File(PathBuf::from("README.md")),
1193                    SerializedTabRef::File(PathBuf::from("src/lib.rs")),
1194                ],
1195                active_tab_index: Some(0),
1196                open_files: vec![PathBuf::from("README.md"), PathBuf::from("src/lib.rs")],
1197                active_file_index: 0,
1198                file_states: HashMap::new(),
1199                tab_scroll_offset: 0,
1200                view_mode: SerializedViewMode::Source,
1201                compose_width: None,
1202            },
1203        );
1204
1205        // Add bookmarks
1206        workspace.bookmarks.insert(
1207            'm',
1208            SerializedBookmark {
1209                file_path: PathBuf::from("src/main.rs"),
1210                position: 100,
1211            },
1212        );
1213
1214        // Set search options
1215        workspace.search_options.case_sensitive = true;
1216        workspace.search_options.use_regex = true;
1217
1218        // Serialize and deserialize
1219        let json = serde_json::to_string_pretty(&workspace).unwrap();
1220        let restored: Workspace = serde_json::from_str(&json).unwrap();
1221
1222        // Verify everything matches
1223        assert_eq!(restored.version, WORKSPACE_VERSION);
1224        assert_eq!(restored.working_dir, PathBuf::from("/home/user/myproject"));
1225        assert_eq!(restored.active_split_id, 1);
1226        assert!(restored.bookmarks.contains_key(&'m'));
1227        assert!(restored.search_options.case_sensitive);
1228        assert!(restored.search_options.use_regex);
1229
1230        // Verify split state
1231        let split_state = restored.split_states.get(&1).unwrap();
1232        assert_eq!(split_state.open_files.len(), 2);
1233        assert_eq!(split_state.open_files[0], PathBuf::from("README.md"));
1234    }
1235
1236    #[test]
1237    fn test_workspace_file_save_load() {
1238        use std::fs;
1239
1240        // Create a temporary directory for testing
1241        let temp_dir = std::env::temp_dir().join("fresh_workspace_test");
1242        drop(fs::remove_dir_all(&temp_dir)); // Clean up from previous runs
1243        fs::create_dir_all(&temp_dir).unwrap();
1244
1245        let workspace_path = temp_dir.join("test_workspace.json");
1246
1247        // Create a workspace
1248        let mut workspace = Workspace::new(temp_dir.clone());
1249        workspace.search_options.case_sensitive = true;
1250        workspace.bookmarks.insert(
1251            'x',
1252            SerializedBookmark {
1253                file_path: PathBuf::from("test.txt"),
1254                position: 42,
1255            },
1256        );
1257
1258        // Save it directly to test path
1259        let content = serde_json::to_string_pretty(&workspace).unwrap();
1260        let temp_path = workspace_path.with_extension("json.tmp");
1261        let mut file = std::fs::File::create(&temp_path).unwrap();
1262        std::io::Write::write_all(&mut file, content.as_bytes()).unwrap();
1263        file.sync_all().unwrap();
1264        std::fs::rename(&temp_path, &workspace_path).unwrap();
1265
1266        // Load it back
1267        let loaded_content = fs::read_to_string(&workspace_path).unwrap();
1268        let loaded: Workspace = serde_json::from_str(&loaded_content).unwrap();
1269
1270        // Verify
1271        assert_eq!(loaded.working_dir, temp_dir);
1272        assert!(loaded.search_options.case_sensitive);
1273        assert_eq!(loaded.bookmarks.get(&'x').unwrap().position, 42);
1274
1275        // Cleanup
1276        drop(fs::remove_dir_all(&temp_dir));
1277    }
1278
1279    #[test]
1280    fn test_workspace_version_check() {
1281        let workspace = Workspace::new(PathBuf::from("/test"));
1282        assert_eq!(workspace.version, WORKSPACE_VERSION);
1283
1284        // Serialize with a future version number
1285        let mut json_value: serde_json::Value = serde_json::to_value(&workspace).unwrap();
1286        json_value["version"] = serde_json::json!(999);
1287
1288        let json = serde_json::to_string(&json_value).unwrap();
1289        let restored: Workspace = serde_json::from_str(&json).unwrap();
1290
1291        // Should still deserialize, but version is 999
1292        assert_eq!(restored.version, 999);
1293    }
1294
1295    #[test]
1296    fn test_empty_workspace_histories() {
1297        let histories = WorkspaceHistories::default();
1298        let json = serde_json::to_string(&histories).unwrap();
1299
1300        // Empty histories should serialize to empty object (due to skip_serializing_if)
1301        assert_eq!(json, "{}");
1302
1303        // But should deserialize back correctly
1304        let restored: WorkspaceHistories = serde_json::from_str(&json).unwrap();
1305        assert!(restored.search.is_empty());
1306        assert!(restored.replace.is_empty());
1307    }
1308
1309    #[test]
1310    fn test_file_explorer_state_percent_round_trip() {
1311        let state = FileExplorerState {
1312            visible: true,
1313            width: crate::config::ExplorerWidth::Percent(25),
1314            side: crate::config::FileExplorerSide::Left,
1315            expanded_dirs: vec![
1316                PathBuf::from("src"),
1317                PathBuf::from("src/app"),
1318                PathBuf::from("tests"),
1319            ],
1320            scroll_offset: 5,
1321            show_hidden: true,
1322            show_gitignored: false,
1323        };
1324
1325        let json = serde_json::to_string(&state).unwrap();
1326        let restored: FileExplorerState = serde_json::from_str(&json).unwrap();
1327
1328        assert!(restored.visible);
1329        assert_eq!(restored.width, crate::config::ExplorerWidth::Percent(25));
1330        assert_eq!(restored.expanded_dirs.len(), 3);
1331        assert_eq!(restored.scroll_offset, 5);
1332        assert!(restored.show_hidden);
1333        assert!(!restored.show_gitignored);
1334    }
1335
1336    #[test]
1337    fn test_file_explorer_state_columns_round_trip() {
1338        let state = FileExplorerState {
1339            visible: true,
1340            width: crate::config::ExplorerWidth::Columns(42),
1341            side: crate::config::FileExplorerSide::Left,
1342            expanded_dirs: vec![],
1343            scroll_offset: 0,
1344            show_hidden: false,
1345            show_gitignored: false,
1346        };
1347        let json = serde_json::to_string(&state).unwrap();
1348        let restored: FileExplorerState = serde_json::from_str(&json).unwrap();
1349        assert_eq!(restored.width, crate::config::ExplorerWidth::Columns(42));
1350    }
1351
1352    /// Legacy workspace files named the field `width_percent` and
1353    /// stored the value as a float fraction in `0.0..=1.0`. Both must
1354    /// still load (via serde `alias` and the `ExplorerWidth`
1355    /// deserializer).
1356    #[test]
1357    fn test_file_explorer_state_legacy_width_percent_alias() {
1358        let json = r#"{
1359            "visible": true,
1360            "width_percent": 0.3,
1361            "expanded_dirs": [],
1362            "scroll_offset": 0,
1363            "show_hidden": false,
1364            "show_gitignored": false
1365        }"#;
1366        let restored: FileExplorerState = serde_json::from_str(json).unwrap();
1367        assert_eq!(restored.width, crate::config::ExplorerWidth::Percent(30));
1368    }
1369}