From 49eade25e43ff31feba5f68d331bd18b9af846ab Mon Sep 17 00:00:00 2001
From: Willian Mori <wmrmrx@gmail.com>
Date: Sat, 9 Sep 2023 19:47:27 -0300
Subject: [PATCH] cli: hint for conflicted branches

---
 cli/src/cli_util.rs        | 44 +++++++++++++++++++++++++++-----------
 cli/tests/test_checkout.rs | 34 +++++++++++++++++++++++++++++
 2 files changed, 65 insertions(+), 13 deletions(-)

diff --git a/cli/src/cli_util.rs b/cli/src/cli_util.rs
index c73ac8e141..95f01fd7c0 100644
--- a/cli/src/cli_util.rs
+++ b/cli/src/cli_util.rs
@@ -51,9 +51,9 @@ use jj_lib::repo::{
 };
 use jj_lib::repo_path::{FsPathParseError, RepoPath};
 use jj_lib::revset::{
-    DefaultSymbolResolver, Revset, RevsetAliasesMap, RevsetEvaluationError, RevsetExpression,
-    RevsetIteratorExt, RevsetParseContext, RevsetParseError, RevsetParseErrorKind,
-    RevsetResolutionError, RevsetWorkspaceContext,
+    DefaultSymbolResolver, Revset, RevsetAliasesMap, RevsetCommitRef, RevsetEvaluationError,
+    RevsetExpression, RevsetIteratorExt, RevsetParseContext, RevsetParseError,
+    RevsetParseErrorKind, RevsetResolutionError, RevsetWorkspaceContext,
 };
 use jj_lib::settings::{ConfigResultExt as _, UserSettings};
 use jj_lib::transaction::Transaction;
@@ -1006,7 +1006,7 @@ impl WorkspaceCommandHelper {
         ui: &mut Ui,
     ) -> Result<Commit, CommandError> {
         let revset_expression = self.parse_revset(revision_str, Some(ui))?;
-        let revset = self.evaluate_revset(revset_expression)?;
+        let revset = self.evaluate_revset(revset_expression.clone())?;
         let mut iter = revset.iter().commits(self.repo().store()).fuse();
         match (iter.next(), iter.next()) {
             (Some(commit), None) => Ok(commit?),
@@ -1017,15 +1017,33 @@ impl WorkspaceCommandHelper {
                 let mut iter = [commit0, commit1].into_iter().chain(iter);
                 let commits: Vec<_> = iter.by_ref().take(5).try_collect()?;
                 let elided = iter.next().is_some();
-                let hint = format!(
-                    r#"The revset "{revision_str}" resolved to these revisions:{eol}{commits}{ellipsis}"#,
-                    eol = "\n",
-                    commits = commits
-                        .iter()
-                        .map(|c| self.format_commit_summary(c))
-                        .join("\n"),
-                    ellipsis = elided.then_some("\n...").unwrap_or_default()
-                );
+                let hint = if let RevsetExpression::CommitRef(RevsetCommitRef::Symbol(
+                    branch_name,
+                )) = revset_expression.as_ref()
+                {
+                    // Separate hint if there's a conflicted branch
+                    format!(
+                        r#"Branch {branch_name} resolved to multiple revisions because it's conflicted.
+It resolved to these revisions:
+{commits}{ellipsis}
+Set which revision the branch points to with "jj branch set {branch_name} -r <REVISION>"."#,
+                        commits = commits
+                            .iter()
+                            .map(|c| self.format_commit_summary(c))
+                            .join("\n"),
+                        ellipsis = elided.then_some("\n...").unwrap_or_default()
+                    )
+                } else {
+                    format!(
+                        r#"The revset "{revision_str}" resolved to these revisions:{eol}{commits}{ellipsis}"#,
+                        eol = "\n",
+                        commits = commits
+                            .iter()
+                            .map(|c| self.format_commit_summary(c))
+                            .join("\n"),
+                        ellipsis = elided.then_some("\n...").unwrap_or_default()
+                    )
+                };
                 Err(user_error_with_hint(
                     format!(r#"Revset "{revision_str}" resolved to more than one revision"#),
                     hint,
diff --git a/cli/tests/test_checkout.rs b/cli/tests/test_checkout.rs
index ea1111048a..664872c177 100644
--- a/cli/tests/test_checkout.rs
+++ b/cli/tests/test_checkout.rs
@@ -100,6 +100,40 @@ fn test_checkout_not_single_rev() {
     "###);
 }
 
+#[test]
+fn test_checkout_conflicting_branches() {
+    // Much of this test is borrowed from `test_git_fetch_conflicting_branches` in
+    // test_git_fetch.rs
+    let test_env = TestEnvironment::default();
+    test_env.jj_cmd_success(test_env.env_root(), &["init", "repo", "--git"]);
+    let repo_path = test_env.env_root().join("repo");
+
+    test_env.jj_cmd_success(&repo_path, &["describe", "-m", "one"]);
+    test_env.jj_cmd_success(&repo_path, &["new", "-m", "two", "@-"]);
+    test_env.jj_cmd_success(&repo_path, &["branch", "create", "foo"]);
+    test_env.jj_cmd_success(&repo_path, &["--at-op=@-", "branch", "create", "foo", "-r", r#"description("one")"#]);
+
+    let stdout = test_env.jj_cmd_success(&repo_path, &["log"]);
+    insta::assert_snapshot!(stdout, @r###"
+    Concurrent modification detected, resolving automatically.
+    @  kkmpptxz test.user@example.com 2001-02-03 04:05:09.000 +07:00 foo?? 66c6502d
+    │  (empty) two
+    │ ◉  qpvuntsm test.user@example.com 2001-02-03 04:05:08.000 +07:00 foo?? a9330854
+    ├─╯  (empty) one
+    ◉  zzzzzzzz root() 00000000
+    "###);
+
+    let stderr = test_env.jj_cmd_failure(&repo_path, &["checkout", "foo"]);
+    insta::assert_snapshot!(stderr, @r###"
+    Error: Revset "foo" resolved to more than one revision
+    Hint: Branch foo resolved to multiple revisions because it's conflicted.
+    It resolved to these revisions:
+    kkmpptxz 66c6502d foo?? | (empty) two
+    qpvuntsm a9330854 foo?? | (empty) one
+    Set which revision the branch points to with "jj branch set foo -r <REVISION>".
+    "###);
+}
+
 fn get_log_output(test_env: &TestEnvironment, cwd: &Path) -> String {
     let template = r#"commit_id ++ " " ++ description"#;
     test_env.jj_cmd_success(cwd, &["log", "-T", template])