API for repository description (#7066)

* API for repository description

* Failing

* Test updates

* Review comments

* Revert yarn.lock

* Passing URI to API

* Review comments

* Only use folder manager for the file, api doc

---------

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

Author: osortega

package.json

@@ -3909,7 +3909,7 @@
 				],
 				"toolReferenceName": "activePullRequest",
 				"displayName": "%languageModelTools.github-pull-request_activePullRequest.displayName%",
-				"modelDescription": "Get information about the active or current GitHub pull request (PR). This information includes: comments, files changed, pull request title + description, pull request state, pull request status checks/CI and coding agent session logs if the pull request was opened by Copilot. When asked about the active or current pull request, do this first!",
+				"modelDescription": "Get comprehensive information about the active or current GitHub pull request (PR). This includes the PR title, full description, list of changed files, review comments, PR state, and status checks/CI results. For PRs created by Copilot, it also includes the session logs which indicate the development process and decisions made by the coding agent. When asked about the active or current pull request, do this first! Use this tool for any request related to \"current changes,\" \"pull request details,\" \"what changed,\" \"PR status,\" or similar queries even if the user does not explicitly mention \"pull request.\"",
 				"icon": "$(git-pull-request)",
 				"canBeReferencedInPrompt": true,
 				"userDescription": "%languageModelTools.github-pull-request_activePullRequest.description%",

src/api/api.d.ts

@@ -257,6 +257,18 @@ export interface ReviewerCommentsProvider {
 	provideReviewerComments(context: { repositoryRoot: string, commitMessages: string[], patches: { patch: string, fileUri: string, previousFileUri?: string }[] }, token: CancellationToken): Promise<ReviewerComments>;
 }
 
+export interface RepositoryDescription {
+	owner: string;
+	repositoryName: string;
+	defaultBranch: string;
+	pullRequest?: {
+		title: string;
+		url: string;
+		number: number;
+		id: number;
+	};
+}
+
 export interface API {
 	/**
 	 * Register a [git provider](#IGit)
@@ -280,4 +292,13 @@ export interface API {
 	 * Register a PR reviewer comments provider.
 	 */
 	registerReviewerCommentsProvider(title: string, provider: ReviewerCommentsProvider): Disposable;
+
+	/**
+	 * Get the repository description for a given URI, where the URI is a subpath of one of the workspace folders.
+	 * This includes the owner, repository name, default branch,
+	 * and pull request information (if applicable).
+	 *
+	 * @returns A promise that resolves to a `RepositoryDescription` object or `undefined` if no repository is found.
+	 */
+	getRepositoryDescription(uri: vscode.Uri): Promise<RepositoryDescription | undefined>;
 }

src/api/api1.ts

@@ -8,6 +8,7 @@ import { APIState, PublishEvent } from '../@types/git';
 import { Disposable } from '../common/lifecycle';
 import Logger from '../common/logger';
 import { TernarySearchTree } from '../common/utils';
+import { RepositoriesManager } from '../github/repositoriesManager';
 import { API, IGit, PostCommitCommandsProvider, Repository, ReviewerCommentsProvider, TitleAndDescriptionProvider } from './api';
 
 export const enum RefType {
@@ -78,6 +79,11 @@ export class GitApiImpl extends Disposable implements API, IGit {
 	private static _handlePool: number = 0;
 	private _providers = new Map<number, IGit>();
 
+	public constructor(
+		private readonly repositoriesManager: RepositoriesManager) {
+		super();
+	}
+
 	public get repositories(): Repository[] {
 		const ret: Repository[] = [];
 
@@ -220,4 +226,26 @@ export class GitApiImpl extends Disposable implements API, IGit {
 	getReviewerCommentsProvider(): { title: string, provider: ReviewerCommentsProvider } | undefined {
 		return this._reviewerCommentsProviders.size > 0 ? this._reviewerCommentsProviders.values().next().value : undefined;
 	}
+
+	async getRepositoryDescription(uri: vscode.Uri) {
+		const folderManagerForRepo = this.repositoriesManager.getManagerForFile(uri);
+
+		if (folderManagerForRepo && folderManagerForRepo.gitHubRepositories.length > 0) {
+			const repositoryMetadata = await folderManagerForRepo.gitHubRepositories[0].getMetadata();
+			const pullRequest = folderManagerForRepo.activePullRequest;
+			if (repositoryMetadata) {
+				return {
+					owner: repositoryMetadata.owner.login,
+					repositoryName: repositoryMetadata.name,
+					defaultBranch: repositoryMetadata.default_branch,
+					pullRequest: pullRequest ? {
+						title: pullRequest.title,
+						url: pullRequest.html_url,
+						number: pullRequest.number,
+						id: pullRequest.id
+					} : undefined
+				};
+			}
+		}
+	}
 }

src/extension.ts

@@ -287,14 +287,11 @@ export async function activate(context: vscode.ExtensionContext): Promise<GitApi
 	// initialize resources
 	Resource.initialize(context);
 	Logger.debug('Creating API implementation.', 'Activation');
-	const apiImpl = new GitApiImpl();
 
 	telemetry = new ExperimentationTelemetry(new TelemetryReporter(ingestionKey));
 	context.subscriptions.push(telemetry);
 
-	await deferredActivate(context, apiImpl, showPRController);
-
-	return apiImpl;
+	return await deferredActivate(context, showPRController);
 }
 
 async function setGitSettingContexts(context: vscode.ExtensionContext) {
@@ -378,7 +375,7 @@ async function deferredActivateRegisterBuiltInGitProvider(context: vscode.Extens
 	}
 }
 
-async function deferredActivate(context: vscode.ExtensionContext, apiImpl: GitApiImpl, showPRController: ShowPullRequest) {
+async function deferredActivate(context: vscode.ExtensionContext, showPRController: ShowPullRequest) {
 	Logger.debug('Initializing state.', 'Activation');
 	PersistentState.init(context);
 	await migrate(context);
@@ -392,6 +389,12 @@ async function deferredActivate(context: vscode.ExtensionContext, apiImpl: GitAp
 	const showBadge = (vscode.env.appHost === 'desktop');
 	await credentialStore.create(showBadge ? undefined : { silent: true });
 
+	const reposManager = new RepositoriesManager(credentialStore, telemetry);
+	context.subscriptions.push(reposManager);
+	// API
+	const apiImpl = new GitApiImpl(reposManager);
+	context.subscriptions.push(apiImpl);
+
 	deferredActivateRegisterBuiltInGitProvider(context, apiImpl, credentialStore);
 
 	Logger.debug('Registering live share git provider.', 'Activation');
@@ -402,8 +405,6 @@ async function deferredActivate(context: vscode.ExtensionContext, apiImpl: GitAp
 	context.subscriptions.push(apiImpl);
 
 	Logger.debug('Creating tree view.', 'Activation');
-	const reposManager = new RepositoriesManager(credentialStore, telemetry);
-	context.subscriptions.push(reposManager);
 
 	const copilotRemoteAgentManager = new CopilotRemoteAgentManager(credentialStore, reposManager);
 	context.subscriptions.push(copilotRemoteAgentManager);
@@ -432,6 +433,7 @@ async function deferredActivate(context: vscode.ExtensionContext, apiImpl: GitAp
 	context.subscriptions.push(vscode.workspace.registerFileSystemProvider(Schemes.Pr, inMemPRFileSystemProvider, { isReadonly: readOnlyMessage }));
 
 	await init(context, apiImpl, credentialStore, repositories, prTree, liveshareApiPromise, showPRController, reposManager, createPrHelper, copilotRemoteAgentManager);
+	return apiImpl;
 }
 
 export async function deactivate() {

src/test/github/folderRepositoryManager.test.ts

@@ -22,6 +22,7 @@ import { MockExtensionContext } from '../mocks/mockExtensionContext';
 import { Uri } from 'vscode';
 import { GitHubServerType } from '../../common/authentication';
 import { CreatePullRequestHelper } from '../../view/createPullRequestHelper';
+import { RepositoriesManager } from '../../github/repositoriesManager';
 
 describe('PullRequestManager', function () {
 	let sinon: SinonSandbox;
@@ -36,7 +37,8 @@ describe('PullRequestManager', function () {
 		const repository = new MockRepository();
 		const context = new MockExtensionContext();
 		const credentialStore = new CredentialStore(telemetry, context);
-		manager = new FolderRepositoryManager(0, context, repository, telemetry, new GitApiImpl(), credentialStore, new CreatePullRequestHelper());
+		const repositoriesManager = new RepositoriesManager(credentialStore, telemetry);
+		manager = new FolderRepositoryManager(0, context, repository, telemetry, new GitApiImpl(repositoriesManager), credentialStore, new CreatePullRequestHelper());
 	});
 
 	afterEach(function () {

src/test/github/pullRequestOverview.test.ts

@@ -24,6 +24,7 @@ import { GitHubServerType } from '../../common/authentication';
 import { GitHubRemote } from '../../common/remote';
 import { CheckState } from '../../github/interface';
 import { CreatePullRequestHelper } from '../../view/createPullRequestHelper';
+import { RepositoriesManager } from '../../github/repositoriesManager';
 
 const EXTENSION_URI = vscode.Uri.joinPath(vscode.Uri.file(__dirname), '../../..');
 
@@ -45,7 +46,8 @@ describe('PullRequestOverview', function () {
 		telemetry = new MockTelemetry();
 		credentialStore = new CredentialStore(telemetry, context);
 		const createPrHelper = new CreatePullRequestHelper();
-		pullRequestManager = new FolderRepositoryManager(0, context, repository, telemetry, new GitApiImpl(), credentialStore, createPrHelper);
+		const repositoriesManager = new RepositoriesManager(credentialStore, telemetry);
+		pullRequestManager = new FolderRepositoryManager(0, context, repository, telemetry, new GitApiImpl(repositoriesManager), credentialStore, createPrHelper);
 
 		const url = 'https://github.com/aaa/bbb';
 		remote = new GitHubRemote('origin', url, new Protocol(url), GitHubServerType.GitHubDotCom);

src/test/view/prsTree.test.ts

@@ -103,7 +103,7 @@ describe('GitHub Pull Requests view', function () {
 	it('has no children when repositories have not yet been initialized', async function () {
 		const repository = new MockRepository();
 		repository.addRemote('origin', 'git@github.com:aaa/bbb');
-		reposManager.insertFolderManager(new FolderRepositoryManager(0, context, repository, telemetry, new GitApiImpl(), credentialStore, createPrHelper));
+		reposManager.insertFolderManager(new FolderRepositoryManager(0, context, repository, telemetry, new GitApiImpl(reposManager), credentialStore, createPrHelper));
 		provider.initialize([], credentialStore);
 
 		const rootNodes = await provider.getChildren();
@@ -113,7 +113,7 @@ describe('GitHub Pull Requests view', function () {
 	it('opens the viewlet and displays the default categories', async function () {
 		const repository = new MockRepository();
 		repository.addRemote('origin', 'git@github.com:aaa/bbb');
-		reposManager.insertFolderManager(new FolderRepositoryManager(0, context, repository, telemetry, new GitApiImpl(), credentialStore, createPrHelper));
+		reposManager.insertFolderManager(new FolderRepositoryManager(0, context, repository, telemetry, new GitApiImpl(reposManager), credentialStore, createPrHelper));
 		sinon.stub(credentialStore, 'isAuthenticated').returns(true);
 		await reposManager.folderManagers[0].updateRepositories();
 		provider.initialize([], credentialStore);
@@ -183,7 +183,7 @@ describe('GitHub Pull Requests view', function () {
 
 			await repository.createBranch('non-pr-branch', false);
 
-			const manager = new FolderRepositoryManager(0, context, repository, telemetry, new GitApiImpl(), credentialStore, createPrHelper);
+			const manager = new FolderRepositoryManager(0, context, repository, telemetry, new GitApiImpl(reposManager), credentialStore, createPrHelper);
 			reposManager.insertFolderManager(manager);
 			sinon.stub(manager, 'createGitHubRepository').callsFake((r, cs) => {
 				assert.deepStrictEqual(r, remote);

src/test/view/reviewCommentController.test.ts

@@ -80,7 +80,7 @@ describe('ReviewCommentController', function () {
 		const activePrViewCoordinator = new WebviewViewCoordinator(context);
 		const createPrHelper = new CreatePullRequestHelper();
 		Resource.initialize(context);
-		gitApiImpl = new GitApiImpl();
+		gitApiImpl = new GitApiImpl(reposManager);
 		manager = new FolderRepositoryManager(0, context, repository, telemetry, gitApiImpl, credentialStore, createPrHelper);
 		reposManager.insertFolderManager(manager);
 		const tree = new PullRequestChangesTreeDataProvider(gitApiImpl, reposManager);