Show non-main worktrees in but status

Note that this is just a first take, and more integrations are likely needed to get it right.
For one, legacy APIs shouldn't be used.

Author: Byron

crates/but-graph/tests/fixtures/scenarios.sh

@@ -214,7 +214,6 @@ mkdir ws
 (cd ws
   git init ambiguous-worktrees
   (cd ambiguous-worktrees
-    set -x
     commit M1
     commit M-base
 

crates/but-workspace/src/branch_details.rs

@@ -86,6 +86,7 @@ pub fn branch_details(
 
     Ok(ui::BranchDetails {
         name: branch_name.into(),
+        linked_worktree_id: None, /* not implemented in legacy mode */
         remote_tracking_branch: upstream
             .as_ref()
             .and_then(|upstream| upstream.get().name())
@@ -228,6 +229,7 @@ pub fn branch_details_v3(
 
     Ok(ui::BranchDetails {
         name: name.as_bstr().into(),
+        linked_worktree_id: None, /* probably not needed here */
         remote_tracking_branch: remote_tracking_branch.map(|b| b.name().as_bstr().to_owned()),
         description: meta.description.clone(),
         pr_number: meta.review.pull_request,

crates/but-workspace/src/stacks.rs

@@ -391,6 +391,7 @@ pub fn stack_details(
 
         branch_details.push(ui::BranchDetails {
             name: branch.name().to_owned().into(),
+            linked_worktree_id: None, /* not implemented in legacy mode */
             remote_tracking_branch: upstream_reference.map(Into::into),
             description: branch.description.clone(),
             pr_number: branch.pr_number,
@@ -549,10 +550,9 @@ impl ui::BranchDetails {
             base,
         }: &Segment,
     ) -> anyhow::Result<Self> {
-        let ref_name = ref_info
+        let ref_info = ref_info
             .clone()
-            .context("Can't handle a stack yet whose tip isn't pointed to by a ref")?
-            .ref_name;
+            .context("Can't handle a stack yet whose tip isn't pointed to by a ref")?;
         let (description, updated_at, review_id, pr_number) = metadata
             .clone()
             .map(|meta| {
@@ -566,10 +566,15 @@ impl ui::BranchDetails {
             .unwrap_or_default();
         let base_commit = base.unwrap_or(gix::hash::Kind::Sha1.null());
         Ok(ui::BranchDetails {
-            is_remote_head: ref_name
+            is_remote_head: ref_info
+                .ref_name
                 .category()
                 .is_some_and(|c| matches!(c, gix::refs::Category::RemoteBranch)),
-            name: ref_name.shorten().into(),
+            name: ref_info.ref_name.shorten().into(),
+            linked_worktree_id: ref_info.worktree.and_then(|ws| match ws {
+                but_graph::Worktree::Main => None,
+                but_graph::Worktree::LinkedId(id) => Some(id),
+            }),
             remote_tracking_branch: remote_tracking_ref_name
                 .as_ref()
                 .map(|full_name| full_name.as_bstr().into()),

crates/but-workspace/src/ui/mod.rs

@@ -362,6 +362,10 @@ pub struct BranchDetails {
     /// The name of the branch.
     #[serde(with = "gitbutler_serde::bstring_lossy")]
     pub name: BString,
+    /// The id of the linked worktree that has the reference of `name` checked out.
+    /// Note that we don't list the main worktree here.
+    #[serde(with = "gitbutler_serde::bstring_opt_lossy")]
+    pub linked_worktree_id: Option<BString>,
     /// Upstream reference, e.g. `refs/remotes/origin/base-branch-improvements`
     #[serde(with = "gitbutler_serde::bstring_opt_lossy")]
     pub remote_tracking_branch: Option<BString>,

crates/but/src/status/mod.rs

@@ -216,6 +216,7 @@ pub fn print_group(
     review_map: &std::collections::HashMap<String, Vec<gitbutler_forge::review::ForgeReview>>,
 ) -> anyhow::Result<()> {
     let mut stdout = std::io::stdout();
+    let repo = project.open_isolated()?;
     if let Some(group) = &group {
         let mut first = true;
         for branch in &group.branch_details {
@@ -242,15 +243,24 @@ pub fn print_group(
                 review_map,
             );
 
+            let workspace = branch
+                .linked_worktree_id
+                .as_ref()
+                .and_then(|id| {
+                    let ws = repo.worktree_proxy_by_id(id.as_bstr())?;
+                    let base = ws.base().ok()?;
+                    let git_dir = gix::path::realpath(repo.git_dir()).ok();
+                    let base = git_dir
+                        .and_then(|git_dir| base.strip_prefix(git_dir).ok())
+                        .unwrap_or_else(|| &base);
+                    format!(" 📁 {base}", base = base.display()).into()
+                })
+                .unwrap_or_default();
             writeln!(
                 stdout,
-                "┊{}┄{} [{}]{} {} {}",
-                notch,
-                id,
-                branch.name.to_string().green().bold(),
-                reviews,
-                no_commits,
-                stack_mark.clone().unwrap_or_default()
+                "┊{notch}┄{id} [{branch}{workspace}]{reviews} {no_commits} {stack_mark}",
+                stack_mark = stack_mark.clone().unwrap_or_default(),
+                branch = branch.name.to_string().green().bold(),
             )
             .ok();
             *stack_mark = None; // Only show the stack mark for the first branch

crates/but/tests/but/snapshots/two-worktrees/status-with-worktrees-verbose.stdout.term.svg

@@ -1,6 +1,46 @@
 use crate::utils::Sandbox;
 use crate::utils::setup_metadata;
 
+#[test]
+fn worktrees() -> anyhow::Result<()> {
+    let env = Sandbox::init_scenario_with_target_slow("two-worktrees")?;
+    insta::assert_snapshot!(env.git_log()?, @r"
+    *   063d8c1 (HEAD -> gitbutler/workspace) GitButler Workspace Commit
+    |\  
+    | * 3e01e28 (B) B
+    * | 4c4624e (A) A
+    |/  
+    | * 8dc508f (origin/main, origin/HEAD, main) M-advanced
+    |/  
+    | * 197ddce (origin/A) A-remote
+    |/  
+    * 081bae9 M-base
+    * 3183e43 M1
+    ");
+
+    // Must set metadata to match the scenario, or else the old APIs used here won't deliver.
+    setup_metadata(&env, &["A", "B"])?;
+
+    env.but("status")
+        .with_assert(env.assert_with_uuid_and_timestamp_redactions())
+        .assert()
+        .success()
+        .stderr_eq(snapbox::str![])
+        .stdout_eq(snapbox::file![
+            "snapshots/two-worktrees/status-with-worktrees.stdout.term.svg"
+        ]);
+
+    env.but("status --verbose")
+        .with_assert(env.assert_with_uuid_and_timestamp_redactions())
+        .assert()
+        .success()
+        .stderr_eq(snapbox::str![])
+        .stdout_eq(snapbox::file![
+            "snapshots/two-worktrees/status-with-worktrees-verbose.stdout.term.svg"
+        ]);
+    Ok(())
+}
+
 #[test]
 fn json_shows_paths_as_strings() -> anyhow::Result<()> {
     let env = Sandbox::init_scenario_with_target("two-stacks")?;
@@ -72,6 +112,7 @@ fn json_shows_paths_as_strings() -> anyhow::Result<()> {
           "branchDetails": [
             {
               "name": "A",
+              "linkedWorktreeId": null,
               "remoteTrackingBranch": null,
               "description": null,
               "prNumber": null,
@@ -126,6 +167,7 @@ fn json_shows_paths_as_strings() -> anyhow::Result<()> {
           "branchDetails": [
             {
               "name": "B",
+              "linkedWorktreeId": null,
               "remoteTrackingBranch": null,
               "description": null,
               "prNumber": null,

crates/but/tests/but/snapshots/two-worktrees/status-with-worktrees.stdout.term.svg

@@ -6,7 +6,7 @@ use but_settings::app_settings::{
     Claude, ExtraCsp, FeatureFlags, Fetch, GitHubOAuthAppSettings, Reviews, TelemetrySettings,
     UiSettings,
 };
-use but_testsupport::gix_testtools::tempfile;
+use but_testsupport::gix_testtools::{Creation, tempfile};
 use but_workspace::StackId;
 use snapbox::{Assert, Redactions};
 use std::env;
@@ -49,9 +49,24 @@ impl Sandbox {
     /// TODO: we shouldn't have to add the project for interaction - it's only useful for listing.
     /// TODO: there should be no need for the target.
     pub fn init_scenario_with_target(name: &str) -> anyhow::Result<Sandbox> {
-        let project = but_testsupport::gix_testtools::scripted_fixture_writable(format!(
-            "scenario/{name}.sh"
-        ))
+        Self::init_scenario_with_target_inner(name, Creation::CopyFromReadOnly)
+    }
+
+    /// Like [`Self::init_scenario_with_target`], Execute the script at `name` instead of
+    /// copying it - necessary if Git places absolute paths.
+    pub fn init_scenario_with_target_slow(name: &str) -> anyhow::Result<Sandbox> {
+        Self::init_scenario_with_target_inner(name, Creation::ExecuteScript)
+    }
+
+    fn init_scenario_with_target_inner(
+        name: &str,
+        script_creation: Creation,
+    ) -> anyhow::Result<Sandbox> {
+        let project = but_testsupport::gix_testtools::scripted_fixture_writable_with_args(
+            format!("scenario/{name}.sh"),
+            None::<String>,
+            script_creation,
+        )
         .map_err(anyhow::Error::from_boxed)?;
         let sandbox = Sandbox {
             projects_root: Some(project),
@@ -148,6 +163,20 @@ impl Sandbox {
         )
     }
 
+    /// return the graph at `HEAD`, along with the `(graph, repo, meta)` repository and metadata used to create it.
+    pub fn graph_at_head(
+        &self,
+    ) -> anyhow::Result<(
+        but_graph::Graph,
+        gix::Repository,
+        impl but_core::RefMetadata,
+    )> {
+        let repo = self.repo()?;
+        let meta = self.meta()?;
+        let graph = but_graph::Graph::from_head(&repo, &meta, Default::default())?;
+        Ok((graph, repo, meta))
+    }
+
     /// Show a git log for all refs.
     pub fn git_log(&self) -> anyhow::Result<String> {
         let repo = self.repo()?;

crates/but/tests/but/status.rs

@@ -0,0 +1,33 @@
+#!/usr/bin/env bash
+
+set -eu -o pipefail
+
+source "${BASH_SOURCE[0]%/*}/shared.sh"
+
+### General Description
+
+# A ws-ref points to a workspace commit, with two stacks inside, each with their own commit.
+git init
+commit M1
+commit M-base
+
+git checkout -b A
+  commit A
+
+git checkout -b soon-origin-A main
+  commit A-remote
+
+git checkout -b B main
+  commit B
+
+git checkout main
+  commit M-advanced
+  setup_target_to_match_main
+
+git checkout A
+create_workspace_commit_once A B
+setup_remote_tracking soon-origin-A A "move"
+
+git worktree add .git/gitbutler/worktrees/A A
+git worktree add .git/gitbutler/worktrees/B B
+