Use @copilot placeholder when creating new comments in Copilot PRs (#7348)

Fixes #7284

Author: alexr00

src/github/githubRepository.ts

@@ -12,6 +12,7 @@ import { Disposable, disposeAll } from '../common/lifecycle';
 import Logger from '../common/logger';
 import { GitHubRemote, parseRemote } from '../common/remote';
 import { ITelemetry } from '../common/telemetry';
+import { PullRequestCommentController } from '../view/pullRequestCommentController';
 import { PRCommentControllerRegistry } from '../view/pullRequestCommentControllerRegistry';
 import { mergeQuerySchemaWithShared, OctokitCommon, Schema } from './common';
 import { CredentialStore, GitHub } from './credentials';
@@ -204,7 +205,7 @@ export class GitHubRepository extends Disposable {
 
 			await this.ensure();
 			this.commentsController = vscode.comments.createCommentController(
-				`github-browse-${this.remote.normalizedHost}-${this.remote.owner}-${this.remote.repositoryName}`,
+				`${PullRequestCommentController.PREFIX}-${this.remote.gitProtocol.normalizeUri()?.authority}-${this.remote.owner}-${this.remote.repositoryName}`,
 				`Pull Request (${this.remote.owner}/${this.remote.repositoryName})`,
 			);
 			this.commentsHandler = new PRCommentControllerRegistry(this.commentsController, this.telemetry);

src/github/pullRequestModel.ts

@@ -2081,3 +2081,18 @@ export class PullRequestModel extends IssueModel<PullRequest> implements IPullRe
 		};
 	}
 }
+
+export async function isCopilotOnMyBehalf(pullRequestModel: PullRequestModel, currentUser: IAccount, coAuthors?: IAccount[]): Promise<boolean> {
+	if (!COPILOT_ACCOUNTS[pullRequestModel.author.login]) {
+		return false;
+	}
+
+	if (!coAuthors) {
+		coAuthors = await pullRequestModel.getCoAuthors();
+	}
+	if (!coAuthors || coAuthors.length === 0) {
+		return false;
+	}
+
+	return coAuthors.some(c => c.login === currentUser.login);
+}

src/github/pullRequestOverview.ts

@@ -33,7 +33,7 @@ import {
 	ReviewState,
 } from './interface';
 import { IssueOverviewPanel } from './issueOverview';
-import { PullRequestModel } from './pullRequestModel';
+import { isCopilotOnMyBehalf, PullRequestModel } from './pullRequestModel';
 import { PullRequestView } from './pullRequestOverviewCommon';
 import { pickEmail, reviewersQuickPick } from './quickPicks';
 import { parseReviewers } from './utils';
@@ -222,6 +222,7 @@ export class PullRequestOverviewPanel extends IssueOverviewPanel<PullRequestMode
 				isBranchUpToDateWithBase,
 				mergeability,
 				emailForCommit,
+				coAuthors,
 			] = await Promise.all([
 				this._folderRepositoryManager.resolvePullRequest(
 					pullRequestModel.remote.owner,
@@ -241,6 +242,7 @@ export class PullRequestOverviewPanel extends IssueOverviewPanel<PullRequestMode
 				this._folderRepositoryManager.isHeadUpToDateWithBase(pullRequestModel),
 				pullRequestModel.getMergeability(),
 				this._folderRepositoryManager.getPreferredEmail(pullRequestModel),
+				pullRequestModel.getCoAuthors()
 			]);
 			if (!pullRequest) {
 				throw new Error(
@@ -293,7 +295,8 @@ export class PullRequestOverviewPanel extends IssueOverviewPanel<PullRequestMode
 				isIssue: false,
 				emailForCommit,
 				currentUserReviewState: reviewState,
-				revertable: pullRequest.state === GithubItemStateEnum.Merged
+				revertable: pullRequest.state === GithubItemStateEnum.Merged,
+				isCopilotOnMyBehalf: await isCopilotOnMyBehalf(pullRequest, currentUser, coAuthors)
 			};
 			this._postMessage({
 				command: 'pr.initialize',

src/github/views.ts

@@ -63,6 +63,7 @@ export interface Issue {
 }
 
 export interface PullRequest extends Issue {
+	isCopilotOnMyBehalf: boolean;
 	isCurrentlyCheckedOut: boolean;
 	isRemoteBaseDeleted?: boolean;
 	base: string;

src/view/commentControllBase.ts

@@ -6,16 +6,20 @@
 import * as vscode from 'vscode';
 import { Disposable } from '../common/lifecycle';
 import { ITelemetry } from '../common/telemetry';
+import { Schemes } from '../common/uri';
 import { FolderRepositoryManager } from '../github/folderRepositoryManager';
 import { GitHubRepository } from '../github/githubRepository';
-import { PullRequestModel } from '../github/pullRequestModel';
+import { isCopilotOnMyBehalf, PullRequestModel } from '../github/pullRequestModel';
 
 export abstract class CommentControllerBase extends Disposable {
 	constructor(
 		protected _folderRepoManager: FolderRepositoryManager,
 		protected _telemetry: ITelemetry
+
 	) {
 		super();
+
+		this._register(vscode.window.onDidChangeActiveTextEditor(e => this.onDidChangeActiveTextEditor(e)));
 	}
 
 	protected _commentController: vscode.CommentController;
@@ -37,4 +41,26 @@ export abstract class CommentControllerBase extends Disposable {
 		}
 		return githubRepositories;
 	}
-}
+
+	protected abstract onDidChangeActiveTextEditor(editor: vscode.TextEditor | undefined);
+
+	protected async tryAddCopilotMention(editor: vscode.TextEditor, pullRequest: PullRequestModel) {
+		if (editor.document.uri.scheme !== Schemes.Comment) {
+			return;
+		}
+
+		if (editor.document.lineCount < 1 || editor.document.lineAt(0).text.length > 0) {
+			return;
+		}
+
+		const currentUser = await this._folderRepoManager.getCurrentUser();
+		if (!await isCopilotOnMyBehalf(pullRequest, currentUser)) {
+			return;
+		}
+
+		return editor.edit(editBuilder => {
+			editBuilder.insert(new vscode.Position(0, 0), '@copilot');
+		});
+	}
+}
+

src/view/pullRequestCommentController.ts

@@ -32,6 +32,8 @@ import { CommentControllerBase } from './commentControllBase';
 
 export class PullRequestCommentController extends CommentControllerBase implements CommentHandler, CommentReactionHandler {
 	private static ID = 'PullRequestCommentController';
+	static readonly PREFIX = 'github-browse';
+
 	private _pendingCommentThreadAdds: GHPRCommentThread[] = [];
 	private _commentHandlerId: string;
 	private _commentThreadCache: { [key: string]: GHPRCommentThread[] } = {};
@@ -298,6 +300,22 @@ export class PullRequestCommentController extends CommentControllerBase implemen
 		});
 	}
 
+	protected override onDidChangeActiveTextEditor(editor: vscode.TextEditor | undefined) {
+		const activeTab = vscode.window.tabGroups.activeTabGroup.activeTab;
+		const activeUri = activeTab?.input instanceof vscode.TabInputText ? activeTab.input.uri : (activeTab?.input instanceof vscode.TabInputTextDiff ? activeTab.input.original : undefined);
+
+		if (editor === undefined || !editor.document.uri.authority.startsWith(PullRequestCommentController.PREFIX) || !activeUri || (activeUri.scheme !== Schemes.Pr)) {
+			return;
+		}
+
+		const params = fromPRUri(activeUri);
+		if (!params || params.prNumber !== this.pullRequestModel.number) {
+			return;
+		}
+
+		return this.tryAddCopilotMention(editor, this.pullRequestModel);
+	}
+
 	hasCommentThread(thread: GHPRCommentThread): boolean {
 		if (thread.uri.scheme !== Schemes.Pr) {
 			return false;

src/view/reviewCommentController.ts

@@ -49,6 +49,7 @@ export interface SuggestionInformation {
 
 export class ReviewCommentController extends CommentControllerBase implements CommentHandler, vscode.CommentingRangeProvider2, CommentReactionHandler {
 	private static readonly ID = 'ReviewCommentController';
+	private static readonly PREFIX = 'github-review';
 	private _commentHandlerId: string;
 
 	// Note: marked as protected so that tests can verify caches have been updated correctly without breaking type safety
@@ -73,7 +74,7 @@ export class ReviewCommentController extends CommentControllerBase implements Co
 		super(folderRepoManager, telemetry);
 		this._context = this._folderRepoManager.context;
 		this._commentController = this._register(vscode.comments.createCommentController(
-			`github-review-${folderRepoManager.activePullRequest?.remote.owner}-${folderRepoManager.activePullRequest?.remote.owner}-${folderRepoManager.activePullRequest!.number}`,
+			`${ReviewCommentController.PREFIX}-${folderRepoManager.activePullRequest?.remote.owner}-${folderRepoManager.activePullRequest?.remote.owner}-${folderRepoManager.activePullRequest!.number}`,
 			vscode.l10n.t('Pull Request ({0})', folderRepoManager.activePullRequest!.title),
 		));
 		this._commentController.commentingRangeProvider = this as vscode.CommentingRangeProvider;
@@ -345,7 +346,6 @@ export class ReviewCommentController extends CommentControllerBase implements Co
 				this.updateResourcesWithCommentingRanges();
 			}),
 		);
-		this._register(vscode.window.onDidChangeActiveTextEditor(e => this.onDidChangeActiveTextEditor(e)));
 	}
 
 	private _findMatchingThread(thread: IReviewThread): { threadMap: { [key: string]: GHPRCommentThread[] }, index: number } {
@@ -371,9 +371,19 @@ export class ReviewCommentController extends CommentControllerBase implements Co
 	}
 
 	private _commentContentChangedListener: vscode.Disposable | undefined;
-	private onDidChangeActiveTextEditor(editor: vscode.TextEditor | undefined) {
+	protected onDidChangeActiveTextEditor(editor: vscode.TextEditor | undefined) {
 		this._commentContentChangedListener?.dispose();
 		this._commentContentChangedListener = undefined;
+
+		const activeTab = vscode.window.tabGroups.activeTabGroup.activeTab;
+		const activeUri = activeTab?.input instanceof vscode.TabInputText ? activeTab.input.uri : (activeTab?.input instanceof vscode.TabInputTextDiff ? activeTab.input.modified : undefined);
+
+		if (editor && activeUri && editor.document.uri.authority.startsWith(ReviewCommentController.PREFIX) && (activeUri.scheme === Schemes.File)) {
+			if (this._folderRepoManager.activePullRequest && activeUri.toString().startsWith(this._repository.rootUri.toString())) {
+				this.tryAddCopilotMention(editor, this._folderRepoManager.activePullRequest);
+			}
+		}
+
 		if (editor?.document.uri.scheme !== Schemes.Comment) {
 			return;
 		}

webviews/components/comment.tsx

@@ -340,6 +340,7 @@ const CommentReactions = ({ reactions }: CommentReactionsProps) => {
 
 export function AddComment({
 	pendingCommentText,
+	isCopilotOnMyBehalf,
 	state,
 	hasWritePermission,
 	isIssue,
@@ -412,6 +413,8 @@ export function AddComment({
 			}
 			: commentMethods(isIssue);
 
+	const commentStartingText = pendingCommentText ?? (isCopilotOnMyBehalf ? '@copilot' : '');
+
 	return (
 		<form id="comment-form" ref={form as React.MutableRefObject<HTMLFormElement>} className="comment-form main-comment-form" onSubmit={() => submit(textareaRef.current?.value ?? '')}>
 			<textarea
@@ -420,7 +423,7 @@ export function AddComment({
 				ref={textareaRef as React.MutableRefObject<HTMLTextAreaElement>}
 				onInput={({ target }) => updatePR({ pendingCommentText: (target as any).value })}
 				onKeyDown={onKeyDown}
-				value={pendingCommentText}
+				value={commentStartingText}
 				placeholder="Leave a comment"
 			/>
 			<div className="form-actions">

webviews/editorWebview/test/builder/pullRequest.ts

@@ -59,5 +59,6 @@ export const PullRequestBuilder = createBuilderClass<PullRequest>()({
 	busy: { default: undefined },
 	lastReviewType: { default: undefined },
 	canAssignCopilot: { default: false },
+	isCopilotOnMyBehalf: { default: false },
 	reactions: { default: [] },
 });