Fixes #4078 deadlock on paused operation detection

- Adds operation priority ordering for proper detection

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 GitLens gets stuck after rebase ([#4078](https://github.com/gitkraken/vscode-gitlens/issues/4078))
+
 ## [16.3.2] - 2025-02-21
 
 ## [16.3.1] - 2025-02-20

src/env/node/git/sub-providers/branches.ts

@@ -17,11 +17,16 @@ import { parseMergeTreeConflict } from '../../../../git/parsers/mergeTreeParser'
 import { getReferenceFromBranch } from '../../../../git/utils/-webview/reference.utils';
 import type { BranchSortOptions } from '../../../../git/utils/-webview/sorting';
 import { sortBranches, sortContributors } from '../../../../git/utils/-webview/sorting';
-import { getLocalBranchByUpstream, isDetachedHead } from '../../../../git/utils/branch.utils';
+import {
+	formatDetachedHeadName,
+	getBranchId,
+	getLocalBranchByUpstream,
+	isDetachedHead,
+} from '../../../../git/utils/branch.utils';
+import { createReference } from '../../../../git/utils/reference.utils';
 import { createRevisionRange } from '../../../../git/utils/revision.utils';
 import { configuration } from '../../../../system/-webview/configuration';
 import { filterMap } from '../../../../system/array';
-import { gate } from '../../../../system/decorators/-webview/gate';
 import { log } from '../../../../system/decorators/log';
 import { Logger } from '../../../../system/logger';
 import { getLogScope } from '../../../../system/logger.scope';
@@ -40,7 +45,6 @@ export class BranchesGitSubProvider implements GitBranchesSubProvider {
 		private readonly provider: LocalGitProvider,
 	) {}
 
-	@gate()
 	@log()
 	async getBranch(repoPath: string, name?: string): Promise<GitBranch | undefined> {
 		if (name != null) {
@@ -67,15 +71,13 @@ export class BranchesGitSubProvider implements GitBranchesSubProvider {
 	}
 
 	private async getCurrentBranch(repoPath: string): Promise<GitBranch | undefined> {
-		const commitOrdering = configuration.get('advanced.commitOrdering');
+		const ref = await this.getCurrentBranchReferenceCore(repoPath);
+		if (ref == null) return undefined;
 
-		const data = await this.git.rev_parse__currentBranch(repoPath, commitOrdering);
-		if (data == null) return undefined;
-
-		const [name, upstream] = data[0].split('\n');
+		const commitOrdering = configuration.get('advanced.commitOrdering');
 
 		const [pausedOpStatusResult, committerDateResult] = await Promise.allSettled([
-			isDetachedHead(name) ? this.provider.status?.getPausedOperationStatus(repoPath) : undefined,
+			isDetachedHead(ref.name) ? this.provider.status?.getPausedOperationStatus(repoPath) : undefined,
 			this.git.log__recent_committerdate(repoPath, commitOrdering),
 		]);
 
@@ -86,12 +88,12 @@ export class BranchesGitSubProvider implements GitBranchesSubProvider {
 		return new GitBranch(
 			this.container,
 			repoPath,
-			rebaseStatus?.incoming.name ?? name,
+			rebaseStatus?.incoming.name ?? ref.name,
 			false,
 			true,
 			committerDate != null ? new Date(Number(committerDate) * 1000) : undefined,
-			data[1],
-			upstream ? { name: upstream, missing: false } : undefined,
+			ref.sha,
+			ref.upstream,
 			undefined,
 			undefined,
 			undefined,
@@ -269,6 +271,40 @@ export class BranchesGitSubProvider implements GitBranchesSubProvider {
 		return filterMap(data.split('\n'), b => b.trim() || undefined);
 	}
 
+	@log()
+	async getCurrentBranchReference(repoPath: string): Promise<GitBranchReference | undefined> {
+		let ref = await this.getCurrentBranchReferenceCore(repoPath);
+		if (ref != null && isDetachedHead(ref.name)) {
+			ref = createReference(ref.sha!, repoPath, {
+				refType: 'branch',
+				name: formatDetachedHeadName(ref.sha!),
+				id: getBranchId(repoPath, ref.remote, ref.sha!),
+				remote: ref.remote,
+				upstream: ref.upstream,
+				sha: ref.sha,
+			});
+		}
+		return ref;
+	}
+
+	private async getCurrentBranchReferenceCore(repoPath: string): Promise<GitBranchReference | undefined> {
+		const commitOrdering = configuration.get('advanced.commitOrdering');
+
+		const data = await this.git.rev_parse__currentBranch(repoPath, commitOrdering);
+		if (data == null) return undefined;
+
+		const [name, upstream] = data[0].split('\n');
+
+		return createReference(name, repoPath, {
+			refType: 'branch',
+			name: name,
+			id: getBranchId(repoPath, false, name),
+			remote: false,
+			upstream: upstream ? { name: upstream, missing: false } : undefined,
+			sha: data[1],
+		});
+	}
+
 	@log({ exit: true })
 	async getDefaultBranchName(repoPath: string | undefined, remote?: string): Promise<string | undefined> {
 		if (repoPath == null) return undefined;

src/env/node/git/sub-providers/status.ts

@@ -21,18 +21,22 @@ import type { GitBranchReference, GitTagReference } from '../../../../git/models
 import { GitStatus } from '../../../../git/models/status';
 import type { GitStatusFile } from '../../../../git/models/statusFile';
 import { parseGitStatus } from '../../../../git/parsers/statusParser';
-import { getReferenceFromBranch } from '../../../../git/utils/-webview/reference.utils';
 import { createReference } from '../../../../git/utils/reference.utils';
 import { configuration } from '../../../../system/-webview/configuration';
 import { splitPath } from '../../../../system/-webview/path';
 import { gate } from '../../../../system/decorators/-webview/gate';
 import { log } from '../../../../system/decorators/log';
 import { Logger } from '../../../../system/logger';
+import { getLogScope, setLogScopeExit } from '../../../../system/logger.scope';
 import { getSettledValue } from '../../../../system/promise';
 import type { Git } from '../git';
 import { GitErrors } from '../git';
 import type { LocalGitProvider } from '../localGitProvider';
 
+type Operation = 'cherry-pick' | 'merge' | 'rebase-apply' | 'rebase-merge' | 'revert';
+
+const orderedOperations: Operation[] = ['rebase-apply', 'rebase-merge', 'merge', 'cherry-pick', 'revert'];
+
 export class StatusGitSubProvider implements GitStatusSubProvider {
 	constructor(
 		private readonly container: Container,
@@ -44,21 +48,23 @@ export class StatusGitSubProvider implements GitStatusSubProvider {
 	@gate()
 	@log()
 	async getPausedOperationStatus(repoPath: string): Promise<GitPausedOperationStatus | undefined> {
+		const scope = getLogScope();
+
 		let status = this.cache.pausedOperationStatus?.get(repoPath);
 		if (status == null) {
 			async function getCore(this: StatusGitSubProvider): Promise<GitPausedOperationStatus | undefined> {
 				const gitDir = await this.provider.getGitDir(repoPath);
 
-				type Operation = 'cherry-pick' | 'merge' | 'rebase-apply' | 'rebase-merge' | 'revert';
-				const operation = await new Promise<Operation | undefined>((resolve, _) => {
+				const operations = await new Promise<Set<Operation>>((resolve, _) => {
 					readdir(gitDir.uri.fsPath, { withFileTypes: true }, (err, entries) => {
+						const operations = new Set<Operation>();
 						if (err != null) {
-							resolve(undefined);
+							resolve(operations);
 							return;
 						}
 
 						if (entries.length === 0) {
-							resolve(undefined);
+							resolve(operations);
 							return;
 						}
 
@@ -67,33 +73,39 @@ export class StatusGitSubProvider implements GitStatusSubProvider {
 							if (entry.isFile()) {
 								switch (entry.name) {
 									case 'CHERRY_PICK_HEAD':
-										resolve('cherry-pick');
-										return;
+										operations.add('cherry-pick');
+										break;
 									case 'MERGE_HEAD':
-										resolve('merge');
-										return;
+										operations.add('merge');
+										break;
 									case 'REVERT_HEAD':
-										resolve('revert');
-										return;
+										operations.add('revert');
+										break;
 								}
 							} else if (entry.isDirectory()) {
 								switch (entry.name) {
 									case 'rebase-apply':
-										resolve('rebase-apply');
-										return;
+										operations.add('rebase-apply');
+										break;
 									case 'rebase-merge':
-										resolve('rebase-merge');
-										return;
+										operations.add('rebase-merge');
+										break;
 								}
 							}
 						}
 
-						resolve(undefined);
+						resolve(operations);
 					});
 				});
 
-				if (operation == null) return undefined;
+				if (!operations.size) return undefined;
+
+				const sortedOperations = [...operations].sort(
+					(a, b) => orderedOperations.indexOf(a) - orderedOperations.indexOf(b),
+				);
+				Logger.log(`Detected paused operations: ${sortedOperations.join(', ')}`);
 
+				const operation = sortedOperations[0];
 				switch (operation) {
 					case 'cherry-pick': {
 						const cherryPickHead = (
@@ -105,16 +117,19 @@ export class StatusGitSubProvider implements GitStatusSubProvider {
 								'CHERRY_PICK_HEAD',
 							)
 						)?.trim();
-						if (!cherryPickHead) return undefined;
+						if (!cherryPickHead) {
+							setLogScopeExit(scope, 'No CHERRY_PICK_HEAD found');
+							return undefined;
+						}
 
-						const branch = (await this.provider.branches.getBranch(repoPath))!;
+						const current = (await this.provider.branches.getCurrentBranchReference(repoPath))!;
 
 						return {
 							type: 'cherry-pick',
 							repoPath: repoPath,
 							// TODO: Validate that these are correct
 							HEAD: createReference(cherryPickHead, repoPath, { refType: 'revision' }),
-							current: getReferenceFromBranch(branch),
+							current: current,
 							incoming: createReference(cherryPickHead, repoPath, { refType: 'revision' }),
 						} satisfies GitCherryPickStatus;
 					}
@@ -128,18 +143,21 @@ export class StatusGitSubProvider implements GitStatusSubProvider {
 								'MERGE_HEAD',
 							)
 						)?.trim();
-						if (!mergeHead) return undefined;
+						if (!mergeHead) {
+							setLogScopeExit(scope, 'No MERGE_HEAD found');
+							return undefined;
+						}
 
 						const [branchResult, mergeBaseResult, possibleSourceBranchesResult] = await Promise.allSettled([
-							this.provider.branches.getBranch(repoPath),
+							this.provider.branches.getCurrentBranchReference(repoPath),
 							this.provider.branches.getMergeBase(repoPath, 'MERGE_HEAD', 'HEAD'),
 							this.provider.branches.getBranchesWithCommits(repoPath, ['MERGE_HEAD'], undefined, {
 								all: true,
 								mode: 'pointsAt',
 							}),
 						]);
 
-						const branch = getSettledValue(branchResult)!;
+						const current = getSettledValue(branchResult)!;
 						const mergeBase = getSettledValue(mergeBaseResult);
 						const possibleSourceBranches = getSettledValue(possibleSourceBranchesResult);
 
@@ -148,7 +166,7 @@ export class StatusGitSubProvider implements GitStatusSubProvider {
 							repoPath: repoPath,
 							mergeBase: mergeBase,
 							HEAD: createReference(mergeHead, repoPath, { refType: 'revision' }),
-							current: getReferenceFromBranch(branch),
+							current: current,
 							incoming:
 								possibleSourceBranches?.length === 1
 									? createReference(possibleSourceBranches[0], repoPath, {
@@ -169,22 +187,28 @@ export class StatusGitSubProvider implements GitStatusSubProvider {
 								'REVERT_HEAD',
 							)
 						)?.trim();
-						if (!revertHead) return undefined;
+						if (!revertHead) {
+							setLogScopeExit(scope, 'No REVERT_HEAD found');
+							return undefined;
+						}
 
-						const branch = (await this.provider.branches.getBranch(repoPath))!;
+						const current = (await this.provider.branches.getCurrentBranchReference(repoPath))!;
 
 						return {
 							type: 'revert',
 							repoPath: repoPath,
 							HEAD: createReference(revertHead, repoPath, { refType: 'revision' }),
-							current: getReferenceFromBranch(branch),
+							current: current,
 							incoming: createReference(revertHead, repoPath, { refType: 'revision' }),
 						} satisfies GitRevertStatus;
 					}
 					case 'rebase-apply':
 					case 'rebase-merge': {
 						let branch = await this.git.readDotGitFile(gitDir, [operation, 'head-name']);
-						if (!branch) return undefined;
+						if (!branch) {
+							setLogScopeExit(scope, `No '${operation}/head-name' found`);
+							return undefined;
+						}
 
 						const [
 							rebaseHeadResult,
@@ -212,7 +236,10 @@ export class StatusGitSubProvider implements GitStatusSubProvider {
 
 						const origHead = getSettledValue(origHeadResult);
 						const onto = getSettledValue(ontoResult);
-						if (origHead == null || onto == null) return undefined;
+						if (origHead == null || onto == null) {
+							setLogScopeExit(scope, `Neither '${operation}/orig-head' nor '${operation}/onto' found`);
+							return undefined;
+						}
 
 						const rebaseHead = getSettledValue(rebaseHeadResult)?.trim();
 

src/git/gitProvider.ts

@@ -321,6 +321,8 @@ export interface GitBranchesSubProvider {
 		branch: GitBranchReference,
 		into: GitBranchReference,
 	): Promise<GitBranchMergedStatus>;
+	/** @internal not intended to be used outside of the sub-providers */
+	getCurrentBranchReference?(repoPath: string): Promise<GitBranchReference | undefined>;
 	getLocalBranchByUpstream?(repoPath: string, remoteBranchName: string): Promise<GitBranch | undefined>;
 	getPotentialMergeOrRebaseConflict?(
 		repoPath: string,

src/git/utils/-webview/reference.utils.ts

@@ -11,6 +11,7 @@ export function getReferenceFromBranch(branch: GitBranch): GitBranchReference {
 		name: branch.name,
 		remote: branch.remote,
 		upstream: branch.upstream,
+		sha: branch.sha,
 	});
 }
 
@@ -39,5 +40,6 @@ export function getReferenceFromTag(tag: GitTag): GitTagReference {
 		id: tag.id,
 		refType: tag.refType,
 		name: tag.name,
+		sha: tag.sha,
 	});
 }