Rename gitbutler/integration -> gitbutler/workspace

mtsgrd · mtsgrd · commit 5f9c2e58328e · 2024-09-02T20:53:19.000+03:00
diff --git a/apps/desktop/src/lib/components/NotOnGitButlerBranch.svelte b/apps/desktop/src/lib/components/NotOnGitButlerBranch.svelte
@@ -48,7 +48,7 @@
 			<ProjectNameLabel projectName={project?.title} />
 		</div>
 		<p class="switchrepo__title text-18 text-body text-bold">
-			Looks like you've switched away from <span class="code-string"> gitbutler/integration </span>
+			Looks like you've switched away from <span class="code-string"> gitbutler/workspace </span>
 		</p>
 
 		<p class="switchrepo__message text-13 text-body">
@@ -69,7 +69,7 @@
 					if (baseBranch) branchController.setTarget(baseBranch.branchName);
 				}}
 			>
-				Go back to gitbutler/integration
+				Go back to gitbutler/workspace
 			</Button>
 
 			{#if project}
diff --git a/crates/gitbutler-branch-actions/src/base.rs b/crates/gitbutler-branch-actions/src/base.rs
@@ -4,7 +4,7 @@ use anyhow::{anyhow, Context, Result};
 use git2::Index;
 use gitbutler_branch::{
     self, Branch, BranchId, BranchOwnershipClaims, Target, VirtualBranchesHandle,
-    GITBUTLER_INTEGRATION_REFERENCE,
+    GITBUTLER_WORKSPACE_REFERENCE,
 };
 use gitbutler_command_context::CommandContext;
 use gitbutler_error::error::Marker;
@@ -176,7 +176,7 @@ pub(crate) fn set_base_branch(
         .context("Failed to get HEAD reference name")?;
     if !head_name
         .to_string()
-        .eq(&GITBUTLER_INTEGRATION_REFERENCE.to_string())
+        .eq(&GITBUTLER_WORKSPACE_REFERENCE.to_string())
     {
         // if there are any commits on the head branch or uncommitted changes in the working directory, we need to
         // put them into a virtual branch
diff --git a/crates/gitbutler-branch-actions/src/branch.rs b/crates/gitbutler-branch-actions/src/branch.rs
@@ -167,7 +167,7 @@ fn combine_branches(
         let Some(identity) = branch.identity(&remotes) else {
             continue;
         };
-        // Skip branches that should not be listed, e.g. the target 'main' or the gitbutler technical branches like 'gitbutler/integration'
+        // Skip branches that should not be listed, e.g. the target 'main' or the gitbutler technical branches like 'gitbutler/workspace'
         if !should_list_git_branch(&identity) {
             continue;
         }
@@ -358,7 +358,8 @@ impl GroupBranch<'_> {
 fn should_list_git_branch(identity: &BranchIdentity) -> bool {
     // Exclude gitbutler technical branches (not useful for the user)
     const TECHNICAL_IDENTITIES: &[&[u8]] = &[
-        b"gitbutler/integration",
+        b"gitbutler/workspace",
+        b"gitbutler/integration", // Remove me after transition.
         b"gitbutler/target",
         b"gitbutler/oplog",
         b"HEAD",
diff --git a/crates/gitbutler-branch-actions/src/integration.rs b/crates/gitbutler-branch-actions/src/integration.rs
@@ -4,12 +4,13 @@ use anyhow::{anyhow, Context, Result};
 use bstr::ByteSlice;
 use gitbutler_branch::{
     self, Branch, BranchCreateRequest, SignaturePurpose, VirtualBranchesHandle,
-    GITBUTLER_INTEGRATION_REFERENCE,
+    GITBUTLER_WORKSPACE_REFERENCE,
 };
 use gitbutler_cherry_pick::RepositoryExt as _;
 use gitbutler_command_context::CommandContext;
 use gitbutler_commit::commit_ext::CommitExt;
 use gitbutler_error::error::Marker;
+use gitbutler_operating_modes::OPEN_WORKSPACE_REFS;
 use gitbutler_project::access::WorktreeWritePermission;
 use gitbutler_repo::{LogUntil, RepoActionsExt, RepositoryExt};
 use tracing::instrument;
@@ -94,9 +95,9 @@ pub(crate) fn get_workspace_head(ctx: &CommandContext) -> Result<git2::Oid> {
     Ok(workspace_head_id)
 }
 
-// Before switching the user to our gitbutler integration branch we save
+// Before switching the user to our gitbutler workspace branch we save
 // the current branch into a text file. It is used in generating the commit
-// message for integration branch, as a helpful hint about how to get back
+// message for workspace branch, as a helpful hint about how to get back
 // to where you were.
 struct PreviousHead {
     head: String,
@@ -138,8 +139,8 @@ pub fn update_gitbutler_integration(
     let integration_filepath = repo.path().join("integration");
     let mut prev_branch = read_integration_file(&integration_filepath)?;
     if let Some(branch) = &prev_branch {
-        if branch.head != GITBUTLER_INTEGRATION_REFERENCE.to_string() {
-            // we are moving from a regular branch to our gitbutler integration branch, write a file to
+        if branch.head != GITBUTLER_WORKSPACE_REFERENCE.to_string() {
+            // we are moving from a regular branch to our gitbutler workspace branch, write a file to
             // .git/integration with the previous head and name
             write_integration_file(&head_ref, integration_filepath)?;
             prev_branch = Some(PreviousHead {
@@ -218,14 +219,14 @@ pub fn update_gitbutler_integration(
         parents.iter().collect::<Vec<_>>().as_slice(),
     )?;
 
-    // Create or replace the integration branch reference, then set as HEAD.
+    // Create or replace the workspace branch reference, then set as HEAD.
     repo.reference(
-        &GITBUTLER_INTEGRATION_REFERENCE.clone().to_string(),
+        &GITBUTLER_WORKSPACE_REFERENCE.clone().to_string(),
         final_commit,
         true,
         "updated integration commit",
     )?;
-    repo.set_head(&GITBUTLER_INTEGRATION_REFERENCE.clone().to_string())?;
+    repo.set_head(&GITBUTLER_WORKSPACE_REFERENCE.clone().to_string())?;
 
     let mut index = repo.index()?;
     index.read_tree(&workspace_tree)?;
@@ -285,21 +286,21 @@ fn verify_head_is_set(ctx: &CommandContext) -> Result<()> {
         .context("failed to get head")?
         .name()
     {
-        Some(refname) if *refname == GITBUTLER_INTEGRATION_REFERENCE.to_string() => Ok(()),
+        Some(refname) if OPEN_WORKSPACE_REFS.contains(&refname) => Ok(()),
         Some(head_name) => Err(invalid_head_err(head_name)),
         None => Err(anyhow!(
             "project in detached head state. Please checkout {} to continue",
-            GITBUTLER_INTEGRATION_REFERENCE.branch()
+            GITBUTLER_WORKSPACE_REFERENCE.branch()
         )),
     }
 }
 
-// Returns an error if repo head is not pointing to the integration branch.
+// Returns an error if repo head is not pointing to the workspace branch.
 fn verify_current_branch_name(ctx: &CommandContext) -> Result<&CommandContext> {
     match ctx.repository().head()?.name() {
         Some(head) => {
             let head_name = head.to_string();
-            if head_name != GITBUTLER_INTEGRATION_REFERENCE.to_string() {
+            if !OPEN_WORKSPACE_REFS.contains(&head_name.as_str()) {
                 return Err(invalid_head_err(&head_name));
             }
             Ok(ctx)
@@ -408,6 +409,6 @@ fn verify_head_is_clean(ctx: &CommandContext, perm: &mut WorktreeWritePermission
 fn invalid_head_err(head_name: &str) -> anyhow::Error {
     anyhow!(
         "project is on {head_name}. Please checkout {} to continue",
-        GITBUTLER_INTEGRATION_REFERENCE.branch()
+        GITBUTLER_WORKSPACE_REFERENCE.branch()
     )
 }
diff --git a/crates/gitbutler-branch-actions/src/remote.rs b/crates/gitbutler-branch-actions/src/remote.rs
@@ -83,12 +83,12 @@ pub fn list_local_branches(ctx: &CommandContext) -> Result<Vec<RemoteBranch>> {
                 continue;
             }
         };
-
         let branch_is_trunk = branch.name.branch() == Some(default_target.branch.branch())
             && branch.name.remote() == Some(default_target.branch.remote());
 
         if !branch_is_trunk
-            && branch.name.branch() != Some("gitbutler/integration")
+            && branch.name.branch() != Some("gitbutler/integration") // Remove after rename migration complete.
+            && branch.name.branch() != Some("gitbutler/workspace")
             && branch.name.branch() != Some("gitbutler/target")
         {
             remote_branches.push(branch);
diff --git a/crates/gitbutler-branch-actions/tests/extra/mod.rs b/crates/gitbutler-branch-actions/tests/extra/mod.rs
@@ -1309,7 +1309,7 @@ fn detect_mergeable_branch() -> Result<()> {
     std::fs::remove_file(Path::new(&project.path).join(file_path3))?;
 
     ctx.repository()
-        .set_head("refs/heads/gitbutler/integration")?;
+        .set_head("refs/heads/gitbutler/workspace")?;
     ctx.repository()
         .checkout_head(Some(&mut git2::build::CheckoutBuilder::default().force()))?;
 
@@ -1986,7 +1986,7 @@ fn verify_branch_not_integration() -> Result<()> {
     assert!(verify_result.is_err());
     assert_eq!(
         format!("{:#}", verify_result.unwrap_err()),
-        "<verification-failed>: project is on refs/heads/master. Please checkout gitbutler/integration to continue"
+        "<verification-failed>: project is on refs/heads/master. Please checkout gitbutler/workspace to continue"
     );
 
     Ok(())
diff --git a/crates/gitbutler-branch-actions/tests/virtual_branches/create_virtual_branch_from_branch.rs b/crates/gitbutler-branch-actions/tests/virtual_branches/create_virtual_branch_from_branch.rs
@@ -68,7 +68,7 @@ fn integration() {
         std::fs::write(repository.path().join("another.txt"), "").unwrap();
         repository.commit_all("another");
         repository.push_branch(&"refs/heads/master".parse().unwrap());
-        repository.checkout(&"refs/heads/gitbutler/integration".parse().unwrap());
+        repository.checkout(&"refs/heads/gitbutler/workspace".parse().unwrap());
     }
 
     {
diff --git a/crates/gitbutler-branch-actions/tests/virtual_branches/init.rs b/crates/gitbutler-branch-actions/tests/virtual_branches/init.rs
@@ -31,7 +31,7 @@ fn twice() {
             .set_base_branch(&project, &"refs/remotes/origin/master".parse().unwrap())
             .unwrap();
 
-        // even though project is on gitbutler/integration, we should not import it
+        // even though project is on gitbutler/workspace, we should not import it
         assert!(controller
             .list_virtual_branches(&project)
             .unwrap()
diff --git a/crates/gitbutler-branch-actions/tests/virtual_branches/verify_branch.rs b/crates/gitbutler-branch-actions/tests/virtual_branches/verify_branch.rs
@@ -2,7 +2,7 @@ use gitbutler_reference::LocalRefname;
 
 use super::*;
 
-// Ensures that `verify_branch` returns an error when not on the integration branch.
+// Ensures that `verify_branch` returns an error when not on the workspace branch.
 #[test]
 fn should_fail_on_incorrect_branch() {
     let Test {
@@ -19,6 +19,6 @@ fn should_fail_on_incorrect_branch() {
     let err = result.unwrap_err();
     assert_eq!(
         format!("{err:#}"),
-        "<verification-failed>: project is on refs/heads/somebranch. Please checkout gitbutler/integration to continue"
+        "<verification-failed>: project is on refs/heads/somebranch. Please checkout gitbutler/workspace to continue"
     );
 }
diff --git a/crates/gitbutler-branch/src/lib.rs b/crates/gitbutler-branch/src/lib.rs
@@ -23,8 +23,8 @@ mod state;
 use lazy_static::lazy_static;
 pub use state::{VirtualBranches as VirtualBranchesState, VirtualBranchesHandle};
 lazy_static! {
-    pub static ref GITBUTLER_INTEGRATION_REFERENCE: gitbutler_reference::LocalRefname =
-        gitbutler_reference::LocalRefname::new("gitbutler/integration", None);
+    pub static ref GITBUTLER_WORKSPACE_REFERENCE: gitbutler_reference::LocalRefname =
+        gitbutler_reference::LocalRefname::new("gitbutler/workspace", None);
 }
 
 pub const GITBUTLER_COMMIT_AUTHOR_NAME: &str = "GitButler";
diff --git a/crates/gitbutler-cli/src/args.rs b/crates/gitbutler-cli/src/args.rs
@@ -106,14 +106,14 @@ pub mod project {
         /// Add the given Git repository as project for use with GitButler.
         Add {
             /// The long name of the remote reference to track, like `refs/remotes/origin/main`,
-            /// when switching to the integration branch.
+            /// when switching to the workspace branch.
             #[clap(short = 's', long)]
             switch_to_integration: Option<RemoteRefname>,
             /// The path at which the repository worktree is located.
             #[clap(default_value = ".", value_name = "REPOSITORY")]
             path: PathBuf,
         },
-        /// Switch back to the integration branch for use of virtual branches.
+        /// Switch back to the workspace branch for use of virtual branches.
         SwitchToIntegration {
             /// The long name of the remote reference to track, like `refs/remotes/origin/main`.
             remote_ref_name: RemoteRefname,
diff --git a/crates/gitbutler-edit-mode/src/lib.rs b/crates/gitbutler-edit-mode/src/lib.rs
@@ -16,7 +16,7 @@ use gitbutler_commit::{
 use gitbutler_diff::hunks_by_filepath;
 use gitbutler_operating_modes::{
     operating_mode, read_edit_mode_metadata, write_edit_mode_metadata, EditModeMetadata,
-    OperatingMode, EDIT_BRANCH_REF, INTEGRATION_BRANCH_REF,
+    OperatingMode, EDIT_BRANCH_REF, WORKSPACE_BRANCH_REF,
 };
 use gitbutler_project::access::{WorktreeReadPermission, WorktreeWritePermission};
 use gitbutler_reference::{ReferenceName, Refname};
@@ -285,14 +285,14 @@ pub(crate) fn save_and_return_to_workspace(
         )
         .context("Failed to reference new commit branch head")?;
 
-    // Move back to gitbutler/integration and restore stashed changes
+    // Move back to gitbutler/workspace and restore stashed changes
     {
         repository
-            .set_head(INTEGRATION_BRANCH_REF)
+            .set_head(WORKSPACE_BRANCH_REF)
             .context("Failed to set head reference")?;
         repository
             .checkout_head(Some(CheckoutBuilder::new().force().remove_untracked(true)))
-            .context("Failed to checkout gitbutler/integration")?;
+            .context("Failed to checkout gitbutler/workspace")?;
 
         virtual_branch.head = new_branch_head;
         virtual_branch.updated_timestamp_ms = gitbutler_time::time::now_ms();
diff --git a/crates/gitbutler-operating-modes/src/lib.rs b/crates/gitbutler-operating-modes/src/lib.rs
@@ -8,7 +8,18 @@ use serde::{Deserialize, Serialize};
 pub mod commands;
 
 /// The reference the app will checkout when the workspace is open
+pub const WORKSPACE_BRANCH_REF: &str = "refs/heads/gitbutler/workspace";
+
+/// Previous workspace reference, delete after transition.
 pub const INTEGRATION_BRANCH_REF: &str = "refs/heads/gitbutler/integration";
+
+/// To prevent clients hitting the "looks like you've moved away from..."
+/// after upgrading to a version using the new gitbutler/workspace branch
+/// name we need some transition period during which both are accepted.
+/// The new branch will be checked out as soon as any modification is made
+/// that triggers `update_gitbutler_integration`.
+pub const OPEN_WORKSPACE_REFS: [&str; 2] = [INTEGRATION_BRANCH_REF, WORKSPACE_BRANCH_REF];
+
 /// The reference the app will checkout when in edit mode
 pub const EDIT_BRANCH_REF: &str = "refs/heads/gitbutler/edit";
 
@@ -54,11 +65,11 @@ pub struct EditModeMetadata {
 #[derive(PartialEq, Debug, Clone, Serialize)]
 #[serde(tag = "type", content = "subject")]
 pub enum OperatingMode {
-    /// The typical app state when its on the gitbutler/integration branch
+    /// The typical app state when its on the gitbutler/workspace branch
     OpenWorkspace,
-    /// When the user has chosen to leave the gitbutler/integration branch
+    /// When the user has chosen to leave the gitbutler/workspace branch
     OutsideWorkspace,
-    /// When the app is off of gitbutler/integration and in edit mode
+    /// When the app is off of gitbutler/workspace and in edit mode
     Edit(EditModeMetadata),
 }
 
@@ -71,7 +82,7 @@ pub fn operating_mode(ctx: &CommandContext) -> OperatingMode {
         return OperatingMode::OutsideWorkspace;
     };
 
-    if head_ref_name == INTEGRATION_BRANCH_REF {
+    if OPEN_WORKSPACE_REFS.contains(&head_ref_name) {
         OperatingMode::OpenWorkspace
     } else if head_ref_name == EDIT_BRANCH_REF {
         let edit_mode_metadata = read_edit_mode_metadata(ctx);
diff --git a/crates/gitbutler-operating-modes/tests/operating_modes.rs b/crates/gitbutler-operating-modes/tests/operating_modes.rs
@@ -40,7 +40,7 @@ mod operating_modes {
             let suite = Suite::default();
             let Case { ctx, .. } = &suite.new_case();
 
-            create_and_checkout_branch(ctx, "gitbutler/integration");
+            create_and_checkout_branch(ctx, "gitbutler/workspace");
 
             let in_open_workspace = in_open_workspace_mode(ctx);
             assert!(in_open_workspace);
@@ -73,7 +73,7 @@ mod operating_modes {
             let suite = Suite::default();
             let Case { ctx, .. } = &suite.new_case();
 
-            create_and_checkout_branch(ctx, "gitbutler/integration");
+            create_and_checkout_branch(ctx, "gitbutler/workspace");
 
             assert!(assure_open_workspace_mode(ctx).is_ok());
         }
@@ -133,7 +133,7 @@ mod operating_modes {
             let suite = Suite::default();
             let Case { ctx, .. } = &suite.new_case();
 
-            create_and_checkout_branch(ctx, "gitbutler/integration");
+            create_and_checkout_branch(ctx, "gitbutler/workspace");
 
             let in_outside_worskpace = in_outside_workspace_mode(ctx);
             assert!(!in_outside_worskpace);
@@ -165,7 +165,7 @@ mod operating_modes {
             let suite = Suite::default();
             let Case { ctx, .. } = &suite.new_case();
 
-            create_and_checkout_branch(ctx, "gitbutler/integration");
+            create_and_checkout_branch(ctx, "gitbutler/workspace");
 
             assert!(assure_outside_workspace_mode(ctx).is_err());
         }
diff --git a/crates/gitbutler-oplog/src/oplog.rs b/crates/gitbutler-oplog/src/oplog.rs
diff --git a/crates/gitbutler-repo/src/repository_ext.rs b/crates/gitbutler-repo/src/repository_ext.rs
diff --git a/crates/gitbutler-watcher/src/handler.rs b/crates/gitbutler-watcher/src/handler.rs

Original file line number	Diff line number	Diff line change
`@@ -83,12 +83,12 @@ pub fn list_local_branches(ctx: &CommandContext) -> Result<Vec<RemoteBranch>> {`
`83`	`83`	`continue;`
`84`	`84`	`}`
`85`	`85`	`};`
`86`		`-`
`87`	`86`	`let branch_is_trunk = branch.name.branch() == Some(default_target.branch.branch())`
`88`	`87`	`&& branch.name.remote() == Some(default_target.branch.remote());`
`89`	`88`
`90`	`89`	`if !branch_is_trunk`
`91`		`- && branch.name.branch() != Some("gitbutler/integration")`
	`90`	`+ && branch.name.branch() != Some("gitbutler/integration") // Remove after rename migration complete.`
	`91`	`+ && branch.name.branch() != Some("gitbutler/workspace")`
`92`	`92`	`&& branch.name.branch() != Some("gitbutler/target")`
`93`	`93`	`{`
`94`	`94`	`remote_branches.push(branch);`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ fn integration() {`
`68`	`68`	`std::fs::write(repository.path().join("another.txt"), "").unwrap();`
`69`	`69`	`repository.commit_all("another");`
`70`	`70`	`repository.push_branch(&"refs/heads/master".parse().unwrap());`
`71`		`- repository.checkout(&"refs/heads/gitbutler/integration".parse().unwrap());`
	`71`	`+ repository.checkout(&"refs/heads/gitbutler/workspace".parse().unwrap());`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`{`