Fixes pull request comparisons

Author: eamodio

CHANGELOG.md

@@ -22,6 +22,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 - Fixes [#3152](https://github.com/gitkraken/vscode-gitlens/issues/3152) - Fixes double encoding of redirect URLs during account sign-in which affects certain environments
 - Fixes [#3153](https://github.com/gitkraken/vscode-gitlens/issues/3153) - `gitlens.defaultDateStyle` not working in Commit Details view
+- Fixes the _Open Pull Request Changes_ & _Compare Pull Request_ commands to scope the changes only to the pull request
 - Fixes issue when switching to a worktree via branch switch when there are multiple repos in the workspace
 
 ## [14.8.2] - 2024-02-16

src/constants.ts

@@ -970,6 +970,7 @@ export interface StoredRepoVisibilityInfo {
 
 export interface StoredBranchComparison {
 	ref: string;
+	label?: string;
 	notation: '..' | '...' | undefined;
 	type: Exclude<ViewShowBranchComparison, false> | undefined;
 	checkedFiles?: string[];

src/git/actions/commit.ts

@@ -16,6 +16,7 @@ import { showRevisionFilesPicker } from '../../quickpicks/revisionFilesPicker';
 import { executeCommand, executeCoreGitCommand, executeEditorCommand } from '../../system/command';
 import { configuration } from '../../system/configuration';
 import { findOrOpenEditor, findOrOpenEditors, openChangesEditor } from '../../system/utils';
+import { getAheadBehindFilesQuery } from '../../views/nodes/compareResultsNode';
 import { GitUri } from '../gitUri';
 import type { GitCommit } from '../models/commit';
 import { isCommit } from '../models/commit';
@@ -24,15 +25,16 @@ import type { GitFile } from '../models/file';
 import { GitFileChange } from '../models/file';
 import type { GitRevisionReference } from '../models/reference';
 import {
+	createRevisionRange,
 	getReferenceFromRevision,
 	getReferenceLabel,
 	isUncommitted,
 	isUncommittedStaged,
 	shortenRevision,
 } from '../models/reference';
 
-type Ref = { repoPath: string; ref: string };
-type RefRange = { repoPath: string; rhs: string; lhs: string };
+export type Ref = { repoPath: string; ref: string };
+export type RefRange = { repoPath: string; rhs: string; lhs: string };
 
 export interface FilesComparison {
 	files: GitFile[];
@@ -454,6 +456,24 @@ export async function openChangesWithWorking(
 	}));
 }
 
+export async function openComparisonChanges(
+	container: Container,
+	refs: RefRange,
+	options?: TextDocumentShowOptions & { title?: string },
+): Promise<void> {
+	refs.lhs = refs.lhs || 'HEAD';
+	refs.rhs = refs.rhs || 'HEAD';
+
+	const { files } = await getAheadBehindFilesQuery(
+		container,
+		refs.repoPath,
+		createRevisionRange(refs.lhs, refs.rhs, '...'),
+		refs.rhs === '',
+	);
+
+	await openAllChangesInChangesEditor(files ?? [], refs, options);
+}
+
 export async function openDirectoryCompare(
 	repoPath: string,
 	ref: string,

src/git/models/pullRequest.ts

@@ -2,6 +2,7 @@ import { Container } from '../../container';
 import { formatDate, fromNow } from '../../system/date';
 import { memoize } from '../../system/decorators/memoize';
 import type { IssueOrPullRequest, IssueOrPullRequestState as PullRequestState } from './issue';
+import { shortenRevision } from './reference';
 import type { RemoteProviderReference } from './remoteProvider';
 
 export type { PullRequestState };
@@ -202,3 +203,31 @@ export class PullRequest implements PullRequestShape {
 		return fromNow(this.date);
 	}
 }
+
+export interface PullRequestComparisonRefs {
+	repoPath: string;
+	base: { ref: string; label: string };
+	head: { ref: string; label: string };
+}
+
+export async function getComparisonRefsForPullRequest(
+	container: Container,
+	repoPath: string,
+	prRefs: PullRequestRefs,
+): Promise<PullRequestComparisonRefs> {
+	const refs: PullRequestComparisonRefs = {
+		repoPath: repoPath,
+		base: { ref: prRefs.base.sha, label: `${prRefs.base.branch} (${shortenRevision(prRefs.base.sha)})` },
+		head: { ref: prRefs.head.sha, label: prRefs.head.branch },
+	};
+
+	// Find the merge base to show a more accurate comparison for the PR
+	const mergeBase =
+		(await container.git.getMergeBase(refs.repoPath, refs.base.ref, refs.head.ref, { forkPoint: true })) ??
+		(await container.git.getMergeBase(refs.repoPath, refs.base.ref, refs.head.ref));
+	if (mergeBase != null) {
+		refs.base = { ref: mergeBase, label: `${prRefs.base.branch} (${shortenRevision(mergeBase)})` };
+	}
+
+	return refs;
+}

src/plus/integrations/providers/github/models.ts

@@ -185,7 +185,7 @@ export function fromGitHubPullRequest(pr: GitHubPullRequest, provider: Provider)
 			head: {
 				exists: pr.headRepository != null,
 				owner: pr.headRepository?.owner.login,
-				repo: pr.baseRepository?.name,
+				repo: pr.headRepository?.name,
 				sha: pr.headRefOid,
 				branch: pr.headRefName,
 				url: pr.headRepository?.url,
@@ -284,7 +284,7 @@ export function fromGitHubPullRequestDetailed(pr: GitHubDetailedPullRequest, pro
 			head: {
 				exists: pr.headRepository != null,
 				owner: pr.headRepository?.owner.login,
-				repo: pr.baseRepository?.name,
+				repo: pr.headRepository?.name,
 				sha: pr.headRefOid,
 				branch: pr.headRefName,
 				url: pr.headRepository?.url,

src/plus/webviews/graph/graphWebview.ts

@@ -22,6 +22,7 @@ import {
 	openAllChangesIndividually,
 	openAllChangesWithWorking,
 	openAllChangesWithWorkingIndividually,
+	openComparisonChanges,
 	openFiles,
 	openFilesAtRevision,
 	openOnlyChangedFiles,
@@ -39,6 +40,7 @@ import type { GitCommit } from '../../../git/models/commit';
 import { uncommitted } from '../../../git/models/constants';
 import { GitContributor } from '../../../git/models/contributor';
 import type { GitGraph, GitGraphRowType } from '../../../git/models/graph';
+import { getComparisonRefsForPullRequest } from '../../../git/models/pullRequest';
 import type {
 	GitBranchReference,
 	GitReference,
@@ -2689,14 +2691,18 @@ export class GraphWebviewProvider implements WebviewProvider<State, State, Graph
 	}
 
 	@debug()
-	private openPullRequestChanges(item?: GraphItemContext) {
+	private async openPullRequestChanges(item?: GraphItemContext) {
 		if (isGraphItemTypedContext(item, 'pullrequest')) {
 			const pr = item.webviewItemValue;
 			if (pr.refs?.base != null && pr.refs.head != null) {
-				return this.container.searchAndCompareView.openComparisonChanges(
-					pr.repoPath,
-					{ ref: pr.refs.head.sha, label: pr.refs.head.branch },
-					{ ref: pr.refs.base.sha, label: pr.refs.base.branch },
+				const refs = await getComparisonRefsForPullRequest(this.container, pr.repoPath, pr.refs);
+				return openComparisonChanges(
+					this.container,
+					{
+						repoPath: refs.repoPath,
+						lhs: refs.base.ref,
+						rhs: refs.head.ref,
+					},
 					{ title: `Changes in Pull Request #${pr.id}` },
 				);
 			}
@@ -2706,15 +2712,12 @@ export class GraphWebviewProvider implements WebviewProvider<State, State, Graph
 	}
 
 	@debug()
-	private openPullRequestComparison(item?: GraphItemContext) {
+	private async openPullRequestComparison(item?: GraphItemContext) {
 		if (isGraphItemTypedContext(item, 'pullrequest')) {
 			const pr = item.webviewItemValue;
 			if (pr.refs?.base != null && pr.refs.head != null) {
-				return this.container.searchAndCompareView.compare(
-					pr.repoPath,
-					{ ref: pr.refs.head.sha, label: pr.refs.head.branch },
-					{ ref: pr.refs.base.sha, label: pr.refs.base.branch },
-				);
+				const refs = await getComparisonRefsForPullRequest(this.container, pr.repoPath, pr.refs);
+				return this.container.searchAndCompareView.compare(refs.repoPath, refs.head, refs.base);
 			}
 		}
 

src/views/nodes/branchNode.ts

@@ -1,12 +1,13 @@
 import { MarkdownString, ThemeColor, ThemeIcon, TreeItem, TreeItemCollapsibleState, Uri, window } from 'vscode';
 import type { ViewShowBranchComparison } from '../../config';
-import type { Colors } from '../../constants';
+import type { Colors, StoredBranchComparison } from '../../constants';
 import { GlyphChars } from '../../constants';
 import type { GitUri } from '../../git/gitUri';
 import type { GitBranch } from '../../git/models/branch';
 import type { GitLog } from '../../git/models/log';
 import type { PullRequest, PullRequestState } from '../../git/models/pullRequest';
 import type { GitBranchReference } from '../../git/models/reference';
+import { shortenRevision } from '../../git/models/reference';
 import { getHighlanderProviders } from '../../git/models/remote';
 import type { Repository } from '../../git/models/repository';
 import type { GitUser } from '../../git/models/user';
@@ -160,6 +161,18 @@ export class BranchNode
 			let pullRequest;
 			let pullRequestInsertIndex = 0;
 
+			function getPullRequestComparison(pr: PullRequest | null | undefined): StoredBranchComparison | undefined {
+				if (pr?.refs?.base == null && pr?.refs?.head == null) return undefined;
+
+				return {
+					ref: pr.refs.base.sha,
+					label: `${pr.refs.base.branch} (${shortenRevision(pr.refs.base.sha)})`,
+					notation: '...',
+					type: 'branch',
+					checkedFiles: [],
+				};
+			}
+
 			if (
 				this.view.config.pullRequests.enabled &&
 				this.view.config.pullRequests.showForBranches &&
@@ -194,6 +207,18 @@ export class BranchNode
 								0,
 								new PullRequestNode(this.view, this, pr, branch),
 							);
+
+							if (pr?.refs?.base != null && pr?.refs?.head != null) {
+								const comparisonNode = this.children.find((n): n is CompareBranchNode =>
+									n.is('compare-branch'),
+								);
+								if (comparisonNode != null) {
+									const comparison = getPullRequestComparison(pr);
+									if (comparison != null) {
+										await comparisonNode.setDefaultCompareWith(comparison);
+									}
+								}
+							}
 						}
 
 						// Refresh this node to add the pull request node or remove the spinner
@@ -319,6 +344,7 @@ export class BranchNode
 						branch,
 						this.options.showComparison,
 						this.splatted,
+						getPullRequestComparison(pullRequest),
 					),
 				);
 			}

src/views/nodes/compareBranchNode.ts

@@ -49,12 +49,16 @@ export class CompareBranchNode extends SubscribeableViewNode<
 		private showComparison: ViewShowBranchComparison,
 		// Specifies that the node is shown as a root
 		public readonly root: boolean = false,
+		defaultCompareWith?: StoredBranchComparison,
 	) {
 		super('compare-branch', uri, view, parent);
 
 		this.updateContext({ branch: branch, root: root, storedComparisonId: this.getStorageId() });
 		this._uniqueId = getViewNodeId(this.type, this.context);
 		this.loadCompareWith();
+		if (defaultCompareWith != null) {
+			void this.setDefaultCompareWith(defaultCompareWith);
+		}
 	}
 
 	protected override etag(): number {
@@ -199,12 +203,12 @@ export class CompareBranchNode extends SubscribeableViewNode<
 				this.compareWithWorkingTree ? 'Working Tree' : this.branch.name
 			} with a branch, tag, or ref`;
 		} else {
-			label = `Compare ${this.compareWithWorkingTree ? 'Working Tree' : this.branch.name} with ${shortenRevision(
-				this._compareWith.ref,
-				{
+			label = `Compare ${this.compareWithWorkingTree ? 'Working Tree' : this.branch.name} with ${
+				this._compareWith.label ??
+				shortenRevision(this._compareWith.ref, {
 					strings: { working: 'Working Tree' },
-				},
-			)}`;
+				})
+			}`;
 			state = TreeItemCollapsibleState.Collapsed;
 		}
 
@@ -270,6 +274,13 @@ export class CompareBranchNode extends SubscribeableViewNode<
 		this.view.triggerNodeChange(this);
 	}
 
+	@log()
+	async setDefaultCompareWith(compareWith: StoredBranchComparison) {
+		if (this._compareWith != null) return;
+
+		await this.updateCompareWith(compareWith);
+	}
+
 	private get comparisonType() {
 		return this._compareWith?.type ?? this.showComparison;
 	}