Merge pull request #7280 from gitbutlerapp/advanced-committing

commit with rebase-engine integration

Author: Byron

Cargo.lock

@@ -5,7 +5,7 @@ resolver = "2"
 [workspace.dependencies]
 bstr = "1.11.1"
 # Add the `tracing` or `tracing-detail` features to see more of gitoxide in the logs. Useful to see which programs it invokes.
-gix = { git = "https://github.com/GitoxideLabs/gitoxide", branch = "improvements", default-features = false, features = [
+gix = { git = "https://github.com/GitoxideLabs/gitoxide", rev = "b4fe425a1a7823790fab592c84aa8494d295640d", default-features = false, features = [
 ] }
 gix-testtools = "0.15.0"
 insta = "1.41.1"
@@ -67,8 +67,8 @@ gitbutler-forge = { path = "crates/gitbutler-forge" }
 gitbutler-hunk-dependency = { path = "crates/gitbutler-hunk-dependency" }
 gitbutler-settings = { path = "crates/gitbutler-settings" }
 gitbutler-workspace = { path = "crates/gitbutler-workspace" }
-but-debugging = { path = "crates/but-debugging" }
-but-rebase = { path = "crates/but-debugging" }
+but-testsupport = { path = "crates/but-testsupport" }
+but-rebase = { path = "crates/but-rebase" }
 but-core = { path = "crates/but-core" }
 but-workspace = { path = "crates/but-workspace" }
 but-hunk-dependency = { path = "crates/but-hunk-dependency" }

Cargo.toml

@@ -23,7 +23,7 @@ gitbutler-error.workspace = true
 uuid.workspace = true
 
 [dev-dependencies]
-gix-testtools.workspace = true
+but-testsupport.workspace = true
 gix = { workspace = true, features = ["revision"] }
 serde_json = "1.0"
 insta.workspace = true

crates/but-core/Cargo.toml

@@ -70,7 +70,8 @@ pub use repo_ext::RepositoryExt;
 pub struct Commit<'repo> {
     /// The id of the commit itself.
     pub id: gix::Id<'repo>,
-    inner: gix::objs::Commit,
+    /// The decoded commit for direct access.
+    pub inner: gix::objs::Commit,
 }
 
 /// A patch in unified diff format to show how a resource changed or now looks like (in case it was newly added),
@@ -93,6 +94,16 @@ pub enum UnifiedDiff {
     },
 }
 
+/// Either git reference or a virtual reference (i.e. a reference not visible in Git).
+#[derive(Debug, Clone, PartialEq)]
+pub enum Reference {
+    /// A git reference or lightweight tag.
+    Git(gix::refs::FullName),
+    /// A reference not visible in Git, managed by GitButler.
+    // TODO: ideally this isn't needed anymore in the final version as all refs are 'real'.
+    Virtual(String),
+}
+
 /// An entry in the worktree that changed and thus is eligible to being committed.
 ///
 /// It either lives (or lived) in the in `.git/index`, or in the `worktree`.

crates/but-core/src/lib.rs

@@ -1,3 +1,5 @@
+use but_testsupport::gix_testtools;
+
 #[test]
 fn is_conflicted() -> anyhow::Result<()> {
     let repo = conflict_repo("normal-and-artificial")?;

crates/but-core/tests/core/commit.rs

@@ -1,4 +1,5 @@
 use but_core::UnifiedDiff;
+use but_testsupport::gix_testtools;
 
 #[test]
 fn worktree_changes() -> anyhow::Result<()> {

crates/but-core/tests/core/diff/ui.rs

@@ -1,6 +1,7 @@
 use anyhow::Result;
 use but_core::diff;
 use but_core::{UnifiedDiff, WorktreeChanges};
+use but_testsupport::gix_testtools;
 
 #[test]
 #[cfg(unix)]

crates/but-core/tests/core/diff/worktree_changes.rs

@@ -1,5 +1,6 @@
 mod git {
     use but_core::{GitConfigSettings, RepositoryExt};
+    use but_testsupport::gix_testtools;
 
     #[test]
     fn set_git_settings() -> anyhow::Result<()> {

crates/but-core/tests/core/settings.rs

@@ -3,10 +3,10 @@ use but_core::TreeStatusKind;
 use but_workspace::StackId;
 use gix::bstr::BString;
 
-/// A whole stack for the purpose of generating hunk locking information from it, for use in [Dependencies::calculate()](crate::Dependencies::calculate()).
+/// A whole stack for the purpose of generating hunk locking information from it, for use in [`WorkspaceRanges::try_from_stacks()`](crate::WorkspaceRanges::try_from_stacks()) .
 #[derive(Debug, Clone)]
 pub struct InputStack {
-    /// The stack that contains [`commits`](InputStack::commits).
+    /// The stack that contains [commits](InputStack::commits_from_base_to_tip).
     pub stack_id: StackId,
     /// The commits in the stack.
     ///

crates/but-hunk-dependency/src/input.rs

@@ -9,18 +9,21 @@ publish = false
 doctest = false
 
 [dependencies]
-gix.workspace = true
+gix = { workspace = true, features = ["revision", "merge"]}
 anyhow.workspace = true
+tracing.workspace = true
+but-core.workspace = true
 gitbutler-repo.workspace = true
 gitbutler-oxidize.workspace = true
+gitbutler-error.workspace = true
 bstr.workspace = true
 git2.workspace = true
-itertools = "0.14"
-smallvec = "1.13.2"
-
-[[test]]
-name = "rebase"
-path = "tests/mod.rs"
+tempfile.workspace = true
 
 [dev-dependencies]
-gix-testtools.workspace = true
+but-testsupport.workspace = true
+insta = "1.42.1"
+but-core = { workspace = true, features = ["testing"] }
+# for stable hashes in `gitbuter-` crates while we use them.
+# TODO: remove once `gitbutler-repo` isn't needed anymore.
+gitbutler-commit = { workspace = true, features = ["testing"] }

crates/but-rebase/Cargo.toml

@@ -4,48 +4,21 @@ use but_core::cmd::prepare_with_shell_on_windows;
 use but_core::{GitConfigSettings, RepositoryExt};
 use gitbutler_error::error::Code;
 use gix::objs::WriteTo;
-use gix::refs::transaction::{Change, LogChange, PreviousValue, RefLog};
-use gix::refs::Target;
 use std::borrow::Cow;
 use std::io::Write;
 use std::path::Path;
 use std::process::Stdio;
 
-/// Create a commit exactly as specified, and sign it depending on Git and GitButler specific Git configuration.
-#[allow(clippy::too_many_arguments)]
-pub fn create_commit(
-    repo: &gix::Repository,
-    update_ref: Option<gix::refs::FullName>,
-    author: gix::actor::Signature,
-    committer: gix::actor::Signature,
-    message: &str,
-    tree: gix::ObjectId,
-    parents: impl IntoIterator<Item = impl Into<gix::ObjectId>>,
-    commit_headers: Option<but_core::commit::HeadersV2>,
-) -> anyhow::Result<(gix::ObjectId, Option<gix::refs::transaction::RefEdit>)> {
-    let commit = gix::objs::Commit {
-        message: message.into(),
-        tree,
-        author,
-        committer,
-        encoding: None,
-        parents: parents.into_iter().map(Into::into).collect(),
-        extra_headers: commit_headers.unwrap_or_default().into(),
-    };
-    create_given_commit(repo, update_ref, commit)
-}
-
-/// Use the given commit and possibly sign it, replacing a possibly existing signature,
+/// Use the given `commit` and possibly sign it, replacing a possibly existing signature,
 /// or removing the signature if GitButler is not configured to keep it.
 ///
 /// Signatures will be removed automatically if signing is disabled to prevent an amended commit
-/// to use the old signature. They will also be added or replace existing signatures.
+/// to use the old signature.
 #[allow(clippy::too_many_arguments)]
-pub fn create_given_commit(
+pub fn create(
     repo: &gix::Repository,
-    update_ref: Option<gix::refs::FullName>,
     mut commit: gix::objs::Commit,
-) -> anyhow::Result<(gix::ObjectId, Option<gix::refs::transaction::RefEdit>)> {
+) -> anyhow::Result<gix::ObjectId> {
     if let Some(pos) = commit
         .extra_headers()
         .find_pos(gix::objs::commit::SIGNATURE_FIELD_NAME)
@@ -74,44 +47,7 @@ pub fn create_given_commit(
         }
     }
 
-    let new_commit_id = repo.write_object(&commit)?.detach();
-    let refedit = if let Some(refname) = update_ref {
-        // TODO:(ST) should this be something more like what Git does (also in terms of reflog message)?
-        //       Probably should support making a commit in full with `gix`.
-        let log_message = commit.message;
-        let edit = update_reference(repo, refname, new_commit_id, log_message)?;
-        Some(edit)
-    } else {
-        None
-    };
-    Ok((new_commit_id, refedit))
-}
-
-fn update_reference(
-    repo: &gix::Repository,
-    name: gix::refs::FullName,
-    target: gix::ObjectId,
-    log_message: BString,
-) -> anyhow::Result<gix::refs::transaction::RefEdit> {
-    let mut edits = repo.edit_reference(gix::refs::transaction::RefEdit {
-        change: Change::Update {
-            log: LogChange {
-                mode: RefLog::AndReference,
-                force_create_reflog: false,
-                message: log_message,
-            },
-            expected: PreviousValue::Any,
-            new: Target::Object(target),
-        },
-        name,
-        deref: false,
-    })?;
-    debug_assert_eq!(
-        edits.len(),
-        1,
-        "only one reference can be created, splits aren't possible"
-    );
-    Ok(edits.pop().expect("exactly one edit"))
+    Ok(repo.write_object(&commit)?.detach())
 }
 
 fn sign_buffer(repo: &gix::Repository, buffer: &[u8]) -> anyhow::Result<BString> {