Add command to generate PR title + description (#8508)

* Add command to generate PR title + description

* Copilot PR feedback

Author: alexr00

package.json

@@ -1874,6 +1874,11 @@
 				"command": "pr.checkoutChatSessionPullRequest",
 				"title": "%command.pr.checkoutChatSessionPullRequest.title%",
 				"category": "%command.pull.request.category%"
+			},
+			{
+				"command": "pr.generateTitleAndDescription",
+				"title": "%command.pr.generateTitleAndDescription.title%",
+				"category": "%command.pull.request.category%"
 			}
 		],
 		"viewsWelcome": [
@@ -2673,6 +2678,10 @@
 				{
 					"command": "review.copyPrLink",
 					"when": "github:inReviewMode"
+				},
+				{
+					"command": "pr.generateTitleAndDescription",
+					"when": "false"
 				}
 			],
 			"view/title": [

package.nls.json

@@ -357,6 +357,7 @@
 	"command.notifications.configureNotificationsViewlet.title": "Configure...",
 	"command.notification.chatSummarizeNotification.title": "Summarize With Copilot",
 	"command.pr.checkoutChatSessionPullRequest.title": "Checkout Pull Request",
+	"command.pr.generateTitleAndDescription.title": "Generate Pull Request Title and Description",
 	"welcome.github.login.contents": {
 		"message": "You have not yet signed in with GitHub\n[Sign in](command:pr.signin)",
 		"comment": [

src/commands.ts

@@ -36,6 +36,7 @@ import { IssueChatContextItem } from './lm/issueContextProvider';
 import { PRChatContextItem } from './lm/pullRequestContextProvider';
 import { isNotificationTreeItem, NotificationTreeItem } from './notifications/notificationItem';
 import { NotificationsManager } from './notifications/notificationsManager';
+import { CreatePullRequestDataModel } from './view/createPullRequestDataModel';
 import { PullRequestsTreeDataProvider } from './view/prsTreeDataProvider';
 import { PrsTreeModel } from './view/prsTreeModel';
 import { ReviewCommentController } from './view/reviewCommentController';
@@ -2044,4 +2045,66 @@ ${contents}
 			}
 		})
 	);
+
+	context.subscriptions.push(
+		vscode.commands.registerCommand('pr.generateTitleAndDescription', async (args: { rootUri: vscode.Uri; baseBranch: string; compareBranch: string }) => {
+			if (!args?.rootUri || !args?.baseBranch || !args?.compareBranch) {
+				Logger.error('Missing required arguments for pr.generateTitleAndDescription', logId);
+				return undefined;
+			}
+
+			const folderManager = reposManager.getManagerForFile(args.rootUri);
+			if (!folderManager) {
+				Logger.error('Unable to find a repository for the provided rootUri.', logId);
+				return undefined;
+			}
+
+			const origin = await folderManager.getOrigin();
+			const defaults = await folderManager.getPullRequestDefaults();
+
+			const model = new CreatePullRequestDataModel(
+				folderManager,
+				defaults.owner,
+				args.baseBranch,
+				origin.remote.owner,
+				args.compareBranch,
+				origin.remote.repositoryName,
+			);
+
+			try {
+				const { commitMessages, patches } = await model.getCommitsAndPatches();
+				const issues = await model.findIssueContext(commitMessages);
+				const template = await folderManager.getPullRequestTemplateBody(defaults.owner);
+
+				const provider = folderManager.getTitleAndDescriptionProvider();
+				if (!provider) {
+					Logger.error('No title and description provider available.', logId);
+					return undefined;
+				}
+
+				const tokenSource = new vscode.CancellationTokenSource();
+				const result = await provider.provider.provideTitleAndDescription(
+					{ commitMessages, patches, issues, template },
+					tokenSource.token,
+				);
+
+				/* __GDPR__
+					"pr.generatedTitleAndDescription" : {
+						"providerTitle" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
+						"source" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
+					}
+				*/
+				telemetry.sendTelemetryEvent('pr.generatedTitleAndDescription', { providerTitle: provider?.title, source: 'command' });
+
+				tokenSource.dispose();
+
+				return result ? { title: result.title, description: result.description } : undefined;
+			} catch (e) {
+				Logger.error(`Error generating title and description: ${formatError(e)}`, logId);
+				return undefined;
+			} finally {
+				model.dispose();
+			}
+		}),
+	);
 }

src/github/createPRViewProvider.ts

@@ -16,7 +16,7 @@ import { BaseBranchMetadata, PullRequestGitHelper } from './pullRequestGitHelper
 import { PullRequestModel } from './pullRequestModel';
 import { getDefaultMergeMethod } from './pullRequestOverview';
 import { branchPicks, getAssigneesQuickPickItems, getLabelOptions, getMilestoneFromQuickPick, getProjectFromQuickPick, reviewersQuickPick } from './quickPicks';
-import { getIssueNumberLabelFromParsed, ISSUE_EXPRESSION, ISSUE_OR_URL_EXPRESSION, parseIssueExpressionOutput, variableSubstitution } from './utils';
+import { ISSUE_EXPRESSION, parseIssueExpressionOutput, variableSubstitution } from './utils';
 import { ChangeTemplateReply, DisplayLabel, PreReviewState } from './views';
 import { RemoteInfo } from '../../common/types';
 import { ChooseBaseRemoteAndBranchResult, ChooseCompareRemoteAndBranchResult, ChooseRemoteAndBranchArgs, CreateParamsNew, CreatePullRequestNew, TitleAndDescriptionArgs } from '../../common/views';
@@ -1142,57 +1142,8 @@ Don't forget to commit your template file to the repository so that it can be us
 		return this._replyMessage(message, chooseResult);
 	}
 
-	private async findIssueContext(commits: string[]): Promise<{ content: string, reference: string }[] | undefined> {
-		const issues: Promise<{ content: string, reference: string } | undefined>[] = [];
-		for (const commit of commits) {
-			const tryParse = parseIssueExpressionOutput(commit.match(ISSUE_OR_URL_EXPRESSION));
-			if (tryParse) {
-				const owner = tryParse.owner ?? this.model.baseOwner;
-				const name = tryParse.name ?? this.model.repositoryName;
-				issues.push(new Promise(resolve => {
-					this._folderRepositoryManager.resolveIssue(owner, name, tryParse.issueNumber).then(issue => {
-						if (issue) {
-							resolve({ content: `${issue.title}\n${issue.body}`, reference: getIssueNumberLabelFromParsed(tryParse) });
-						} else {
-							resolve(undefined);
-						}
-					}).catch(() => resolve(undefined));
-				}));
-			}
-		}
-		if (issues.length) {
-			return (await Promise.all(issues)).filter(issue => !!issue) as { content: string, reference: string }[];
-		}
-		return undefined;
-	}
-
 	private async getCommitsAndPatches(): Promise<{ commitMessages: string[], patches: { patch: string, fileUri: string, previousFileUri?: string }[] }> {
-		let commitMessages: string[];
-		let patches: ({ patch: string, fileUri: string, previousFileUri?: string } | undefined)[] | undefined;
-		if (await this.model.getCompareHasUpstream()) {
-			[commitMessages, patches] = await Promise.all([
-				this.model.gitHubCommits().then(rawCommits => rawCommits.map(commit => commit.commit.message)),
-				this.model.gitHubFiles().then(rawPatches => rawPatches?.map(file => {
-					if (!file.patch) {
-						return;
-					}
-					const fileUri = vscode.Uri.joinPath(this._folderRepositoryManager.repository.rootUri, file.filename).toString();
-					const previousFileUri = file.previous_filename ? vscode.Uri.joinPath(this._folderRepositoryManager.repository.rootUri, file.previous_filename).toString() : undefined;
-					return { patch: file.patch, fileUri, previousFileUri };
-				}))]);
-		} else {
-			[commitMessages, patches] = await Promise.all([
-				this.model.gitCommits().then(rawCommits => rawCommits.filter(commit => commit.parents.length === 1).map(commit => commit.message)),
-				Promise.all((await this.model.gitFiles()).map(async (file) => {
-					return {
-						patch: await this._folderRepositoryManager.repository.diffBetween(this.model.baseBranch, this.model.compareBranch, file.uri.fsPath),
-						fileUri: file.uri.toString(),
-					};
-				}))]);
-		}
-		const filteredPatches: { patch: string, fileUri: string, previousFileUri?: string }[] =
-			patches?.filter<{ patch: string, fileUri: string, previousFileUri?: string }>((patch): patch is { patch: string, fileUri: string, previousFileUri?: string } => !!patch) ?? [];
-		return { commitMessages, patches: filteredPatches };
+		return this.model.getCommitsAndPatches();
 	}
 
 	private lastGeneratedTitleAndDescription: { title?: string, description?: string, providerTitle: string } | undefined;
@@ -1201,7 +1152,7 @@ Don't forget to commit your template file to the repository so that it can be us
 			try {
 				const templatePromise = this.getPullRequestTemplate(); // Fetch in parallel
 				const { commitMessages, patches } = await this.getCommitsAndPatches();
-				const issues = await this.findIssueContext(commitMessages);
+				const issues = await this.model.findIssueContext(commitMessages);
 				const template = await templatePromise;
 
 				const provider = this._folderRepositoryManager.getTitleAndDescriptionProvider(searchTerm);

src/github/pullRequestOverview.ts

@@ -1022,6 +1022,14 @@ export class PullRequestOverviewPanel extends IssueOverviewPanel<PullRequestMode
 				this.generatingDescriptionCancellationToken.token
 			);
 
+			/* __GDPR__
+				"pr.generatedTitleAndDescription" : {
+					"providerTitle" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
+					"source" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
+				}
+			*/
+			this._telemetry.sendTelemetryEvent('pr.generatedTitleAndDescription', { providerTitle: provider?.title, source: 'regenerate' });
+
 			this.generatingDescriptionCancellationToken = undefined;
 			return this._replyMessage(message, { description: result?.description });
 		} catch (e) {

src/view/createPullRequestDataModel.ts

@@ -11,6 +11,7 @@ import Logger from '../common/logger';
 import { OctokitCommon } from '../github/common';
 import { FolderRepositoryManager } from '../github/folderRepositoryManager';
 import { GitHubRepository } from '../github/githubRepository';
+import { getIssueNumberLabelFromParsed, ISSUE_OR_URL_EXPRESSION, parseIssueExpressionOutput } from '../github/utils';
 
 export interface CreateModelChangeEvent {
 	baseOwner?: string;
@@ -252,4 +253,57 @@ export class CreatePullRequestDataModel extends Disposable {
 		}
 		return this._gitHubMergeBase!;
 	}
+
+	public async getCommitsAndPatches(): Promise<{ commitMessages: string[]; patches: { patch: string; fileUri: string; previousFileUri?: string }[] }> {
+		let commitMessages: string[];
+		let patches: ({ patch: string; fileUri: string; previousFileUri?: string } | undefined)[] | undefined;
+		if (await this.getCompareHasUpstream()) {
+			[commitMessages, patches] = await Promise.all([
+				this.gitHubCommits().then(rawCommits => rawCommits.map(commit => commit.commit.message)),
+				this.gitHubFiles().then(rawPatches => rawPatches?.map(file => {
+					if (!file.patch) {
+						return;
+					}
+					const fileUri = vscode.Uri.joinPath(this.folderRepositoryManager.repository.rootUri, file.filename).toString();
+					const previousFileUri = file.previous_filename ? vscode.Uri.joinPath(this.folderRepositoryManager.repository.rootUri, file.previous_filename).toString() : undefined;
+					return { patch: file.patch, fileUri, previousFileUri };
+				}))]);
+		} else {
+			[commitMessages, patches] = await Promise.all([
+				this.gitCommits().then(rawCommits => rawCommits.filter(commit => commit.parents.length === 1).map(commit => commit.message)),
+				Promise.all((await this.gitFiles()).map(async (file) => {
+					return {
+						patch: await this.folderRepositoryManager.repository.diffBetween(this._baseBranch, this._compareBranch, file.uri.fsPath),
+						fileUri: file.uri.toString(),
+					};
+				}))]);
+		}
+		const filteredPatches: { patch: string; fileUri: string; previousFileUri?: string }[] =
+			patches?.filter<{ patch: string; fileUri: string; previousFileUri?: string }>((patch): patch is { patch: string; fileUri: string; previousFileUri?: string } => !!patch) ?? [];
+		return { commitMessages, patches: filteredPatches };
+	}
+
+	public async findIssueContext(commits: string[]): Promise<{ content: string; reference: string }[] | undefined> {
+		const issues: Promise<{ content: string; reference: string } | undefined>[] = [];
+		for (const commit of commits) {
+			const tryParse = parseIssueExpressionOutput(commit.match(ISSUE_OR_URL_EXPRESSION));
+			if (tryParse) {
+				const owner = tryParse.owner ?? this._baseOwner;
+				const name = tryParse.name ?? this.repositoryName;
+				issues.push(new Promise(resolve => {
+					this.folderRepositoryManager.resolveIssue(owner, name, tryParse.issueNumber).then(issue => {
+						if (issue) {
+							resolve({ content: `${issue.title}\n${issue.body}`, reference: getIssueNumberLabelFromParsed(tryParse) });
+						} else {
+							resolve(undefined);
+						}
+					}).catch(() => resolve(undefined));
+				}));
+			}
+		}
+		if (issues.length) {
+			return (await Promise.all(issues)).filter(issue => !!issue) as { content: string; reference: string }[];
+		}
+		return undefined;
+	}
 }