Merge pull request #9751 from Byron/fix

Turn silent removal of stacks into error that says how to fix it when committed onto ws-commit. (#9740)

Author: Byron

crates/but-workspace/src/ref_info.rs

@@ -323,6 +323,7 @@ pub(crate) mod function {
     use super::ui::{LocalCommit, LocalCommitRelation};
     use crate::ui::PushStatus;
     use crate::{AncestorWorkspaceCommit, RefInfo, WorkspaceCommit, branch, ref_info::ui};
+    use anyhow::{Context, bail};
     use but_core::ref_metadata::ValueInfo;
     use but_graph::petgraph::Direction;
     use but_graph::{
@@ -449,10 +450,28 @@ pub(crate) mod function {
             ancestor_workspace_commit,
             is_entrypoint: graph.lookup_entrypoint()?.segment_index == id,
         };
-        if info.ancestor_workspace_commit.is_some() {
-            // Don't trust the stacks anymore, they now contain the workspace comit and shouldn't be acted on.
-            // That way it's clear this must be fixed first.
-            info.stacks.clear();
+
+        if let Some(info) = &info.ancestor_workspace_commit {
+            // This is the MVP version of what should be guided by the UI - just communicate through
+            // an error message, which can only be recovered once the command is executed.
+            let mut msg = format!(
+                "Found {} commit(s) on top of the workspace commit.\n\n",
+                info.commits_outside.len()
+            );
+            let ws_commit_id = graph[info.segment_with_managed_commit].commits
+                [info.commit_index_of_managed_commit]
+                .id;
+            msg.push_str(
+                    "The current changes will be stashed and must be re-applied manually. Commit them otherwise.\n",
+                );
+            msg.push_str(
+                    "Run the following command in your working directory to fix this and restore the committed changes.\n\n",
+                );
+            msg.push_str(&format!("    git stash && git reset --hard {ws_commit_id} && git checkout {user_commit_id} -- .",
+                                      user_commit_id = info.commits_outside
+                                                              .first()
+                                                              .context("BUG: at least one user commit on top")?.id));
+            bail!("{msg}");
         }
         info.compute_similarity(graph, repo, opts.expensive_commit_info)?;
         Ok(info)

crates/but-workspace/tests/workspace/ref_info/with_workspace_commit/mod.rs

@@ -3207,49 +3207,15 @@ fn advanced_workspace_multi_stack() -> anyhow::Result<()> {
     add_stack_with_segments(&mut meta, 1, "B", StackState::InWorkspace, &[]);
 
     let opts = standard_options();
-    let info = head_info(&repo, &meta, opts)?;
-    // It can find the exact location of the workspace commit in the ancestry.
-    insta::assert_debug_snapshot!(info, @r#"
-    RefInfo {
-        workspace_ref_name: Some(
-            FullName(
-                "refs/heads/gitbutler/workspace",
-            ),
-        ),
-        stacks: [],
-        target: Some(
-            Target {
-                ref_name: FullName(
-                    "refs/remotes/origin/main",
-                ),
-                segment_index: NodeIndex(1),
-                commits_ahead: 0,
-            },
-        ),
-        extra_target: Some(
-            NodeIndex(1),
-        ),
-        lower_bound: Some(
-            NodeIndex(2),
-        ),
-        is_managed_ref: true,
-        is_managed_commit: false,
-        ancestor_workspace_commit: Some(
-            AncestorWorkspaceCommit {
-                commits_outside: [
-                    Commit(a7131b1, "on-top4\n"🏘️),
-                    Commit(4d3831e, "on-top3\n"🏘️),
-                    Commit(468357f, "on-top2-merge\n"🏘️),
-                    Commit(d3166f7, "on-top-sibling\n"🏘️),
-                    Commit(118ddbb, "on-top1\n"🏘️),
-                ],
-                segment_with_managed_commit: NodeIndex(10),
-                commit_index_of_managed_commit: 0,
-            },
-        ),
-        is_entrypoint: true,
-    }
-    "#);
+    let err = head_info(&repo, &meta, opts).unwrap_err();
+    insta::assert_snapshot!(err.to_string(), @r"
+    Found 5 commit(s) on top of the workspace commit.
+
+    The current changes will be stashed and must be re-applied manually. Commit them otherwise.
+    Run the following command in your working directory to fix this and restore the committed changes.
+
+        git stash && git reset --hard 619d5486e6f5ae7f5e4ecc4a6ea506d6c8433410 && git checkout a7131b181b20c699ecbe4f6145bbb8746716c18b -- .
+    ");
     Ok(())
 }
 
@@ -3273,49 +3239,15 @@ fn advanced_workspace_single_stack() -> anyhow::Result<()> {
     add_stack_with_segments(&mut meta, 0, "A", StackState::InWorkspace, &[]);
 
     let opts = standard_options();
-    let info = head_info(&repo, &meta, opts)?;
-    // It can find the exact location of the workspace commit in the ancestry.
-    insta::assert_debug_snapshot!(info, @r#"
-    RefInfo {
-        workspace_ref_name: Some(
-            FullName(
-                "refs/heads/gitbutler/workspace",
-            ),
-        ),
-        stacks: [],
-        target: Some(
-            Target {
-                ref_name: FullName(
-                    "refs/remotes/origin/main",
-                ),
-                segment_index: NodeIndex(1),
-                commits_ahead: 0,
-            },
-        ),
-        extra_target: Some(
-            NodeIndex(1),
-        ),
-        lower_bound: Some(
-            NodeIndex(2),
-        ),
-        is_managed_ref: true,
-        is_managed_commit: false,
-        ancestor_workspace_commit: Some(
-            AncestorWorkspaceCommit {
-                commits_outside: [
-                    Commit(da912a8, "on-top4\n"🏘️),
-                    Commit(198eaf8, "on-top3\n"🏘️),
-                    Commit(3147997, "on-top2-merge\n"🏘️),
-                    Commit(dd7bb9a, "on-top-sibling\n"🏘️),
-                    Commit(9785229, "on-top1\n"🏘️),
-                ],
-                segment_with_managed_commit: NodeIndex(7),
-                commit_index_of_managed_commit: 1,
-            },
-        ),
-        is_entrypoint: true,
-    }
-    "#);
+    let err = head_info(&repo, &meta, opts).unwrap_err();
+    insta::assert_snapshot!(err.to_string(), @r"
+    Found 5 commit(s) on top of the workspace commit.
+
+    The current changes will be stashed and must be re-applied manually. Commit them otherwise.
+    Run the following command in your working directory to fix this and restore the committed changes.
+
+        git stash && git reset --hard c58f15768a8ba280fe773ffc4820b13ad882cd84 && git checkout da912a8a455bca9e94ed65cb42328177fa891081 -- .
+    ");
     Ok(())
 }