1use crate::commit::parse_git_diff_name_status;
2use crate::status::{GitStatus, StatusCode};
3use crate::{Oid, SHORT_SHA_LENGTH};
4use anyhow::{Context as _, Result, anyhow, bail};
5use collections::HashMap;
6use futures::future::BoxFuture;
7use futures::{AsyncWriteExt, FutureExt as _, select_biased};
8use git2::BranchType;
9use gpui::{AppContext as _, AsyncApp, BackgroundExecutor, SharedString, Task};
10use parking_lot::Mutex;
11use rope::Rope;
12use schemars::JsonSchema;
13use serde::Deserialize;
14use std::borrow::{Borrow, Cow};
15use std::ffi::{OsStr, OsString};
16use std::io::prelude::*;
17use std::path::Component;
18use std::process::{ExitStatus, Stdio};
19use std::sync::LazyLock;
20use std::{
21 cmp::Ordering,
22 future,
23 io::{BufRead, BufReader, BufWriter, Read},
24 path::{Path, PathBuf},
25 sync::Arc,
26};
27use sum_tree::MapSeekTarget;
28use thiserror::Error;
29use util::command::{new_smol_command, new_std_command};
30use util::{ResultExt, paths};
31use uuid::Uuid;
32
33pub use askpass::{AskPassDelegate, AskPassResult, AskPassSession};
34
35pub const REMOTE_CANCELLED_BY_USER: &str = "Operation cancelled by user";
36
37#[derive(Clone, Debug, Hash, PartialEq, Eq)]
38pub struct Branch {
39 pub is_head: bool,
40 pub ref_name: SharedString,
41 pub upstream: Option<Upstream>,
42 pub most_recent_commit: Option<CommitSummary>,
43}
44
45impl Branch {
46 pub fn name(&self) -> &str {
47 self.ref_name
48 .as_ref()
49 .strip_prefix("refs/heads/")
50 .or_else(|| self.ref_name.as_ref().strip_prefix("refs/remotes/"))
51 .unwrap_or(self.ref_name.as_ref())
52 }
53
54 pub fn is_remote(&self) -> bool {
55 self.ref_name.starts_with("refs/remotes/")
56 }
57
58 pub fn tracking_status(&self) -> Option<UpstreamTrackingStatus> {
59 self.upstream
60 .as_ref()
61 .and_then(|upstream| upstream.tracking.status())
62 }
63
64 pub fn priority_key(&self) -> (bool, Option<i64>) {
65 (
66 self.is_head,
67 self.most_recent_commit
68 .as_ref()
69 .map(|commit| commit.commit_timestamp),
70 )
71 }
72}
73
74#[derive(Clone, Debug, Hash, PartialEq, Eq)]
75pub struct Upstream {
76 pub ref_name: SharedString,
77 pub tracking: UpstreamTracking,
78}
79
80impl Upstream {
81 pub fn is_remote(&self) -> bool {
82 self.remote_name().is_some()
83 }
84
85 pub fn remote_name(&self) -> Option<&str> {
86 self.ref_name
87 .strip_prefix("refs/remotes/")
88 .and_then(|stripped| stripped.split("/").next())
89 }
90
91 pub fn stripped_ref_name(&self) -> Option<&str> {
92 self.ref_name.strip_prefix("refs/remotes/")
93 }
94}
95
96#[derive(Clone, Copy, Default)]
97pub struct CommitOptions {
98 pub amend: bool,
99 pub signoff: bool,
100}
101
102#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
103pub enum UpstreamTracking {
104 /// Remote ref not present in local repository.
105 Gone,
106 /// Remote ref present in local repository (fetched from remote).
107 Tracked(UpstreamTrackingStatus),
108}
109
110impl From<UpstreamTrackingStatus> for UpstreamTracking {
111 fn from(status: UpstreamTrackingStatus) -> Self {
112 UpstreamTracking::Tracked(status)
113 }
114}
115
116impl UpstreamTracking {
117 pub fn is_gone(&self) -> bool {
118 matches!(self, UpstreamTracking::Gone)
119 }
120
121 pub fn status(&self) -> Option<UpstreamTrackingStatus> {
122 match self {
123 UpstreamTracking::Gone => None,
124 UpstreamTracking::Tracked(status) => Some(*status),
125 }
126 }
127}
128
129#[derive(Debug, Clone)]
130pub struct RemoteCommandOutput {
131 pub stdout: String,
132 pub stderr: String,
133}
134
135impl RemoteCommandOutput {
136 pub fn is_empty(&self) -> bool {
137 self.stdout.is_empty() && self.stderr.is_empty()
138 }
139}
140
141#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
142pub struct UpstreamTrackingStatus {
143 pub ahead: u32,
144 pub behind: u32,
145}
146
147#[derive(Clone, Debug, Hash, PartialEq, Eq)]
148pub struct CommitSummary {
149 pub sha: SharedString,
150 pub subject: SharedString,
151 /// This is a unix timestamp
152 pub commit_timestamp: i64,
153 pub has_parent: bool,
154}
155
156#[derive(Clone, Debug, Default, Hash, PartialEq, Eq)]
157pub struct CommitDetails {
158 pub sha: SharedString,
159 pub message: SharedString,
160 pub commit_timestamp: i64,
161 pub author_email: SharedString,
162 pub author_name: SharedString,
163}
164
165#[derive(Debug)]
166pub struct CommitDiff {
167 pub files: Vec<CommitFile>,
168}
169
170#[derive(Debug)]
171pub struct CommitFile {
172 pub path: RepoPath,
173 pub old_text: Option<String>,
174 pub new_text: Option<String>,
175}
176
177impl CommitDetails {
178 pub fn short_sha(&self) -> SharedString {
179 self.sha[..SHORT_SHA_LENGTH].to_string().into()
180 }
181}
182
183#[derive(Debug, Clone, Hash, PartialEq, Eq)]
184pub struct Remote {
185 pub name: SharedString,
186}
187
188pub enum ResetMode {
189 /// Reset the branch pointer, leave index and worktree unchanged (this will make it look like things that were
190 /// committed are now staged).
191 Soft,
192 /// Reset the branch pointer and index, leave worktree unchanged (this makes it look as though things that were
193 /// committed are now unstaged).
194 Mixed,
195}
196
197#[derive(Debug, Clone, Hash, PartialEq, Eq)]
198pub enum FetchOptions {
199 All,
200 Remote(Remote),
201}
202
203impl FetchOptions {
204 pub fn to_proto(&self) -> Option<String> {
205 match self {
206 FetchOptions::All => None,
207 FetchOptions::Remote(remote) => Some(remote.clone().name.into()),
208 }
209 }
210
211 pub fn from_proto(remote_name: Option<String>) -> Self {
212 match remote_name {
213 Some(name) => FetchOptions::Remote(Remote { name: name.into() }),
214 None => FetchOptions::All,
215 }
216 }
217
218 pub fn name(&self) -> SharedString {
219 match self {
220 Self::All => "Fetch all remotes".into(),
221 Self::Remote(remote) => remote.name.clone(),
222 }
223 }
224}
225
226impl std::fmt::Display for FetchOptions {
227 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
228 match self {
229 FetchOptions::All => write!(f, "--all"),
230 FetchOptions::Remote(remote) => write!(f, "{}", remote.name),
231 }
232 }
233}
234
235/// Modifies .git/info/exclude temporarily
236pub struct GitExcludeOverride {
237 git_exclude_path: PathBuf,
238 original_excludes: Option<String>,
239 added_excludes: Option<String>,
240}
241
242impl GitExcludeOverride {
243 pub async fn new(git_exclude_path: PathBuf) -> Result<Self> {
244 let original_excludes = smol::fs::read_to_string(&git_exclude_path).await.ok();
245
246 Ok(GitExcludeOverride {
247 git_exclude_path,
248 original_excludes,
249 added_excludes: None,
250 })
251 }
252
253 pub async fn add_excludes(&mut self, excludes: &str) -> Result<()> {
254 self.added_excludes = Some(if let Some(ref already_added) = self.added_excludes {
255 format!("{already_added}\n{excludes}")
256 } else {
257 excludes.to_string()
258 });
259
260 let mut content = self.original_excludes.clone().unwrap_or_default();
261 content.push_str("\n\n# ====== Auto-added by Zed: =======\n");
262 content.push_str(self.added_excludes.as_ref().unwrap());
263 content.push('\n');
264
265 smol::fs::write(&self.git_exclude_path, content).await?;
266 Ok(())
267 }
268
269 pub async fn restore_original(&mut self) -> Result<()> {
270 if let Some(ref original) = self.original_excludes {
271 smol::fs::write(&self.git_exclude_path, original).await?;
272 } else {
273 if self.git_exclude_path.exists() {
274 smol::fs::remove_file(&self.git_exclude_path).await?;
275 }
276 }
277
278 self.added_excludes = None;
279
280 Ok(())
281 }
282}
283
284impl Drop for GitExcludeOverride {
285 fn drop(&mut self) {
286 if self.added_excludes.is_some() {
287 let git_exclude_path = self.git_exclude_path.clone();
288 let original_excludes = self.original_excludes.clone();
289 smol::spawn(async move {
290 if let Some(original) = original_excludes {
291 smol::fs::write(&git_exclude_path, original).await
292 } else {
293 smol::fs::remove_file(&git_exclude_path).await
294 }
295 })
296 .detach();
297 }
298 }
299}
300
301pub trait GitRepository: Send + Sync {
302 fn reload_index(&self);
303
304 /// Returns the contents of an entry in the repository's index, or None if there is no entry for the given path.
305 ///
306 /// Also returns `None` for symlinks.
307 fn load_index_text(&self, path: RepoPath) -> BoxFuture<'_, Option<String>>;
308
309 /// Returns the contents of an entry in the repository's HEAD, or None if HEAD does not exist or has no entry for the given path.
310 ///
311 /// Also returns `None` for symlinks.
312 fn load_committed_text(&self, path: RepoPath) -> BoxFuture<'_, Option<String>>;
313
314 fn set_index_text(
315 &self,
316 path: RepoPath,
317 content: Option<String>,
318 env: Arc<HashMap<String, String>>,
319 ) -> BoxFuture<'_, anyhow::Result<()>>;
320
321 /// Returns the URL of the remote with the given name.
322 fn remote_url(&self, name: &str) -> Option<String>;
323
324 /// Resolve a list of refs to SHAs.
325 fn revparse_batch(&self, revs: Vec<String>) -> BoxFuture<'_, Result<Vec<Option<String>>>>;
326
327 fn head_sha(&self) -> BoxFuture<'_, Option<String>> {
328 async move {
329 self.revparse_batch(vec!["HEAD".into()])
330 .await
331 .unwrap_or_default()
332 .into_iter()
333 .next()
334 .flatten()
335 }
336 .boxed()
337 }
338
339 fn merge_message(&self) -> BoxFuture<'_, Option<String>>;
340
341 fn status(&self, path_prefixes: &[RepoPath]) -> Task<Result<GitStatus>>;
342
343 fn branches(&self) -> BoxFuture<'_, Result<Vec<Branch>>>;
344
345 fn change_branch(&self, name: String) -> BoxFuture<'_, Result<()>>;
346 fn create_branch(&self, name: String) -> BoxFuture<'_, Result<()>>;
347
348 fn reset(
349 &self,
350 commit: String,
351 mode: ResetMode,
352 env: Arc<HashMap<String, String>>,
353 ) -> BoxFuture<'_, Result<()>>;
354
355 fn checkout_files(
356 &self,
357 commit: String,
358 paths: Vec<RepoPath>,
359 env: Arc<HashMap<String, String>>,
360 ) -> BoxFuture<'_, Result<()>>;
361
362 fn show(&self, commit: String) -> BoxFuture<'_, Result<CommitDetails>>;
363
364 fn load_commit(&self, commit: String, cx: AsyncApp) -> BoxFuture<'_, Result<CommitDiff>>;
365 fn blame(&self, path: RepoPath, content: Rope) -> BoxFuture<'_, Result<crate::blame::Blame>>;
366
367 /// Returns the absolute path to the repository. For worktrees, this will be the path to the
368 /// worktree's gitdir within the main repository (typically `.git/worktrees/<name>`).
369 fn path(&self) -> PathBuf;
370
371 fn main_repository_path(&self) -> PathBuf;
372
373 /// Updates the index to match the worktree at the given paths.
374 ///
375 /// If any of the paths have been deleted from the worktree, they will be removed from the index if found there.
376 fn stage_paths(
377 &self,
378 paths: Vec<RepoPath>,
379 env: Arc<HashMap<String, String>>,
380 ) -> BoxFuture<'_, Result<()>>;
381 /// Updates the index to match HEAD at the given paths.
382 ///
383 /// If any of the paths were previously staged but do not exist in HEAD, they will be removed from the index.
384 fn unstage_paths(
385 &self,
386 paths: Vec<RepoPath>,
387 env: Arc<HashMap<String, String>>,
388 ) -> BoxFuture<'_, Result<()>>;
389
390 fn commit(
391 &self,
392 message: SharedString,
393 name_and_email: Option<(SharedString, SharedString)>,
394 options: CommitOptions,
395 env: Arc<HashMap<String, String>>,
396 ) -> BoxFuture<'_, Result<()>>;
397
398 fn stash_paths(
399 &self,
400 paths: Vec<RepoPath>,
401 env: Arc<HashMap<String, String>>,
402 ) -> BoxFuture<'_, Result<()>>;
403
404 fn stash_pop(&self, env: Arc<HashMap<String, String>>) -> BoxFuture<'_, Result<()>>;
405
406 fn push(
407 &self,
408 branch_name: String,
409 upstream_name: String,
410 options: Option<PushOptions>,
411 askpass: AskPassDelegate,
412 env: Arc<HashMap<String, String>>,
413 // This method takes an AsyncApp to ensure it's invoked on the main thread,
414 // otherwise git-credentials-manager won't work.
415 cx: AsyncApp,
416 ) -> BoxFuture<'_, Result<RemoteCommandOutput>>;
417
418 fn pull(
419 &self,
420 branch_name: String,
421 upstream_name: String,
422 askpass: AskPassDelegate,
423 env: Arc<HashMap<String, String>>,
424 // This method takes an AsyncApp to ensure it's invoked on the main thread,
425 // otherwise git-credentials-manager won't work.
426 cx: AsyncApp,
427 ) -> BoxFuture<'_, Result<RemoteCommandOutput>>;
428
429 fn fetch(
430 &self,
431 fetch_options: FetchOptions,
432 askpass: AskPassDelegate,
433 env: Arc<HashMap<String, String>>,
434 // This method takes an AsyncApp to ensure it's invoked on the main thread,
435 // otherwise git-credentials-manager won't work.
436 cx: AsyncApp,
437 ) -> BoxFuture<'_, Result<RemoteCommandOutput>>;
438
439 fn get_remotes(&self, branch_name: Option<String>) -> BoxFuture<'_, Result<Vec<Remote>>>;
440
441 /// returns a list of remote branches that contain HEAD
442 fn check_for_pushed_commit(&self) -> BoxFuture<'_, Result<Vec<SharedString>>>;
443
444 /// Run git diff
445 fn diff(&self, diff: DiffType) -> BoxFuture<'_, Result<String>>;
446
447 /// Creates a checkpoint for the repository.
448 fn checkpoint(&self) -> BoxFuture<'static, Result<GitRepositoryCheckpoint>>;
449
450 /// Resets to a previously-created checkpoint.
451 fn restore_checkpoint(&self, checkpoint: GitRepositoryCheckpoint) -> BoxFuture<'_, Result<()>>;
452
453 /// Compares two checkpoints, returning true if they are equal
454 fn compare_checkpoints(
455 &self,
456 left: GitRepositoryCheckpoint,
457 right: GitRepositoryCheckpoint,
458 ) -> BoxFuture<'_, Result<bool>>;
459
460 /// Computes a diff between two checkpoints.
461 fn diff_checkpoints(
462 &self,
463 base_checkpoint: GitRepositoryCheckpoint,
464 target_checkpoint: GitRepositoryCheckpoint,
465 ) -> BoxFuture<'_, Result<String>>;
466
467 fn default_branch(&self) -> BoxFuture<'_, Result<Option<SharedString>>>;
468}
469
470pub enum DiffType {
471 HeadToIndex,
472 HeadToWorktree,
473}
474
475#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, JsonSchema)]
476pub enum PushOptions {
477 SetUpstream,
478 Force,
479}
480
481impl std::fmt::Debug for dyn GitRepository {
482 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
483 f.debug_struct("dyn GitRepository<...>").finish()
484 }
485}
486
487pub struct RealGitRepository {
488 pub repository: Arc<Mutex<git2::Repository>>,
489 pub git_binary_path: PathBuf,
490 executor: BackgroundExecutor,
491}
492
493impl RealGitRepository {
494 pub fn new(
495 dotgit_path: &Path,
496 git_binary_path: Option<PathBuf>,
497 executor: BackgroundExecutor,
498 ) -> Option<Self> {
499 let workdir_root = dotgit_path.parent()?;
500 let repository = git2::Repository::open(workdir_root).log_err()?;
501 Some(Self {
502 repository: Arc::new(Mutex::new(repository)),
503 git_binary_path: git_binary_path.unwrap_or_else(|| PathBuf::from("git")),
504 executor,
505 })
506 }
507
508 fn working_directory(&self) -> Result<PathBuf> {
509 self.repository
510 .lock()
511 .workdir()
512 .context("failed to read git work directory")
513 .map(Path::to_path_buf)
514 }
515}
516
517#[derive(Clone, Debug)]
518pub struct GitRepositoryCheckpoint {
519 pub commit_sha: Oid,
520}
521
522#[derive(Debug)]
523pub struct GitCommitter {
524 pub name: Option<String>,
525 pub email: Option<String>,
526}
527
528pub async fn get_git_committer(cx: &AsyncApp) -> GitCommitter {
529 if cfg!(any(feature = "test-support", test)) {
530 return GitCommitter {
531 name: None,
532 email: None,
533 };
534 }
535
536 let git_binary_path =
537 if cfg!(target_os = "macos") && option_env!("ZED_BUNDLE").as_deref() == Some("true") {
538 cx.update(|cx| {
539 cx.path_for_auxiliary_executable("git")
540 .context("could not find git binary path")
541 .log_err()
542 })
543 .ok()
544 .flatten()
545 } else {
546 None
547 };
548
549 let git = GitBinary::new(
550 git_binary_path.unwrap_or(PathBuf::from("git")),
551 paths::home_dir().clone(),
552 cx.background_executor().clone(),
553 );
554
555 cx.background_spawn(async move {
556 let name = git.run(["config", "--global", "user.name"]).await.log_err();
557 let email = git
558 .run(["config", "--global", "user.email"])
559 .await
560 .log_err();
561 GitCommitter { name, email }
562 })
563 .await
564}
565
566impl GitRepository for RealGitRepository {
567 fn reload_index(&self) {
568 if let Ok(mut index) = self.repository.lock().index() {
569 _ = index.read(false);
570 }
571 }
572
573 fn path(&self) -> PathBuf {
574 let repo = self.repository.lock();
575 repo.path().into()
576 }
577
578 fn main_repository_path(&self) -> PathBuf {
579 let repo = self.repository.lock();
580 repo.commondir().into()
581 }
582
583 fn show(&self, commit: String) -> BoxFuture<'_, Result<CommitDetails>> {
584 let working_directory = self.working_directory();
585 self.executor
586 .spawn(async move {
587 let working_directory = working_directory?;
588 let output = new_std_command("git")
589 .current_dir(&working_directory)
590 .args([
591 "--no-optional-locks",
592 "show",
593 "--no-patch",
594 "--format=%H%x00%B%x00%at%x00%ae%x00%an%x00",
595 &commit,
596 ])
597 .output()?;
598 let output = std::str::from_utf8(&output.stdout)?;
599 let fields = output.split('\0').collect::<Vec<_>>();
600 if fields.len() != 6 {
601 bail!("unexpected git-show output for {commit:?}: {output:?}")
602 }
603 let sha = fields[0].to_string().into();
604 let message = fields[1].to_string().into();
605 let commit_timestamp = fields[2].parse()?;
606 let author_email = fields[3].to_string().into();
607 let author_name = fields[4].to_string().into();
608 Ok(CommitDetails {
609 sha,
610 message,
611 commit_timestamp,
612 author_email,
613 author_name,
614 })
615 })
616 .boxed()
617 }
618
619 fn load_commit(&self, commit: String, cx: AsyncApp) -> BoxFuture<'_, Result<CommitDiff>> {
620 let Some(working_directory) = self.repository.lock().workdir().map(ToOwned::to_owned)
621 else {
622 return future::ready(Err(anyhow!("no working directory"))).boxed();
623 };
624 cx.background_spawn(async move {
625 let show_output = util::command::new_std_command("git")
626 .current_dir(&working_directory)
627 .args([
628 "--no-optional-locks",
629 "show",
630 "--format=%P",
631 "-z",
632 "--no-renames",
633 "--name-status",
634 ])
635 .arg(&commit)
636 .stdin(Stdio::null())
637 .stdout(Stdio::piped())
638 .stderr(Stdio::piped())
639 .output()
640 .context("starting git show process")?;
641
642 let show_stdout = String::from_utf8_lossy(&show_output.stdout);
643 let mut lines = show_stdout.split('\n');
644 let parent_sha = lines.next().unwrap().trim().trim_end_matches('\0');
645 let changes = parse_git_diff_name_status(lines.next().unwrap_or(""));
646
647 let mut cat_file_process = util::command::new_std_command("git")
648 .current_dir(&working_directory)
649 .args(["--no-optional-locks", "cat-file", "--batch=%(objectsize)"])
650 .stdin(Stdio::piped())
651 .stdout(Stdio::piped())
652 .stderr(Stdio::piped())
653 .spawn()
654 .context("starting git cat-file process")?;
655
656 use std::io::Write as _;
657 let mut files = Vec::<CommitFile>::new();
658 let mut stdin = BufWriter::with_capacity(512, cat_file_process.stdin.take().unwrap());
659 let mut stdout = BufReader::new(cat_file_process.stdout.take().unwrap());
660 let mut info_line = String::new();
661 let mut newline = [b'\0'];
662 for (path, status_code) in changes {
663 match status_code {
664 StatusCode::Modified => {
665 writeln!(&mut stdin, "{commit}:{}", path.display())?;
666 writeln!(&mut stdin, "{parent_sha}:{}", path.display())?;
667 }
668 StatusCode::Added => {
669 writeln!(&mut stdin, "{commit}:{}", path.display())?;
670 }
671 StatusCode::Deleted => {
672 writeln!(&mut stdin, "{parent_sha}:{}", path.display())?;
673 }
674 _ => continue,
675 }
676 stdin.flush()?;
677
678 info_line.clear();
679 stdout.read_line(&mut info_line)?;
680
681 let len = info_line.trim_end().parse().with_context(|| {
682 format!("invalid object size output from cat-file {info_line}")
683 })?;
684 let mut text = vec![0; len];
685 stdout.read_exact(&mut text)?;
686 stdout.read_exact(&mut newline)?;
687 let text = String::from_utf8_lossy(&text).to_string();
688
689 let mut old_text = None;
690 let mut new_text = None;
691 match status_code {
692 StatusCode::Modified => {
693 info_line.clear();
694 stdout.read_line(&mut info_line)?;
695 let len = info_line.trim_end().parse().with_context(|| {
696 format!("invalid object size output from cat-file {}", info_line)
697 })?;
698 let mut parent_text = vec![0; len];
699 stdout.read_exact(&mut parent_text)?;
700 stdout.read_exact(&mut newline)?;
701 old_text = Some(String::from_utf8_lossy(&parent_text).to_string());
702 new_text = Some(text);
703 }
704 StatusCode::Added => new_text = Some(text),
705 StatusCode::Deleted => old_text = Some(text),
706 _ => continue,
707 }
708
709 files.push(CommitFile {
710 path: path.into(),
711 old_text,
712 new_text,
713 })
714 }
715
716 Ok(CommitDiff { files })
717 })
718 .boxed()
719 }
720
721 fn reset(
722 &self,
723 commit: String,
724 mode: ResetMode,
725 env: Arc<HashMap<String, String>>,
726 ) -> BoxFuture<'_, Result<()>> {
727 async move {
728 let working_directory = self.working_directory();
729
730 let mode_flag = match mode {
731 ResetMode::Mixed => "--mixed",
732 ResetMode::Soft => "--soft",
733 };
734
735 let output = new_smol_command(&self.git_binary_path)
736 .envs(env.iter())
737 .current_dir(&working_directory?)
738 .args(["reset", mode_flag, &commit])
739 .output()
740 .await?;
741 anyhow::ensure!(
742 output.status.success(),
743 "Failed to reset:\n{}",
744 String::from_utf8_lossy(&output.stderr),
745 );
746 Ok(())
747 }
748 .boxed()
749 }
750
751 fn checkout_files(
752 &self,
753 commit: String,
754 paths: Vec<RepoPath>,
755 env: Arc<HashMap<String, String>>,
756 ) -> BoxFuture<'_, Result<()>> {
757 let working_directory = self.working_directory();
758 let git_binary_path = self.git_binary_path.clone();
759 async move {
760 if paths.is_empty() {
761 return Ok(());
762 }
763
764 let output = new_smol_command(&git_binary_path)
765 .current_dir(&working_directory?)
766 .envs(env.iter())
767 .args(["checkout", &commit, "--"])
768 .args(paths.iter().map(|path| path.as_ref()))
769 .output()
770 .await?;
771 anyhow::ensure!(
772 output.status.success(),
773 "Failed to checkout files:\n{}",
774 String::from_utf8_lossy(&output.stderr),
775 );
776 Ok(())
777 }
778 .boxed()
779 }
780
781 fn load_index_text(&self, path: RepoPath) -> BoxFuture<'_, Option<String>> {
782 // https://git-scm.com/book/en/v2/Git-Internals-Git-Objects
783 const GIT_MODE_SYMLINK: u32 = 0o120000;
784
785 let repo = self.repository.clone();
786 self.executor
787 .spawn(async move {
788 fn logic(repo: &git2::Repository, path: &RepoPath) -> Result<Option<String>> {
789 // This check is required because index.get_path() unwraps internally :(
790 check_path_to_repo_path_errors(path)?;
791
792 let mut index = repo.index()?;
793 index.read(false)?;
794
795 const STAGE_NORMAL: i32 = 0;
796 let oid = match index.get_path(path, STAGE_NORMAL) {
797 Some(entry) if entry.mode != GIT_MODE_SYMLINK => entry.id,
798 _ => return Ok(None),
799 };
800
801 let content = repo.find_blob(oid)?.content().to_owned();
802 Ok(String::from_utf8(content).ok())
803 }
804
805 match logic(&repo.lock(), &path) {
806 Ok(value) => return value,
807 Err(err) => log::error!("Error loading index text: {:?}", err),
808 }
809 None
810 })
811 .boxed()
812 }
813
814 fn load_committed_text(&self, path: RepoPath) -> BoxFuture<'_, Option<String>> {
815 let repo = self.repository.clone();
816 self.executor
817 .spawn(async move {
818 let repo = repo.lock();
819 let head = repo.head().ok()?.peel_to_tree().log_err()?;
820 let entry = head.get_path(&path).ok()?;
821 if entry.filemode() == i32::from(git2::FileMode::Link) {
822 return None;
823 }
824 let content = repo.find_blob(entry.id()).log_err()?.content().to_owned();
825 String::from_utf8(content).ok()
826 })
827 .boxed()
828 }
829
830 fn set_index_text(
831 &self,
832 path: RepoPath,
833 content: Option<String>,
834 env: Arc<HashMap<String, String>>,
835 ) -> BoxFuture<'_, anyhow::Result<()>> {
836 let working_directory = self.working_directory();
837 let git_binary_path = self.git_binary_path.clone();
838 self.executor
839 .spawn(async move {
840 let working_directory = working_directory?;
841 if let Some(content) = content {
842 let mut child = new_smol_command(&git_binary_path)
843 .current_dir(&working_directory)
844 .envs(env.iter())
845 .args(["hash-object", "-w", "--stdin"])
846 .stdin(Stdio::piped())
847 .stdout(Stdio::piped())
848 .spawn()?;
849 let mut stdin = child.stdin.take().unwrap();
850 stdin.write_all(content.as_bytes()).await?;
851 stdin.flush().await?;
852 drop(stdin);
853 let output = child.output().await?.stdout;
854 let sha = str::from_utf8(&output)?.trim();
855
856 log::debug!("indexing SHA: {sha}, path {path:?}");
857
858 let output = new_smol_command(&git_binary_path)
859 .current_dir(&working_directory)
860 .envs(env.iter())
861 .args(["update-index", "--add", "--cacheinfo", "100644", sha])
862 .arg(path.to_unix_style())
863 .output()
864 .await?;
865
866 anyhow::ensure!(
867 output.status.success(),
868 "Failed to stage:\n{}",
869 String::from_utf8_lossy(&output.stderr)
870 );
871 } else {
872 log::debug!("removing path {path:?} from the index");
873 let output = new_smol_command(&git_binary_path)
874 .current_dir(&working_directory)
875 .envs(env.iter())
876 .args(["update-index", "--force-remove"])
877 .arg(path.to_unix_style())
878 .output()
879 .await?;
880 anyhow::ensure!(
881 output.status.success(),
882 "Failed to unstage:\n{}",
883 String::from_utf8_lossy(&output.stderr)
884 );
885 }
886
887 Ok(())
888 })
889 .boxed()
890 }
891
892 fn remote_url(&self, name: &str) -> Option<String> {
893 let repo = self.repository.lock();
894 let remote = repo.find_remote(name).ok()?;
895 remote.url().map(|url| url.to_string())
896 }
897
898 fn revparse_batch(&self, revs: Vec<String>) -> BoxFuture<'_, Result<Vec<Option<String>>>> {
899 let working_directory = self.working_directory();
900 self.executor
901 .spawn(async move {
902 let working_directory = working_directory?;
903 let mut process = new_std_command("git")
904 .current_dir(&working_directory)
905 .args([
906 "--no-optional-locks",
907 "cat-file",
908 "--batch-check=%(objectname)",
909 ])
910 .stdin(Stdio::piped())
911 .stdout(Stdio::piped())
912 .stderr(Stdio::piped())
913 .spawn()?;
914
915 let stdin = process
916 .stdin
917 .take()
918 .context("no stdin for git cat-file subprocess")?;
919 let mut stdin = BufWriter::new(stdin);
920 for rev in &revs {
921 write!(&mut stdin, "{rev}\n")?;
922 }
923 stdin.flush()?;
924 drop(stdin);
925
926 let output = process.wait_with_output()?;
927 let output = std::str::from_utf8(&output.stdout)?;
928 let shas = output
929 .lines()
930 .map(|line| {
931 if line.ends_with("missing") {
932 None
933 } else {
934 Some(line.to_string())
935 }
936 })
937 .collect::<Vec<_>>();
938
939 if shas.len() != revs.len() {
940 // In an octopus merge, git cat-file still only outputs the first sha from MERGE_HEAD.
941 bail!("unexpected number of shas")
942 }
943
944 Ok(shas)
945 })
946 .boxed()
947 }
948
949 fn merge_message(&self) -> BoxFuture<'_, Option<String>> {
950 let path = self.path().join("MERGE_MSG");
951 self.executor
952 .spawn(async move { std::fs::read_to_string(&path).ok() })
953 .boxed()
954 }
955
956 fn status(&self, path_prefixes: &[RepoPath]) -> Task<Result<GitStatus>> {
957 let git_binary_path = self.git_binary_path.clone();
958 let working_directory = match self.working_directory() {
959 Ok(working_directory) => working_directory,
960 Err(e) => return Task::ready(Err(e)),
961 };
962 let args = git_status_args(path_prefixes);
963 log::debug!("Checking for git status in {path_prefixes:?}");
964 self.executor.spawn(async move {
965 let output = new_std_command(&git_binary_path)
966 .current_dir(working_directory)
967 .args(args)
968 .output()?;
969 if output.status.success() {
970 let stdout = String::from_utf8_lossy(&output.stdout);
971 stdout.parse()
972 } else {
973 let stderr = String::from_utf8_lossy(&output.stderr);
974 anyhow::bail!("git status failed: {stderr}");
975 }
976 })
977 }
978
979 fn branches(&self) -> BoxFuture<'_, Result<Vec<Branch>>> {
980 let working_directory = self.working_directory();
981 let git_binary_path = self.git_binary_path.clone();
982 self.executor
983 .spawn(async move {
984 let fields = [
985 "%(HEAD)",
986 "%(objectname)",
987 "%(parent)",
988 "%(refname)",
989 "%(upstream)",
990 "%(upstream:track)",
991 "%(committerdate:unix)",
992 "%(contents:subject)",
993 ]
994 .join("%00");
995 let args = vec![
996 "for-each-ref",
997 "refs/heads/**/*",
998 "refs/remotes/**/*",
999 "--format",
1000 &fields,
1001 ];
1002 let working_directory = working_directory?;
1003 let output = new_smol_command(&git_binary_path)
1004 .current_dir(&working_directory)
1005 .args(args)
1006 .output()
1007 .await?;
1008
1009 anyhow::ensure!(
1010 output.status.success(),
1011 "Failed to git git branches:\n{}",
1012 String::from_utf8_lossy(&output.stderr)
1013 );
1014
1015 let input = String::from_utf8_lossy(&output.stdout);
1016
1017 let mut branches = parse_branch_input(&input)?;
1018 if branches.is_empty() {
1019 let args = vec!["symbolic-ref", "--quiet", "HEAD"];
1020
1021 let output = new_smol_command(&git_binary_path)
1022 .current_dir(&working_directory)
1023 .args(args)
1024 .output()
1025 .await?;
1026
1027 // git symbolic-ref returns a non-0 exit code if HEAD points
1028 // to something other than a branch
1029 if output.status.success() {
1030 let name = String::from_utf8_lossy(&output.stdout).trim().to_string();
1031
1032 branches.push(Branch {
1033 ref_name: name.into(),
1034 is_head: true,
1035 upstream: None,
1036 most_recent_commit: None,
1037 });
1038 }
1039 }
1040
1041 Ok(branches)
1042 })
1043 .boxed()
1044 }
1045
1046 fn change_branch(&self, name: String) -> BoxFuture<'_, Result<()>> {
1047 let repo = self.repository.clone();
1048 let working_directory = self.working_directory();
1049 let git_binary_path = self.git_binary_path.clone();
1050 let executor = self.executor.clone();
1051 let branch = self.executor.spawn(async move {
1052 let repo = repo.lock();
1053 let branch = if let Ok(branch) = repo.find_branch(&name, BranchType::Local) {
1054 branch
1055 } else if let Ok(revision) = repo.find_branch(&name, BranchType::Remote) {
1056 let (_, branch_name) = name.split_once("/").context("Unexpected branch format")?;
1057 let revision = revision.get();
1058 let branch_commit = revision.peel_to_commit()?;
1059 let mut branch = repo.branch(branch_name, &branch_commit, false)?;
1060 branch.set_upstream(Some(&name))?;
1061 branch
1062 } else {
1063 anyhow::bail!("Branch not found");
1064 };
1065
1066 Ok(branch
1067 .name()?
1068 .context("cannot checkout anonymous branch")?
1069 .to_string())
1070 });
1071
1072 self.executor
1073 .spawn(async move {
1074 let branch = branch.await?;
1075
1076 GitBinary::new(git_binary_path, working_directory?, executor)
1077 .run(&["checkout", &branch])
1078 .await?;
1079
1080 anyhow::Ok(())
1081 })
1082 .boxed()
1083 }
1084
1085 fn create_branch(&self, name: String) -> BoxFuture<'_, Result<()>> {
1086 let repo = self.repository.clone();
1087 self.executor
1088 .spawn(async move {
1089 let repo = repo.lock();
1090 let current_commit = repo.head()?.peel_to_commit()?;
1091 repo.branch(&name, ¤t_commit, false)?;
1092 Ok(())
1093 })
1094 .boxed()
1095 }
1096
1097 fn blame(&self, path: RepoPath, content: Rope) -> BoxFuture<'_, Result<crate::blame::Blame>> {
1098 let working_directory = self.working_directory();
1099 let git_binary_path = self.git_binary_path.clone();
1100
1101 let remote_url = self
1102 .remote_url("upstream")
1103 .or_else(|| self.remote_url("origin"));
1104
1105 self.executor
1106 .spawn(async move {
1107 crate::blame::Blame::for_path(
1108 &git_binary_path,
1109 &working_directory?,
1110 &path,
1111 &content,
1112 remote_url,
1113 )
1114 .await
1115 })
1116 .boxed()
1117 }
1118
1119 fn diff(&self, diff: DiffType) -> BoxFuture<'_, Result<String>> {
1120 let working_directory = self.working_directory();
1121 let git_binary_path = self.git_binary_path.clone();
1122 self.executor
1123 .spawn(async move {
1124 let args = match diff {
1125 DiffType::HeadToIndex => Some("--staged"),
1126 DiffType::HeadToWorktree => None,
1127 };
1128
1129 let output = new_smol_command(&git_binary_path)
1130 .current_dir(&working_directory?)
1131 .args(["diff"])
1132 .args(args)
1133 .output()
1134 .await?;
1135
1136 anyhow::ensure!(
1137 output.status.success(),
1138 "Failed to run git diff:\n{}",
1139 String::from_utf8_lossy(&output.stderr)
1140 );
1141 Ok(String::from_utf8_lossy(&output.stdout).to_string())
1142 })
1143 .boxed()
1144 }
1145
1146 fn stage_paths(
1147 &self,
1148 paths: Vec<RepoPath>,
1149 env: Arc<HashMap<String, String>>,
1150 ) -> BoxFuture<'_, Result<()>> {
1151 let working_directory = self.working_directory();
1152 let git_binary_path = self.git_binary_path.clone();
1153 self.executor
1154 .spawn(async move {
1155 if !paths.is_empty() {
1156 let output = new_smol_command(&git_binary_path)
1157 .current_dir(&working_directory?)
1158 .envs(env.iter())
1159 .args(["update-index", "--add", "--remove", "--"])
1160 .args(paths.iter().map(|p| p.to_unix_style()))
1161 .output()
1162 .await?;
1163 anyhow::ensure!(
1164 output.status.success(),
1165 "Failed to stage paths:\n{}",
1166 String::from_utf8_lossy(&output.stderr),
1167 );
1168 }
1169 Ok(())
1170 })
1171 .boxed()
1172 }
1173
1174 fn unstage_paths(
1175 &self,
1176 paths: Vec<RepoPath>,
1177 env: Arc<HashMap<String, String>>,
1178 ) -> BoxFuture<'_, Result<()>> {
1179 let working_directory = self.working_directory();
1180 let git_binary_path = self.git_binary_path.clone();
1181
1182 self.executor
1183 .spawn(async move {
1184 if !paths.is_empty() {
1185 let output = new_smol_command(&git_binary_path)
1186 .current_dir(&working_directory?)
1187 .envs(env.iter())
1188 .args(["reset", "--quiet", "--"])
1189 .args(paths.iter().map(|p| p.as_ref()))
1190 .output()
1191 .await?;
1192
1193 anyhow::ensure!(
1194 output.status.success(),
1195 "Failed to unstage:\n{}",
1196 String::from_utf8_lossy(&output.stderr),
1197 );
1198 }
1199 Ok(())
1200 })
1201 .boxed()
1202 }
1203
1204 fn stash_paths(
1205 &self,
1206 paths: Vec<RepoPath>,
1207 env: Arc<HashMap<String, String>>,
1208 ) -> BoxFuture<'_, Result<()>> {
1209 let working_directory = self.working_directory();
1210 self.executor
1211 .spawn(async move {
1212 let mut cmd = new_smol_command("git");
1213 cmd.current_dir(&working_directory?)
1214 .envs(env.iter())
1215 .args(["stash", "push", "--quiet"])
1216 .arg("--include-untracked");
1217
1218 cmd.args(paths.iter().map(|p| p.as_ref()));
1219
1220 let output = cmd.output().await?;
1221
1222 anyhow::ensure!(
1223 output.status.success(),
1224 "Failed to stash:\n{}",
1225 String::from_utf8_lossy(&output.stderr)
1226 );
1227 Ok(())
1228 })
1229 .boxed()
1230 }
1231
1232 fn stash_pop(&self, env: Arc<HashMap<String, String>>) -> BoxFuture<'_, Result<()>> {
1233 let working_directory = self.working_directory();
1234 self.executor
1235 .spawn(async move {
1236 let mut cmd = new_smol_command("git");
1237 cmd.current_dir(&working_directory?)
1238 .envs(env.iter())
1239 .args(["stash", "pop"]);
1240
1241 let output = cmd.output().await?;
1242
1243 anyhow::ensure!(
1244 output.status.success(),
1245 "Failed to stash pop:\n{}",
1246 String::from_utf8_lossy(&output.stderr)
1247 );
1248 Ok(())
1249 })
1250 .boxed()
1251 }
1252
1253 fn commit(
1254 &self,
1255 message: SharedString,
1256 name_and_email: Option<(SharedString, SharedString)>,
1257 options: CommitOptions,
1258 env: Arc<HashMap<String, String>>,
1259 ) -> BoxFuture<'_, Result<()>> {
1260 let working_directory = self.working_directory();
1261 self.executor
1262 .spawn(async move {
1263 let mut cmd = new_smol_command("git");
1264 cmd.current_dir(&working_directory?)
1265 .envs(env.iter())
1266 .args(["commit", "--quiet", "-m"])
1267 .arg(&message.to_string())
1268 .arg("--cleanup=strip");
1269
1270 if options.amend {
1271 cmd.arg("--amend");
1272 }
1273
1274 if options.signoff {
1275 cmd.arg("--signoff");
1276 }
1277
1278 if let Some((name, email)) = name_and_email {
1279 cmd.arg("--author").arg(&format!("{name} <{email}>"));
1280 }
1281
1282 let output = cmd.output().await?;
1283
1284 anyhow::ensure!(
1285 output.status.success(),
1286 "Failed to commit:\n{}",
1287 String::from_utf8_lossy(&output.stderr)
1288 );
1289 Ok(())
1290 })
1291 .boxed()
1292 }
1293
1294 fn push(
1295 &self,
1296 branch_name: String,
1297 remote_name: String,
1298 options: Option<PushOptions>,
1299 ask_pass: AskPassDelegate,
1300 env: Arc<HashMap<String, String>>,
1301 cx: AsyncApp,
1302 ) -> BoxFuture<'_, Result<RemoteCommandOutput>> {
1303 let working_directory = self.working_directory();
1304 let executor = cx.background_executor().clone();
1305 async move {
1306 let working_directory = working_directory?;
1307 let mut command = new_smol_command("git");
1308 command
1309 .envs(env.iter())
1310 .current_dir(&working_directory)
1311 .args(["push"])
1312 .args(options.map(|option| match option {
1313 PushOptions::SetUpstream => "--set-upstream",
1314 PushOptions::Force => "--force-with-lease",
1315 }))
1316 .arg(remote_name)
1317 .arg(format!("{}:{}", branch_name, branch_name))
1318 .stdin(smol::process::Stdio::null())
1319 .stdout(smol::process::Stdio::piped())
1320 .stderr(smol::process::Stdio::piped());
1321
1322 run_git_command(env, ask_pass, command, &executor).await
1323 }
1324 .boxed()
1325 }
1326
1327 fn pull(
1328 &self,
1329 branch_name: String,
1330 remote_name: String,
1331 ask_pass: AskPassDelegate,
1332 env: Arc<HashMap<String, String>>,
1333 cx: AsyncApp,
1334 ) -> BoxFuture<'_, Result<RemoteCommandOutput>> {
1335 let working_directory = self.working_directory();
1336 let executor = cx.background_executor().clone();
1337 async move {
1338 let mut command = new_smol_command("git");
1339 command
1340 .envs(env.iter())
1341 .current_dir(&working_directory?)
1342 .args(["pull"])
1343 .arg(remote_name)
1344 .arg(branch_name)
1345 .stdout(smol::process::Stdio::piped())
1346 .stderr(smol::process::Stdio::piped());
1347
1348 run_git_command(env, ask_pass, command, &executor).await
1349 }
1350 .boxed()
1351 }
1352
1353 fn fetch(
1354 &self,
1355 fetch_options: FetchOptions,
1356 ask_pass: AskPassDelegate,
1357 env: Arc<HashMap<String, String>>,
1358 cx: AsyncApp,
1359 ) -> BoxFuture<'_, Result<RemoteCommandOutput>> {
1360 let working_directory = self.working_directory();
1361 let remote_name = format!("{}", fetch_options);
1362 let executor = cx.background_executor().clone();
1363 async move {
1364 let mut command = new_smol_command("git");
1365 command
1366 .envs(env.iter())
1367 .current_dir(&working_directory?)
1368 .args(["fetch", &remote_name])
1369 .stdout(smol::process::Stdio::piped())
1370 .stderr(smol::process::Stdio::piped());
1371
1372 run_git_command(env, ask_pass, command, &executor).await
1373 }
1374 .boxed()
1375 }
1376
1377 fn get_remotes(&self, branch_name: Option<String>) -> BoxFuture<'_, Result<Vec<Remote>>> {
1378 let working_directory = self.working_directory();
1379 let git_binary_path = self.git_binary_path.clone();
1380 self.executor
1381 .spawn(async move {
1382 let working_directory = working_directory?;
1383 if let Some(branch_name) = branch_name {
1384 let output = new_smol_command(&git_binary_path)
1385 .current_dir(&working_directory)
1386 .args(["config", "--get"])
1387 .arg(format!("branch.{}.remote", branch_name))
1388 .output()
1389 .await?;
1390
1391 if output.status.success() {
1392 let remote_name = String::from_utf8_lossy(&output.stdout);
1393
1394 return Ok(vec![Remote {
1395 name: remote_name.trim().to_string().into(),
1396 }]);
1397 }
1398 }
1399
1400 let output = new_smol_command(&git_binary_path)
1401 .current_dir(&working_directory)
1402 .args(["remote"])
1403 .output()
1404 .await?;
1405
1406 anyhow::ensure!(
1407 output.status.success(),
1408 "Failed to get remotes:\n{}",
1409 String::from_utf8_lossy(&output.stderr)
1410 );
1411 let remote_names = String::from_utf8_lossy(&output.stdout)
1412 .split('\n')
1413 .filter(|name| !name.is_empty())
1414 .map(|name| Remote {
1415 name: name.trim().to_string().into(),
1416 })
1417 .collect();
1418 Ok(remote_names)
1419 })
1420 .boxed()
1421 }
1422
1423 fn check_for_pushed_commit(&self) -> BoxFuture<'_, Result<Vec<SharedString>>> {
1424 let working_directory = self.working_directory();
1425 let git_binary_path = self.git_binary_path.clone();
1426 self.executor
1427 .spawn(async move {
1428 let working_directory = working_directory?;
1429 let git_cmd = async |args: &[&str]| -> Result<String> {
1430 let output = new_smol_command(&git_binary_path)
1431 .current_dir(&working_directory)
1432 .args(args)
1433 .output()
1434 .await?;
1435 anyhow::ensure!(
1436 output.status.success(),
1437 String::from_utf8_lossy(&output.stderr).to_string()
1438 );
1439 Ok(String::from_utf8(output.stdout)?)
1440 };
1441
1442 let head = git_cmd(&["rev-parse", "HEAD"])
1443 .await
1444 .context("Failed to get HEAD")?
1445 .trim()
1446 .to_owned();
1447
1448 let mut remote_branches = vec![];
1449 let mut add_if_matching = async |remote_head: &str| {
1450 if let Ok(merge_base) = git_cmd(&["merge-base", &head, remote_head]).await
1451 && merge_base.trim() == head
1452 && let Some(s) = remote_head.strip_prefix("refs/remotes/") {
1453 remote_branches.push(s.to_owned().into());
1454 }
1455 };
1456
1457 // check the main branch of each remote
1458 let remotes = git_cmd(&["remote"])
1459 .await
1460 .context("Failed to get remotes")?;
1461 for remote in remotes.lines() {
1462 if let Ok(remote_head) =
1463 git_cmd(&["symbolic-ref", &format!("refs/remotes/{remote}/HEAD")]).await
1464 {
1465 add_if_matching(remote_head.trim()).await;
1466 }
1467 }
1468
1469 // ... and the remote branch that the checked-out one is tracking
1470 if let Ok(remote_head) =
1471 git_cmd(&["rev-parse", "--symbolic-full-name", "@{u}"]).await
1472 {
1473 add_if_matching(remote_head.trim()).await;
1474 }
1475
1476 Ok(remote_branches)
1477 })
1478 .boxed()
1479 }
1480
1481 fn checkpoint(&self) -> BoxFuture<'static, Result<GitRepositoryCheckpoint>> {
1482 let working_directory = self.working_directory();
1483 let git_binary_path = self.git_binary_path.clone();
1484 let executor = self.executor.clone();
1485 self.executor
1486 .spawn(async move {
1487 let working_directory = working_directory?;
1488 let mut git = GitBinary::new(git_binary_path, working_directory.clone(), executor)
1489 .envs(checkpoint_author_envs());
1490 git.with_temp_index(async |git| {
1491 let head_sha = git.run(&["rev-parse", "HEAD"]).await.ok();
1492 let mut excludes = exclude_files(git).await?;
1493
1494 git.run(&["add", "--all"]).await?;
1495 let tree = git.run(&["write-tree"]).await?;
1496 let checkpoint_sha = if let Some(head_sha) = head_sha.as_deref() {
1497 git.run(&["commit-tree", &tree, "-p", head_sha, "-m", "Checkpoint"])
1498 .await?
1499 } else {
1500 git.run(&["commit-tree", &tree, "-m", "Checkpoint"]).await?
1501 };
1502
1503 excludes.restore_original().await?;
1504
1505 Ok(GitRepositoryCheckpoint {
1506 commit_sha: checkpoint_sha.parse()?,
1507 })
1508 })
1509 .await
1510 })
1511 .boxed()
1512 }
1513
1514 fn restore_checkpoint(&self, checkpoint: GitRepositoryCheckpoint) -> BoxFuture<'_, Result<()>> {
1515 let working_directory = self.working_directory();
1516 let git_binary_path = self.git_binary_path.clone();
1517
1518 let executor = self.executor.clone();
1519 self.executor
1520 .spawn(async move {
1521 let working_directory = working_directory?;
1522
1523 let git = GitBinary::new(git_binary_path, working_directory, executor);
1524 git.run(&[
1525 "restore",
1526 "--source",
1527 &checkpoint.commit_sha.to_string(),
1528 "--worktree",
1529 ".",
1530 ])
1531 .await?;
1532
1533 // TODO: We don't track binary and large files anymore,
1534 // so the following call would delete them.
1535 // Implement an alternative way to track files added by agent.
1536 //
1537 // git.with_temp_index(async move |git| {
1538 // git.run(&["read-tree", &checkpoint.commit_sha.to_string()])
1539 // .await?;
1540 // git.run(&["clean", "-d", "--force"]).await
1541 // })
1542 // .await?;
1543
1544 Ok(())
1545 })
1546 .boxed()
1547 }
1548
1549 fn compare_checkpoints(
1550 &self,
1551 left: GitRepositoryCheckpoint,
1552 right: GitRepositoryCheckpoint,
1553 ) -> BoxFuture<'_, Result<bool>> {
1554 let working_directory = self.working_directory();
1555 let git_binary_path = self.git_binary_path.clone();
1556
1557 let executor = self.executor.clone();
1558 self.executor
1559 .spawn(async move {
1560 let working_directory = working_directory?;
1561 let git = GitBinary::new(git_binary_path, working_directory, executor);
1562 let result = git
1563 .run(&[
1564 "diff-tree",
1565 "--quiet",
1566 &left.commit_sha.to_string(),
1567 &right.commit_sha.to_string(),
1568 ])
1569 .await;
1570 match result {
1571 Ok(_) => Ok(true),
1572 Err(error) => {
1573 if let Some(GitBinaryCommandError { status, .. }) =
1574 error.downcast_ref::<GitBinaryCommandError>()
1575 && status.code() == Some(1) {
1576 return Ok(false);
1577 }
1578
1579 Err(error)
1580 }
1581 }
1582 })
1583 .boxed()
1584 }
1585
1586 fn diff_checkpoints(
1587 &self,
1588 base_checkpoint: GitRepositoryCheckpoint,
1589 target_checkpoint: GitRepositoryCheckpoint,
1590 ) -> BoxFuture<'_, Result<String>> {
1591 let working_directory = self.working_directory();
1592 let git_binary_path = self.git_binary_path.clone();
1593
1594 let executor = self.executor.clone();
1595 self.executor
1596 .spawn(async move {
1597 let working_directory = working_directory?;
1598 let git = GitBinary::new(git_binary_path, working_directory, executor);
1599 git.run(&[
1600 "diff",
1601 "--find-renames",
1602 "--patch",
1603 &base_checkpoint.commit_sha.to_string(),
1604 &target_checkpoint.commit_sha.to_string(),
1605 ])
1606 .await
1607 })
1608 .boxed()
1609 }
1610
1611 fn default_branch(&self) -> BoxFuture<'_, Result<Option<SharedString>>> {
1612 let working_directory = self.working_directory();
1613 let git_binary_path = self.git_binary_path.clone();
1614
1615 let executor = self.executor.clone();
1616 self.executor
1617 .spawn(async move {
1618 let working_directory = working_directory?;
1619 let git = GitBinary::new(git_binary_path, working_directory, executor);
1620
1621 if let Ok(output) = git
1622 .run(&["symbolic-ref", "refs/remotes/upstream/HEAD"])
1623 .await
1624 {
1625 let output = output
1626 .strip_prefix("refs/remotes/upstream/")
1627 .map(|s| SharedString::from(s.to_owned()));
1628 return Ok(output);
1629 }
1630
1631 let output = git
1632 .run(&["symbolic-ref", "refs/remotes/origin/HEAD"])
1633 .await?;
1634
1635 Ok(output
1636 .strip_prefix("refs/remotes/origin/")
1637 .map(|s| SharedString::from(s.to_owned())))
1638 })
1639 .boxed()
1640 }
1641}
1642
1643fn git_status_args(path_prefixes: &[RepoPath]) -> Vec<OsString> {
1644 let mut args = vec![
1645 OsString::from("--no-optional-locks"),
1646 OsString::from("status"),
1647 OsString::from("--porcelain=v1"),
1648 OsString::from("--untracked-files=all"),
1649 OsString::from("--no-renames"),
1650 OsString::from("-z"),
1651 ];
1652 args.extend(path_prefixes.iter().map(|path_prefix| {
1653 if path_prefix.0.as_ref() == Path::new("") {
1654 Path::new(".").into()
1655 } else {
1656 path_prefix.as_os_str().into()
1657 }
1658 }));
1659 args
1660}
1661
1662/// Temporarily git-ignore commonly ignored files and files over 2MB
1663async fn exclude_files(git: &GitBinary) -> Result<GitExcludeOverride> {
1664 const MAX_SIZE: u64 = 2 * 1024 * 1024; // 2 MB
1665 let mut excludes = git.with_exclude_overrides().await?;
1666 excludes
1667 .add_excludes(include_str!("./checkpoint.gitignore"))
1668 .await?;
1669
1670 let working_directory = git.working_directory.clone();
1671 let untracked_files = git.list_untracked_files().await?;
1672 let excluded_paths = untracked_files.into_iter().map(|path| {
1673 let working_directory = working_directory.clone();
1674 smol::spawn(async move {
1675 let full_path = working_directory.join(path.clone());
1676 match smol::fs::metadata(&full_path).await {
1677 Ok(metadata) if metadata.is_file() && metadata.len() >= MAX_SIZE => {
1678 Some(PathBuf::from("/").join(path.clone()))
1679 }
1680 _ => None,
1681 }
1682 })
1683 });
1684
1685 let excluded_paths = futures::future::join_all(excluded_paths).await;
1686 let excluded_paths = excluded_paths.into_iter().flatten().collect::<Vec<_>>();
1687
1688 if !excluded_paths.is_empty() {
1689 let exclude_patterns = excluded_paths
1690 .into_iter()
1691 .map(|path| path.to_string_lossy().to_string())
1692 .collect::<Vec<_>>()
1693 .join("\n");
1694 excludes.add_excludes(&exclude_patterns).await?;
1695 }
1696
1697 Ok(excludes)
1698}
1699
1700struct GitBinary {
1701 git_binary_path: PathBuf,
1702 working_directory: PathBuf,
1703 executor: BackgroundExecutor,
1704 index_file_path: Option<PathBuf>,
1705 envs: HashMap<String, String>,
1706}
1707
1708impl GitBinary {
1709 fn new(
1710 git_binary_path: PathBuf,
1711 working_directory: PathBuf,
1712 executor: BackgroundExecutor,
1713 ) -> Self {
1714 Self {
1715 git_binary_path,
1716 working_directory,
1717 executor,
1718 index_file_path: None,
1719 envs: HashMap::default(),
1720 }
1721 }
1722
1723 async fn list_untracked_files(&self) -> Result<Vec<PathBuf>> {
1724 let status_output = self
1725 .run(&["status", "--porcelain=v1", "--untracked-files=all", "-z"])
1726 .await?;
1727
1728 let paths = status_output
1729 .split('\0')
1730 .filter(|entry| entry.len() >= 3 && entry.starts_with("?? "))
1731 .map(|entry| PathBuf::from(&entry[3..]))
1732 .collect::<Vec<_>>();
1733 Ok(paths)
1734 }
1735
1736 fn envs(mut self, envs: HashMap<String, String>) -> Self {
1737 self.envs = envs;
1738 self
1739 }
1740
1741 pub async fn with_temp_index<R>(
1742 &mut self,
1743 f: impl AsyncFnOnce(&Self) -> Result<R>,
1744 ) -> Result<R> {
1745 let index_file_path = self.path_for_index_id(Uuid::new_v4());
1746
1747 let delete_temp_index = util::defer({
1748 let index_file_path = index_file_path.clone();
1749 let executor = self.executor.clone();
1750 move || {
1751 executor
1752 .spawn(async move {
1753 smol::fs::remove_file(index_file_path).await.log_err();
1754 })
1755 .detach();
1756 }
1757 });
1758
1759 // Copy the default index file so that Git doesn't have to rebuild the
1760 // whole index from scratch. This might fail if this is an empty repository.
1761 smol::fs::copy(
1762 self.working_directory.join(".git").join("index"),
1763 &index_file_path,
1764 )
1765 .await
1766 .ok();
1767
1768 self.index_file_path = Some(index_file_path.clone());
1769 let result = f(self).await;
1770 self.index_file_path = None;
1771 let result = result?;
1772
1773 smol::fs::remove_file(index_file_path).await.ok();
1774 delete_temp_index.abort();
1775
1776 Ok(result)
1777 }
1778
1779 pub async fn with_exclude_overrides(&self) -> Result<GitExcludeOverride> {
1780 let path = self
1781 .working_directory
1782 .join(".git")
1783 .join("info")
1784 .join("exclude");
1785
1786 GitExcludeOverride::new(path).await
1787 }
1788
1789 fn path_for_index_id(&self, id: Uuid) -> PathBuf {
1790 self.working_directory
1791 .join(".git")
1792 .join(format!("index-{}.tmp", id))
1793 }
1794
1795 pub async fn run<S>(&self, args: impl IntoIterator<Item = S>) -> Result<String>
1796 where
1797 S: AsRef<OsStr>,
1798 {
1799 let mut stdout = self.run_raw(args).await?;
1800 if stdout.chars().last() == Some('\n') {
1801 stdout.pop();
1802 }
1803 Ok(stdout)
1804 }
1805
1806 /// Returns the result of the command without trimming the trailing newline.
1807 pub async fn run_raw<S>(&self, args: impl IntoIterator<Item = S>) -> Result<String>
1808 where
1809 S: AsRef<OsStr>,
1810 {
1811 let mut command = self.build_command(args);
1812 let output = command.output().await?;
1813 anyhow::ensure!(
1814 output.status.success(),
1815 GitBinaryCommandError {
1816 stdout: String::from_utf8_lossy(&output.stdout).to_string(),
1817 status: output.status,
1818 }
1819 );
1820 Ok(String::from_utf8(output.stdout)?)
1821 }
1822
1823 fn build_command<S>(&self, args: impl IntoIterator<Item = S>) -> smol::process::Command
1824 where
1825 S: AsRef<OsStr>,
1826 {
1827 let mut command = new_smol_command(&self.git_binary_path);
1828 command.current_dir(&self.working_directory);
1829 command.args(args);
1830 if let Some(index_file_path) = self.index_file_path.as_ref() {
1831 command.env("GIT_INDEX_FILE", index_file_path);
1832 }
1833 command.envs(&self.envs);
1834 command
1835 }
1836}
1837
1838#[derive(Error, Debug)]
1839#[error("Git command failed: {stdout}")]
1840struct GitBinaryCommandError {
1841 stdout: String,
1842 status: ExitStatus,
1843}
1844
1845async fn run_git_command(
1846 env: Arc<HashMap<String, String>>,
1847 ask_pass: AskPassDelegate,
1848 mut command: smol::process::Command,
1849 executor: &BackgroundExecutor,
1850) -> Result<RemoteCommandOutput> {
1851 if env.contains_key("GIT_ASKPASS") {
1852 let git_process = command.spawn()?;
1853 let output = git_process.output().await?;
1854 anyhow::ensure!(
1855 output.status.success(),
1856 "{}",
1857 String::from_utf8_lossy(&output.stderr)
1858 );
1859 Ok(RemoteCommandOutput {
1860 stdout: String::from_utf8_lossy(&output.stdout).to_string(),
1861 stderr: String::from_utf8_lossy(&output.stderr).to_string(),
1862 })
1863 } else {
1864 let ask_pass = AskPassSession::new(executor, ask_pass).await?;
1865 command
1866 .env("GIT_ASKPASS", ask_pass.script_path())
1867 .env("SSH_ASKPASS", ask_pass.script_path())
1868 .env("SSH_ASKPASS_REQUIRE", "force");
1869 let git_process = command.spawn()?;
1870
1871 run_askpass_command(ask_pass, git_process).await
1872 }
1873}
1874
1875async fn run_askpass_command(
1876 mut ask_pass: AskPassSession,
1877 git_process: smol::process::Child,
1878) -> anyhow::Result<RemoteCommandOutput> {
1879 select_biased! {
1880 result = ask_pass.run().fuse() => {
1881 match result {
1882 AskPassResult::CancelledByUser => {
1883 Err(anyhow!(REMOTE_CANCELLED_BY_USER))?
1884 }
1885 AskPassResult::Timedout => {
1886 Err(anyhow!("Connecting to host timed out"))?
1887 }
1888 }
1889 }
1890 output = git_process.output().fuse() => {
1891 let output = output?;
1892 anyhow::ensure!(
1893 output.status.success(),
1894 "{}",
1895 String::from_utf8_lossy(&output.stderr)
1896 );
1897 Ok(RemoteCommandOutput {
1898 stdout: String::from_utf8_lossy(&output.stdout).to_string(),
1899 stderr: String::from_utf8_lossy(&output.stderr).to_string(),
1900 })
1901 }
1902 }
1903}
1904
1905pub static WORK_DIRECTORY_REPO_PATH: LazyLock<RepoPath> =
1906 LazyLock::new(|| RepoPath(Path::new("").into()));
1907
1908#[derive(Clone, Debug, Ord, Hash, PartialOrd, Eq, PartialEq)]
1909pub struct RepoPath(pub Arc<Path>);
1910
1911impl RepoPath {
1912 pub fn new(path: PathBuf) -> Self {
1913 debug_assert!(path.is_relative(), "Repo paths must be relative");
1914
1915 RepoPath(path.into())
1916 }
1917
1918 pub fn from_str(path: &str) -> Self {
1919 let path = Path::new(path);
1920 debug_assert!(path.is_relative(), "Repo paths must be relative");
1921
1922 RepoPath(path.into())
1923 }
1924
1925 pub fn to_unix_style(&self) -> Cow<'_, OsStr> {
1926 #[cfg(target_os = "windows")]
1927 {
1928 use std::ffi::OsString;
1929
1930 let path = self.0.as_os_str().to_string_lossy().replace("\\", "/");
1931 Cow::Owned(OsString::from(path))
1932 }
1933 #[cfg(not(target_os = "windows"))]
1934 {
1935 Cow::Borrowed(self.0.as_os_str())
1936 }
1937 }
1938}
1939
1940impl std::fmt::Display for RepoPath {
1941 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1942 self.0.to_string_lossy().fmt(f)
1943 }
1944}
1945
1946impl From<&Path> for RepoPath {
1947 fn from(value: &Path) -> Self {
1948 RepoPath::new(value.into())
1949 }
1950}
1951
1952impl From<Arc<Path>> for RepoPath {
1953 fn from(value: Arc<Path>) -> Self {
1954 RepoPath(value)
1955 }
1956}
1957
1958impl From<PathBuf> for RepoPath {
1959 fn from(value: PathBuf) -> Self {
1960 RepoPath::new(value)
1961 }
1962}
1963
1964impl From<&str> for RepoPath {
1965 fn from(value: &str) -> Self {
1966 Self::from_str(value)
1967 }
1968}
1969
1970impl Default for RepoPath {
1971 fn default() -> Self {
1972 RepoPath(Path::new("").into())
1973 }
1974}
1975
1976impl AsRef<Path> for RepoPath {
1977 fn as_ref(&self) -> &Path {
1978 self.0.as_ref()
1979 }
1980}
1981
1982impl std::ops::Deref for RepoPath {
1983 type Target = Path;
1984
1985 fn deref(&self) -> &Self::Target {
1986 &self.0
1987 }
1988}
1989
1990impl Borrow<Path> for RepoPath {
1991 fn borrow(&self) -> &Path {
1992 self.0.as_ref()
1993 }
1994}
1995
1996#[derive(Debug)]
1997pub struct RepoPathDescendants<'a>(pub &'a Path);
1998
1999impl MapSeekTarget<RepoPath> for RepoPathDescendants<'_> {
2000 fn cmp_cursor(&self, key: &RepoPath) -> Ordering {
2001 if key.starts_with(self.0) {
2002 Ordering::Greater
2003 } else {
2004 self.0.cmp(key)
2005 }
2006 }
2007}
2008
2009fn parse_branch_input(input: &str) -> Result<Vec<Branch>> {
2010 let mut branches = Vec::new();
2011 for line in input.split('\n') {
2012 if line.is_empty() {
2013 continue;
2014 }
2015 let mut fields = line.split('\x00');
2016 let is_current_branch = fields.next().context("no HEAD")? == "*";
2017 let head_sha: SharedString = fields.next().context("no objectname")?.to_string().into();
2018 let parent_sha: SharedString = fields.next().context("no parent")?.to_string().into();
2019 let ref_name = fields.next().context("no refname")?.to_string().into();
2020 let upstream_name = fields.next().context("no upstream")?.to_string();
2021 let upstream_tracking = parse_upstream_track(fields.next().context("no upstream:track")?)?;
2022 let commiterdate = fields.next().context("no committerdate")?.parse::<i64>()?;
2023 let subject: SharedString = fields
2024 .next()
2025 .context("no contents:subject")?
2026 .to_string()
2027 .into();
2028
2029 branches.push(Branch {
2030 is_head: is_current_branch,
2031 ref_name: ref_name,
2032 most_recent_commit: Some(CommitSummary {
2033 sha: head_sha,
2034 subject,
2035 commit_timestamp: commiterdate,
2036 has_parent: !parent_sha.is_empty(),
2037 }),
2038 upstream: if upstream_name.is_empty() {
2039 None
2040 } else {
2041 Some(Upstream {
2042 ref_name: upstream_name.into(),
2043 tracking: upstream_tracking,
2044 })
2045 },
2046 })
2047 }
2048
2049 Ok(branches)
2050}
2051
2052fn parse_upstream_track(upstream_track: &str) -> Result<UpstreamTracking> {
2053 if upstream_track == "" {
2054 return Ok(UpstreamTracking::Tracked(UpstreamTrackingStatus {
2055 ahead: 0,
2056 behind: 0,
2057 }));
2058 }
2059
2060 let upstream_track = upstream_track.strip_prefix("[").context("missing [")?;
2061 let upstream_track = upstream_track.strip_suffix("]").context("missing [")?;
2062 let mut ahead: u32 = 0;
2063 let mut behind: u32 = 0;
2064 for component in upstream_track.split(", ") {
2065 if component == "gone" {
2066 return Ok(UpstreamTracking::Gone);
2067 }
2068 if let Some(ahead_num) = component.strip_prefix("ahead ") {
2069 ahead = ahead_num.parse::<u32>()?;
2070 }
2071 if let Some(behind_num) = component.strip_prefix("behind ") {
2072 behind = behind_num.parse::<u32>()?;
2073 }
2074 }
2075 Ok(UpstreamTracking::Tracked(UpstreamTrackingStatus {
2076 ahead,
2077 behind,
2078 }))
2079}
2080
2081fn check_path_to_repo_path_errors(relative_file_path: &Path) -> Result<()> {
2082 match relative_file_path.components().next() {
2083 None => anyhow::bail!("repo path should not be empty"),
2084 Some(Component::Prefix(_)) => anyhow::bail!(
2085 "repo path `{}` should be relative, not a windows prefix",
2086 relative_file_path.to_string_lossy()
2087 ),
2088 Some(Component::RootDir) => {
2089 anyhow::bail!(
2090 "repo path `{}` should be relative",
2091 relative_file_path.to_string_lossy()
2092 )
2093 }
2094 Some(Component::CurDir) => {
2095 anyhow::bail!(
2096 "repo path `{}` should not start with `.`",
2097 relative_file_path.to_string_lossy()
2098 )
2099 }
2100 Some(Component::ParentDir) => {
2101 anyhow::bail!(
2102 "repo path `{}` should not start with `..`",
2103 relative_file_path.to_string_lossy()
2104 )
2105 }
2106 _ => Ok(()),
2107 }
2108}
2109
2110fn checkpoint_author_envs() -> HashMap<String, String> {
2111 HashMap::from_iter([
2112 ("GIT_AUTHOR_NAME".to_string(), "Zed".to_string()),
2113 ("GIT_AUTHOR_EMAIL".to_string(), "hi@zed.dev".to_string()),
2114 ("GIT_COMMITTER_NAME".to_string(), "Zed".to_string()),
2115 ("GIT_COMMITTER_EMAIL".to_string(), "hi@zed.dev".to_string()),
2116 ])
2117}
2118
2119#[cfg(test)]
2120mod tests {
2121 use super::*;
2122 use gpui::TestAppContext;
2123
2124 #[gpui::test]
2125 async fn test_checkpoint_basic(cx: &mut TestAppContext) {
2126 cx.executor().allow_parking();
2127
2128 let repo_dir = tempfile::tempdir().unwrap();
2129
2130 git2::Repository::init(repo_dir.path()).unwrap();
2131 let file_path = repo_dir.path().join("file");
2132 smol::fs::write(&file_path, "initial").await.unwrap();
2133
2134 let repo =
2135 RealGitRepository::new(&repo_dir.path().join(".git"), None, cx.executor()).unwrap();
2136 repo.stage_paths(
2137 vec![RepoPath::from_str("file")],
2138 Arc::new(HashMap::default()),
2139 )
2140 .await
2141 .unwrap();
2142 repo.commit(
2143 "Initial commit".into(),
2144 None,
2145 CommitOptions::default(),
2146 Arc::new(checkpoint_author_envs()),
2147 )
2148 .await
2149 .unwrap();
2150
2151 smol::fs::write(&file_path, "modified before checkpoint")
2152 .await
2153 .unwrap();
2154 smol::fs::write(repo_dir.path().join("new_file_before_checkpoint"), "1")
2155 .await
2156 .unwrap();
2157 let checkpoint = repo.checkpoint().await.unwrap();
2158
2159 // Ensure the user can't see any branches after creating a checkpoint.
2160 assert_eq!(repo.branches().await.unwrap().len(), 1);
2161
2162 smol::fs::write(&file_path, "modified after checkpoint")
2163 .await
2164 .unwrap();
2165 repo.stage_paths(
2166 vec![RepoPath::from_str("file")],
2167 Arc::new(HashMap::default()),
2168 )
2169 .await
2170 .unwrap();
2171 repo.commit(
2172 "Commit after checkpoint".into(),
2173 None,
2174 CommitOptions::default(),
2175 Arc::new(checkpoint_author_envs()),
2176 )
2177 .await
2178 .unwrap();
2179
2180 smol::fs::remove_file(repo_dir.path().join("new_file_before_checkpoint"))
2181 .await
2182 .unwrap();
2183 smol::fs::write(repo_dir.path().join("new_file_after_checkpoint"), "2")
2184 .await
2185 .unwrap();
2186
2187 // Ensure checkpoint stays alive even after a Git GC.
2188 repo.gc().await.unwrap();
2189 repo.restore_checkpoint(checkpoint.clone()).await.unwrap();
2190
2191 assert_eq!(
2192 smol::fs::read_to_string(&file_path).await.unwrap(),
2193 "modified before checkpoint"
2194 );
2195 assert_eq!(
2196 smol::fs::read_to_string(repo_dir.path().join("new_file_before_checkpoint"))
2197 .await
2198 .unwrap(),
2199 "1"
2200 );
2201 // See TODO above
2202 // assert_eq!(
2203 // smol::fs::read_to_string(repo_dir.path().join("new_file_after_checkpoint"))
2204 // .await
2205 // .ok(),
2206 // None
2207 // );
2208 }
2209
2210 #[gpui::test]
2211 async fn test_checkpoint_empty_repo(cx: &mut TestAppContext) {
2212 cx.executor().allow_parking();
2213
2214 let repo_dir = tempfile::tempdir().unwrap();
2215 git2::Repository::init(repo_dir.path()).unwrap();
2216 let repo =
2217 RealGitRepository::new(&repo_dir.path().join(".git"), None, cx.executor()).unwrap();
2218
2219 smol::fs::write(repo_dir.path().join("foo"), "foo")
2220 .await
2221 .unwrap();
2222 let checkpoint_sha = repo.checkpoint().await.unwrap();
2223
2224 // Ensure the user can't see any branches after creating a checkpoint.
2225 assert_eq!(repo.branches().await.unwrap().len(), 1);
2226
2227 smol::fs::write(repo_dir.path().join("foo"), "bar")
2228 .await
2229 .unwrap();
2230 smol::fs::write(repo_dir.path().join("baz"), "qux")
2231 .await
2232 .unwrap();
2233 repo.restore_checkpoint(checkpoint_sha).await.unwrap();
2234 assert_eq!(
2235 smol::fs::read_to_string(repo_dir.path().join("foo"))
2236 .await
2237 .unwrap(),
2238 "foo"
2239 );
2240 // See TODOs above
2241 // assert_eq!(
2242 // smol::fs::read_to_string(repo_dir.path().join("baz"))
2243 // .await
2244 // .ok(),
2245 // None
2246 // );
2247 }
2248
2249 #[gpui::test]
2250 async fn test_compare_checkpoints(cx: &mut TestAppContext) {
2251 cx.executor().allow_parking();
2252
2253 let repo_dir = tempfile::tempdir().unwrap();
2254 git2::Repository::init(repo_dir.path()).unwrap();
2255 let repo =
2256 RealGitRepository::new(&repo_dir.path().join(".git"), None, cx.executor()).unwrap();
2257
2258 smol::fs::write(repo_dir.path().join("file1"), "content1")
2259 .await
2260 .unwrap();
2261 let checkpoint1 = repo.checkpoint().await.unwrap();
2262
2263 smol::fs::write(repo_dir.path().join("file2"), "content2")
2264 .await
2265 .unwrap();
2266 let checkpoint2 = repo.checkpoint().await.unwrap();
2267
2268 assert!(
2269 !repo
2270 .compare_checkpoints(checkpoint1, checkpoint2.clone())
2271 .await
2272 .unwrap()
2273 );
2274
2275 let checkpoint3 = repo.checkpoint().await.unwrap();
2276 assert!(
2277 repo.compare_checkpoints(checkpoint2, checkpoint3)
2278 .await
2279 .unwrap()
2280 );
2281 }
2282
2283 #[gpui::test]
2284 async fn test_checkpoint_exclude_binary_files(cx: &mut TestAppContext) {
2285 cx.executor().allow_parking();
2286
2287 let repo_dir = tempfile::tempdir().unwrap();
2288 let text_path = repo_dir.path().join("main.rs");
2289 let bin_path = repo_dir.path().join("binary.o");
2290
2291 git2::Repository::init(repo_dir.path()).unwrap();
2292
2293 smol::fs::write(&text_path, "fn main() {}").await.unwrap();
2294
2295 smol::fs::write(&bin_path, "some binary file here")
2296 .await
2297 .unwrap();
2298
2299 let repo =
2300 RealGitRepository::new(&repo_dir.path().join(".git"), None, cx.executor()).unwrap();
2301
2302 // initial commit
2303 repo.stage_paths(
2304 vec![RepoPath::from_str("main.rs")],
2305 Arc::new(HashMap::default()),
2306 )
2307 .await
2308 .unwrap();
2309 repo.commit(
2310 "Initial commit".into(),
2311 None,
2312 CommitOptions::default(),
2313 Arc::new(checkpoint_author_envs()),
2314 )
2315 .await
2316 .unwrap();
2317
2318 let checkpoint = repo.checkpoint().await.unwrap();
2319
2320 smol::fs::write(&text_path, "fn main() { println!(\"Modified\"); }")
2321 .await
2322 .unwrap();
2323 smol::fs::write(&bin_path, "Modified binary file")
2324 .await
2325 .unwrap();
2326
2327 repo.restore_checkpoint(checkpoint).await.unwrap();
2328
2329 // Text files should be restored to checkpoint state,
2330 // but binaries should not (they aren't tracked)
2331 assert_eq!(
2332 smol::fs::read_to_string(&text_path).await.unwrap(),
2333 "fn main() {}"
2334 );
2335
2336 assert_eq!(
2337 smol::fs::read_to_string(&bin_path).await.unwrap(),
2338 "Modified binary file"
2339 );
2340 }
2341
2342 #[test]
2343 fn test_branches_parsing() {
2344 // suppress "help: octal escapes are not supported, `\0` is always null"
2345 #[allow(clippy::octal_escapes)]
2346 let input = "*\0060964da10574cd9bf06463a53bf6e0769c5c45e\0\0refs/heads/zed-patches\0refs/remotes/origin/zed-patches\0\01733187470\0generated protobuf\n";
2347 assert_eq!(
2348 parse_branch_input(input).unwrap(),
2349 vec![Branch {
2350 is_head: true,
2351 ref_name: "refs/heads/zed-patches".into(),
2352 upstream: Some(Upstream {
2353 ref_name: "refs/remotes/origin/zed-patches".into(),
2354 tracking: UpstreamTracking::Tracked(UpstreamTrackingStatus {
2355 ahead: 0,
2356 behind: 0
2357 })
2358 }),
2359 most_recent_commit: Some(CommitSummary {
2360 sha: "060964da10574cd9bf06463a53bf6e0769c5c45e".into(),
2361 subject: "generated protobuf".into(),
2362 commit_timestamp: 1733187470,
2363 has_parent: false,
2364 })
2365 }]
2366 )
2367 }
2368
2369 impl RealGitRepository {
2370 /// Force a Git garbage collection on the repository.
2371 fn gc(&self) -> BoxFuture<'_, Result<()>> {
2372 let working_directory = self.working_directory();
2373 let git_binary_path = self.git_binary_path.clone();
2374 let executor = self.executor.clone();
2375 self.executor
2376 .spawn(async move {
2377 let git_binary_path = git_binary_path.clone();
2378 let working_directory = working_directory?;
2379 let git = GitBinary::new(git_binary_path, working_directory, executor);
2380 git.run(&["gc", "--prune"]).await?;
2381 Ok(())
2382 })
2383 .boxed()
2384 }
2385 }
2386}