Merge pull request #11371 from Byron/next2

Single-branch support for `but branch apply`

Author: Byron

.github/workflows/push.yaml

@@ -64,19 +64,24 @@ jobs:
     needs: changes
     if: ${{ needs.changes.outputs.node == 'true' || needs.changes.outputs.rust == 'true' }}
     runs-on: ubuntu-latest
-    container:
-      image: ghcr.io/gitbutlerapp/ci-base-image:latest
     env:
       CARGO_TERM_COLOR: always
     steps:
       - uses: actions/checkout@v6
         with:
           persist-credentials: false
+      - name: Rust Cache
+        uses: Swatinem/rust-cache@v2.8.1
+        with:
+          shared-key: ts-def-gen
+          save-if: ${{ github.ref == 'refs/heads/master' }}
+      # Node is needed for the formatting of typescript files.
       - uses: ./.github/actions/init-env-node
-      - run: pnpm generate-ts-definitions
+      - run: |
+          sudo apt install libdbus-1-dev pkg-config
+          ./scripts/generate-ts-definitions-from-rust.sh
 
   lint-node:
-    needs: generate-ts-definitions
     if: ${{ needs.changes.outputs.node == 'true' || needs.changes.outputs.rust == 'true' }}
     runs-on: ubuntu-latest
     steps:
@@ -87,7 +92,6 @@ jobs:
       - run: pnpm lint
 
   check-node:
-    needs: generate-ts-definitions
     if: ${{ needs.changes.outputs.node == 'true' || needs.changes.outputs.rust == 'true' }}
     runs-on: ubuntu-latest
     steps:
@@ -98,7 +102,6 @@ jobs:
       - run: pnpm check
 
   unittest-node:
-    needs: generate-ts-definitions
     if: ${{ needs.changes.outputs.node == 'true' }}
     runs-on: ubuntu-latest
     steps:
@@ -180,10 +183,12 @@ jobs:
           sudo apt update
           sudo apt install -y libdbus-1-dev pkg-config
       - run: |
-          cargo test --workspace --exclude gitbutler-tauri
+          cargo test --workspace --exclude gitbutler-tauri --exclude but-server
         env:
           GITBUTLER_TESTS_NO_CLEANUP: '1'
         name: cargo test
+      # It's intentional to use 'name equals run-script' so it's easy to re-run locally on failure.
+      - run: cargo test -p but --no-default-features
 
   rust-test-tauri:
     needs: changes

Cargo.lock

@@ -37,6 +37,7 @@ but-settings = { path = "crates/but-settings" }
 but-oxidize = { path = "crates/but-oxidize" }
 but-fs = { path = "crates/but-fs" }
 but-forge = { path = "crates/but-forge" }
+but-oplog = { path = "crates/but-oplog" }
 
 gitbutler-git = { path = "crates/gitbutler-git" }
 gitbutler-watcher = { path = "crates/gitbutler-watcher" }

Cargo.toml

@@ -137,3 +137,4 @@ at the [DEVELOPMENT.md](DEVELOPMENT.md) file.
 <a href="https://github.com/gitbutlerapp/gitbutler/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=gitbutlerapp/gitbutler" />
 </a>
+hi

README.md

@@ -22,12 +22,13 @@ tauri = ["dep:tauri"]
 path-bytes = ["dep:bstr"]
 ## Make legacy functionality available.
 legacy = [
+    "but-ctx/legacy",
+    "but-workspace/legacy",
     "dep:gitbutler-user",
     "dep:gitbutler-project",
     "dep:gitbutler-branch",
     "dep:gitbutler-branch-actions",
     "dep:gitbutler-commit",
-    "dep:but-ctx",
     "dep:gitbutler-reference",
     "dep:gitbutler-stack",
     "dep:gitbutler-repo",
@@ -36,35 +37,51 @@ legacy = [
     "dep:gitbutler-operating-modes",
     "dep:gitbutler-sync",
     "dep:gitbutler-oplog",
+    "dep:but-action",
+    "dep:but-hunk-assignment",
+    "dep:but-hunk-dependency",
+    "dep:but-claude",
+    "dep:but-rules",
+    "dep:but-gerrit",
+    "dep:but-worktrees",
+    "dep:but-cherry-apply",
 ]
 
 
 [dependencies]
-but-settings.workspace = true
-but-github = { workspace = true, features = ["legacy"] }
-but-secret.workspace = true
-but-workspace = { workspace = true, features = ["legacy"] }
-but-worktrees.workspace = true
-but-core.workspace = true
-but-gerrit.workspace = true
-but-hunk-assignment.workspace = true
-but-action.workspace = true
-but-api-macros.workspace = true
-but-rebase.workspace = true
 but-serde.workspace = true
-but-graph.workspace = true
-but-meta = { workspace = true, features = ["legacy"] }
-but-claude.workspace = true
-but-cherry-apply.workspace = true
-but-hunk-dependency.workspace = true
 but-path.workspace = true
-but-forge-storage.workspace = true
+but-api-macros.workspace = true
+but-oxidize.workspace = true
 but-error.workspace = true
+but-core.workspace = true
+but-graph.workspace = true
+but-ctx.workspace = true
+but-workspace.workspace = true
+but-settings.workspace = true
+but-secret.workspace = true
+but-rebase.workspace = true
 but-db.workspace = true
-but-rules.workspace = true
-but-oxidize.workspace = true
 but-forge.workspace = true
-but-ctx = {workspace = true, optional = true}
+but-forge-storage.workspace = true
+# needs `gitbutler_user::User`, which can probably be ported over.
+but-github = { workspace = true, features = ["legacy"] }
+# 'legacy' is needed while we only have `virtual-branches.toml`
+but-meta = { workspace = true, features = ["legacy"] }
+# 'legacy' is needed while this is only a sketch of what the oplog could be.
+# For single-branch testing, we also want the oplog and just take it as it is.
+but-oplog = { workspace = true, features = ["legacy"] }
+
+# What follows is *basically* newly written crates that are built on top of legacy,
+# so need some refactoring/rethinking to become usable.
+but-cherry-apply = { workspace = true, optional = true }
+but-action = { workspace = true, optional = true }
+but-hunk-assignment = { workspace = true, optional = true }
+but-hunk-dependency = { workspace = true, optional = true }
+but-claude = { workspace = true, optional = true }
+but-rules = { workspace = true, optional = true }
+but-gerrit = { workspace = true, optional = true }
+but-worktrees = { workspace = true, optional = true }
 
 gitbutler-user = {workspace = true, optional = true}
 gitbutler-project = {workspace = true, optional = true}

crates/but-api/Cargo.toml

@@ -0,0 +1,56 @@
+use but_core::worktree::checkout::UncommitedWorktreeChanges;
+use but_oplog::legacy::{OperationKind, SnapshotDetails, Trailer};
+use but_workspace::branch::OnWorkspaceMergeConflict;
+use but_workspace::branch::apply::{WorkspaceMerge, WorkspaceReferenceNaming};
+
+/// Just like [apply()], but without updating the oplog.
+pub fn apply_only(
+    ctx: &but_ctx::Context,
+    existing_branch: &gix::refs::FullNameRef,
+) -> anyhow::Result<but_workspace::branch::apply::Outcome<'static>> {
+    let mut guard = ctx.exclusive_worktree_access();
+    let (repo, mut meta, graph) =
+        ctx.graph_and_meta_mut_and_repo_from_head(guard.write_permission())?;
+    let ws = graph.to_workspace()?;
+    let out = but_workspace::branch::apply(
+        existing_branch,
+        &ws,
+        &repo,
+        &mut meta,
+        // NOTE: Options can later be passed as parameter, or we have a separate function for that.
+        //       Showing them off here while leaving defaults.
+        but_workspace::branch::apply::Options {
+            workspace_merge: WorkspaceMerge::default(),
+            on_workspace_conflict: OnWorkspaceMergeConflict::default(),
+            workspace_reference_naming: WorkspaceReferenceNaming::default(),
+            uncommitted_changes: UncommitedWorktreeChanges::default(),
+            order: None,
+            new_stack_id: None,
+        },
+    )?
+    .into_owned();
+    Ok(out)
+}
+
+/// Apply `existing_branch` to the workspace in the repository that `ctx` refers to, or create the workspace with default name.
+// TODO: generate this with an improved `api_cmd_tauri` macro.
+pub fn apply(
+    ctx: &but_ctx::Context,
+    existing_branch: &gix::refs::FullNameRef,
+) -> anyhow::Result<but_workspace::branch::apply::Outcome<'static>> {
+    // NOTE: since this is optional by nature, the same would be true if snapshotting/undo would be disabled via `ctx` app settings, for instance.
+    let maybe_oplog_entry = but_oplog::UnmaterializedOplogSnapshot::from_details(
+        ctx,
+        SnapshotDetails::new(OperationKind::CreateBranch).with_trailers(vec![Trailer {
+            key: "name".into(),
+            value: existing_branch.to_string(),
+        }]),
+    )
+    .ok();
+
+    let res = apply_only(ctx, existing_branch);
+    if let Some(snapshot) = maybe_oplog_entry.filter(|_| res.is_ok()) {
+        snapshot.commit(ctx).ok();
+    }
+    res
+}

crates/but-api/src/branch.rs

@@ -1,4 +1,5 @@
-//! In place of commands.rs
+// TODO: everything should be fully documented.
+#![allow(missing_docs)]
 use anyhow::Result;
 use but_api_macros::api_cmd_tauri;
 use but_github::{AuthStatusResponse, AuthenticatedUser, Verification};

crates/but-api/src/github.rs

@@ -1,3 +1,4 @@
+//! JSON types and utilities to produce decent JSON from API types.
 pub use error::{Error, ToJsonError, UnmarkedError};
 use gix::refs::Target;
 use schemars::{self, JsonSchema};
@@ -195,7 +196,9 @@ mod error {
         }
     }
 
+    /// A utility to convert any `Result<T, impl std::error::Error>` into a [JSON-Error](Error).
     pub trait ToJsonError<T> {
+        /// Convert this instance into a Result<T, [JSON-Error](Error)>.
         fn to_json_error(self) -> Result<T, Error>;
     }
 

crates/but-api/src/json.rs

@@ -1,3 +1,4 @@
+#![allow(missing_docs)]
 //! Legacy data structures and functionality tied to `gitbutler-*` crates.
 //!
 pub mod askpass;

crates/but-api/src/legacy/mod.rs

@@ -327,7 +327,7 @@ pub fn amend_commit_from_worktree_changes(
     let app_settings = AppSettings::load_from_default_path_creating()?;
     let outcome = but_workspace::legacy::commit_engine::create_commit_and_update_refs_with_project(
         &repo,
-        &project,
+        &project.gb_dir(),
         Some(stack_id),
         commit_engine::Destination::AmendCommit {
             commit_id: commit_id.into(),
@@ -620,7 +620,7 @@ pub fn stash_into_branch(
 
     let outcome = but_workspace::legacy::commit_engine::create_commit_and_update_refs_with_project(
         &repo,
-        &ctx.legacy_project,
+        &ctx.project_data_dir(),
         Some(stack.id),
         commit_engine::Destination::NewCommit {
             parent_commit_id: Some(parent_commit_id),