use crate::GitHostingProviderRegistry;use crate::{blame::Blame, status::GitStatus};use anyhow::{Context, Result};use collections::HashMap;use git2::BranchType;use parking_lot::Mutex;use rope::Rope;use serde::{Deserialize, Serialize};use std::{ cmp::Ordering, path::{Component, Path, PathBuf}, sync::Arc,};use sum_tree::MapSeekTarget;use util::ResultExt; #[derive(Clone, Debug, Hash, PartialEq)]pub struct Branch { pub is_head: bool, pub name: Box<str>, /// Timestamp of most recent commit, normalized to Unix Epoch format. pub unix_timestamp: Option<i64>,} pub trait GitRepository: Send + Sync { fn reload_index(&self); /// Loads a git repository entry's contents. /// Note that for symlink entries, this will return the contents of the symlink, not the target. fn load_index_text(&self, relative_file_path: &Path) -> Option<String>; /// Returns the URL of the remote with the given name. fn remote_url(&self, name: &str) -> Option<String>; fn branch_name(&self) -> Option<String>; /// Returns the SHA of the current HEAD. fn head_sha(&self) -> Option<String>; fn statuses(&self, path_prefix: &Path) -> Result<GitStatus>; fn status(&self, path: &Path) -> Option<GitFileStatus> { Some(self.statuses(path).ok()?.entries.first()?.1) } fn branches(&self) -> Result<Vec<Branch>>; fn change_branch(&self, _: &str) -> Result<()>; fn create_branch(&self, _: &str) -> Result<()>; fn blame(&self, path: &Path, content: Rope) -> Result<crate::blame::Blame>;} impl std::fmt::Debug for dyn GitRepository { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { f.debug_struct("dyn GitRepository<...>").finish() }} pub struct RealGitRepository { pub repository: Mutex<git2::Repository>, pub git_binary_path: PathBuf, hosting_provider_registry: Arc<GitHostingProviderRegistry>,} impl RealGitRepository { pub fn new( repository: git2::Repository, git_binary_path: Option<PathBuf>, hosting_provider_registry: Arc<GitHostingProviderRegistry>, ) -> Self { Self { repository: Mutex::new(repository), git_binary_path: git_binary_path.unwrap_or_else(|| PathBuf::from("git")), hosting_provider_registry, } }} impl GitRepository for RealGitRepository { fn reload_index(&self) { if let Ok(mut index) = self.repository.lock().index() { _ = index.read(false); } } fn load_index_text(&self, relative_file_path: &Path) -> Option<String> { fn logic(repo: &git2::Repository, relative_file_path: &Path) -> Result<Option<String>> { const STAGE_NORMAL: i32 = 0; let index = repo.index()?; // This check is required because index.get_path() unwraps internally :( check_path_to_repo_path_errors(relative_file_path)?; let oid = match index.get_path(relative_file_path, STAGE_NORMAL) { Some(entry) => entry.id, None => return Ok(None), }; let content = repo.find_blob(oid)?.content().to_owned(); Ok(Some(String::from_utf8(content)?)) } match logic(&self.repository.lock(), relative_file_path) { Ok(value) => return value, Err(err) => log::error!("Error loading head text: {:?}", err), } None } fn remote_url(&self, name: &str) -> Option<String> { let repo = self.repository.lock(); let remote = repo.find_remote(name).ok()?; remote.url().map(|url| url.to_string()) } fn branch_name(&self) -> Option<String> { let repo = self.repository.lock(); let head = repo.head().log_err()?; let branch = String::from_utf8_lossy(head.shorthand_bytes()); Some(branch.to_string()) } fn head_sha(&self) -> Option<String> { Some(self.repository.lock().head().ok()?.target()?.to_string()) } fn statuses(&self, path_prefix: &Path) -> Result<GitStatus> { let working_directory = self .repository .lock() .workdir() .context("failed to read git work directory")? .to_path_buf(); GitStatus::new(&self.git_binary_path, &working_directory, path_prefix) } fn branches(&self) -> Result<Vec<Branch>> { let repo = self.repository.lock(); let local_branches = repo.branches(Some(BranchType::Local))?; let valid_branches = local_branches .filter_map(|branch| { branch.ok().and_then(|(branch, _)| { let is_head = branch.is_head(); let name = branch.name().ok().flatten().map(Box::from)?; let timestamp = branch.get().peel_to_commit().ok()?.time(); let unix_timestamp = timestamp.seconds(); let timezone_offset = timestamp.offset_minutes(); let utc_offset = time::UtcOffset::from_whole_seconds(timezone_offset * 60).ok()?; let unix_timestamp = time::OffsetDateTime::from_unix_timestamp(unix_timestamp).ok()?; Some(Branch { is_head, name, unix_timestamp: Some(unix_timestamp.to_offset(utc_offset).unix_timestamp()), }) }) }) .collect(); Ok(valid_branches) } fn change_branch(&self, name: &str) -> Result<()> { let repo = self.repository.lock(); let revision = repo.find_branch(name, BranchType::Local)?; let revision = revision.get(); let as_tree = revision.peel_to_tree()?; repo.checkout_tree(as_tree.as_object(), None)?; repo.set_head( revision .name() .ok_or_else(|| anyhow::anyhow!("Branch name could not be retrieved"))?, )?; Ok(()) } fn create_branch(&self, name: &str) -> Result<()> { let repo = self.repository.lock(); let current_commit = repo.head()?.peel_to_commit()?; repo.branch(name, ¤t_commit, false)?; Ok(()) } fn blame(&self, path: &Path, content: Rope) -> Result<crate::blame::Blame> { let working_directory = self .repository .lock() .workdir() .with_context(|| format!("failed to get git working directory for file {:?}", path))? .to_path_buf(); const REMOTE_NAME: &str = "origin"; let remote_url = self.remote_url(REMOTE_NAME); crate::blame::Blame::for_path( &self.git_binary_path, &working_directory, path, &content, remote_url, self.hosting_provider_registry.clone(), ) }} #[derive(Debug, Clone, Default)]pub struct FakeGitRepository { state: Arc<Mutex<FakeGitRepositoryState>>,} #[derive(Debug, Clone, Default)]pub struct FakeGitRepositoryState { pub index_contents: HashMap<PathBuf, String>, pub blames: HashMap<PathBuf, Blame>, pub worktree_statuses: HashMap<RepoPath, GitFileStatus>, pub branch_name: Option<String>,} impl FakeGitRepository { pub fn open(state: Arc<Mutex<FakeGitRepositoryState>>) -> Arc<dyn GitRepository> { Arc::new(FakeGitRepository { state }) }} impl GitRepository for FakeGitRepository { fn reload_index(&self) {} fn load_index_text(&self, path: &Path) -> Option<String> { let state = self.state.lock(); state.index_contents.get(path).cloned() } fn remote_url(&self, _name: &str) -> Option<String> { None } fn branch_name(&self) -> Option<String> { let state = self.state.lock(); state.branch_name.clone() } fn head_sha(&self) -> Option<String> { None } fn statuses(&self, path_prefix: &Path) -> Result<GitStatus> { let state = self.state.lock(); let mut entries = state .worktree_statuses .iter() .filter_map(|(repo_path, status)| { if repo_path.0.starts_with(path_prefix) { Some((repo_path.to_owned(), *status)) } else { None } }) .collect::<Vec<_>>(); entries.sort_unstable_by(|a, b| a.0.cmp(&b.0)); Ok(GitStatus { entries: entries.into(), }) } fn branches(&self) -> Result<Vec<Branch>> { Ok(vec![]) } fn change_branch(&self, name: &str) -> Result<()> { let mut state = self.state.lock(); state.branch_name = Some(name.to_owned()); Ok(()) } fn create_branch(&self, name: &str) -> Result<()> { let mut state = self.state.lock(); state.branch_name = Some(name.to_owned()); Ok(()) } fn blame(&self, path: &Path, _content: Rope) -> Result<crate::blame::Blame> { let state = self.state.lock(); state .blames .get(path) .with_context(|| format!("failed to get blame for {:?}", path)) .cloned() }} fn check_path_to_repo_path_errors(relative_file_path: &Path) -> Result<()> { match relative_file_path.components().next() { None => anyhow::bail!("repo path should not be empty"), Some(Component::Prefix(_)) => anyhow::bail!( "repo path `{}` should be relative, not a windows prefix", relative_file_path.to_string_lossy() ), Some(Component::RootDir) => { anyhow::bail!( "repo path `{}` should be relative", relative_file_path.to_string_lossy() ) } Some(Component::CurDir) => { anyhow::bail!( "repo path `{}` should not start with `.`", relative_file_path.to_string_lossy() ) } Some(Component::ParentDir) => { anyhow::bail!( "repo path `{}` should not start with `..`", relative_file_path.to_string_lossy() ) } _ => Ok(()), }} #[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]pub enum GitFileStatus { Added, Modified, Conflict,} impl GitFileStatus { pub fn merge( this: Option<GitFileStatus>, other: Option<GitFileStatus>, prefer_other: bool, ) -> Option<GitFileStatus> { if prefer_other { return other; } match (this, other) { (Some(GitFileStatus::Conflict), _) | (_, Some(GitFileStatus::Conflict)) => { Some(GitFileStatus::Conflict) } (Some(GitFileStatus::Modified), _) | (_, Some(GitFileStatus::Modified)) => { Some(GitFileStatus::Modified) } (Some(GitFileStatus::Added), _) | (_, Some(GitFileStatus::Added)) => { Some(GitFileStatus::Added) } _ => None, } }} #[derive(Clone, Debug, Ord, Hash, PartialOrd, Eq, PartialEq)]pub struct RepoPath(pub PathBuf); impl RepoPath { pub fn new(path: PathBuf) -> Self { debug_assert!(path.is_relative(), "Repo paths must be relative"); RepoPath(path) }} impl From<&Path> for RepoPath { fn from(value: &Path) -> Self { RepoPath::new(value.to_path_buf()) }} impl From<PathBuf> for RepoPath { fn from(value: PathBuf) -> Self { RepoPath::new(value) }} impl Default for RepoPath { fn default() -> Self { RepoPath(PathBuf::new()) }} impl AsRef<Path> for RepoPath { fn as_ref(&self) -> &Path { self.0.as_ref() }} impl std::ops::Deref for RepoPath { type Target = PathBuf; fn deref(&self) -> &Self::Target { &self.0 }} #[derive(Debug)]pub struct RepoPathDescendants<'a>(pub &'a Path); impl<'a> MapSeekTarget<RepoPath> for RepoPathDescendants<'a> { fn cmp_cursor(&self, key: &RepoPath) -> Ordering { if key.starts_with(self.0) { Ordering::Greater } else { self.0.cmp(key) } }}
use crate::GitHostingProviderRegistry;
use crate::{blame::Blame, status::GitStatus};
use anyhow::{Context, Result};
use collections::HashMap;
use git2::BranchType;
use parking_lot::Mutex;
use rope::Rope;
use serde::{Deserialize, Serialize};
use std::{
cmp::Ordering,
path::{Component, Path, PathBuf},
sync::Arc,
};
use sum_tree::MapSeekTarget;
use util::ResultExt;
#[derive(Clone, Debug, Hash, PartialEq)]
pub struct Branch {
pub is_head: bool,
pub name: Box<str>,
/// Timestamp of most recent commit, normalized to Unix Epoch format.
pub unix_timestamp: Option<i64>,
}
pub trait GitRepository: Send + Sync {
fn reload_index(&self);
/// Loads a git repository entry's contents.
/// Note that for symlink entries, this will return the contents of the symlink, not the target.
fn load_index_text(&self, relative_file_path: &Path) -> Option<String>;
/// Returns the URL of the remote with the given name.
fn remote_url(&self, name: &str) -> Option<String>;
fn branch_name(&self) -> Option<String>;
/// Returns the SHA of the current HEAD.
fn head_sha(&self) -> Option<String>;
fn statuses(&self, path_prefix: &Path) -> Result<GitStatus>;
fn status(&self, path: &Path) -> Option<GitFileStatus> {
Some(self.statuses(path).ok()?.entries.first()?.1)
}
fn branches(&self) -> Result<Vec<Branch>>;
fn change_branch(&self, _: &str) -> Result<()>;
fn create_branch(&self, _: &str) -> Result<()>;
fn blame(&self, path: &Path, content: Rope) -> Result<crate::blame::Blame>;
}
impl std::fmt::Debug for dyn GitRepository {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("dyn GitRepository<...>").finish()
}
}
pub struct RealGitRepository {
pub repository: Mutex<git2::Repository>,
pub git_binary_path: PathBuf,
hosting_provider_registry: Arc<GitHostingProviderRegistry>,
}
impl RealGitRepository {
pub fn new(
repository: git2::Repository,
git_binary_path: Option<PathBuf>,
hosting_provider_registry: Arc<GitHostingProviderRegistry>,
) -> Self {
Self {
repository: Mutex::new(repository),
git_binary_path: git_binary_path.unwrap_or_else(|| PathBuf::from("git")),
hosting_provider_registry,
}
}
}
impl GitRepository for RealGitRepository {
fn reload_index(&self) {
if let Ok(mut index) = self.repository.lock().index() {
_ = index.read(false);
}
}
fn load_index_text(&self, relative_file_path: &Path) -> Option<String> {
fn logic(repo: &git2::Repository, relative_file_path: &Path) -> Result<Option<String>> {
const STAGE_NORMAL: i32 = 0;
let index = repo.index()?;
// This check is required because index.get_path() unwraps internally :(
check_path_to_repo_path_errors(relative_file_path)?;
let oid = match index.get_path(relative_file_path, STAGE_NORMAL) {
Some(entry) => entry.id,
None => return Ok(None),
};
let content = repo.find_blob(oid)?.content().to_owned();
Ok(Some(String::from_utf8(content)?))
}
match logic(&self.repository.lock(), relative_file_path) {
Ok(value) => return value,
Err(err) => log::error!("Error loading head text: {:?}", err),
}
None
}
fn remote_url(&self, name: &str) -> Option<String> {
let repo = self.repository.lock();
let remote = repo.find_remote(name).ok()?;
remote.url().map(|url| url.to_string())
}
fn branch_name(&self) -> Option<String> {
let repo = self.repository.lock();
let head = repo.head().log_err()?;
let branch = String::from_utf8_lossy(head.shorthand_bytes());
Some(branch.to_string())
}
fn head_sha(&self) -> Option<String> {
Some(self.repository.lock().head().ok()?.target()?.to_string())
}
fn statuses(&self, path_prefix: &Path) -> Result<GitStatus> {
let working_directory = self
.repository
.lock()
.workdir()
.context("failed to read git work directory")?
.to_path_buf();
GitStatus::new(&self.git_binary_path, &working_directory, path_prefix)
}
fn branches(&self) -> Result<Vec<Branch>> {
let repo = self.repository.lock();
let local_branches = repo.branches(Some(BranchType::Local))?;
let valid_branches = local_branches
.filter_map(|branch| {
branch.ok().and_then(|(branch, _)| {
let is_head = branch.is_head();
let name = branch.name().ok().flatten().map(Box::from)?;
let timestamp = branch.get().peel_to_commit().ok()?.time();
let unix_timestamp = timestamp.seconds();
let timezone_offset = timestamp.offset_minutes();
let utc_offset =
time::UtcOffset::from_whole_seconds(timezone_offset * 60).ok()?;
let unix_timestamp =
time::OffsetDateTime::from_unix_timestamp(unix_timestamp).ok()?;
Some(Branch {
is_head,
name,
unix_timestamp: Some(unix_timestamp.to_offset(utc_offset).unix_timestamp()),
})
})
})
.collect();
Ok(valid_branches)
}
fn change_branch(&self, name: &str) -> Result<()> {
let repo = self.repository.lock();
let revision = repo.find_branch(name, BranchType::Local)?;
let revision = revision.get();
let as_tree = revision.peel_to_tree()?;
repo.checkout_tree(as_tree.as_object(), None)?;
repo.set_head(
revision
.name()
.ok_or_else(|| anyhow::anyhow!("Branch name could not be retrieved"))?,
)?;
Ok(())
}
fn create_branch(&self, name: &str) -> Result<()> {
let repo = self.repository.lock();
let current_commit = repo.head()?.peel_to_commit()?;
repo.branch(name, ¤t_commit, false)?;
Ok(())
}
fn blame(&self, path: &Path, content: Rope) -> Result<crate::blame::Blame> {
let working_directory = self
.repository
.lock()
.workdir()
.with_context(|| format!("failed to get git working directory for file {:?}", path))?
.to_path_buf();
const REMOTE_NAME: &str = "origin";
let remote_url = self.remote_url(REMOTE_NAME);
crate::blame::Blame::for_path(
&self.git_binary_path,
&working_directory,
path,
&content,
remote_url,
self.hosting_provider_registry.clone(),
)
}
}
#[derive(Debug, Clone, Default)]
pub struct FakeGitRepository {
state: Arc<Mutex<FakeGitRepositoryState>>,
}
#[derive(Debug, Clone, Default)]
pub struct FakeGitRepositoryState {
pub index_contents: HashMap<PathBuf, String>,
pub blames: HashMap<PathBuf, Blame>,
pub worktree_statuses: HashMap<RepoPath, GitFileStatus>,
pub branch_name: Option<String>,
}
impl FakeGitRepository {
pub fn open(state: Arc<Mutex<FakeGitRepositoryState>>) -> Arc<dyn GitRepository> {
Arc::new(FakeGitRepository { state })
}
}
impl GitRepository for FakeGitRepository {
fn reload_index(&self) {}
fn load_index_text(&self, path: &Path) -> Option<String> {
let state = self.state.lock();
state.index_contents.get(path).cloned()
}
fn remote_url(&self, _name: &str) -> Option<String> {
None
}
fn branch_name(&self) -> Option<String> {
let state = self.state.lock();
state.branch_name.clone()
}
fn head_sha(&self) -> Option<String> {
None
}
fn statuses(&self, path_prefix: &Path) -> Result<GitStatus> {
let state = self.state.lock();
let mut entries = state
.worktree_statuses
.iter()
.filter_map(|(repo_path, status)| {
if repo_path.0.starts_with(path_prefix) {
Some((repo_path.to_owned(), *status))
} else {
None
}
})
.collect::<Vec<_>>();
entries.sort_unstable_by(|a, b| a.0.cmp(&b.0));
Ok(GitStatus {
entries: entries.into(),
})
}
fn branches(&self) -> Result<Vec<Branch>> {
Ok(vec![])
}
fn change_branch(&self, name: &str) -> Result<()> {
let mut state = self.state.lock();
state.branch_name = Some(name.to_owned());
Ok(())
}
fn create_branch(&self, name: &str) -> Result<()> {
let mut state = self.state.lock();
state.branch_name = Some(name.to_owned());
Ok(())
}
fn blame(&self, path: &Path, _content: Rope) -> Result<crate::blame::Blame> {
let state = self.state.lock();
state
.blames
.get(path)
.with_context(|| format!("failed to get blame for {:?}", path))
.cloned()
}
}
fn check_path_to_repo_path_errors(relative_file_path: &Path) -> Result<()> {
match relative_file_path.components().next() {
None => anyhow::bail!("repo path should not be empty"),
Some(Component::Prefix(_)) => anyhow::bail!(
"repo path `{}` should be relative, not a windows prefix",
relative_file_path.to_string_lossy()
),
Some(Component::RootDir) => {
anyhow::bail!(
"repo path `{}` should be relative",
relative_file_path.to_string_lossy()
)
}
Some(Component::CurDir) => {
anyhow::bail!(
"repo path `{}` should not start with `.`",
relative_file_path.to_string_lossy()
)
}
Some(Component::ParentDir) => {
anyhow::bail!(
"repo path `{}` should not start with `..`",
relative_file_path.to_string_lossy()
)
}
_ => Ok(()),
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum GitFileStatus {
Added,
Modified,
Conflict,
}
impl GitFileStatus {
pub fn merge(
this: Option<GitFileStatus>,
other: Option<GitFileStatus>,
prefer_other: bool,
) -> Option<GitFileStatus> {
if prefer_other {
return other;
}
match (this, other) {
(Some(GitFileStatus::Conflict), _) | (_, Some(GitFileStatus::Conflict)) => {
Some(GitFileStatus::Conflict)
}
(Some(GitFileStatus::Modified), _) | (_, Some(GitFileStatus::Modified)) => {
Some(GitFileStatus::Modified)
}
(Some(GitFileStatus::Added), _) | (_, Some(GitFileStatus::Added)) => {
Some(GitFileStatus::Added)
}
_ => None,
}
}
}
#[derive(Clone, Debug, Ord, Hash, PartialOrd, Eq, PartialEq)]
pub struct RepoPath(pub PathBuf);
impl RepoPath {
pub fn new(path: PathBuf) -> Self {
debug_assert!(path.is_relative(), "Repo paths must be relative");
RepoPath(path)
}
}
impl From<&Path> for RepoPath {
fn from(value: &Path) -> Self {
RepoPath::new(value.to_path_buf())
}
}
impl From<PathBuf> for RepoPath {
fn from(value: PathBuf) -> Self {
RepoPath::new(value)
}
}
impl Default for RepoPath {
fn default() -> Self {
RepoPath(PathBuf::new())
}
}
impl AsRef<Path> for RepoPath {
fn as_ref(&self) -> &Path {
self.0.as_ref()
}
}
impl std::ops::Deref for RepoPath {
type Target = PathBuf;
fn deref(&self) -> &Self::Target {
&self.0
}
}
#[derive(Debug)]
pub struct RepoPathDescendants<'a>(pub &'a Path);
impl<'a> MapSeekTarget<RepoPath> for RepoPathDescendants<'a> {
fn cmp_cursor(&self, key: &RepoPath) -> Ordering {
if key.starts_with(self.0) {
Ordering::Greater
} else {
self.0.cmp(key)
}
}
}