Merge pull request #9822 from gitbutlerapp/fix-edit-mode

Don't use the old refs/gitbutler/xxx for edit mode

Author: Caleb-T-Owens

Cargo.lock

@@ -6,7 +6,6 @@ use gitbutler_command_context::CommandContext;
 use gitbutler_edit_mode::ConflictEntryPresence;
 use gitbutler_operating_modes::{EditModeMetadata, OperatingMode};
 use gitbutler_project::ProjectId;
-use gitbutler_stack::VirtualBranchesHandle;
 use serde::Deserialize;
 
 use crate::{App, error::Error};
@@ -34,17 +33,10 @@ pub struct EnterEditModeParams {
 pub fn enter_edit_mode(app: &App, params: EnterEditModeParams) -> Result<EditModeMetadata, Error> {
     let project = gitbutler_project::get(params.project_id)?;
     let ctx = CommandContext::open(&project, app.app_settings.get()?.clone())?;
-    let handle = VirtualBranchesHandle::new(project.gb_dir());
-    let stack = handle.get_stack(params.stack_id)?;
-
     let commit = git2::Oid::from_str(&params.commit_id).context("Failed to parse commit oid")?;
 
-    gitbutler_edit_mode::commands::enter_edit_mode(
-        &ctx,
-        commit,
-        stack.refname()?.to_string().into(),
-    )
-    .map_err(Into::into)
+    gitbutler_edit_mode::commands::enter_edit_mode(&ctx, commit, params.stack_id)
+        .map_err(Into::into)
 }
 
 #[derive(Deserialize)]

crates/but-api/src/commands/modes.rs

@@ -29,6 +29,7 @@ but-rebase.workspace = true
 but-core.workspace = true
 serde.workspace = true
 tracing.workspace = true
+uuid.workspace = true
 
 [dev-dependencies]
 gitbutler-testsupport.workspace = true

crates/gitbutler-edit-mode/Cargo.toml

@@ -1,19 +1,19 @@
 use anyhow::{Context, Result};
 use but_core::ui::TreeChange;
+use but_workspace::StackId;
 use gitbutler_command_context::CommandContext;
 use gitbutler_operating_modes::{ensure_edit_mode, ensure_open_workspace_mode, EditModeMetadata};
 use gitbutler_oplog::{
     entry::{OperationKind, SnapshotDetails},
     OplogExt,
 };
-use gitbutler_reference::ReferenceName;
 
 use crate::ConflictEntryPresence;
 
 pub fn enter_edit_mode(
     ctx: &CommandContext,
     commit_oid: git2::Oid,
-    branch_reference_name: ReferenceName,
+    stack_id: StackId,
 ) -> Result<EditModeMetadata> {
     let mut guard = ctx.project().exclusive_worktree_access();
 
@@ -25,17 +25,12 @@ pub fn enter_edit_mode(
         .find_commit(commit_oid)
         .context("Failed to find commit")?;
 
-    let branch = ctx
-        .repo()
-        .find_reference(&branch_reference_name)
-        .context("Failed to find branch reference")?;
-
     let snapshot = ctx
         .prepare_snapshot(guard.read_permission())
         .context("Failed to prepare snapshot")?;
 
     let edit_mode_metadata =
-        crate::enter_edit_mode(ctx, commit, &branch, guard.write_permission())?;
+        crate::enter_edit_mode(ctx, commit, stack_id, guard.write_permission())?;
 
     let _ = ctx.commit_snapshot(
         snapshot,

crates/gitbutler-edit-mode/src/commands.rs

@@ -1,10 +1,9 @@
 use std::collections::HashMap;
-use std::str::FromStr;
 
 use anyhow::{bail, Context, Result};
 use bstr::{BString, ByteSlice};
 use but_core::TreeChange;
-use but_workspace::stack_ext::StackExt;
+use but_workspace::{stack_ext::StackExt, StackId};
 use git2::build::CheckoutBuilder;
 use gitbutler_branch_actions::update_workspace_commit;
 use gitbutler_cherry_pick::{ConflictedTreeKey, RepositoryExt as _};
@@ -21,10 +20,9 @@ use gitbutler_oxidize::{
     git2_to_gix_object_id, gix_to_git2_index, GixRepositoryExt, ObjectIdExt, OidExt, RepoExt,
 };
 use gitbutler_project::access::{WorktreeReadPermission, WorktreeWritePermission};
-use gitbutler_reference::{ReferenceName, Refname};
 use gitbutler_repo::RepositoryExt;
 use gitbutler_repo::{signature, SignaturePurpose};
-use gitbutler_stack::{Stack, VirtualBranchesHandle};
+use gitbutler_stack::VirtualBranchesHandle;
 use gitbutler_workspace::branch_trees::{update_uncommited_changes_with_tree, WorkspaceState};
 #[allow(deprecated)]
 use serde::Serialize;
@@ -169,46 +167,20 @@ fn checkout_edit_branch(ctx: &CommandContext, commit: git2::Commit) -> Result<()
     Ok(())
 }
 
-fn find_stack_by_reference(
-    ctx: &CommandContext,
-    reference: &ReferenceName,
-) -> Result<Option<Stack>> {
-    let vb_state = VirtualBranchesHandle::new(ctx.project().gb_dir());
-    let all_stacks = vb_state
-        .list_stacks_in_workspace()
-        .context("Failed to read virtual branches")?;
-
-    Ok(all_stacks.into_iter().find(|branch| {
-        let Ok(refname) = branch.refname() else {
-            return false;
-        };
-
-        let Ok(checked_out_refname) = Refname::from_str(reference) else {
-            return false;
-        };
-
-        checked_out_refname == refname.into()
-    }))
-}
-
 pub(crate) fn enter_edit_mode(
     ctx: &CommandContext,
     commit: git2::Commit,
-    branch: &git2::Reference,
+    stack_id: StackId,
     _perm: &mut WorktreeWritePermission,
 ) -> Result<EditModeMetadata> {
-    let Some(branch_reference) = branch.name() else {
-        bail!("Failed to get branch reference name");
-    };
-
     let edit_mode_metadata = EditModeMetadata {
         commit_oid: commit.id(),
-        branch_reference: branch_reference.to_string().into(),
+        stack_id,
     };
 
-    if find_stack_by_reference(ctx, &edit_mode_metadata.branch_reference)?.is_none() {
-        bail!("Can not enter edit mode for a reference which does not have a cooresponding virtual branch")
-    }
+    let vb_state = VirtualBranchesHandle::new(ctx.project().gb_dir());
+    // Validate the stack_id
+    vb_state.get_stack_in_workspace(stack_id)?;
 
     commit_uncommited_changes(ctx)?;
     write_edit_mode_metadata(ctx, &edit_mode_metadata).context("Failed to persist metadata")?;
@@ -254,10 +226,7 @@ pub(crate) fn save_and_return_to_workspace(
         .find_commit(edit_mode_metadata.commit_oid)
         .context("Failed to find commit")?;
 
-    let Some(mut stack) = find_stack_by_reference(ctx, &edit_mode_metadata.branch_reference)?
-    else {
-        bail!("Failed to find virtual branch for this reference. Entering and leaving edit mode for non-virtual branches is unsupported")
-    };
+    let mut stack = vb_state.get_stack_in_workspace(edit_mode_metadata.stack_id)?;
 
     let parents = commit.parents().collect::<Vec<_>>();
 

crates/gitbutler-edit-mode/src/lib.rs

@@ -2,6 +2,7 @@ use anyhow::Result;
 use git2::build::CheckoutBuilder;
 use gitbutler_command_context::CommandContext;
 use gitbutler_edit_mode::commands::{enter_edit_mode, save_and_return_to_workspace};
+use gitbutler_stack::VirtualBranchesHandle;
 use tempfile::TempDir;
 
 fn command_ctx(folder: &str) -> Result<(CommandContext, TempDir)> {
@@ -24,7 +25,10 @@ fn conficted_entries_get_written_when_leaving_edit_mode() -> Result<()> {
 
     let foobar = repository.head()?.peel_to_commit()?.parent(0)?;
 
-    enter_edit_mode(&ctx, foobar.id(), "refs/gitbutler/branchy".into())?;
+    let vb_state = VirtualBranchesHandle::new(ctx.project().gb_dir());
+    let stacks = vb_state.list_stacks_in_workspace()?;
+    let stack = stacks.first().unwrap();
+    enter_edit_mode(&ctx, foobar.id(), stack.id)?;
 
     let init = repository
         .find_reference("refs/heads/main")?

crates/gitbutler-edit-mode/tests/edit_mode.rs

@@ -23,6 +23,7 @@ gitbutler-repo.workspace = true
 gitbutler-stack.workspace = true
 but-settings.workspace = true
 gitbutler-project.workspace = true
+uuid.workspace = true
 
 [dev-dependencies]
 gitbutler-testsupport.workspace = true

crates/gitbutler-operating-modes/Cargo.toml

@@ -2,8 +2,8 @@ use std::{fs, path::PathBuf};
 
 use anyhow::{bail, Context, Result};
 use bstr::BString;
+use but_workspace::StackId;
 use gitbutler_command_context::CommandContext;
-use gitbutler_reference::ReferenceName;
 use gitbutler_serde::BStringForFrontend;
 use gitbutler_stack::VirtualBranchesHandle;
 use serde::{Deserialize, Serialize};
@@ -60,7 +60,7 @@ pub struct EditModeMetadata {
     #[serde(with = "gitbutler_serde::oid")]
     pub commit_oid: git2::Oid,
     /// The ref of the vbranch which owns this commit.
-    pub branch_reference: ReferenceName,
+    pub stack_id: StackId,
 }
 
 #[derive(Debug, Default, Serialize, PartialEq, Clone)]

crates/gitbutler-operating-modes/src/lib.rs

@@ -21,8 +21,8 @@ fn create_edit_mode_metadata(ctx: &CommandContext) {
     write_edit_mode_metadata(
         ctx,
         &EditModeMetadata {
-            branch_reference: "asdf".into(),
             commit_oid: git2::Oid::zero(),
+            stack_id: uuid::Uuid::new_v4().into(),
         },
     )
     .unwrap();