Resolve insteadOf URL aliases in remaining remote-parsing call sites (#8754)

* Initial plan

* Apply insteadOf alias resolution in remaining remote parse callers

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

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>

Author: Copilot

src/github/folderRepositoryManager.ts

@@ -38,7 +38,7 @@ import { stripCoAuthoredByTrailers, unwrapCommitMessageBody } from '../common/gi
 import { Disposable, disposeAll } from '../common/lifecycle';
 import Logger from '../common/logger';
 import { Protocol, ProtocolType } from '../common/protocol';
-import { GitHubRemote, parseRemote, parseRepositoryRemotes, parseRepositoryRemotesAsync, Remote } from '../common/remote';
+import { GitHubRemote, parseRemote, parseRepositoryRemotesAsync, Remote } from '../common/remote';
 import {
 	ALLOW_FETCH,
 	AUTO_STASH,
@@ -2915,7 +2915,7 @@ export class FolderRepositoryManager extends Disposable {
 			Logger.debug(`Skipping inaccessible repository: ${owner}/${repositoryName}`, this.id);
 			return undefined;
 		}
-		const gitRemotes = parseRepositoryRemotes(this.repository);
+		const gitRemotes = await parseRepositoryRemotesAsync(this.repository);
 		const gitRemote = gitRemotes.find(r => r.owner === owner && r.repositoryName === repositoryName);
 		const uri = gitRemote?.url ?? `https://github.com/${owner}/${repositoryName}`;
 		const repo = await this.createAndAddGitHubRepository(new Remote(gitRemote?.remoteName ?? repositoryName, uri, new Protocol(uri)), this._credentialStore);

src/github/pullRequestGitHelper.ts

@@ -11,7 +11,7 @@ import { IResolvedPullRequestModel, PullRequestModel } from './pullRequestModel'
 import { Branch, Repository } from '../api/api';
 import Logger from '../common/logger';
 import { Protocol } from '../common/protocol';
-import { parseRepositoryRemotes, Remote } from '../common/remote';
+import { parseRepositoryRemotesAsync, Remote } from '../common/remote';
 import { PR_SETTINGS_NAMESPACE, PULL_PR_BRANCH_BEFORE_CHECKOUT, PullPRBranchVariants } from '../common/settingKeys';
 
 const PullRequestRemoteMetadataKey = 'github-pr-remote';
@@ -343,14 +343,14 @@ export class PullRequestGitHelper {
 	static async createRemote(repository: Repository, baseRemote: Remote, cloneUrl: Protocol) {
 		Logger.appendLine(`create remote for ${cloneUrl}.`, PullRequestGitHelper.ID);
 
-		const remotes = parseRepositoryRemotes(repository);
+		const remotes = await parseRepositoryRemotesAsync(repository);
 		for (const remote of remotes) {
 			if (new Protocol(remote.url).equals(cloneUrl)) {
 				return remote.remoteName;
 			}
 		}
 
-		const remoteName = PullRequestGitHelper.getUniqueRemoteName(repository, cloneUrl.owner);
+		const remoteName = await PullRequestGitHelper.getUniqueRemoteName(repository, cloneUrl.owner);
 		cloneUrl.update({
 			type: baseRemote.gitProtocol.type,
 		});
@@ -390,10 +390,10 @@ export class PullRequestGitHelper {
 		return result;
 	}
 
-	static getUniqueRemoteName(repository: Repository, name: string) {
+	static async getUniqueRemoteName(repository: Repository, name: string) {
 		let uniqueName = name;
 		let number = 1;
-		const remotes = parseRepositoryRemotes(repository);
+		const remotes = await parseRepositoryRemotesAsync(repository);
 
 		// eslint-disable-next-line no-loop-func
 		while (remotes.find(e => e.remoteName === uniqueName)) {

src/issues/stateManager.ts

@@ -9,7 +9,7 @@ import { CurrentIssue } from './currentIssue';
 import { Repository } from '../api/api';
 import { GitApiImpl } from '../api/api1';
 import { AuthProvider } from '../common/authentication';
-import { parseRepositoryRemotes } from '../common/remote';
+import { parseRepositoryRemotesAsync } from '../common/remote';
 import {
 	DEFAULT,
 	DEV_MODE,
@@ -321,7 +321,7 @@ export class StateManager {
 			return;
 		}
 		singleRepoState.issueCollection.clear();
-		const enterpriseRemotes = parseRepositoryRemotes(folderManager.repository).filter(
+		const enterpriseRemotes = (await parseRepositoryRemotesAsync(folderManager.repository)).filter(
 			remote => remote.isEnterprise
 		);
 		const user = await this.getCurrentUser(enterpriseRemotes.length ? AuthProvider.githubEnterprise : AuthProvider.github);

src/test/common/remote.test.ts

@@ -0,0 +1,53 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { default as assert } from 'assert';
+import { parseRepositoryRemotesAsync } from '../../common/remote';
+import { MockRepository } from '../mocks/mockRepository';
+
+describe('parseRepositoryRemotesAsync', () => {
+	it('resolves a remote URL using a global "url.<base>.insteadOf" alias', async () => {
+		const repository = new MockRepository();
+		// Simulate `git config url."https://github.abc.com/".insteadOf github:`
+		await repository.setConfig('url.https://github.abc.com/.insteadof', 'github:');
+		// And a remote stored as `github:org/repo` (as returned by `git config --get remote.origin.url`
+		// when the user clones with `git clone github:org/repo`).
+		await repository.addRemote('origin', 'github:org/repo');
+
+		const remotes = await parseRepositoryRemotesAsync(repository);
+
+		assert.strictEqual(remotes.length, 1);
+		assert.strictEqual(remotes[0].remoteName, 'origin');
+		assert.strictEqual(remotes[0].host, 'github.abc.com');
+		assert.strictEqual(remotes[0].owner, 'org');
+		assert.strictEqual(remotes[0].repositoryName, 'repo');
+	});
+
+	it('applies the longest matching insteadOf prefix when multiple match', async () => {
+		const repository = new MockRepository();
+		await repository.setConfig('url.https://short.example.com/.insteadof', 'gh:');
+		await repository.setConfig('url.https://long.example.com/.insteadof', 'gh:org/');
+		await repository.addRemote('origin', 'gh:org/repo');
+
+		const remotes = await parseRepositoryRemotesAsync(repository);
+
+		assert.strictEqual(remotes.length, 1);
+		assert.strictEqual(remotes[0].host, 'long.example.com');
+		assert.strictEqual(remotes[0].repositoryName, 'repo');
+	});
+
+	it('leaves URLs unchanged when no insteadOf alias matches', async () => {
+		const repository = new MockRepository();
+		await repository.setConfig('url.https://github.abc.com/.insteadof', 'github:');
+		await repository.addRemote('origin', 'https://github.com/owner/repo');
+
+		const remotes = await parseRepositoryRemotesAsync(repository);
+
+		assert.strictEqual(remotes.length, 1);
+		assert.strictEqual(remotes[0].host, 'github.com');
+		assert.strictEqual(remotes[0].owner, 'owner');
+		assert.strictEqual(remotes[0].repositoryName, 'repo');
+	});
+});