Skip to content
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

Increase number of commits checked for squash merge #866

Merged
merged 11 commits into from
Dec 7, 2023
Merged

Increase number of commits checked for squash merge #866

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
618fe2e
Refactored squash merge detection to run after git tracing
tmeasday Nov 28, 2023
9534865
Update code to check all visited commits
tmeasday Nov 28, 2023
b6e5772
use new query for looking up multiple merged pull requests
tevanoff Nov 30, 2023
bbdf7d9
rename
tevanoff Dec 1, 2023
7bc27a9
limit amount sent in API request
tevanoff Dec 1, 2023
194e9a7
add some tests
tevanoff Dec 1, 2023
eb76c00
fix name
tevanoff Dec 4, 2023
ac447d0
add new test
tevanoff Dec 5, 2023
84f11f8
allow for commits that no longer exist in the history
tevanoff Dec 5, 2023
b9cf522
tweak tests
tevanoff Dec 5, 2023
026df68
remove erroneous comment
tevanoff Dec 5, 2023
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
176 changes: 172 additions & 4 deletions node-src/git/getParentCommits.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import generateGitRepository from './generateGitRepository';

import longLineDescription from './mocks/long-line';
import longLoopDescription from './mocks/long-loop';
import doubleLoopDescription from './mocks/double-loop';
import createMockIndex from './mocks/mock-index';
import simpleLoopDescription from './mocks/simple-loop';
import threeParentsDescription from './mocks/three-parents';
Expand All @@ -19,6 +20,7 @@ const descriptions = {
simpleLoop: simpleLoopDescription,
longLine: longLineDescription,
longLoop: longLoopDescription,
doubleLoop: doubleLoopDescription,
threeParents: threeParentsDescription,
twoRoots: twoRootsDescription,
};
Expand Down Expand Up @@ -49,7 +51,7 @@ function createClient({
}

function expectCommitsToEqualNames(hashes, names, { commitMap }) {
return expect(hashes).toEqual(names.map((n) => commitMap[n].hash));
return expect(hashes).toEqual(names.map((name) => commitMap[name]?.hash || name));
}

async function checkoutCommit(name, branch, { dirname, runGit, commitMap }) {
Expand Down Expand Up @@ -133,7 +135,7 @@ describe('getParentCommits', () => {
repository,
builds: [
['D', 'main'],
['E', 'main'],
['E', 'branch'],
],
});
const git = { branch: 'main', ...(await getCommit()) };
Expand Down Expand Up @@ -615,11 +617,11 @@ describe('getParentCommits', () => {
it(`also includes PR head commits that were squashed to this commit`, async () => {
//
//
// [D] [branch, squash merged into E]
// [D] [branch, squash merged into E]
// / \
// A - B -[C] F
// \ /
// [E] [main]
// (E) [main]
const repository = repositories.simpleLoop;
await checkoutCommit('E', 'main', repository);
const client = createClient({
Expand All @@ -637,5 +639,171 @@ describe('getParentCommits', () => {
// This doesn't include 'C' as D "covers" it.
expectCommitsToEqualNames(parentCommits, ['D'], repository);
});

it(`also finds squash merge commits that were on previous commits without builds`, async () => {
// []: has build, <>: is squash merge, (): current commit
//
// B -[D] [branch]
// /
// A -[C]-<E>-(G) [main]
const repository = repositories.longLoop;
await checkoutCommit('G', 'main', repository);
const client = createClient({
repository,
builds: [
['C', 'main'],
['D', 'branch'],
],
// Talking to GH (etc) tells us that commit E is the merge commit for "branch"
prs: [['E', 'branch']],
});
const git = { branch: 'main', ...(await getCommit()) };

const parentCommits = await getParentCommits({ client, log, git, options } as any);
expectCommitsToEqualNames(parentCommits, ['D', 'C'], repository);
});

it(`deals with situations where the last build on the squashed branch isn't the last commit`, async () => {
tevanoff marked this conversation as resolved.
Show resolved Hide resolved
// []: has build, <>: is squash merge, (): current commit
//
// [B]- D [branch]
// /
// A -[C]-<E>-(G) [main]
const repository = repositories.longLoop;
await checkoutCommit('G', 'main', repository);
const client = createClient({
repository,
builds: [
['C', 'main'],
['B', 'branch'],
],
// Talking to GH (etc) tells us that commit E is the merge commit for "branch"
prs: [['E', 'branch']],
});
const git = { branch: 'main', ...(await getCommit()) };

const parentCommits = await getParentCommits({ client, log, git, options } as any);
expectCommitsToEqualNames(parentCommits, ['C', 'B'], repository);
});

it(`occludes commits that have a more recent build on a squashed branch`, async () => {
// []: has build, <>: is squash merge, (): current commit
//
// [B]- D [branch]
// /
// [A]- C -<E>-(G) [main]
const repository = repositories.longLoop;
await checkoutCommit('G', 'main', repository);
const client = createClient({
repository,
builds: [
['A', 'main'],
['B', 'branch'],
],
// Talking to GH (etc) tells us that commit E is the merge commit for "branch"
prs: [['E', 'branch']],
});
const git = { branch: 'main', ...(await getCommit()) };

const parentCommits = await getParentCommits({ client, log, git, options } as any);
// This doesn't include A as B "covers" it.
expectCommitsToEqualNames(parentCommits, ['B'], repository);
});

it(`deals with situations where squashed branches have no builds`, async () => {
// []: has build, <>: is squash merge, (): current commit
//
// B - D [branch]
// /
// A -[C]-<E>-(G) [main]
const repository = repositories.longLoop;
await checkoutCommit('G', 'main', repository);
const client = createClient({
repository,
builds: [
['C', 'main'],
],
// Talking to GH (etc) tells us that commit E is the merge commit for "branch"
prs: [['E', 'branch']],
});
const git = { branch: 'main', ...(await getCommit()) };

const parentCommits = await getParentCommits({ client, log, git, options } as any);
expectCommitsToEqualNames(parentCommits, ['C'], repository);
});

it(`deals with situations where squashed branches no longer exist in the repo but have a build`, async () => {
// []: has build, <>: is squash merge, (): current commit
//
// [MISSING] [no longer in repo]
//
// [A]- C -<(D)> [main]
const repository = repositories.twoRoots;
await checkoutCommit('D', 'main', repository);
const client = createClient({
repository,
builds: [
['A', 'main'],
['MISSING', 'branch'],
],
// Talking to GH (etc) tells us that commit D is the merge commit for "branch" (which no longer exists)
prs: [['D', 'branch']],
});
const git = { branch: 'main', ...(await getCommit()) };

const parentCommits = await getParentCommits({ client, log, git, options } as any);
expectCommitsToEqualNames(parentCommits, ['MISSING', 'A'], repository);
});

// We could support this situation via recursing and doing a second (etc) check for squash merge commits,
// but that would make things a lot more complex and this situation seems quite unlikely and is easily avoided
// by ensuring you run a build for E.
it(`does not find parents for commits on a squashed branch that are themselves squash merge commits`, async () => {
// []: has build, <>: is squash merge, (): current commit
//
// [F] [branch2]
// /
// [C]-<E> [branch]
// /
// A -[B]-<D>- G [main]
const repository = repositories.doubleLoop;
await checkoutCommit('G', 'main', repository);
const client = createClient({
repository,
builds: [
['B', 'main'],
['C', 'branch'],
['F', 'branch2'],
],
// Talking to GH (etc) tells us that commit G is the merge commit for "branch"
prs: [['D', 'branch'], ['E', 'branch2']],
});
const git = { branch: 'main', ...(await getCommit()) };

const parentCommits = await getParentCommits({ client, log, git, options } as any);
expectCommitsToEqualNames(parentCommits, ['C', 'B'], repository);
});

it(`does not affect finding a merge commit's parents (in correct order) when they already have a build`, async () => {
// []: has build, <>: is squash merge, (): current commit
// A - B - C -[D]-(F) [main]
// \ /
// [E] [branch]
const repository = repositories.simpleLoop;
await checkoutCommit('F', 'main', repository);
const client = createClient({
repository,
builds: [
['D', 'main'],
['E', 'branch'],
],
// Talking to GH (etc) tells us that commit F is the merge commit for "branch"
prs: [['F', 'branch']],
});
const git = { branch: 'main', ...(await getCommit()) };

const parentCommits = await getParentCommits({ client, log, git, options } as any);
expectCommitsToEqualNames(parentCommits, ['E', 'D'], repository);
});
});
});
Loading
Loading