Skip to content

Commit

Permalink
Implement jj parallelize
Browse files Browse the repository at this point in the history
  • Loading branch information
emesterhazy committed Apr 3, 2024
1 parent e4de3f5 commit 306d5a0
Show file tree
Hide file tree
Showing 7 changed files with 567 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

* new function `working_copies()` for revsets to show the working copy commits of all workspaces.

* New command `jj parallelize` that rebases a chain of commits into siblings.

### Fixed bugs

## [0.15.1] - 2024-03-06
Expand Down
5 changes: 5 additions & 0 deletions cli/src/commands/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ mod new;
mod next;
mod obslog;
mod operation;
mod parallelize;
mod prev;
mod rebase;
mod resolve;
Expand Down Expand Up @@ -114,6 +115,7 @@ enum Command {
#[command(subcommand)]
#[command(visible_alias = "op")]
Operation(operation::OperationCommand),
Parallelize(parallelize::ParallelizeArgs),
Prev(prev::PrevArgs),
Rebase(rebase::RebaseArgs),
Resolve(resolve::ResolveArgs),
Expand Down Expand Up @@ -180,6 +182,9 @@ pub fn run_command(ui: &mut Ui, command_helper: &CommandHelper) -> Result<(), Co
Command::Abandon(sub_args) => abandon::cmd_abandon(ui, command_helper, sub_args),
Command::Edit(sub_args) => edit::cmd_edit(ui, command_helper, sub_args),
Command::Next(sub_args) => next::cmd_next(ui, command_helper, sub_args),
Command::Parallelize(sub_args) => {
parallelize::cmd_parallelize(ui, command_helper, sub_args)
}
Command::Prev(sub_args) => prev::cmd_prev(ui, command_helper, sub_args),
Command::New(sub_args) => new::cmd_new(ui, command_helper, sub_args),
Command::Move(sub_args) => r#move::cmd_move(ui, command_helper, sub_args),
Expand Down
183 changes: 183 additions & 0 deletions cli/src/commands/parallelize.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,183 @@
// Copyright 2024 The Jujutsu Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use std::io::Write;
use std::rc::Rc;

use indexmap::IndexSet;
use itertools::Itertools;
use jj_lib::backend::CommitId;
use jj_lib::commit::Commit;
use jj_lib::repo::Repo;
use jj_lib::revset::{RevsetExpression, RevsetIteratorExt};
use tracing::instrument;

use crate::cli_util::{short_commit_hash, CommandHelper, RevisionArg};
use crate::command_error::{user_error, CommandError};
use crate::commands::rebase::rebase_descendants;
use crate::ui::Ui;

/// Parallelize revisions by making them siblings
///
/// The set of target commits being parallelized must have a single head and
/// root commit (not to be confused with the repo root), otherwise the command
/// will fail. Each of the target commits is rebased onto the parents of the
/// root commit. The children of the head commit are rebased onto the target
/// commits.
///
/// Running `jj parallelize 1::2` will transform the history like this:
/// ```text
/// 3
/// | 3
/// 2 / \
/// | -> 1 2
/// 1 \ /
/// | 0
/// 0
/// ```
#[derive(clap::Args, Clone, Debug)]
#[command(verbatim_doc_comment)]
pub(crate) struct ParallelizeArgs {
/// Revisions to parallelize
revisions: Vec<RevisionArg>,
}

#[instrument(skip_all)]
pub(crate) fn cmd_parallelize(
ui: &mut Ui,
command: &CommandHelper,
args: &ParallelizeArgs,
) -> Result<(), CommandError> {
let mut workspace_command = command.workspace_helper(ui)?;
// The target commits are the commits being parallelized. Ordered with parents
// before children.
let target_commits: Vec<CommitId> = workspace_command
.parse_union_revsets(&args.revisions)?
.evaluate_to_commit_ids()?
.collect();
if target_commits.len() < 2 {
writeln!(ui.status(), "Nothing changed.")?;
return Ok(());
}
workspace_command.check_rewritable(target_commits.iter())?;
let mut tx = workspace_command.start_transaction();
let target_revset = RevsetExpression::commits(target_commits.clone());
let target_head = get_head(&target_revset, tx.repo())?;
let target_root = get_root(&target_revset, tx.repo())?;
let connected_length = RevsetExpression::commits(vec![target_head, target_root.clone()])
.connected()
.evaluate_programmatic(tx.repo())?
.iter()
.count();
if connected_length != target_commits.len() {
return Err(user_error(
"Cannot parallelize since the target revisions are not connected.",
));
}

// Rebase the non-target children of each target commit onto its new
// parents. A child which had a target commit as an ancestor before
// parallelize ran will have the target commit as a parent afterward.
for (i, target_commit) in target_commits.iter().enumerate() {
// These parents are shared by all children of the target commit and
// include the target commit itself plus any of its ancestors which are
// being parallelized. The commits in `target_commits` form a linear
// chain ordered with parents before children.
let common_parents: IndexSet<CommitId> = target_commits[i..].iter().cloned().collect();
// Children of the target commit, excluding other target commits.
let children: Vec<Commit> = RevsetExpression::commit(target_commit.clone())
.children()
.minus(&target_revset)
.evaluate_programmatic(tx.repo())?
.iter()
.commits(tx.repo().store())
.try_collect()?;
for child in children {
let mut new_parents = common_parents.clone();
new_parents.extend(child.parent_ids().iter().cloned());
let parents: Vec<Commit> = new_parents
.iter()
.map(|c| tx.repo().store().get_commit(c))
.try_collect()?;
rebase_descendants(
&mut tx,
command.settings(),
&parents,
&[child],
Default::default(),
)?;
}
}

// Rebase the target commits onto the parents of the root commit.
let new_parents = tx.repo().store().get_commit(&target_root)?.parents();
// We need to reverse the iterator so that when we rebase the target commits
// they will appear in the same relative order in `jj log` that they were in
// before being parallelized.
let target_commits: Vec<Commit> = target_commits
.iter()
// Children before parents.
.rev()
.map(|c| tx.repo().store().get_commit(c))
.try_collect()?;
rebase_descendants(
&mut tx,
command.settings(),
&new_parents,
&target_commits,
Default::default(),
)?;

tx.finish(ui, format!("parallelized {} commits", target_commits.len()))
}

// Returns the head of the target revset or an error if the revset has multiple
// heads.
fn get_head(
target_revset: &Rc<RevsetExpression>,
repo: &dyn Repo,
) -> Result<CommitId, CommandError> {
let mut target_heads: Vec<CommitId> = target_revset
.heads()
.evaluate_programmatic(repo)?
.iter()
.collect();
if target_heads.len() != 1 {
let heads = target_heads.iter().map(short_commit_hash).join(", ");
return Err(user_error(format!(
"Cannot parallelize a set of revisions with multiple heads. Heads: {heads}"
)));
}
Ok(target_heads.pop().unwrap())
}

// Returns the root of the target revset or an error if the revset has multiple
// roots.
fn get_root(
target_revset: &Rc<RevsetExpression>,
repo: &dyn Repo,
) -> Result<CommitId, CommandError> {
let mut target_roots: Vec<CommitId> = target_revset
.roots()
.evaluate_programmatic(repo)?
.iter()
.collect();
if target_roots.len() != 1 {
let roots = target_roots.iter().map(short_commit_hash).join(", ");
return Err(user_error(format!(
"Cannot parallelize a set of revisions with multiple roots. Roots: {roots}"
)));
}
Ok(target_roots.pop().unwrap())
}
37 changes: 37 additions & 0 deletions cli/tests/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ This document contains the help content for the `jj` command-line program.
* [`jj operation log`↴](#jj-operation-log)
* [`jj operation undo`↴](#jj-operation-undo)
* [`jj operation restore`↴](#jj-operation-restore)
* [`jj parallelize`↴](#jj-parallelize)
* [`jj prev`↴](#jj-prev)
* [`jj rebase`↴](#jj-rebase)
* [`jj resolve`↴](#jj-resolve)
Expand Down Expand Up @@ -126,6 +127,7 @@ To get started, see the tutorial at https://github.com/martinvonz/jj/blob/main/d
* `next`Move the working-copy commit to the child revision
* `obslog`Show how a change has evolved
* `operation`Commands for working with the operation log
* `parallelize`Parallelize revisions by making them siblings
* `prev`Move the working-copy commit to the parent revision
* `rebase`Move revisions to different parent(s)
* `resolve`Resolve a conflicted file with an external merge tool
Expand Down Expand Up @@ -1345,6 +1347,41 @@ This restores the repo to the state at the specified operation, effectively undo
## `jj parallelize`
Parallelize revisions by making them siblings
The set of target commits being parallelized must have a single head and
root commit (not to be confused with the repo root), otherwise the command
will fail. Each of the target commits is rebased onto the parents of the
root commit. The children of the head commit are rebased onto the target
commits.
Example usage:
```text
jj log
◉ 3
◉ 2
◉ 1
jj parallelize 1::2
jj log
◉ 3
├─╮
│ ◉ 2
◉ │ 1
├─╯
```
**Usage:** `jj parallelize [REVISIONS]...`
###### **Arguments:**
* `<REVISIONS>`
## `jj prev`
Move the working-copy commit to the parent revision
Expand Down
1 change: 1 addition & 0 deletions cli/tests/runner.rs
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ mod test_new_command;
mod test_next_prev_commands;
mod test_obslog_command;
mod test_operations;
mod test_parallelize_command;
mod test_rebase_command;
mod test_repo_change_report;
mod test_resolve_command;
Expand Down
6 changes: 6 additions & 0 deletions cli/tests/test_immutable_commits.rs
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,12 @@ fn test_rewrite_immutable_commands() {
Error: Commit 3d14df18607e is immutable
Hint: Configure the set of immutable commits via `revset-aliases.immutable_heads()`.
"###);
// parallelize
let stderr = test_env.jj_cmd_failure(&repo_path, &["parallelize", "description(b)", "main"]);
insta::assert_snapshot!(stderr, @r###"
Error: Commit 3d14df18607e is immutable
Hint: Configure the set of immutable commits via `revset-aliases.immutable_heads()`.
"###);
// rebase -s
let stderr = test_env.jj_cmd_failure(&repo_path, &["rebase", "-s=main", "-d=@"]);
insta::assert_snapshot!(stderr, @r###"
Expand Down
Loading

0 comments on commit 306d5a0

Please sign in to comment.