Fixes #3514 avoids trying to delete main worktree branch

Also avoids attempting to delete the main worktree

Author: eamodio

CHANGELOG.md

@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 ## [Unreleased]
 
+### Fixed
+
+- Fixes [#3514](https://github.com/gitkraken/vscode-gitlens/issues/3514) - Attempting to delete the main worktree's branch causes a invalid prompt to delete the main worktree
+
 ## [15.4.0] - 2024-09-04
 
 ### Added

package.json

@@ -13968,12 +13968,12 @@
 				},
 				{
 					"command": "gitlens.views.switchToAnotherBranch",
-					"when": "!gitlens:readonly && !gitlens:untrusted && !gitlens:hasVirtualFolders && viewItem =~ /gitlens:branch\\b(?=.*?\\b\\+current\\b)(?!.*?\\b\\+closed\\b)/",
+					"when": "!gitlens:readonly && !gitlens:untrusted && !gitlens:hasVirtualFolders && viewItem =~ /gitlens:branch\\b(?=.*?\\b\\+(current|main)\\b)(?!.*?\\b\\+closed\\b)/",
 					"group": "inline@7"
 				},
 				{
 					"command": "gitlens.views.switchToBranch",
-					"when": "!gitlens:readonly && !gitlens:untrusted && !gitlens:hasVirtualFolders && viewItem =~ /gitlens:branch\\b(?!.*?\\b\\+(current|closed|worktree)\\b)/",
+					"when": "!gitlens:readonly && !gitlens:untrusted && !gitlens:hasVirtualFolders && viewItem =~ /gitlens:branch\\b(?!.*?\\b\\+(current|closed|main|worktree)\\b)/",
 					"group": "inline@7"
 				},
 				{
@@ -14064,17 +14064,17 @@
 				},
 				{
 					"command": "gitlens.views.openInWorktree",
-					"when": "!listMultiSelection && !gitlens:hasVirtualFolders && viewItem =~ /gitlens:branch\\b(?!.*?\\b\\+(current|closed|worktree)\\b)/",
+					"when": "!listMultiSelection && !gitlens:hasVirtualFolders && viewItem =~ /gitlens:branch\\b(?!.*?\\b\\+(current|closed|main|worktree)\\b)/",
 					"group": "1_gitlens_action@3"
 				},
 				{
 					"command": "gitlens.views.switchToAnotherBranch",
-					"when": "!listMultiSelection && !gitlens:readonly && !gitlens:untrusted && !gitlens:hasVirtualFolders && viewItem =~ /gitlens:branch\\b(?=.*?\\b\\+current\\b)(?!.*?\\b\\+closed\\b)/",
+					"when": "!listMultiSelection && !gitlens:readonly && !gitlens:untrusted && !gitlens:hasVirtualFolders && viewItem =~ /gitlens:branch\\b(?=.*?\\b\\+(current|main)\\b)(?!.*?\\b\\+closed\\b)/",
 					"group": "1_gitlens_action@1"
 				},
 				{
 					"command": "gitlens.views.switchToBranch",
-					"when": "!listMultiSelection && !gitlens:readonly && !gitlens:untrusted && !gitlens:hasVirtualFolders && viewItem =~ /gitlens:branch\\b(?!.*?\\b\\+(current|closed|worktree)\\b)/",
+					"when": "!listMultiSelection && !gitlens:readonly && !gitlens:untrusted && !gitlens:hasVirtualFolders && viewItem =~ /gitlens:branch\\b(?!.*?\\b\\+(current|closed|main|worktree)\\b)/",
 					"group": "1_gitlens_action@1"
 				},
 				{
@@ -14119,12 +14119,12 @@
 				},
 				{
 					"command": "gitlens.views.deleteBranch",
-					"when": "!listMultiSelection && !gitlens:readonly && !gitlens:untrusted && !gitlens:hasVirtualFolders && viewItem =~ /gitlens:branch\\b(?!.*?\\b\\+current\\b)(?!.*?\\b\\+closed\\b)/",
+					"when": "!listMultiSelection && !gitlens:readonly && !gitlens:untrusted && !gitlens:hasVirtualFolders && viewItem =~ /gitlens:branch\\b(?!.*?\\b\\+(current|main)\\b)(?!.*?\\b\\+closed\\b)/",
 					"group": "1_gitlens_actions@7"
 				},
 				{
 					"command": "gitlens.views.deleteBranch.multi",
-					"when": "listMultiSelection && !gitlens:readonly && !gitlens:untrusted && !gitlens:hasVirtualFolders && viewItem =~ /gitlens:branch\\b(?!.*?\\b\\+current\\b)(?!.*?\\b\\+closed\\b)/",
+					"when": "listMultiSelection && !gitlens:readonly && !gitlens:untrusted && !gitlens:hasVirtualFolders && viewItem =~ /gitlens:branch\\b(?!.*?\\b\\+(current|main)\\b)(?!.*?\\b\\+closed\\b)/",
 					"group": "1_gitlens_actions@7"
 				},
 				{
@@ -15585,17 +15585,17 @@
 				},
 				{
 					"command": "gitlens.graph.openInWorktree",
-					"when": "!gitlens:hasVirtualFolders && webviewItem =~ /gitlens:branch\\b(?!.*?\\b\\+(current|worktree)\\b)/",
+					"when": "!gitlens:hasVirtualFolders && webviewItem =~ /gitlens:branch\\b(?!.*?\\b\\+(current|main|worktree)\\b)/",
 					"group": "1_gitlens_action@3"
 				},
 				{
 					"command": "gitlens.graph.switchToAnotherBranch",
-					"when": "!gitlens:readonly && !gitlens:untrusted && !gitlens:hasVirtualFolders && webviewItem =~ /gitlens:branch\\b(?=.*?\\b\\+current\\b)/",
+					"when": "!gitlens:readonly && !gitlens:untrusted && !gitlens:hasVirtualFolders && webviewItem =~ /gitlens:branch\\b(?=.*?\\b\\+(current|main)\\b)/",
 					"group": "1_gitlens_action@1"
 				},
 				{
 					"command": "gitlens.graph.switchToBranch",
-					"when": "!gitlens:readonly && !gitlens:untrusted && !gitlens:hasVirtualFolders && webviewItem =~ /gitlens:branch\\b(?!.*?\\b\\+(current|worktree)\\b)/",
+					"when": "!gitlens:readonly && !gitlens:untrusted && !gitlens:hasVirtualFolders && webviewItem =~ /gitlens:branch\\b(?!.*?\\b\\+(current|main|worktree)\\b)/",
 					"group": "1_gitlens_action@1"
 				},
 				{
@@ -15640,7 +15640,7 @@
 				},
 				{
 					"command": "gitlens.graph.deleteBranch",
-					"when": "!gitlens:readonly && !gitlens:untrusted && !gitlens:hasVirtualFolders && webviewItem =~ /gitlens:branch\\b(?!.*?\\b\\+current\\b)/",
+					"when": "!gitlens:readonly && !gitlens:untrusted && !gitlens:hasVirtualFolders && webviewItem =~ /gitlens:branch\\b(?!.*?\\b\\+(current|main)\\b)/",
 					"group": "1_gitlens_actions@7"
 				},
 				{

src/commands/git/branch.ts

@@ -4,10 +4,12 @@ import type { GitBranchReference, GitReference } from '../../git/models/referenc
 import { getNameWithoutRemote, getReferenceLabel, isRevisionReference } from '../../git/models/reference';
 import { Repository } from '../../git/models/repository';
 import type { GitWorktree } from '../../git/models/worktree';
+import { getWorktreesByBranch } from '../../git/models/worktree';
 import type { QuickPickItemOfT } from '../../quickpicks/items/common';
 import { createQuickPickSeparator } from '../../quickpicks/items/common';
 import type { FlagsQuickPickItem } from '../../quickpicks/items/flags';
 import { createFlagsQuickPickItem } from '../../quickpicks/items/flags';
+import { ensureArray } from '../../system/array';
 import { pluralize } from '../../system/string';
 import type { ViewsWithRepositoryFolders } from '../../views/viewBase';
 import { getSteps } from '../gitCommands.utils';
@@ -437,6 +439,8 @@ export class BranchGitCommand extends QuickCommand {
 				state.references = [state.references];
 			}
 
+			const worktreesByBranch = await getWorktreesByBranch(state.repo, { includeMainWorktree: true });
+
 			if (
 				state.counter < 3 ||
 				state.references == null ||
@@ -445,7 +449,9 @@ export class BranchGitCommand extends QuickCommand {
 				context.title = getTitle('Branches', state.subcommand);
 
 				const result = yield* pickBranchesStep(state, context, {
-					filter: prune ? b => !b.current && Boolean(b.upstream?.missing) : b => !b.current,
+					filter: prune
+						? b => !b.current && Boolean(b.upstream?.missing) && !worktreesByBranch.get(b.id)?.main
+						: b => !b.current && !worktreesByBranch.get(b.id)?.main,
 					picked: state.references?.map(r => r.ref),
 					placeholder: prune
 						? 'Choose branches with missing upstreams to delete'
@@ -468,7 +474,7 @@ export class BranchGitCommand extends QuickCommand {
 
 			assertStateStepDeleteBranches(state);
 
-			const worktrees = await this.getWorktreesOfSelectedBranches(state);
+			const worktrees = this.getSelectedWorktrees(state, worktreesByBranch);
 			if (worktrees.length) {
 				const result = yield* getSteps(
 					this.container,
@@ -503,18 +509,20 @@ export class BranchGitCommand extends QuickCommand {
 		}
 	}
 
-	private async getWorktreesOfSelectedBranches(state: DeleteStepState | PruneStepState): Promise<GitWorktree[]> {
-		const worktrees = await state.repo.getWorktrees();
-
-		const refs = new Set<string>(
-			Array.isArray(state.references)
-				? state.references.map(r => r.name)
-				: state.references != null
-				  ? [state.references.name]
-				  : undefined,
-		);
+	private getSelectedWorktrees(
+		state: DeleteStepState | PruneStepState,
+		worktreesByBranch: Map<string, GitWorktree>,
+	): GitWorktree[] {
+		const worktrees: GitWorktree[] = [];
+
+		for (const ref of ensureArray(state.references)) {
+			const worktree = worktreesByBranch.get(ref.id!);
+			if (worktree != null && !worktree.main) {
+				worktrees.push(worktree);
+			}
+		}
 
-		return worktrees.filter(wt => wt.branch && refs.has(wt.branch.name));
+		return worktrees;
 	}
 
 	private *deleteCommandConfirmStep(

src/commands/openOnRemote.ts

@@ -9,7 +9,7 @@ import { RemoteResourceType } from '../git/models/remoteResource';
 import type { RemoteProvider } from '../git/remotes/remoteProvider';
 import { showGenericErrorMessage } from '../messages';
 import { showRemoteProviderPicker } from '../quickpicks/remoteProviderPicker';
-import { ensure } from '../system/array';
+import { ensureArray } from '../system/array';
 import { command } from '../system/command';
 import { Logger } from '../system/logger';
 import { pad, splitSingle } from '../system/string';
@@ -88,7 +88,7 @@ export class OpenOnRemoteCommand extends Command {
 		}
 
 		try {
-			const resources = ensure(args.resource)!;
+			const resources = ensureArray(args.resource);
 			for (const resource of resources) {
 				await processResource.call(this, resource);
 			}

src/env/node/git/localGitProvider.ts

@@ -2326,7 +2326,7 @@ export class LocalGitProvider implements GitProvider, Disposable {
 				this.getBranches(repoPath),
 				this.getRemotes(repoPath),
 				this.getCurrentUser(repoPath),
-				getWorktreesByBranch(this.container.git.getRepository(repoPath)),
+				getWorktreesByBranch(this.container.git.getRepository(repoPath), { includeMainWorktree: true }),
 			]);
 
 		const branches = getSettledValue(branchesResult)?.values;
@@ -2335,6 +2335,14 @@ export class LocalGitProvider implements GitProvider, Disposable {
 		const headRefUpstreamName = headBranch?.upstream?.name;
 		const worktreesByBranch = getSettledValue(worktreesByBranchResult);
 
+		let branchIdOfMainWorktree: string | undefined;
+		if (worktreesByBranch != null) {
+			branchIdOfMainWorktree = find(worktreesByBranch, ([, wt]) => wt.main)?.[0];
+			if (branchIdOfMainWorktree != null) {
+				worktreesByBranch.delete(branchIdOfMainWorktree);
+			}
+		}
+
 		const currentUser = getSettledValue(currentUserResult);
 
 		const remotes = getSettledValue(remotesResult);
@@ -2607,7 +2615,13 @@ export class LocalGitProvider implements GitProvider, Disposable {
 						context = {
 							webviewItem: `gitlens:branch${head ? '+current' : ''}${
 								branch?.upstream != null ? '+tracking' : ''
-							}${worktreesByBranch?.has(branchId) ? '+worktree' : ''}`,
+							}${
+								worktreesByBranch?.has(branchId)
+									? '+worktree'
+									: branchIdOfMainWorktree === branchId
+									  ? '+main'
+									  : ''
+							}`,
 							webviewItemValue: {
 								type: 'branch',
 								ref: createReference(tip, repoPath, {

src/git/models/worktree.ts

@@ -337,14 +337,17 @@ export function sortWorktrees(worktrees: GitWorktree[] | WorktreeQuickPickItem[]
 	}
 }
 
-export async function getWorktreesByBranch(repos: Repository | Repository[] | undefined) {
+export async function getWorktreesByBranch(
+	repos: Repository | Repository[] | undefined,
+	options?: { includeMainWorktree?: boolean },
+) {
 	const worktreesByBranch = new Map<string, GitWorktree>();
 	if (repos == null) return worktreesByBranch;
 
 	async function addWorktrees(repo: Repository) {
 		const worktrees = await repo.getWorktrees();
 		for (const wt of worktrees) {
-			if (wt.branch == null || wt.main) continue;
+			if (wt.branch == null || (!options?.includeMainWorktree && wt.main)) continue;
 
 			worktreesByBranch.set(wt.branch.id, wt);
 		}

src/system/array.ts

@@ -28,7 +28,9 @@ export function countUniques<T>(source: T[], accessor: (item: T) => string): Rec
 	return uniqueCounts;
 }
 
-export function ensure<T>(source: T | T[] | undefined): T[] | undefined {
+export function ensureArray<T>(source: T | T[]): T[];
+export function ensureArray<T>(source: T | T[] | undefined): T[] | undefined;
+export function ensureArray<T>(source: T | T[] | undefined): T[] | undefined {
 	return source == null ? undefined : Array.isArray(source) ? source : [source];
 }
 

src/views/branchesView.ts

@@ -68,7 +68,7 @@ export class BranchesViewNode extends RepositoriesSubscribeableNode<BranchesView
 			this.view.message = undefined;
 
 			// Get all the worktree branches (and track if they are opened) to pass along downstream, e.g. in the BranchNode to display an indicator
-			const worktreesByBranch = await getWorktreesByBranch(repositories);
+			const worktreesByBranch = await getWorktreesByBranch(repositories, { includeMainWorktree: true });
 			this.updateContext({
 				worktreesByBranch: worktreesByBranch?.size ? worktreesByBranch : undefined,
 			});

src/views/nodes/branchNode.ts

@@ -136,7 +136,8 @@ export class BranchNode
 	}
 
 	get worktree(): GitWorktree | undefined {
-		return this.context.worktreesByBranch?.get(this.branch.id);
+		const worktree = this.context.worktreesByBranch?.get(this.branch.id);
+		return worktree?.main ? undefined : worktree;
 	}
 
 	private _children: ViewNode[] | undefined;
@@ -449,6 +450,8 @@ export class BranchNode
 		}
 		if (worktree != null) {
 			contextValue += '+worktree';
+		} else if (this.context.worktreesByBranch?.get(this.branch.id)?.main) {
+			contextValue += '+main';
 		}
 		// TODO@axosoft-ramint Temporary workaround, remove when our git commands work on closed repos.
 		if (this.repo.closed) {