Merge pull request #10382 from Byron/next

Add the `head_info` endpoint

Author: Byron

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

@@ -25,6 +25,30 @@ fn ref_metadata_toml(project: &Project) -> anyhow::Result<VirtualBranchesTomlMet
     VirtualBranchesTomlMetadata::from_path(project.gb_dir().join("virtual_branches.toml"))
 }
 
+#[api_cmd]
+#[tauri::command(async)]
+#[instrument(err(Debug))]
+pub fn head_info(project_id: ProjectId) -> Result<but_workspace::ui::RefInfo, Error> {
+    let project = gitbutler_project::get(project_id)?;
+    let ctx = CommandContext::open(&project, AppSettings::load_from_default_path_creating()?)?;
+    let repo = ctx.gix_repo_for_merging_non_persisting()?;
+    let meta = ref_metadata_toml(ctx.project())?;
+    but_workspace::head_info(
+        &repo,
+        &meta,
+        but_workspace::ref_info::Options {
+            traversal: but_graph::init::Options::limited(),
+            expensive_commit_info: true,
+        },
+    )
+    .map_err(Into::into)
+    .and_then(|info| {
+        but_workspace::ui::RefInfo::for_ui(info, &repo)
+            .map(|ref_info| ref_info.pruned_to_entrypoint())
+            .map_err(Into::into)
+    })
+}
+
 #[api_cmd]
 #[tauri::command(async)]
 #[instrument(err(Debug))]

crates/but-core/src/ref_metadata.rs

@@ -81,7 +81,8 @@ impl Workspace {
 }
 
 /// Metadata about branches, associated with any Git branch.
-#[derive(Clone, Eq, PartialEq, Default)]
+#[derive(serde::Serialize, Clone, Eq, PartialEq, Default)]
+#[serde(rename_all = "camelCase")]
 pub struct Branch {
     /// Standard data we want to know about any ref.
     pub ref_info: RefInfo,
@@ -132,7 +133,8 @@ impl<T: std::fmt::Debug> std::fmt::Debug for MaybeDebug<'_, T> {
 ///
 /// It allows keeping track of when it changed, but also if we created it initially, a useful
 /// bit of information.
-#[derive(Default, Clone, Eq, PartialEq)]
+#[derive(serde::Serialize, Default, Clone, Eq, PartialEq)]
+#[serde(rename_all = "camelCase")]
 pub struct RefInfo {
     /// The time of creation, *if we created the reference*.
     pub created_at: Option<gix::date::Time>,
@@ -219,7 +221,8 @@ impl WorkspaceStack {
 }
 
 /// Metadata about branches, associated with any Git branch.
-#[derive(Clone, Eq, PartialEq, Default)]
+#[derive(serde::Serialize, Clone, Eq, PartialEq, Default)]
+#[serde(rename_all = "camelCase")]
 pub struct Review {
     /// The number for the PR that was associated with this branch.
     pub pull_request: Option<usize>,

crates/but-server/src/lib.rs

@@ -164,6 +164,7 @@ async fn handle_command(
         "assign_hunk" => diff::assign_hunk_cmd(request.params),
         // Workspace commands
         "stacks" => workspace::stacks_cmd(request.params),
+        "head_info" => workspace::head_info_cmd(request.params),
         #[cfg(unix)]
         "show_graph_svg" => workspace::show_graph_svg_cmd(request.params),
         "stack_details" => workspace::stack_details_cmd(request.params),

crates/but-workspace/Cargo.toml

@@ -36,7 +36,7 @@ tempfile.workspace = true
 
 [dev-dependencies]
 but-testsupport.workspace = true
-insta = "1.43.1"
+insta = { version = "1.43.1", features = ["json"] }
 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.

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

@@ -431,7 +431,7 @@ pub struct Stack {
     pub base: Option<gix::ObjectId>,
     /// The branch-name denoted segments of the stack from its tip to the point of reference, typically a merge-base.
     /// This array is never empty.
-    pub segments: Vec<ref_info::ui::Segment>,
+    pub segments: Vec<ref_info::Segment>,
 }
 
 impl Stack {

crates/but-workspace/src/changeset.rs

@@ -6,10 +6,7 @@
 
 use crate::{
     RefInfo,
-    ref_info::{
-        ui,
-        ui::{LocalCommit, LocalCommitRelation},
-    },
+    ref_info::{LocalCommit, LocalCommitRelation},
     ui::PushStatus,
 };
 use bstr::{BStr, BString, ByteSlice, ByteVec};
@@ -94,7 +91,7 @@ impl RefInfo {
             repo,
             upstream_commits.iter().filter_map(|id| {
                 but_core::Commit::from_id(id.attach(repo))
-                    .map(ui::Commit::from)
+                    .map(crate::ref_info::Commit::from)
                     .ok()
             }),
             cost_info,
@@ -262,7 +259,7 @@ impl PushStatus {
 
 fn changeset_identifier(
     repo: &gix::Repository,
-    commit: Option<&ui::Commit>,
+    commit: Option<&crate::ref_info::Commit>,
     elapsed: &mut Duration,
 ) -> anyhow::Result<Option<Identifier>> {
     let Some(commit) = commit else {
@@ -296,7 +293,7 @@ enum ChangeId {
 
 fn lookup_similar<'a>(
     map: &'a Identity,
-    commit: &ui::Commit,
+    commit: &crate::ref_info::Commit,
     expensive: Option<&Identifier>,
     change_id: ChangeId,
 ) -> Option<&'a gix::ObjectId> {
@@ -312,7 +309,7 @@ fn lookup_similar<'a>(
 /// Returns the fully-loaded commits suitable to be passed to UI, to have better re-use.
 fn create_similarity_lut(
     repo: &gix::Repository,
-    commits: impl Iterator<Item = impl Borrow<ui::Commit>>,
+    commits: impl Iterator<Item = impl Borrow<crate::ref_info::Commit>>,
     (max_commits, num_tracked_files): (usize, usize),
     expensive: bool,
 ) -> anyhow::Result<Identity> {
@@ -633,7 +630,7 @@ enum Identifier {
     ChangesetId(ChangesetID),
 }
 
-fn commit_data_id(c: &ui::Commit) -> anyhow::Result<Identifier> {
+fn commit_data_id(c: &crate::ref_info::Commit) -> anyhow::Result<Identifier> {
     let mut hasher = gix::hash::hasher(gix::hash::Kind::Sha1);
 
     let gix::actor::Signature {

crates/but-workspace/src/lib.rs

@@ -222,7 +222,7 @@ pub struct RefInfo {
 pub struct AncestorWorkspaceCommit {
     /// The commits along the first parent that are between the managed workspace reference and the managed workspace commit.
     /// The vec is never empty.
-    pub commits_outside: Vec<ref_info::ui::Commit>,
+    pub commits_outside: Vec<crate::ref_info::Commit>,
     /// The index of the segment that actually holds the managed workspace commit.
     pub segment_with_managed_commit: SegmentIndex,
     /// The index of the workspace commit within the `commits` array in its parent segment.