cli git push: allow pushing explicitly named bookmarks

By explicitly naming the bookmark to push, users already express their
intent to push that particular bookmark. Requiring them to express
that intent a second time by manually marking the bookmark as tracked
is therefore unnecessary. There are some exceptional situations where
the intent can still be unclear related to multiple remotes and glob
patterns.

Author: senekor

CHANGELOG.md

@@ -24,6 +24,9 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
   filesystem's behavior, but this can be overridden manually by setting
   `working-copy.exec-bit-change = "respect" | "ignore"`.
 
+* `jj git push --bookmark <name>` will now automatically track the bookmark in
+  cases where the user intent is unambiguous.
+
 ### Fixed bugs
 
 * Broken symlink on Windows. [#6934](https://github.com/jj-vcs/jj/issues/6934).

cli/src/commands/git/push.rs

@@ -49,6 +49,7 @@ use jj_lib::revset::RevsetExpression;
 use jj_lib::settings::UserSettings;
 use jj_lib::signing::SignBehavior;
 use jj_lib::str_util::StringExpression;
+use jj_lib::str_util::StringMatcher;
 use jj_lib::view::View;
 
 use crate::cli_util::CommandHelper;
@@ -349,6 +350,36 @@ pub fn cmd_git_push(
                 continue;
             }
             let remote_symbol = name.to_remote_symbol(remote);
+            // Check for some targeted allow_new overrides. These are
+            // conservative heuristics, rather than principled rules. They
+            // should cover most practical situations without causing harm.
+            let allow_new = if args.bookmark.iter().any(|b| b.contains(':')) {
+                // The user specified bookmarks with something more complicated
+                // than exact matching. It's possible that some bookmarks which
+                // shouldn't be pushed are matched by mistake. Therefore, do not
+                // override allow_new.
+                allow_new
+            } else if args.remote.is_some() {
+                // The user specified all bookmarks exactly and provided an
+                // explicit remote to push to. Since the user's intent is
+                // unambiguous, allow the bookmark to be pushed.
+                true
+            } else if view
+                .remote_bookmarks_matching(&StringMatcher::Exact(name.into()), &StringMatcher::All)
+                .any(|(_, target)| target.is_tracked())
+            {
+                // The bookmark is already tracked with some remote. If it
+                // is not tracked with the default remote being pushed to,
+                // there is a good chance the user meant to push the bookmark
+                // to the remote it's already tracking, but forgot to supply
+                // `--remote`. Therefore, do not override allow_new.
+                allow_new
+            } else {
+                // The user specified this bookmark exactly and it is not
+                // tracked with any other remote. The user unambiguously intends
+                // to push this new bookmark to the default remote.
+                true
+            };
             let allow_delete = true; // named explicitly, allow delete without --delete
             match classify_bookmark_update(remote_symbol, targets, allow_new, allow_delete) {
                 Ok(Some(update)) => bookmark_updates.push((name.to_owned(), update)),

cli/tests/test_git_push.rs

@@ -1369,7 +1369,7 @@ fn test_git_push_mixed() {
         .success();
     work_dir.write_file("file", "modified again");
 
-    // --allow-new is not implied for --bookmark=.. and -r=..
+    // --allow-new is not implied for -r=..
     let output = work_dir.run_jj([
         "git",
         "push",
@@ -1380,10 +1380,14 @@ fn test_git_push_mixed() {
     insta::assert_snapshot!(output, @r"
     ------- stderr -------
     Creating bookmark push-yqosqzytrlsw for revision yqosqzytrlsw
-    Error: Refusing to create new remote bookmark bookmark-1@origin
-    Hint: Run `jj bookmark track bookmark-1@origin` and try again.
+    Warning: Refusing to create new remote bookmark bookmark-2a@origin
+    Hint: Run `jj bookmark track bookmark-2a@origin` and try again.
+    Warning: Refusing to create new remote bookmark bookmark-2b@origin
+    Hint: Run `jj bookmark track bookmark-2b@origin` and try again.
+    Changes to push to origin:
+      Add bookmark push-yqosqzytrlsw to 0f8164cd580b
+      Add bookmark bookmark-1 to e76139e55e1e
     [EOF]
-    [exit status: 1]
     ");
 
     let output = work_dir.run_jj([
@@ -1397,16 +1401,123 @@ fn test_git_push_mixed() {
     insta::assert_snapshot!(output, @r"
     ------- stderr -------
     Warning: --allow-new is deprecated, track bookmarks manually or configure remotes.<name>.auto-track-bookmarks instead.
-    Creating bookmark push-yqosqzytrlsw for revision yqosqzytrlsw
+    Bookmark push-yqosqzytrlsw@origin already matches push-yqosqzytrlsw
+    Bookmark bookmark-1@origin already matches bookmark-1
     Changes to push to origin:
-      Add bookmark push-yqosqzytrlsw to 0f8164cd580b
-      Add bookmark bookmark-1 to e76139e55e1e
       Add bookmark bookmark-2a to 57d822f901bb
       Add bookmark bookmark-2b to 57d822f901bb
     [EOF]
     ");
 }
 
+#[test]
+fn test_git_push_allow_new_bookmark_heuristics() {
+    let test_env = TestEnvironment::default();
+    set_up(&test_env);
+    let work_dir = test_env.work_dir("local");
+    test_env
+        .run_jj_in(".", ["git", "init", "--colocate", "upstream"])
+        .success();
+    work_dir
+        .run_jj([
+            "git",
+            "remote",
+            "add",
+            "upstream",
+            test_env
+                .work_dir("upstream")
+                .root()
+                .join(".git")
+                .to_str()
+                .unwrap(),
+        ])
+        .success();
+    work_dir.run_jj(["describe", "-m", "foo"]).success();
+    work_dir.write_file("file", "contents");
+
+    work_dir
+        .run_jj(["bookmark", "create", "untracked"])
+        .success();
+
+    let start_op = work_dir.current_operation_id();
+
+    // Pushing untracked bookmarks with --bookmark automatically trackes it.
+    let output = work_dir.run_jj(["git", "push", "--bookmark", "untracked"]);
+    insta::assert_snapshot!(output, @r"
+    ------- stderr -------
+    Changes to push to origin:
+      Add bookmark untracked to b9124726209b
+    [EOF]
+    ");
+
+    work_dir.run_jj(["op", "restore", &start_op]).success();
+    work_dir
+        .run_jj([
+            "git",
+            "push",
+            "--bookmark",
+            "untracked",
+            "--remote",
+            "upstream",
+        ])
+        .success();
+
+    // ...unless the bookmark is already tracked with a different remote, in
+    // which case the user may have simply forgotten to specify --remote.
+    let output = work_dir.run_jj(["git", "push", "--bookmark", "untracked"]);
+    insta::assert_snapshot!(output, @r"
+    ------- stderr -------
+    Error: Refusing to create new remote bookmark untracked@origin
+    Hint: Run `jj bookmark track untracked@origin` and try again.
+    [EOF]
+    [exit status: 1]
+    ");
+
+    work_dir.run_jj(["op", "restore", &start_op]).success();
+    work_dir
+        .run_jj(["git", "push", "--bookmark", "untracked"])
+        .success();
+
+    // If the user explicitly requests to push the bookmark to a different
+    // remote than the one it's already tracking, that is fine.
+    let output = work_dir.run_jj([
+        "git",
+        "push",
+        "--bookmark",
+        "untracked",
+        "--remote",
+        "upstream",
+    ]);
+    insta::assert_snapshot!(output, @r"
+    ------- stderr -------
+    Changes to push to upstream:
+      Add bookmark untracked to b9124726209b
+    [EOF]
+    ");
+
+    work_dir.run_jj(["op", "restore", &start_op]).success();
+
+    // If the user provides something other than an exact string to
+    // match with --bookmark, the automatic tracking is completely disabled,
+    // because a glob pattern could accidentally match a bookmark name
+    // that wasn't intended to be pushed.
+    let output = work_dir.run_jj([
+        "git",
+        "push",
+        "--bookmark",
+        "glob:*tracked",
+        "--remote",
+        "origin",
+    ]);
+    insta::assert_snapshot!(output, @r"
+    ------- stderr -------
+    Error: Refusing to create new remote bookmark untracked@origin
+    Hint: Run `jj bookmark track untracked@origin` and try again.
+    [EOF]
+    [exit status: 1]
+    ");
+}
+
 #[test]
 fn test_git_push_unsnapshotted_change() {
     let test_env = TestEnvironment::default();