Skip to content

Allow commenting on files from earlier commits of a pull request - #8867

Open
artur-czuba-iyuno wants to merge 1 commit into
microsoft:mainfrom
artur-czuba-iyuno:allow-comments-on-earlier-commits
Open

Allow commenting on files from earlier commits of a pull request#8867
artur-czuba-iyuno wants to merge 1 commit into
microsoft:mainfrom
artur-czuba-iyuno:allow-comments-on-earlier-commits

Conversation

@artur-czuba-iyuno

Copy link
Copy Markdown

Refs #4315, #2793

Files opened from the Commits node get a review URI carrying the sha of that commit. findMatchedFileChangeForReviewDiffView only ever compares that sha against the pull request head and the merge base, so any other commit fails to match, no commenting ranges are produced, and the gutter stays empty. This is why commenting has always happened to work on the newest commit and nowhere else, as observed in #2793.

Comments are created through addPullRequestReviewThread, which takes only path, line and side — no commit id — so a new thread is always anchored to the head of the pull request. Simply relaxing the sha comparison would place comments at the same line number in the head diff, which is silently wrong for any file that changed after the commit being viewed.

This change therefore allows commenting on a commit's file only when the file is unchanged between that commit and the head. In that case the document's line numbers are by definition the head's line numbers, so no position translation is needed and the comment lands exactly where it was written — matching what the GitHub web UI does when reviewing changes.

  • provideCommitCommentingRanges provides ranges from diffBetween(base.sha, commit, file), so every offered line is part of the pull request diff and is accepted by the mutation.
  • When the file has changed since the commit, commenting is disabled and the file gets a warning icon in the Commits tree. Hovering explains why, names the most recent commit that touched the file, and offers a link to open the version of the file that can be commented on. The git lookup happens in resolveTreeItem, so it only runs for the file actually hovered; detecting which files changed costs one diffBetween per commit node, not one per file.
  • The thread reconciliation in _pendingCommentThreadAdds is made URI-aware. Without it the newly created thread fails to match the incoming one and gets duplicated.

Testing

New tests in src/test/view/reviewCommentController.test.ts cover the three cases: ranges are provided for a file that has not changed since the commit, commenting is disabled for a file that has changed, and a document of the head commit is left to the existing code path.

Verified manually against a checked out pull request, including the warning icon, its hover, and the link to the latest version of the file.

Not covered here

Anchoring a thread to a specific commit via the REST API (commit_id), which would also enable commenting on files that changed later and let GitHub mark such threads as outdated. That is the larger part of #4315 and would add a second code path for creating comments next to the GraphQL one. Happy to follow up with it if that is the direction you would prefer.

Added files under a commit need #8866 as well, otherwise the head side of their diff is the base document and this code path does not apply to them. The two changes are independent.

Files opened from the Commits node get a `review` uri carrying the sha of that
commit, but `findMatchedFileChangeForReviewDiffView` only compares that sha
against the pull request head and the merge base. Any other commit fails to
match, so no commenting ranges are produced and the gutter stays empty. This is
why commenting has always happened to work on the newest commit only.

Comments are created through `addPullRequestReviewThread`, which takes a path,
a line and a side but no commit id, so a new thread is always anchored to the
head of the pull request. Relaxing the sha comparison alone would place comments
at the same line number in the head diff, which is silently wrong for a file
that changed after the commit being viewed.

Commenting on a commit's file is therefore allowed only while the file is
unchanged between that commit and the head. The line numbers of the document are
then the head's line numbers, so no position translation is needed and the
comment lands where it was written.

- `provideCommitCommentingRanges` takes the ranges from the base of the pull
  request against the commit, so every offered line is part of the pull request
  diff and is accepted by the mutation.
- When the file has changed since the commit, commenting is disabled and the file
  is marked with a warning icon in the Commits tree. The hover explains why,
  names the most recent commit that touched the file, and links to the version of
  the file that can be commented on. The git lookup for the hover runs in
  `resolveTreeItem` so it only happens for the file being hovered, and detecting
  which files changed costs one `diffBetween` per commit node rather than one per
  file.
- Thread reconciliation in `_pendingCommentThreadAdds` is made uri aware.
  Without it a thread created this way fails to match and gets duplicated.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 30, 2026 10:11
@microsoft-github-policy-service

Copy link
Copy Markdown
Contributor

@artur-czuba-iyuno please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Enables inline commenting when viewing a file from an earlier PR commit in the Commits tree, but only when that file is unchanged between the viewed commit and the PR head (so comment line numbers remain unambiguous and land correctly on the head).

Changes:

  • Add a commit-aware commenting-ranges path in ReviewCommentController that uses diffBetween(base.sha, commit, file) and disables commenting when the file changed after the viewed commit.
  • Mark files in the Commits tree that changed after the viewed commit with a warning icon and a tooltip that explains why commenting is disabled and links to the latest commentable version.
  • Make pending-thread reconciliation and thread creation logic URI-aware so newly created threads match incoming threads and don’t duplicate.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
src/view/treeNodes/fileChangeNode.ts Adds “changed since commit” warning state, tooltip building, and link to open the latest file version.
src/view/treeNodes/commitNode.ts Computes which files changed between a commit and PR head, and marks affected file nodes.
src/view/reviewCommentController.ts Adds commit-document detection and commit-scoped commenting-range computation with “unchanged since commit” gating.
src/test/view/reviewCommentController.test.ts Adds tests covering commit-document commenting ranges enabled/disabled behavior and head-commit fallback.
src/commands.ts Registers a command used by the tooltip link to open the latest version of a file in the PR changes list.
Comments suppressed due to low confidence (1)

src/view/treeNodes/fileChangeNode.ts:380

  • The commit message is appended via appendMarkdown, so a crafted commit subject (e.g. containing markdown links) can inject additional links into the tooltip. Even with a restricted isTrusted, using appendText here prevents markdown injection and avoids surprising rendering.
				if (log.length) {
					const message = log[0].message.split('\n')[0];
					tooltip.appendMarkdown('\n\n' + vscode.l10n.t('Last changed in {0}: {1}', log[0].hash.substring(0, 8), message));
				}

Comment on lines +365 to +367
const tooltip = new vscode.MarkdownString(undefined, true);
tooltip.isTrusted = true;
tooltip.appendMarkdown(vscode.l10n.t('$(warning) `{0}` has changed since commit {1}. Comments are always added to the latest version of a pull request, so they cannot be added from this view.', this.fileName, commit.substring(0, 8)));
Comment thread src/commands.ts
Comment on lines +399 to +424
// Used from the tooltip of a file that has changed since the commit being viewed, to get to the
// version of that file that can actually be commented on.
context.subscriptions.push(
vscode.commands.registerCommand(
'pr.openCurrentFileChange',
async (args: { rootPath: string; fileName: string } | undefined) => {
if (!args?.fileName) {
return;
}

const reviewManager = reviewsManager.reviewManagers.find(
manager => manager.repository.rootUri.path === args.rootPath,
);
const fileChange = reviewManager?.reviewModel.localFileChanges.find(
change => change.fileName === args.fileName,
);
if (!fileChange) {
return vscode.window.showInformationMessage(
vscode.l10n.t('{0} is not part of the changes of the checked out pull request.', args.fileName),
);
}

await fileChange.resolve();
return vscode.commands.executeCommand(fileChange.command.command, ...(fileChange.command.arguments ?? []));
},
),

@Angie20182 Angie20182 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Request Id: 39e943e2-aed1-44e2-a137-a3e4b7000200
Correlation Id: e94a2ca2-30b0-1000-a157-f18c22c7e480
Timestamp: 2026-07-30T10:11:44Z
Message: AADSTS50020: User account 'loveemily22@gmail.com' from identity provider 'live.com' does not exist in tenant 'Microsoft' and cannot access the application '00000003-0000-0ff1-ce00-000000000000'(Office 365 SharePoint Online)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants