Show commit count as decoration on Commits tree node (#7959)

* Initial plan

* Add commit count decoration to Commits tree node

Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>

* Use file decoration instead of description for commit count

Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>

* Address review feedback: add owner/repo, use scheme constant, listen for timeline changes

Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>

* Remove commit count from URI, fetch from PR model instead

Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>

* Clean up

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>

Author: Copilot

src/common/uri.ts

@@ -520,6 +520,36 @@ export function createPRNodeUri(
 	});
 }
 
+export interface CommitsNodeUriParams {
+	owner: string;
+	repo: string;
+	prNumber: number;
+}
+
+export function createCommitsNodeUri(owner: string, repo: string, prNumber: number): vscode.Uri {
+	const params: CommitsNodeUriParams = {
+		owner,
+		repo,
+		prNumber
+	};
+
+	return vscode.Uri.parse(`${Schemes.CommitsNode}:${owner}/${repo}/${prNumber}`).with({
+		scheme: Schemes.CommitsNode,
+		query: JSON.stringify(params)
+	});
+}
+
+export function fromCommitsNodeUri(uri: vscode.Uri): CommitsNodeUriParams | undefined {
+	if (uri.scheme !== Schemes.CommitsNode) {
+		return undefined;
+	}
+	try {
+		return JSON.parse(uri.query) as CommitsNodeUriParams;
+	} catch (e) {
+		return undefined;
+	}
+}
+
 export interface NotificationUriParams {
 	key: string;
 }
@@ -750,7 +780,8 @@ export enum Schemes {
 	Repo = 'repo', // New issue file for passing data
 	Git = 'git', // File content from the git extension
 	PRQuery = 'prquery', // PR query tree item
-	GitHubCommit = 'githubcommit' // file content from GitHub for a commit
+	GitHubCommit = 'githubcommit', // file content from GitHub for a commit
+	CommitsNode = 'commitsnode' // Commits tree node, for decorations
 }
 
 export function resolvePath(from: vscode.Uri, to: string) {

src/extension.ts

@@ -41,6 +41,7 @@ import { NotificationsProvider } from './notifications/notificationsProvider';
 import { ThemeWatcher } from './themeWatcher';
 import { resumePendingCheckout, UriHandler } from './uriHandler';
 import { CommentDecorationProvider } from './view/commentDecorationProvider';
+import { CommitsDecorationProvider } from './view/commitsDecorationProvider';
 import { CompareChanges } from './view/compareChangesTreeDataProvider';
 import { CreatePullRequestHelper } from './view/createPullRequestHelper';
 import { EmojiCompletionProvider } from './view/emojiCompletionProvider';
@@ -171,7 +172,7 @@ async function init(
 	);
 	const treeDecorationProviders = new TreeDecorationProviders(reposManager);
 	context.subscriptions.push(treeDecorationProviders);
-	treeDecorationProviders.registerProviders([new FileTypeDecorationProvider(), new CommentDecorationProvider(reposManager)]);
+	treeDecorationProviders.registerProviders([new FileTypeDecorationProvider(), new CommentDecorationProvider(reposManager), new CommitsDecorationProvider(reposManager)]);
 
 	const notificationsProvider = new NotificationsProvider(credentialStore, reposManager);
 	context.subscriptions.push(notificationsProvider);

src/view/commitsDecorationProvider.ts

@@ -0,0 +1,61 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as vscode from 'vscode';
+import { TreeDecorationProvider } from './treeDecorationProviders';
+import { createCommitsNodeUri, fromCommitsNodeUri, Schemes } from '../common/uri';
+import { FolderRepositoryManager } from '../github/folderRepositoryManager';
+import { PullRequestModel } from '../github/pullRequestModel';
+import { RepositoriesManager } from '../github/repositoriesManager';
+
+export class CommitsDecorationProvider extends TreeDecorationProvider {
+
+	constructor(private readonly _repositoriesManager: RepositoriesManager) {
+		super();
+	}
+
+	registerPullRequestPropertyChangedListeners(_folderManager: FolderRepositoryManager, model: PullRequestModel): vscode.Disposable {
+		return model.onDidChange(e => {
+			if (e.timeline) {
+				// Timeline changed, which may include new commits, so update the decoration
+				const uri = createCommitsNodeUri(model.remote.owner, model.remote.repositoryName, model.number);
+				this._onDidChangeFileDecorations.fire(uri);
+			}
+		});
+	}
+
+	provideFileDecoration(
+		uri: vscode.Uri,
+		_token: vscode.CancellationToken,
+	): vscode.ProviderResult<vscode.FileDecoration> {
+		if (uri.scheme !== Schemes.CommitsNode) {
+			return undefined;
+		}
+
+		const params = fromCommitsNodeUri(uri);
+		if (!params) {
+			return undefined;
+		}
+
+		const folderManager = this._repositoriesManager.getManagerForRepository(params.owner, params.repo);
+
+		if (folderManager) {
+			const repo = folderManager.findExistingGitHubRepository({ owner: params.owner, repositoryName: params.repo });
+			if (repo) {
+				const pr = repo.getExistingPullRequestModel(params.prNumber);
+				if (pr) {
+					const commitsCount = pr.item.commits.length;
+					return {
+						badge: commitsCount.toString(),
+						tooltip: vscode.l10n.t('{0} commits', commitsCount)
+					};
+				}
+			}
+		}
+
+		return undefined;
+	}
+
+}

src/view/treeDecorationProviders.ts

@@ -11,7 +11,7 @@ import { PullRequestModel } from '../github/pullRequestModel';
 import { RepositoriesManager } from '../github/repositoriesManager';
 
 export abstract class TreeDecorationProvider extends Disposable implements vscode.FileDecorationProvider {
-	private _onDidChangeFileDecorations: vscode.EventEmitter<vscode.Uri | vscode.Uri[]> = this._register(new vscode.EventEmitter<
+	protected _onDidChangeFileDecorations: vscode.EventEmitter<vscode.Uri | vscode.Uri[]> = this._register(new vscode.EventEmitter<
 		vscode.Uri | vscode.Uri[]
 	>());
 	onDidChangeFileDecorations?: vscode.Event<vscode.Uri | vscode.Uri[] | undefined> | undefined = this._onDidChangeFileDecorations.event;

src/view/treeNodes/commitsCategoryNode.ts

@@ -7,13 +7,16 @@ import * as vscode from 'vscode';
 import { CommitNode } from './commitNode';
 import { TreeNode, TreeNodeParent } from './treeNode';
 import Logger, { PR_TREE } from '../../common/logger';
+import { createCommitsNodeUri } from '../../common/uri';
 import { FolderRepositoryManager } from '../../github/folderRepositoryManager';
 import { PullRequestModel } from '../../github/pullRequestModel';
 
 export class CommitsNode extends TreeNode implements vscode.TreeItem {
 	public collapsibleState: vscode.TreeItemCollapsibleState;
+	public resourceUri: vscode.Uri;
 	private _folderRepoManager: FolderRepositoryManager;
 	private _pr: PullRequestModel;
+	public tooltip?: string;
 
 	constructor(
 		parent: TreeNodeParent,
@@ -25,6 +28,8 @@ export class CommitsNode extends TreeNode implements vscode.TreeItem {
 		this._pr = pr;
 		this._folderRepoManager = reposManager;
 		this.collapsibleState = vscode.TreeItemCollapsibleState.Collapsed;
+		this.resourceUri = createCommitsNodeUri(pr.remote.owner, pr.remote.repositoryName, pr.number);
+		this.tooltip = vscode.l10n.t('Commits');
 
 		this.childrenDisposables = [];
 		this.childrenDisposables.push(this._pr.onDidChangeReviewThreads(() => {