Skip to content

Fix duplicate entries in .git/config for GitHub PRs #8876

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Alex Ross (alexr00) merged 4 commits into from
Aug 12, 2026
+94 −2
Merged

Fix duplicate entries in .git/config for GitHub PRs #8876

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
911750d
Initial plan
Copilot Aug 5, 2026
94a21f9
Prevent duplicate PR config entries
Copilot Aug 5, 2026
4fca727
Serialize PR config updates
Copilot Aug 11, 2026
83a0c92
Attestation commit
alexr00 Aug 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 36 additions & 2 deletions src/github/pullRequestGitHelper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ export type BranchInfo = {

export class PullRequestGitHelper {
static ID = 'PullRequestGitHelper';
private static readonly configUpdates = new WeakMap<Repository, Map<string, Promise<void>>>();

static async checkoutFromFork(
repository: Repository,
pullRequest: PullRequestModel & IResolvedPullRequestModel,
Expand Down Expand Up @@ -307,6 +309,38 @@ export class PullRequestGitHelper {
return `${owner}#${repository}#${baseBranch}`;
}

private static async setConfig(repository: Repository, key: string, value: string): Promise<void> {
let repositoryUpdates = PullRequestGitHelper.configUpdates.get(repository);
if (!repositoryUpdates) {
repositoryUpdates = new Map();
PullRequestGitHelper.configUpdates.set(repository, repositoryUpdates);
}

const previousUpdate = repositoryUpdates.get(key);
const update = (previousUpdate ? previousUpdate.catch(() => undefined) : Promise.resolve()).then(async () => {
const existingConfigs = (await repository.getConfigs()).filter(config => config.key === key);
if (existingConfigs.some(config => config.value === value)) {
return;
}
Comment thread
alexr00 marked this conversation as resolved.
if (existingConfigs.length === 1 && repository.unsetConfig) {
await repository.unsetConfig(key);
}
await repository.setConfig(key, value);
});
repositoryUpdates.set(key, update);

try {
await update;
} finally {
if (repositoryUpdates.get(key) === update) {
repositoryUpdates.delete(key);
if (!repositoryUpdates.size) {
PullRequestGitHelper.configUpdates.delete(repository);
}
}
}
}

static parsePullRequestMetadata(value: string): PullRequestMetadata | undefined {
if (value) {
const matches = /(.*)#(.*)#(.*)/g.exec(value);
Expand Down Expand Up @@ -434,7 +468,7 @@ export class PullRequestGitHelper {
}
const prConfigKey = `branch.${branchName}.${PullRequestMetadataKey}`;
if (pullRequest) {
await repository.setConfig(prConfigKey, PullRequestGitHelper.buildPullRequestMetadata(pullRequest));
await PullRequestGitHelper.setConfig(repository, prConfigKey, PullRequestGitHelper.buildPullRequestMetadata(pullRequest));
} else if (repository.unsetConfig) {
await repository.unsetConfig(prConfigKey);
}
Expand All @@ -458,7 +492,7 @@ export class PullRequestGitHelper {
const prConfigKey = `branch.${branch}.${BaseBranchMetadataKey}`;
if (base) {
Logger.appendLine(`associate ${branch} with base branch ${base.owner}/${base.repo}#${base.branch}`, PullRequestGitHelper.ID);
await repository.setConfig(prConfigKey, PullRequestGitHelper.buildBaseBranchMetadata(base.owner, base.repo, base.branch));
await PullRequestGitHelper.setConfig(repository, prConfigKey, PullRequestGitHelper.buildBaseBranchMetadata(base.owner, base.repo, base.branch));
} else if (repository.unsetConfig) {
await repository.unsetConfig(prConfigKey);
const vscodeBaseBranchConfigKey = `branch.${branch}.${VscodeBaseBranchMetadataKey}`;
Expand Down
58 changes: 58 additions & 0 deletions src/test/github/pullRequestGitHelper.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,64 @@ describe('PullRequestGitHelper', function () {
});
});

describe('associateBranchWithPullRequest', function () {
const pullRequest = (number: number) => ({
number,
base: {
repositoryCloneUrl: {
owner: 'owner',
repositoryName: 'name',
},
},
}) as PullRequestModel;

it('replaces pull request metadata instead of appending values', async function () {
await PullRequestGitHelper.associateBranchWithPullRequest(repository, pullRequest(100), 'feature');
await PullRequestGitHelper.associateBranchWithPullRequest(repository, pullRequest(100), 'feature');
await PullRequestGitHelper.associateBranchWithPullRequest(repository, pullRequest(101), 'feature');

const key = 'branch.feature.github-pr-owner-number';
assert.deepStrictEqual((await repository.getConfigs()).filter(config => config.key === key), [
{ key, value: 'owner#name#101' },
]);
});

it('does not append metadata during concurrent associations', async function () {
await Promise.all([
PullRequestGitHelper.associateBranchWithPullRequest(repository, pullRequest(100), 'feature'),
PullRequestGitHelper.associateBranchWithPullRequest(repository, pullRequest(100), 'feature'),
]);

const key = 'branch.feature.github-pr-owner-number';
assert.deepStrictEqual((await repository.getConfigs()).filter(config => config.key === key), [
{ key, value: 'owner#name#100' },
]);
});

it('does not append to existing duplicate metadata', async function () {
const key = 'branch.feature.github-pr-owner-number';
await repository.setConfig(key, 'owner#name#100');
await repository.setConfig(key, 'owner#name#100');

await PullRequestGitHelper.associateBranchWithPullRequest(repository, pullRequest(100), 'feature');

assert.strictEqual((await repository.getConfigs()).filter(config => config.key === key).length, 2);
});
});

describe('associateBaseBranchWithBranch', function () {
it('replaces base branch metadata instead of appending values', async function () {
await PullRequestGitHelper.associateBaseBranchWithBranch(repository, 'feature', { owner: 'owner', repo: 'name', branch: 'main' });
await PullRequestGitHelper.associateBaseBranchWithBranch(repository, 'feature', { owner: 'owner', repo: 'name', branch: 'main' });
await PullRequestGitHelper.associateBaseBranchWithBranch(repository, 'feature', { owner: 'owner', repo: 'name', branch: 'next' });

const key = 'branch.feature.github-pr-base-branch';
assert.deepStrictEqual((await repository.getConfigs()).filter(config => config.key === key), [
{ key, value: 'owner#name#next' },
]);
});
});

describe('getMatchingPullRequestMetadataForBranch', function () {
it('returns the highest-numbered PR when duplicate config entries exist for the branch', async function () {
// Simulate the case where a branch name has been associated with multiple
Expand Down
Loading