fix(web): gate merge button on required_reviews so it matches GitHub (#993)
* fix(web): gate merge button on required_reviews so it matches GitHub GitHub's mergeable_state can lag branch-protection state (dismissed approvals, fresh-commit invalidations, partial polls), letting the green merge button appear when GitHub itself still says blocked. isPRReadyToMerge now refuses to surface the button when the recorded approval count is below required_reviews, mirroring the "K / M required" pair the CI popover already renders. isPRAwaitingReview follows the same gate so the icon shows sky-blue "awaiting review" instead of plain green when approvals are short. * test(web): cover bug-repro path in getPRStatusColor + trim guard comments Address Claude review on #993: trim the two new multi-line guard comments in isPRReadyToMerge / isPRAwaitingReview to one short line each (per CLAUDE.md), and add a getPRStatusColor regression test that confirms the icon downgrades from emerald to sky-400 in the stale-clean + unmet required_reviews scenario the PR fixes. * chore(web): collapse required_reviews guard comment to one line Final pass on CLAUDE.md's one-short-line-max comment rule, per Claude review thread on #993. --------- Co-authored-by: Kandev Agent <agent@kandev.dev>
This commit is contained in:
@@ -41,6 +41,8 @@ function makePR(overrides: Partial<TaskPR> = {}): TaskPR {
|
||||
};
|
||||
}
|
||||
|
||||
const SKY_400 = "text-sky-400";
|
||||
|
||||
describe("isPRReadyToMerge", () => {
|
||||
it("is true when open + approved + success + clean", () => {
|
||||
expect(
|
||||
@@ -140,6 +142,57 @@ describe("isPRReadyToMerge", () => {
|
||||
);
|
||||
});
|
||||
|
||||
describe("isPRReadyToMerge — required_reviews gate", () => {
|
||||
it("is false when required_reviews is unmet even if mergeable_state is clean", () => {
|
||||
// GitHub's stored mergeable_state can lag branch-protection state (e.g.
|
||||
// after a dismissed approval); the required_reviews gate guarantees the
|
||||
// button matches GitHub's merge box.
|
||||
expect(
|
||||
isPRReadyToMerge(
|
||||
makePR({
|
||||
state: "open",
|
||||
review_state: "approved",
|
||||
checks_state: "success",
|
||||
mergeable_state: "clean",
|
||||
required_reviews: 2,
|
||||
review_count: 1,
|
||||
}),
|
||||
),
|
||||
).toBe(false);
|
||||
});
|
||||
|
||||
it("is true when required_reviews equals review_count and everything else is clean", () => {
|
||||
expect(
|
||||
isPRReadyToMerge(
|
||||
makePR({
|
||||
state: "open",
|
||||
review_state: "approved",
|
||||
checks_state: "success",
|
||||
mergeable_state: "clean",
|
||||
required_reviews: 2,
|
||||
review_count: 2,
|
||||
}),
|
||||
),
|
||||
).toBe(true);
|
||||
});
|
||||
|
||||
it("is true when required_reviews is zero (protected branch with no approval requirement)", () => {
|
||||
expect(
|
||||
isPRReadyToMerge(
|
||||
makePR({
|
||||
state: "open",
|
||||
review_state: "",
|
||||
checks_state: "success",
|
||||
mergeable_state: "clean",
|
||||
required_reviews: 0,
|
||||
review_count: 0,
|
||||
pending_review_count: 0,
|
||||
}),
|
||||
),
|
||||
).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe("getPRStatusColor", () => {
|
||||
it("returns ready-to-merge color when all conditions are met", () => {
|
||||
const pr = makePR({
|
||||
@@ -172,7 +225,22 @@ describe("getPRStatusColor", () => {
|
||||
mergeable_state: "blocked",
|
||||
pending_review_count: 1,
|
||||
});
|
||||
expect(getPRStatusColor(pr)).toBe("text-sky-400");
|
||||
expect(getPRStatusColor(pr)).toBe(SKY_400);
|
||||
});
|
||||
|
||||
it("returns sky-400 when required_reviews is unmet but mergeable_state is clean (bug repro)", () => {
|
||||
// The stale-snapshot bug: GitHub still reports mergeable_state="clean" while
|
||||
// branch protection has recorded one fewer approval than required. The icon
|
||||
// must downgrade to "awaiting review" instead of the emerald "ready to merge".
|
||||
const pr = makePR({
|
||||
state: "open",
|
||||
review_state: "approved",
|
||||
checks_state: "success",
|
||||
mergeable_state: "clean",
|
||||
required_reviews: 2,
|
||||
review_count: 1,
|
||||
});
|
||||
expect(getPRStatusColor(pr)).toBe(SKY_400);
|
||||
});
|
||||
|
||||
it("returns plain green when mergeable_state is empty (backfilled row)", () => {
|
||||
@@ -193,7 +261,7 @@ describe("getPRStatusColor", () => {
|
||||
mergeable_state: "clean",
|
||||
pending_review_count: 2,
|
||||
});
|
||||
expect(getPRStatusColor(pr)).toBe("text-sky-400");
|
||||
expect(getPRStatusColor(pr)).toBe(SKY_400);
|
||||
});
|
||||
|
||||
it("returns sky-400 when CI passed and reviewers are requested but no review state set", () => {
|
||||
@@ -204,7 +272,7 @@ describe("getPRStatusColor", () => {
|
||||
mergeable_state: "blocked",
|
||||
pending_review_count: 1,
|
||||
});
|
||||
expect(getPRStatusColor(pr)).toBe("text-sky-400");
|
||||
expect(getPRStatusColor(pr)).toBe(SKY_400);
|
||||
});
|
||||
|
||||
it("returns emerald when CI passed and no reviewers are required", () => {
|
||||
@@ -299,6 +367,23 @@ describe("isPRAwaitingReview", () => {
|
||||
),
|
||||
).toBe(false);
|
||||
});
|
||||
|
||||
it("is true when required_reviews is unmet even with no pending reviewers", () => {
|
||||
// 1 of 2 approvals; the second reviewer is no longer requested but branch
|
||||
// protection still demands two approvals — surface as awaiting review.
|
||||
expect(
|
||||
isPRAwaitingReview(
|
||||
makePR({
|
||||
state: "open",
|
||||
review_state: "approved",
|
||||
checks_state: "success",
|
||||
pending_review_count: 0,
|
||||
required_reviews: 2,
|
||||
review_count: 1,
|
||||
}),
|
||||
),
|
||||
).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe("aggregatePRStatusColor", () => {
|
||||
|
||||
@@ -24,6 +24,10 @@ export function isPRReadyToMerge(pr: TaskPR): boolean {
|
||||
if (pr.state !== "open") return false;
|
||||
if (pr.checks_state !== "success") return false;
|
||||
if (pr.mergeable_state !== "clean") return false;
|
||||
// Guard against stale mergeable_state: enforce required_reviews to match GitHub's gate.
|
||||
if (pr.required_reviews != null && pr.review_count < pr.required_reviews) {
|
||||
return false;
|
||||
}
|
||||
if (pr.review_state === "approved") return true;
|
||||
// No review process: no requested reviewers and no submitted reviews. GitHub
|
||||
// sets mergeable_state=clean when branch protection is satisfied, so this
|
||||
@@ -39,6 +43,10 @@ export function isPRReadyToMerge(pr: TaskPR): boolean {
|
||||
export function isPRAwaitingReview(pr: TaskPR): boolean {
|
||||
if (pr.state !== "open") return false;
|
||||
if (pr.checks_state !== "success") return false;
|
||||
// Shortfall is "awaiting review" even when no reviewer is currently requested.
|
||||
if (pr.required_reviews != null && pr.review_count < pr.required_reviews) {
|
||||
return true;
|
||||
}
|
||||
if (pr.review_state === "approved") return pr.pending_review_count > 0;
|
||||
return pr.review_state === "pending" || pr.pending_review_count > 0;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user