Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bookmark: Make bookmark {create, set, move} unhide hidden commits #5050

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+95 −2
Open

bookmark: Make bookmark {create, set, move} unhide hidden commits #5050

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c8fe996
commit: Add `commit.is_hidden(repo)`
PhilipMetzger Dec 7, 2024
e08a04e
bookmark: Make `bookmark {create, set, move}` unhide hidden commits
PhilipMetzger Dec 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions cli/src/commands/bookmark/create.rs
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Implementing it as such makes it consistent with both jj edit and jj new
which unhide any predecessor.

I find "predecessor" a bit confusing the unhidden commit doesn't need to be a predecessor of the current commit, or a predecessor of any commit at all for that matter (maybe it was just abandoned).

Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,9 @@ pub fn cmd_bookmark_create(
let mut workspace_command = command.workspace_helper(ui)?;
let target_commit = workspace_command
.resolve_single_rev(ui, args.revision.as_ref().unwrap_or(&RevisionArg::AT))?;
let repo = workspace_command.repo();
let view = workspace_command.repo().view();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: use repo here

let is_hidden = target_commit.is_hidden(repo.as_ref())?;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: I think is_hidden() test is redundant (in all commands.) iirc, these commands check if bookmarks are moved/created, so we can just do .add_head() if there are any bookmark changes.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True, the repo seems like a better level to do it. I've updated my branch. I should also add tests for it in jj-lib. Or do you want to take my commit and add tests, @PhilipMetzger?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think is_hidden() test is redundant (in all commands.) iirc, these commands check if bookmarks are moved/created, so we can just do .add_head() if there are any bookmark changes.

I agree, but it was the simplest way to implement it.

True, the repo seems like a better level to do it. I've updated my branch. I should also add tests for it in jj-lib. Or do you want to take my commit and add tests, @PhilipMetzger?

I in general agree with the direction we take here, so I probably should take over Martin's branch and drop the first commit, if it otherwise doesn't provide value.

let bookmark_names = &args.names;
for name in bookmark_names {
if view.get_local_bookmark(name).is_present() {
Expand Down Expand Up @@ -94,6 +96,11 @@ pub fn cmd_bookmark_create(
writeln!(ui.hint_default(), "Use -r to specify the target revision.")?;
}

// The commit was hidden, so make it visible again.
if is_hidden {
tx.repo_mut().add_head(&target_commit)?;
}

tx.finish(
ui,
format!(
Expand Down
6 changes: 6 additions & 0 deletions cli/src/commands/bookmark/move.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ pub fn cmd_bookmark_move(
let repo = workspace_command.repo().clone();

let target_commit = workspace_command.resolve_single_rev(ui, &args.to)?;
let is_hidden = target_commit.is_hidden(repo.as_ref())?;
let matched_bookmarks = {
let is_source_ref: Box<dyn Fn(&RefTarget) -> _> = if !args.from.is_empty() {
let is_source_commit = workspace_command
Expand Down Expand Up @@ -168,6 +169,11 @@ pub fn cmd_bookmark_move(
)?;
}

// The commit was hidden, unhide it.
if is_hidden {
tx.repo_mut().add_head(&target_commit)?;
}

tx.finish(
ui,
format!(
Expand Down
7 changes: 7 additions & 0 deletions cli/src/commands/bookmark/set.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ pub fn cmd_bookmark_set(
.resolve_single_rev(ui, args.revision.as_ref().unwrap_or(&RevisionArg::AT))?;
let repo = workspace_command.repo().as_ref();
let bookmark_names = &args.names;
let is_hidden = target_commit.is_hidden(repo)?;
let mut new_bookmark_count = 0;
let mut moved_bookmark_count = 0;
for name in bookmark_names {
Expand Down Expand Up @@ -106,6 +107,12 @@ pub fn cmd_bookmark_set(
if bookmark_names.len() > 1 && args.revision.is_none() {
writeln!(ui.hint_default(), "Use -r to specify the target revision.")?;
}

// The commit is hidden, so unhide it.
if is_hidden {
tx.repo_mut().add_head(&target_commit)?;
}

if new_bookmark_count > 0 {
// TODO: delete this hint in jj 0.25+
writeln!(
Expand Down
4 changes: 2 additions & 2 deletions cli/src/commit_templater.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -774,8 +774,8 @@ fn builtin_commit_methods<'repo>() -> CommitTemplateBuildMethodFnMap<'repo, Comm
function.expect_no_arguments()?;
let repo = language.repo;
let out_property = self_property.map(|commit| {
let maybe_entries = repo.resolve_change_id(commit.change_id());
maybe_entries.map_or(true, |entries| !entries.contains(commit.id()))
let value = commit.is_hidden(repo);
value.unwrap_or_default()
Comment on lines +777 to +778
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: inline value? It's so short now that I think it's easier to read as one expression

});
Ok(L::wrap_boolean(out_property))
},
Expand Down
67 changes: 67 additions & 0 deletions cli/tests/test_bookmark_command.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1898,6 +1898,73 @@ fn test_bookmark_list_conflicted() {
"###);
}

#[test]
fn test_bookmark_create_onto_hidden_unhides() {
let test_env = TestEnvironment::default();
test_env.jj_cmd_ok(test_env.env_root(), &["git", "init", "repo"]);
let repo_path = test_env.env_root().join("repo");

std::fs::write(repo_path.join("a.txt"), "AA").unwrap();
test_env.jj_cmd_ok(&repo_path, &["commit", "-m", "A"]);
// Emulate a simple commit change, where we want to recover the initial version.
std::fs::write(repo_path.join("b.txt"), "BB").unwrap();
test_env.jj_cmd_ok(&repo_path, &["debug", "snapshot"]);
std::fs::write(repo_path.join("b.txt"), "Art").unwrap();
test_env.jj_cmd_ok(&repo_path, &["commit", "-m", "B"]);
// Create our bookmark onto the hidden commit.
let (stdout, _) = test_env.jj_cmd_ok(&repo_path, &["bookmark", "create", "back"]);
insta::assert_snapshot!(stdout, r#""#);
}

#[test]
fn test_bookmark_move_onto_hidden_unhides() {
let test_env = TestEnvironment::default();
test_env.jj_cmd_ok(test_env.env_root(), &["git", "init", "repo"]);
let repo_path = test_env.env_root().join("repo");

std::fs::write(repo_path.join("a.txt"), "AA").unwrap();
test_env.jj_cmd_ok(&repo_path, &["commit", "-m", "A"]);
// Create our bookmark on the first commit. It will be moved to a predecessor of
// the second one.
test_env.jj_cmd_ok(&repo_path, &["bookmark", "create", "back"]);
// Emulate a simple commit change, where we want to recover the initial version.
std::fs::write(repo_path.join("b.txt"), "BB").unwrap();
test_env.jj_cmd_ok(&repo_path, &["debug", "snapshot"]);
std::fs::write(repo_path.join("b.txt"), "Art").unwrap();
test_env.jj_cmd_ok(&repo_path, &["commit", "-m", "B"]);

insta::assert_snapshot!(get_evolog_output(&test_env, &repo_path), r#""#);

let (stdout, _) =
test_env.jj_cmd_ok(&repo_path, &["bookmark", "move", "back", "-r", "<old-id>"]);
insta::assert_snapshot!(stdout, r#""#);
}

#[test]
fn test_bookmark_set_onto_hidden_unhides() {
// TODO: write
let test_env = TestEnvironment::default();
test_env.jj_cmd_ok(test_env.env_root(), &["git", "init", "repo"]);
let repo_path = test_env.env_root().join("repo");

std::fs::write(repo_path.join("a.txt"), "AA").unwrap();
test_env.jj_cmd_ok(&repo_path, &["commit", "-m", "A"]);
// Emulate a simple commit change, where we want to recover the initial version.
std::fs::write(repo_path.join("b.txt"), "BB").unwrap();
test_env.jj_cmd_ok(&repo_path, &["debug", "snapshot"]);
std::fs::write(repo_path.join("b.txt"), "Art").unwrap();
test_env.jj_cmd_ok(&repo_path, &["commit", "-m", "B"]);
insta::assert_snapshot!(get_evolog_output(&test_env, &repo_path), r#""#);
let (stdout, _) =
test_env.jj_cmd_ok(&repo_path, &["bookmark", "set", "back", "-r", "<old-id>"]);
insta::assert_snapshot!(stdout, r#""#);
}

fn get_evolog_output(test_env: &TestEnvironment, cwd: &Path) -> String {
let template = r#"change_id ++ " " ++ commit_id"#;
test_env.jj_cmd_success(cwd, &["evolog", "-T", template])
}

fn get_log_output(test_env: &TestEnvironment, cwd: &Path) -> String {
let template = r#"bookmarks ++ " " ++ commit_id.short()"#;
test_env.jj_cmd_success(cwd, &["log", "-T", template])
Expand Down
6 changes: 6 additions & 0 deletions lib/src/commit.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,12 @@ impl Commit {
&self.data.committer
}

/// A commit is hidden, if its commit id is not in the predecessor set.
pub fn is_hidden(&self, repo: &dyn Repo) -> BackendResult<bool> {
let maybe_entries = repo.resolve_change_id(self.change_id());
Ok(maybe_entries.map_or(true, |entries| !entries.contains(&self.id)))
}

/// A commit is discardable if it has no change from its parent, and an
/// empty description.
pub fn is_discardable(&self, repo: &dyn Repo) -> BackendResult<bool> {
Expand Down
Loading