Fixes issues with worktree delete

Author: eamodio

CHANGELOG.md

@@ -13,6 +13,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 - Fixes [#3657](https://github.com/gitkraken/vscode-gitlens/issues/3657) - Creating a worktree from within a worktree chooses the wrong path
 - Fixes [#3090](https://github.com/gitkraken/vscode-gitlens/issues/3090) - Manually created empty bare clone repositories in a trusted directory crash worktree view since LocalGitProvider.findRepositoryUri returns just ".git" — thanks to [PR #3092](https://github.com/gitkraken/vscode-gitlens/pull/3092) by Dawn Hwang ([@hwangh95](https://github.com/hwangh95))
 - Fixes [#3667](https://github.com/gitkraken/vscode-gitlens/issues/3667) - Makes Launchpad search by repo name
+- Fixes failure to prompt to delete the branch after deleting a worktree when a modal was shown (e.g. when prompting for force)
+- Fixes issues when git fails to delete the worktree folder on Windows
 
 ## [15.6.0] - 2024-10-07
 

src/commands/git/worktree.ts

@@ -5,6 +5,7 @@ import { proBadge, proBadgeSuperscript } from '../../constants';
 import type { Container } from '../../container';
 import { CancellationError } from '../../errors';
 import { PlusFeatures } from '../../features';
+import { executeGitCommand } from '../../git/actions';
 import { convertLocationToOpenFlags, convertOpenFlagsToLocation, reveal } from '../../git/actions/worktree';
 import {
 	ApplyPatchCommitError,
@@ -15,7 +16,7 @@ import {
 	WorktreeDeleteErrorReason,
 } from '../../git/errors';
 import { uncommitted, uncommittedStaged } from '../../git/models/constants';
-import type { GitReference } from '../../git/models/reference';
+import type { GitBranchReference, GitReference } from '../../git/models/reference';
 import {
 	getNameWithoutRemote,
 	getReferenceFromBranch,
@@ -69,7 +70,6 @@ import {
 	pickWorktreesStep,
 	pickWorktreeStep,
 } from '../quickCommand.steps';
-import { getSteps } from '../quickWizard.utils';
 
 interface Context {
 	repos: Repository[];
@@ -864,20 +864,20 @@ export class WorktreeGitCommand extends QuickCommand<State> {
 
 			state.flags = result;
 
-			endSteps(state);
-
-			const branchesToDelete = [];
+			const branchesToDelete: GitBranchReference[] = [];
 
 			for (const uri of state.uris) {
-				let retry = false;
 				let skipHasChangesPrompt = false;
-				do {
-					retry = false;
-					const force = state.flags.includes('--force');
-					const deleteBranches = state.flags.includes('--delete-branches');
+				let succeeded = false;
+
+				const deleteBranches = state.flags.includes('--delete-branches');
+				let force = state.flags.includes('--force');
+				const worktree = context.worktrees.find(wt => wt.uri.toString() === uri.toString());
+
+				while (true) {
+					succeeded = false;
 
 					try {
-						const worktree = context.worktrees.find(wt => wt.uri.toString() === uri.toString());
 						if (force) {
 							let status;
 							try {
@@ -899,16 +899,35 @@ export class WorktreeGitCommand extends QuickCommand<State> {
 						}
 
 						await state.repo.git.deleteWorktree(uri, { force: force });
-						if (deleteBranches && worktree?.branch) {
-							branchesToDelete.push(getReferenceFromBranch(worktree?.branch));
-						}
+						succeeded = true;
 					} catch (ex) {
 						skipHasChangesPrompt = false;
 
 						if (WorktreeDeleteError.is(ex)) {
-							if (ex.reason === WorktreeDeleteErrorReason.MainWorkingTree) {
-								void window.showErrorMessage('Unable to delete the main worktree');
-							} else if (!force) {
+							if (ex.reason === WorktreeDeleteErrorReason.DefaultWorkingTree) {
+								void window.showErrorMessage('Cannot delete the default worktree.');
+								break;
+							}
+
+							if (ex.reason === WorktreeDeleteErrorReason.DirectoryNotEmpty) {
+								const openFolder: MessageItem = { title: 'Open Folder' };
+								const confirm: MessageItem = { title: 'OK', isCloseAffordance: true };
+								const result = await window.showErrorMessage(
+									`Unable to fully clean up the delete worktree in '${uri.fsPath}' because the folder is not empty.`,
+									{ modal: true },
+									openFolder,
+									confirm,
+								);
+
+								if (result === openFolder) {
+									void revealInFileExplorer(uri);
+								}
+
+								succeeded = true;
+								break;
+							}
+
+							if (!force) {
 								const confirm: MessageItem = { title: 'Force Delete' };
 								const cancel: MessageItem = { title: 'Cancel', isCloseAffordance: true };
 								const result = await window.showErrorMessage(
@@ -921,31 +940,39 @@ export class WorktreeGitCommand extends QuickCommand<State> {
 								);
 
 								if (result === confirm) {
-									state.flags.push('--force');
-									retry = true;
+									force = true;
 									skipHasChangesPrompt = ex.reason === WorktreeDeleteErrorReason.HasChanges;
+									continue;
 								}
+
+								break;
 							}
-						} else {
-							void showGenericErrorMessage(`Unable to delete worktree in '${uri.fsPath}.`);
 						}
+
+						void showGenericErrorMessage(`Unable to delete worktree in '${uri.fsPath}. ex=${String(ex)}`);
 					}
-				} while (retry);
+
+					break;
+				}
+
+				if (succeeded && deleteBranches && worktree?.branch) {
+					branchesToDelete.push(getReferenceFromBranch(worktree?.branch));
+				}
 			}
 
+			endSteps(state);
+
 			if (branchesToDelete.length) {
-				yield* getSteps(
-					this.container,
-					{
-						command: 'branch',
-						state: {
-							subcommand: 'delete',
-							repo: state.repo,
-							references: branchesToDelete,
-						},
+				// Don't use `getSteps` here because this is a whole new flow, a
+				// and because of the modals above it won't even work (since the modals will trigger the quick pick to hide)
+				void executeGitCommand({
+					command: 'branch',
+					state: {
+						subcommand: 'delete',
+						repo: state.repo,
+						references: branchesToDelete,
 					},
-					this.pickedVia,
-				);
+				});
 			}
 		}
 	}

src/env/node/git/git.ts

@@ -77,6 +77,7 @@ export const GitErrors = {
 	changesWouldBeOverwritten: /Your local changes to the following files would be overwritten/i,
 	commitChangesFirst: /Please, commit your changes before you can/i,
 	conflict: /^CONFLICT \([^)]+\): \b/m,
+	failedToDeleteDirectoryNotEmpty: /failed to delete '(.*?)': Directory not empty/i,
 	invalidObjectName: /invalid object name: (.*)\s/i,
 	invalidObjectNameList: /could not open object name list: (.*)\s/i,
 	noFastForward: /\(non-fast-forward\)/i,

src/env/node/git/localGitProvider.ts

@@ -1,3 +1,4 @@
+import { exec } from 'child_process';
 import { promises as fs, readdir, realpath } from 'fs';
 import { homedir, hostname, tmpdir, userInfo } from 'os';
 import path, { resolve as resolvePath } from 'path';
@@ -6081,27 +6082,78 @@ export class LocalGitProvider implements GitProvider, Disposable {
 			' Please install a more recent version of Git and try again.',
 		);
 
+		path = normalizePath(typeof path === 'string' ? path : path.fsPath);
 		try {
-			await this.git.worktree__remove(
-				repoPath,
-				normalizePath(typeof path === 'string' ? path : path.fsPath),
-				options,
-			);
-			this.container.events.fire('git:cache:reset', { repoPath: repoPath, caches: ['worktrees'] });
+			await this.git.worktree__remove(repoPath, path, options);
 		} catch (ex) {
 			Logger.error(ex, scope);
 
 			const msg = String(ex);
 
 			if (GitErrors.mainWorkingTree.test(msg)) {
-				throw new WorktreeDeleteError(WorktreeDeleteErrorReason.MainWorkingTree, ex);
+				throw new WorktreeDeleteError(WorktreeDeleteErrorReason.DefaultWorkingTree, ex);
 			}
 
 			if (GitErrors.uncommittedChanges.test(msg)) {
 				throw new WorktreeDeleteError(WorktreeDeleteErrorReason.HasChanges, ex);
 			}
 
+			if (GitErrors.failedToDeleteDirectoryNotEmpty.test(msg)) {
+				Logger.warn(
+					scope,
+					`Failed to fully delete worktree '${path}' because it is not empty. Attempting to delete it manually.`,
+					scope,
+				);
+				try {
+					await fs.rm(path, { force: true, recursive: true });
+					return;
+				} catch (ex) {
+					if (isWindows) {
+						const match = /EPERM: operation not permitted, unlink '(.*?)'/i.exec(ex.message);
+						if (match != null) {
+							Logger.warn(
+								scope,
+								`Failed to manually delete '${path}' because it is in use. Attempting to forcefully delete it.`,
+								scope,
+							);
+
+							function deleteInUseSymlink(symlink: string) {
+								return new Promise((resolve, reject) => {
+									exec(`del "${symlink}"`, (ex, stdout, stderr) => {
+										if (ex) {
+											reject(ex instanceof Error ? ex : new Error(ex));
+										} else if (stderr) {
+											reject(new Error(stderr));
+										} else {
+											resolve(stdout);
+										}
+									});
+								});
+							}
+
+							const [, file] = match;
+							try {
+								await deleteInUseSymlink(file);
+								await fs.rm(path, { force: true, recursive: true, maxRetries: 1, retryDelay: 1 });
+								return;
+							} catch (ex) {
+								Logger.error(
+									ex,
+									scope,
+									`Failed to forcefully delete '${path}' because it is in use.`,
+									scope,
+								);
+							}
+						}
+					}
+
+					throw new WorktreeDeleteError(WorktreeDeleteErrorReason.DirectoryNotEmpty, ex);
+				}
+			}
+
 			throw new WorktreeDeleteError(undefined, ex);
+		} finally {
+			this.container.events.fire('git:cache:reset', { repoPath: repoPath, caches: ['worktrees'] });
 		}
 	}
 

src/git/errors.ts

@@ -449,7 +449,8 @@ export class WorktreeCreateError extends Error {
 
 export const enum WorktreeDeleteErrorReason {
 	HasChanges,
-	MainWorkingTree,
+	DefaultWorkingTree,
+	DirectoryNotEmpty,
 }
 
 export class WorktreeDeleteError extends Error {
@@ -476,8 +477,8 @@ export class WorktreeDeleteError extends Error {
 				case WorktreeDeleteErrorReason.HasChanges:
 					message = 'Unable to delete worktree because there are uncommitted changes';
 					break;
-				case WorktreeDeleteErrorReason.MainWorkingTree:
-					message = 'Unable to delete worktree because it is a main working tree';
+				case WorktreeDeleteErrorReason.DefaultWorkingTree:
+					message = 'Cannot delete worktree because it is the default working tree';
 					break;
 			}
 		}