endringer_core/

backend.rs

//! The [`VcsBackend`] trait that all VCS backends implement.
//!
//! This trait is `pub` so that downstream crates can implement custom
//! backends and inject them via [`endringer::repository::Repository::with_backend`].
//!
//! # Stability
//!
//! **Before v1.0, this trait is implementable but not fully stable.**
//! New required methods may still be added; however, any method that has a
//! truthful default implementation will be given one, so that adding it does
//! not break existing custom backends. Methods without a default are the
//! *required core methods* listed first in the trait below.
//!
//! Consumers that depend only on [`endringer::repository::Repository`]
//! receive stronger stability guarantees than consumers that implement
//! `VcsBackend` directly.
//!
//! # Method categories
//!
//! | Category | Default | Notes |
//! |---|---|---|
//! | Required core | none | must be implemented; no safe default exists |
//! | Optional-empty | `Ok(vec![])` or `None` | backend may have no such data |
//! | Write-side exception | unsupported error | tags are the only in-scope writes |

use std::time::SystemTime;

use crate::error::Result;
use crate::types::{
    AheadBehind, BlameEntry, BranchInfo, BranchTrackingInfo, CommitId, CommitInfo,
    CommitQuery, CommitQueryResult,
    ConflictSummary, DiffEntry, DiffOptions, DiffSummary,
    OperationState, RefInfo, RefKind, RemoteInfo,
    RepositoryInfo, RepositorySnapshot, RichWorktreeStatus, SnapshotRequest,
    SortOrder, StashDetail, StashEntry, StatusDigest, StatusOptions,
    SubmoduleInfo, SubmoduleSummary, TagInfo, TreeEntry,
    WorktreeDetail, WorktreeInfo, WorktreeStatus,
};

/// Common interface implemented by every VCS backend.
///
/// All methods take `&self` and are safe to call concurrently from multiple
/// threads (`Send + Sync` bound).
///
/// See the [module documentation][self] for the stability policy and method
/// classification.
pub trait VcsBackend: Send + Sync {
    // ── Required core methods ──────────────────────────────────────────── //
    //
    // No defaults: a safe stand-in would be misleading or wrong.

    fn status_digest(&self) -> Result<StatusDigest>;

    fn local_branches(&self) -> Result<Vec<BranchInfo>>;
    fn remote_branches(&self) -> Result<Vec<BranchInfo>>;

    fn list_commits(&self) -> Result<Vec<CommitInfo>>;
    fn list_commits_sorted(&self, order: SortOrder) -> Result<Vec<CommitInfo>>;
    fn log_since(&self, since: SystemTime, until: SystemTime) -> Result<Vec<CommitInfo>>;
    fn find_commit(&self, id: &CommitId) -> Result<CommitInfo>;

    /// Returns a bounded page of commit history according to `query`.
    ///
    /// `CommitQueryResult::truncated` is `true` when `max_count` was reached
    /// and more commits may exist beyond the page.
    ///
    /// Default: unsupported-feature error.
    fn query_commits(&self, _query: CommitQuery) -> Result<CommitQueryResult> {
        Err(crate::error::Error::UnsupportedBackendFeature { backend: None, feature: "query_commits" })
    }

    fn list_tags(&self) -> Result<Vec<TagInfo>>;
    fn list_tags_sorted(&self, order: SortOrder) -> Result<Vec<TagInfo>>;

    fn diff(&self, from: &CommitId, to: &CommitId) -> Result<DiffSummary>;

    /// Returns `true` if the working tree has any uncommitted changes
    /// (staged or unstaged). Bare repositories always return `false`.
    fn is_dirty(&self) -> Result<bool>;

    /// Returns the best common ancestor of `a` and `b`, or `None` if there
    /// is no shared history (unrelated histories).
    fn merge_base(&self, a: &CommitId, b: &CommitId) -> Result<Option<CommitId>>;

    /// Returns `true` if `candidate` is a direct or transitive ancestor of
    /// `descendant`. A commit is considered its own ancestor.
    fn is_ancestor(&self, candidate: &CommitId, descendant: &CommitId) -> Result<bool>;

    /// Returns per-line commit attribution for `path` at HEAD.
    ///
    /// `path` is relative to the repository root.
    /// Entries are in ascending line order.
    fn blame(&self, path: &std::path::Path) -> Result<Vec<BlameEntry>>;

    /// Returns per-file working-tree status: staged changes, unstaged
    /// changes, and untracked files (with gitignore applied).
    fn worktree_status(&self) -> Result<WorktreeStatus>;

    /// Returns a richer working-tree status with more file-level change kinds.
    ///
    /// Default: unsupported-feature error.
    fn rich_worktree_status(&self, _options: StatusOptions) -> Result<RichWorktreeStatus> {
        Err(crate::error::Error::UnsupportedBackendFeature { backend: None, feature: "rich_worktree_status" })
    }

    /// Returns the raw bytes of `path` (relative to the repository root)
    /// as it exists in the tree of `commit_id`.
    fn file_at_commit(&self, path: &std::path::Path, commit_id: &CommitId) -> Result<Vec<u8>>;

    /// Returns ahead/behind counts between `local` and `upstream` commit tips.
    ///
    /// See [`AheadBehind`] for the full contract and edge cases.
    fn ahead_behind(&self, local: &CommitId, upstream: &CommitId) -> Result<AheadBehind>;

    /// Returns a lightweight metadata snapshot of the repository.
    ///
    /// Includes backend kind, working tree path, HEAD state, object format,
    /// and backend capabilities. All fields are a fresh read; this is not a
    /// subscription.
    fn repository_info(&self) -> Result<RepositoryInfo>;

    // ── Optional-empty methods ─────────────────────────────────────────── //
    //
    // Returning empty is semantically valid when the backend has no such data.

    /// Returns the fetch URL of the named remote, or `Ok(None)` if not configured.
    ///
    /// Returns `Err` only on an actual I/O or config parsing failure.
    ///
    /// Default: `Ok(None)`.
    fn remote_url(&self, _name: &str) -> Result<Option<String>> {
        Ok(None)
    }

    /// Returns metadata for all submodules declared in `.gitmodules`.
    ///
    /// Default: empty `Vec`.
    fn submodules(&self) -> Result<Vec<SubmoduleInfo>> {
        Ok(Vec::new())
    }

    /// Returns all stash entries, newest first.
    ///
    /// Default: empty `Vec`.
    fn stash_entries(&self) -> Result<Vec<StashEntry>> {
        Ok(Vec::new())
    }

    /// Returns all linked worktrees. The main worktree is not included.
    ///
    /// Default: empty `Vec`.
    fn worktrees(&self) -> Result<Vec<WorktreeInfo>> {
        Ok(Vec::new())
    }

    // ── Write-side exception methods ───────────────────────────────────── //
    //
    // Tags are the only in-scope writes. Custom backends that do not support
    // tag operations receive unsupported-feature errors by default.

    /// Creates a lightweight tag at HEAD.
    ///
    /// Default: unsupported-feature error.
    fn create_tag(&self, _name: &str) -> Result<()> {
        return Err(crate::error::Error::UnsupportedBackendFeature { backend: None, feature: "create_tag" })
    }

    /// Creates an annotated tag at HEAD.
    ///
    /// Requires `user.name` and `user.email` in git config. On the jj
    /// backend this returns an unsupported error; use
    /// [`create_tag`][VcsBackend::create_tag] instead.
    ///
    /// Default: unsupported-feature error.
    fn create_annotated_tag(&self, _name: &str, _message: &str) -> Result<()> {
        return Err(crate::error::Error::UnsupportedBackendFeature { backend: None, feature: "create_annotated_tag" })
    }

    /// Deletes the named tag.
    ///
    /// Default: unsupported-feature error.
    fn delete_tag(&self, _name: &str) -> Result<()> {
        return Err(crate::error::Error::UnsupportedBackendFeature { backend: None, feature: "delete_tag" })
    }

    // ── Optional-unsupported methods ───────────────────────────────────── //
    //
    // These have a truthful default but backends should override where possible.

    /// Returns tracking metadata and divergence data for `branch`.
    ///
    /// Default: unsupported-feature error.
    fn branch_tracking(&self, _branch: &str) -> Result<BranchTrackingInfo> {
        return Err(crate::error::Error::UnsupportedBackendFeature { backend: None, feature: "branch_tracking" })
    }

    /// Returns tracking metadata for all local branches, sorted ascending
    /// by full ref name.
    ///
    /// Default: unsupported-feature error.
    fn local_branch_tracking(&self) -> Result<Vec<BranchTrackingInfo>> {
        return Err(crate::error::Error::UnsupportedBackendFeature { backend: None, feature: "local_branch_tracking" })
    }

    /// Returns `true` if `branch` has been merged into `target`.
    ///
    /// Equivalent to `is_ancestor(branch_tip, target_tip)` but with named
    /// branches, preventing callers from accidentally reversing the arguments.
    ///
    /// Default: unsupported-feature error.
    fn is_merged_into(&self, _branch: &str, _target: &str) -> Result<bool> {
        Err(crate::error::Error::UnsupportedBackendFeature {
            backend: None,
            feature: "is_merged_into",
        })
    }

    /// Returns ahead/behind counts for the configured upstream of `branch`.
    ///
    /// Returns `Ok(None)` when the branch has no configured upstream.
    /// Returns an error when the configured upstream ref no longer exists
    /// locally.
    ///
    /// Default: unsupported-feature error.
    fn branch_ahead_behind(&self, _branch: &str) -> Result<Option<AheadBehind>> {
        return Err(crate::error::Error::UnsupportedBackendFeature { backend: None, feature: "branch_ahead_behind" })
    }

    // ── Operation and conflict state (RFC 008) ─────────────────────────── //

    /// Returns the current in-progress repository operation, if any.
    ///
    /// Reads Git marker files (`MERGE_HEAD`, `rebase-merge/`, `rebase-apply/`,
    /// `CHERRY_PICK_HEAD`, `REVERT_HEAD`, `BISECT_LOG`, `refs/bisect/`).
    ///
    /// Returns `Ok(OperationState::None)` when no operation is in progress.
    ///
    /// Default: unsupported-feature error.
    fn operation_state(&self) -> Result<OperationState> {
        Err(crate::error::Error::UnsupportedBackendFeature { backend: None, feature: "operation_state" })
    }

    /// Returns paths with unmerged (higher-stage) index entries.
    ///
    /// Returns a sorted, deduplicated list. Empty when no conflicts exist.
    ///
    /// Default: unsupported-feature error.
    fn unmerged_paths(&self) -> Result<Vec<std::path::PathBuf>> {
        Err(crate::error::Error::UnsupportedBackendFeature { backend: None, feature: "unmerged_paths" })
    }

    /// Returns a structured summary of all conflicted index entries.
    ///
    /// Includes per-stage object IDs. For a lighter-weight check,
    /// prefer [`unmerged_paths`][Self::unmerged_paths].
    ///
    /// Default: unsupported-feature error.
    fn conflict_summary(&self) -> Result<ConflictSummary> {
        Err(crate::error::Error::UnsupportedBackendFeature { backend: None, feature: "conflict_summary" })
    }

    // ── Point-in-time reads (RFC 010) ──────────────────────────────────── //

    /// Per-line commit attribution for `path` at `commit_id` (not HEAD).
    ///
    /// Default: unsupported-feature error.
    fn blame_at(&self, _path: &std::path::Path, _commit_id: &CommitId) -> Result<Vec<BlameEntry>> {
        Err(crate::error::Error::UnsupportedBackendFeature { backend: None, feature: "blame_at" })
    }

    /// Non-recursive root-level tree listing at `commit_id`, sorted ascending by name.
    ///
    /// Default: unsupported-feature error.
    fn tree_at_commit(&self, _commit_id: &CommitId) -> Result<Vec<TreeEntry>> {
        Err(crate::error::Error::UnsupportedBackendFeature { backend: None, feature: "tree_at_commit" })
    }

    /// Non-recursive tree listing of the directory at `path` within `commit_id`.
    ///
    /// Returns `Err(PathNotFound)` if `path` does not exist or is not a directory.
    /// Entries sorted ascending by name.
    ///
    /// Default: unsupported-feature error.
    fn tree_at_path(&self, _commit_id: &CommitId, _path: &std::path::Path) -> Result<Vec<TreeEntry>> {
        Err(crate::error::Error::UnsupportedBackendFeature { backend: None, feature: "tree_at_path" })
    }

    // ── Remote and reference inventory (RFC 011) ──────────────────────── //

    /// Returns all configured remotes, sorted ascending by name.
    ///
    /// Default: unsupported-feature error.
    fn remotes(&self) -> Result<Vec<RemoteInfo>> {
        Err(crate::error::Error::UnsupportedBackendFeature { backend: None, feature: "remotes" })
    }

    /// Returns all references, sorted ascending by full name.
    ///
    /// Default: unsupported-feature error.
    fn references(&self) -> Result<Vec<RefInfo>> {
        Err(crate::error::Error::UnsupportedBackendFeature { backend: None, feature: "references" })
    }

    /// Returns references matching `kind`, sorted ascending by full name.
    ///
    /// Default: unsupported-feature error.
    fn references_by_kind(&self, _kind: RefKind) -> Result<Vec<RefInfo>> {
        Err(crate::error::Error::UnsupportedBackendFeature { backend: None, feature: "references_by_kind" })
    }

    // ── Submodule detail (RFC 019) ─────────────────────────────────────── //

    /// Returns rich metadata for each submodule, including initialization
    /// and sync state. More expensive than [`submodules`][Self::submodules].
    /// Sorted ascending by path.
    ///
    /// Default: unsupported-feature error.
    fn submodule_summaries(&self) -> Result<Vec<SubmoduleSummary>> {
        Err(crate::error::Error::UnsupportedBackendFeature { backend: None, feature: "submodule_summaries" })
    }

    // ── Stash detail (RFC 020) ─────────────────────────────────────────── //

    /// Returns detailed metadata for the stash entry at `index`.
    ///
    /// Default: unsupported-feature error.
    fn stash_detail(&self, _index: usize) -> Result<StashDetail> {
        Err(crate::error::Error::UnsupportedBackendFeature { backend: None, feature: "stash_detail" })
    }

    /// Returns a diff summary for the stash at `index` vs its first parent.
    ///
    /// Default: unsupported-feature error.
    fn stash_diff(&self, _index: usize) -> Result<DiffSummary> {
        Err(crate::error::Error::UnsupportedBackendFeature { backend: None, feature: "stash_diff" })
    }

    // ── Worktree detail (RFC 021) ──────────────────────────────────────── //

    /// Returns rich detail for all linked worktrees, sorted by id.
    /// Missing worktrees are reported as `WorktreeState::MissingPath` rather
    /// than omitted.
    ///
    /// Default: unsupported-feature error.
    fn worktree_details(&self) -> Result<Vec<WorktreeDetail>> {
        Err(crate::error::Error::UnsupportedBackendFeature { backend: None, feature: "worktree_details" })
    }

    // ── Snapshot batch read (RFC 027) ──────────────────────────────────── //

    /// Returns a batch of related reads collected in one method call.
    ///
    /// Reduces inter-call drift for status-widget data. Not an atomic
    /// snapshot — concurrent mutation can still produce a mixed view.
    ///
    /// Default: calls each included method sequentially.
    fn snapshot(&self, request: SnapshotRequest) -> Result<RepositorySnapshot> {
        let info = self.repository_info()?;
        let status_digest = if request.include_status_digest {
            Some(self.status_digest()?)
        } else { None };
        let operation_state = if request.include_operation_state {
            self.operation_state().ok()
        } else { None };
        let local_branches = if request.include_local_branches {
            Some(self.local_branches()?)
        } else { None };
        let tags = if request.include_tags {
            Some(self.list_tags()?)
        } else { None };
        Ok(RepositorySnapshot { info, status_digest, operation_state, local_branches, tags })
    }

    // ── Rename/copy-aware diff (RFC 028) ──────────────────────────────── //

    /// Returns a rename/copy-aware diff between `from` and `to`.
    ///
    /// When `options.detect_renames` is `false` (default), the result is
    /// equivalent to `diff()` expressed as `DiffEntry` values. Rename
    /// detection is opt-in because it can be expensive.
    ///
    /// Default: unsupported-feature error.
    fn diff_entries(
        &self,
        _from: &CommitId,
        _to: &CommitId,
        _options: DiffOptions,
    ) -> Result<Vec<DiffEntry>> {
        Err(crate::error::Error::UnsupportedBackendFeature { backend: None, feature: "diff_entries" })
    }
}