Merge pull request #10564 from gitbutlerapp/tear-branch

tear-branch

Author: estib-vega

apps/desktop/src/components/BranchCard.svelte

@@ -78,6 +78,7 @@
 		contextMenu?: typeof BranchHeaderContextMenu;
 		dropzones: DropzoneHandler[];
 		numberOfCommits: number;
+		numberOfBranchesInStack: number;
 		onclick: () => void;
 		menu?: Snippet<[{ rightClickTrigger: HTMLElement }]>;
 		buttons?: Snippet;
@@ -161,7 +162,13 @@
 		viewportId: 'board-viewport',
 		data:
 			args.type === 'stack-branch' && args.stackId
-				? new BranchDropData(args.stackId, branchName, args.isConflicted, args.numberOfCommits)
+				? new BranchDropData(
+						args.stackId,
+						branchName,
+						args.isConflicted,
+						args.numberOfBranchesInStack,
+						args.numberOfCommits
+					)
 				: undefined,
 		dropzoneRegistry,
 		dragStateService

apps/desktop/src/components/BranchList.svelte

@@ -206,6 +206,7 @@
 					{reviewId}
 					{prNumber}
 					numberOfCommits={localAndRemoteCommits.length}
+					numberOfBranchesInStack={branches.length}
 					dropzones={[stackingReorderDropzoneManager.top(branchName)]}
 					trackingBranch={branch.remoteTrackingBranch ?? undefined}
 					readonly={!!branch.remoteTrackingBranch}

apps/desktop/src/components/MultiStackOfflaneDropzone.svelte

@@ -7,6 +7,7 @@
 	import { STACK_SERVICE } from '$lib/stacks/stackService.svelte';
 	import { UI_STATE } from '$lib/state/uiState.svelte';
 	import { inject } from '@gitbutler/core/context';
+	import { TestId } from '@gitbutler/ui';
 	import { focusable } from '@gitbutler/ui/focus/focusable';
 	import { intersectionObserver } from '@gitbutler/ui/utils/intersectionObserver';
 	import type { Snippet } from 'svelte';
@@ -32,6 +33,7 @@
 
 <div
 	class="hidden-dropzone"
+	data-testid={TestId.StackOfflaneDropzone}
 	use:focusable
 	use:intersectionObserver={{
 		callback: (entry) => {

apps/desktop/src/components/SnapshotCard.svelte

@@ -115,6 +115,8 @@
 				return { text: 'Move commit', icon: 'move-commit' };
 			case 'MoveBranch':
 				return { text: 'Move branch', icon: 'move-commit' };
+			case 'TearOffBranch':
+				return { text: 'Tear off branch', icon: 'move-commit' };
 			case 'ReorderCommit':
 				return { text: 'Reorder commit', icon: 'move-commit' };
 			case 'InsertBlankCommit':

apps/desktop/src/lib/branches/dropHandler.ts

@@ -6,6 +6,7 @@ export class BranchDropData {
 		readonly stackId: string,
 		readonly branchName: string,
 		readonly hasConflicts: boolean,
+		readonly numberOfBranchesInStack: number,
 		readonly numberOfCommits: number
 	) {}
 

apps/desktop/src/lib/history/types.ts

@@ -26,6 +26,7 @@ export type Operation =
 	| 'UpdateCommitMessage'
 	| 'MoveCommit'
 	| 'MoveBranch'
+	| 'TearOffBranch'
 	| 'RestoreFromSnapshot'
 	| 'ReorderCommit'
 	| 'InsertBlankCommit'

apps/desktop/src/lib/stacks/dropHandler.ts

@@ -1,6 +1,8 @@
+import { BranchDropData } from '$lib/branches/dropHandler';
 import { changesToDiffSpec } from '$lib/commits/utils';
 import { ChangeDropData } from '$lib/dragging/draggables';
 import StackMacros from '$lib/stacks/macros';
+import { handleMoveBranchResult } from '$lib/stacks/stack';
 import { ensureValue } from '$lib/utils/validation';
 import { chipToasts } from '@gitbutler/ui';
 import type { DropzoneHandler } from '$lib/dragging/handler';
@@ -23,13 +25,25 @@ export class OutsideLaneDzHandler implements DropzoneHandler {
 		this.macros = new StackMacros(this.projectId, this.stackService, this.uiState);
 	}
 
-	accepts(data: unknown) {
+	private acceptsChangeDropData(data: unknown): data is ChangeDropData {
 		if (!(data instanceof ChangeDropData)) return false;
 		if (data.selectionId.type === 'commit' && data.stackId === undefined) return false;
 		return true;
 	}
 
-	async ondrop(data: ChangeDropData) {
+	private acceptsBranchDropData(data: unknown): data is BranchDropData {
+		if (!(data instanceof BranchDropData)) return false;
+		if (data.hasConflicts) return false;
+		if (data.numberOfBranchesInStack <= 1) return false; // Can't tear off the last branch of a stack
+		if (data.numberOfCommits === 0) return false; // TODO: Allow to rip empty branches
+		return true;
+	}
+
+	accepts(data: unknown) {
+		return this.acceptsChangeDropData(data) || this.acceptsBranchDropData(data);
+	}
+
+	async ondropChangeData(data: ChangeDropData) {
 		switch (data.selectionId.type) {
 			case 'branch': {
 				const newBranchName = await this.stackService.fetchNewBranchName(this.projectId);
@@ -112,4 +126,28 @@ export class OutsideLaneDzHandler implements DropzoneHandler {
 			}
 		}
 	}
+
+	async ondropBranchData(data: BranchDropData) {
+		await this.stackService
+			.tearOffBranch({
+				projectId: this.projectId,
+				sourceStackId: data.stackId,
+				subjectBranchName: data.branchName
+			})
+			.then((result) => {
+				handleMoveBranchResult(result);
+			});
+	}
+
+	async ondrop(data: unknown): Promise<void> {
+		if (this.acceptsChangeDropData(data)) {
+			await this.ondropChangeData(data);
+			return;
+		}
+
+		if (this.acceptsBranchDropData(data)) {
+			await this.ondropBranchData(data);
+			return;
+		}
+	}
 }

apps/desktop/src/lib/stacks/stack.ts

@@ -337,4 +337,16 @@ export type InteractiveIntegrationStep =
 
 export type MoveBranchResult = {
 	deletedStacks: string[];
+	unappliedStacks: string[];
 };
+
+export function handleMoveBranchResult(result: MoveBranchResult) {
+	if (result.unappliedStacks.length > 0) {
+		showToast({
+			testId: TestId.StacksUnappliedToast,
+			title: 'Heads up: We had to unapply some stacks to move this branch',
+			message: `It seems that the branch moved couldn't be applied cleanly alongside your other ${result.unappliedStacks.length} ${result.unappliedStacks.length === 1 ? 'stack' : 'stacks'}.
+You can always re-apply them later from the branches page.`
+		});
+	}
+}

apps/desktop/src/lib/stacks/stackService.svelte.ts

@@ -755,6 +755,10 @@ export class StackService {
 		return this.api.endpoints.moveBranch.mutate;
 	}
 
+	get tearOffBranch() {
+		return this.api.endpoints.tearOffBranch.mutate;
+	}
+
 	get integrateUpstreamCommits() {
 		return this.api.endpoints.integrateUpstreamCommits.useMutation();
 	}
@@ -1485,9 +1489,7 @@ function injectEndpoints(api: ClientState['backendApi'], uiState: UiState) {
 				},
 				query: (args) => args,
 				invalidatesTags: (result, _error, args) => {
-					if (result === undefined) return [];
-
-					if (result.deletedStacks.includes(args.sourceStackId)) {
+					if (result?.deletedStacks.includes(args.sourceStackId)) {
 						// The source stack was deleted, so we need to invalidate the list of stacks.
 						return [
 							invalidatesList(ReduxTag.Stacks),
@@ -1503,6 +1505,27 @@ function injectEndpoints(api: ClientState['backendApi'], uiState: UiState) {
 					];
 				}
 			}),
+			tearOffBranch: build.mutation<
+				MoveBranchResult,
+				{
+					projectId: string;
+					sourceStackId: string;
+					subjectBranchName: string;
+				}
+			>({
+				extraOptions: {
+					command: 'tear_off_branch',
+					actionName: 'Tear Off Branch'
+				},
+				query: (args) => args,
+				invalidatesTags: (_result, _error, args) => {
+					return [
+						invalidatesList(ReduxTag.Stacks),
+						invalidatesList(ReduxTag.WorktreeChanges), // Moving commits can cause conflicts
+						invalidatesItem(ReduxTag.StackDetails, args.sourceStackId)
+					];
+				}
+			}),
 			integrateUpstreamCommits: build.mutation<
 				void,
 				{

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

@@ -502,6 +502,20 @@ pub fn move_branch(
     .map_err(Into::into)
 }
 
+#[api_cmd]
+#[tauri::command(async)]
+#[instrument(err(Debug))]
+pub fn tear_off_branch(
+    project_id: ProjectId,
+    source_stack_id: StackId,
+    subject_branch_name: String,
+) -> Result<MoveBranchResult, Error> {
+    let project = gitbutler_project::get(project_id)?;
+    let ctx = CommandContext::open(&project, AppSettings::load_from_default_path_creating()?)?;
+    gitbutler_branch_actions::tear_off_branch(&ctx, source_stack_id, subject_branch_name.as_str())
+        .map_err(Into::into)
+}
+
 #[api_cmd]
 #[tauri::command(async)]
 #[instrument(err(Debug))]