Fix commit links in PR description to open multi diff editor instead of browser (#7217)

* Initial plan

* Implement command to open commit changes in multi diff editor

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

* Address PR review feedback - move to static method and fix parameter naming

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

* Remove command registration and call static method directly

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

* Conditionally use href for commit links when PR not checked out

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

* Use review scheme URIs in openCommitChanges method

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

* Fix renames

* Replace ~1 syntax with actual parent commit SHA lookup

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

* Use the correct path

* nit

* Add OpenCommitChangesArgs type to common/views.ts and use it in pullRequestOverview and context

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

* nit

---------

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

common/views.ts

@@ -169,10 +169,14 @@ export interface TitleAndDescriptionResult {
 	description: string | undefined;
 }
 
-export interface CloseResult {
-	state: GithubItemStateEnum;
-	commentEvent?: CommentEvent;
-	closeEvent: ClosedEvent;
-}
-
+export interface CloseResult {
+	state: GithubItemStateEnum;
+	commentEvent?: CommentEvent;
+	closeEvent: ClosedEvent;
+}
+
+export interface OpenCommitChangesArgs {
+	commitSha: string;
+}
+
 // #endregion

src/common/uri.ts

@@ -323,6 +323,13 @@ export namespace DataUri {
 	}
 }
 
+/**
+ * @param fileName The repo relative path to the file
+ */
+export function reviewPath(fileName: string, commitSha: string) {
+	return vscode.Uri.parse(pathUtils.posix.join(`commit~${commitSha.substr(0, 8)}`, fileName));
+}
+
 export function toReviewUri(
 	uri: vscode.Uri,
 	filePath: string | undefined,

src/github/pullRequestModel.ts

@@ -11,13 +11,14 @@ import * as vscode from 'vscode';
 import { Repository } from '../api/api';
 import { COPILOT_ACCOUNTS, DiffSide, IComment, IReviewThread, SubjectType, ViewedState } from '../common/comment';
 import { getModifiedContentFromDiffHunk, parseDiff } from '../common/diffHunk';
+import { commands } from '../common/executeCommands';
 import { GitChangeType, InMemFileChange, SlimFileChange } from '../common/file';
 import { GitHubRef } from '../common/githubRef';
 import Logger from '../common/logger';
 import { Remote } from '../common/remote';
 import { ITelemetry } from '../common/telemetry';
 import { ClosedEvent, EventType, ReviewEvent } from '../common/timelineEvent';
-import { resolvePath, Schemes, toPRUri, toReviewUri } from '../common/uri';
+import { resolvePath, reviewPath, Schemes, toPRUri, toReviewUri } from '../common/uri';
 import { formatError, isDescendant } from '../common/utils';
 import { InMemFileChangeModel, RemoteFileChangeModel } from '../view/fileChangeModel';
 import { OctokitCommon } from './common';
@@ -1190,6 +1191,64 @@ export class PullRequestModel extends IssueModel<PullRequest> implements IPullRe
 		return vscode.commands.executeCommand('vscode.changes', vscode.l10n.t('Changes in Pull Request #{0}', pullRequestModel.number), args);
 	}
 
+	static async openCommitChanges(folderManager: FolderRepositoryManager, commitSha: string) {
+		try {
+			// Get the repository from the folder manager
+			const repository = folderManager.repository;
+			if (!repository) {
+				vscode.window.showErrorMessage(vscode.l10n.t('No repository found'));
+				return;
+			}
+
+			// Get the commit to find its parent
+			const commit = await repository.getCommit(commitSha);
+			if (!commit.parents || commit.parents.length === 0) {
+				vscode.window.showErrorMessage(vscode.l10n.t('Commit {0} has no parent', commitSha.substring(0, 7)));
+				return;
+			}
+			const parentSha = commit.parents[0];
+
+			// Get the changes between the commit and its parent
+			const changes = await repository.diffBetween(parentSha, commitSha);
+			if (!changes || changes.length === 0) {
+				vscode.window.showInformationMessage(vscode.l10n.t('No changes found in commit {0}', commitSha.substring(0, 7)));
+				return;
+			}
+
+			// Create URI pairs for the multi diff editor using review scheme
+			const args: [vscode.Uri, vscode.Uri | undefined, vscode.Uri | undefined][] = [];
+			for (const change of changes) {
+				const rightRelativePath = path.relative(repository.rootUri.fsPath, change.uri.fsPath);
+				const rightPath = reviewPath(rightRelativePath, commitSha);
+				let rightUri = toReviewUri(rightPath, rightRelativePath, undefined, commitSha, false, { base: false }, repository.rootUri);
+
+				const leftRelativePath = path.relative(repository.rootUri.fsPath, change.originalUri.fsPath);
+				const leftPath = reviewPath(leftRelativePath, parentSha);
+				let leftUri = toReviewUri(leftPath, (change.status === GitChangeType.RENAME) ? path.relative(repository.rootUri.fsPath, change.originalUri.fsPath) : leftRelativePath, undefined, parentSha, false, { base: true }, repository.rootUri);
+
+				if (change.status === GitChangeType.ADD) {
+					// For added files, show against empty
+					args.push([rightUri, undefined, rightUri]);
+				} else if (change.status === GitChangeType.DELETE) {
+					// For deleted files, show old version against empty
+					args.push([rightPath, leftUri, undefined]);
+				} else {
+					args.push([rightUri, leftUri, rightUri]);
+				}
+			}
+
+			/* __GDPR__
+				"pr.openCommitChanges" : {}
+			*/
+			folderManager.telemetry.sendTelemetryEvent('pr.openCommitChanges');
+
+			return commands.executeCommand('vscode.changes', vscode.l10n.t('Changes in Commit {0}', commitSha.substring(0, 7)), args);
+		} catch (error) {
+			const errorMessage = error instanceof Error ? error.message : String(error);
+			vscode.window.showErrorMessage(vscode.l10n.t('Failed to open commit changes: {0}', errorMessage));
+		}
+	}
+
 	static async openDiffFromComment(
 		folderManager: FolderRepositoryManager,
 		pullRequestModel: PullRequestModel,

src/github/pullRequestOverview.ts

@@ -5,6 +5,7 @@
 'use strict';
 
 import * as vscode from 'vscode';
+import { OpenCommitChangesArgs } from '../../common/views';
 import { openPullRequestOnGitHub } from '../commands';
 import { IComment } from '../common/comment';
 import { copilotEventToStatus, CopilotPRStatus, mostRecentCopilotEvent } from '../common/copilot';
@@ -384,6 +385,8 @@ export class PullRequestOverviewPanel extends IssueOverviewPanel<PullRequestMode
 				return this.openSessionLog(message);
 			case 'pr.cancel-coding-agent':
 				return this.cancelCodingAgent(message);
+			case 'pr.openCommitChanges':
+				return this.openCommitChanges(message);
 		}
 	}
 
@@ -532,6 +535,16 @@ export class PullRequestOverviewPanel extends IssueOverviewPanel<PullRequestMode
 		}
 	}
 
+	private async openCommitChanges(message: IRequestMessage<OpenCommitChangesArgs>): Promise<void> {
+		try {
+			const { commitSha } = message.args;
+			await PullRequestModel.openCommitChanges(this._folderRepositoryManager, commitSha);
+		} catch (error) {
+			Logger.error(`Failed to open commit changes: ${formatError(error)}`, PullRequestOverviewPanel.ID);
+			vscode.window.showErrorMessage(vscode.l10n.t('Failed to open commit changes: {0}', formatError(error)));
+		}
+	}
+
 	private async openChanges(message?: IRequestMessage<{ openToTheSide?: boolean }>): Promise<void> {
 		const openToTheSide = message?.args?.openToTheSide || false;
 		return PullRequestModel.openChanges(this._folderRepositoryManager, this._item, openToTheSide);

src/view/treeNodes/commitNode.ts

@@ -3,11 +3,10 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import * as path from 'path';
 import * as vscode from 'vscode';
 import { getGitChangeType } from '../../common/diffHunk';
 import { FILE_LIST_LAYOUT, PR_SETTINGS_NAMESPACE } from '../../common/settingKeys';
-import { DataUri, toReviewUri } from '../../common/uri';
+import { DataUri, reviewPath, toReviewUri } from '../../common/uri';
 import { dateFromNow } from '../../common/utils';
 import { OctokitCommon } from '../../github/common';
 import { FolderRepositoryManager } from '../../github/folderRepositoryManager';
@@ -58,7 +57,7 @@ export class CommitNode extends TreeNode implements vscode.TreeItem {
 
 		const fileChangeNodes = fileChanges.map(change => {
 			const fileName = change.filename!;
-			const uri = vscode.Uri.parse(path.posix.join(`commit~${this.commit.sha.substr(0, 8)}`, fileName));
+			const uri = reviewPath(fileName, this.commit.sha);
 			const changeModel = new GitFileChangeModel(
 				this.pullRequestManager,
 				this.pullRequest,

webviews/common/context.tsx

@@ -4,7 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { createContext } from 'react';
-import { CloseResult } from '../../common/views';
+import { CloseResult, OpenCommitChangesArgs } from '../../common/views';
 import { IComment } from '../../src/common/comment';
 import { EventType, ReviewEvent, SessionLinkInfo, TimelineEvent } from '../../src/common/timelineEvent';
 import { IProjectItem, MergeMethod, ReadyForReview } from '../../src/github/interface';
@@ -254,6 +254,8 @@ export class PRContext {
 
 	public openSessionLog = (link: SessionLinkInfo, openToTheSide?: boolean) => this.postMessage({ command: 'pr.open-session-log', args: { link, openToTheSide } });
 
+	public openCommitChanges = (commitSha: string) => this.postMessage({ command: 'pr.openCommitChanges', args: { commitSha } as OpenCommitChangesArgs });
+
 	setPR = (pr: PullRequest) => {
 		this.pr = pr;
 		setState(this.pr);

webviews/components/timeline.tsx

@@ -105,28 +105,51 @@ export const Timeline = ({ events, isIssue }: { events: TimelineEvent[], isIssue
 
 export default Timeline;
 
-const CommitEventView = (event: CommitEvent) => (
-	<div className="comment-container commit">
-		<div className="commit-message">
-			{commitIcon}
-			{nbsp}
-			<div className="avatar-container">
-				<Avatar for={event.author} />
+const CommitEventView = (event: CommitEvent) => {
+	const context = useContext(PullRequestContext);
+	const pr = context.pr;
+
+	const handleCommitClick = (e: React.MouseEvent) => {
+		if (pr.isCurrentlyCheckedOut) {
+			e.preventDefault();
+			context.openCommitChanges(event.sha);
+		}
+		// If not checked out, let the default href behavior proceed
+	};
+
+	return (
+		<div className="comment-container commit">
+			<div className="commit-message">
+				{commitIcon}
+				{nbsp}
+				<div className="avatar-container">
+					<Avatar for={event.author} />
+				</div>
+				<div className="message-container">
+					<a
+						className="message"
+						onClick={handleCommitClick}
+						href={pr.isCurrentlyCheckedOut ? undefined : event.htmlUrl}
+						title={event.htmlUrl}
+					>
+						{event.message.substr(0, event.message.indexOf('\n') > -1 ? event.message.indexOf('\n') : event.message.length)}
+					</a>
+				</div>
 			</div>
-			<div className="message-container">
-				<a className="message" href={event.htmlUrl} title={event.htmlUrl}>
-					{event.message.substr(0, event.message.indexOf('\n') > -1 ? event.message.indexOf('\n') : event.message.length)}
+			<div className="timeline-detail">
+				<a
+					className="sha"
+					onClick={handleCommitClick}
+					href={pr.isCurrentlyCheckedOut ? undefined : event.htmlUrl}
+					title={event.htmlUrl}
+				>
+					{event.sha.slice(0, 7)}
 				</a>
+				<Timestamp date={event.committedDate} />
 			</div>
 		</div>
-		<div className="timeline-detail">
-			<a className="sha" href={event.htmlUrl} title={event.htmlUrl}>
-				{event.sha.slice(0, 7)}
-			</a>
-			<Timestamp date={event.committedDate} />
-		</div>
-	</div>
-);
+	);
+};
 
 const NewCommitsSinceReviewEventView = () => {
 	const { gotoChangesSinceReview, pr } = useContext(PullRequestContext);