From db5999a61851f11e8223d127d7b3f0b532226682 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20Flor=C3=AAncio?= Date: Sat, 25 Apr 2026 18:21:59 +0100 Subject: [PATCH] feat(web): distinguish CI-passed PRs awaiting review from ready-to-merge (#702) --- .../my-github/use-saved-presets.test.ts | 28 +++- .../components/github/pr-task-icon.test.ts | 133 +++++++++++++++++- apps/web/components/github/pr-task-icon.tsx | 29 ++-- 3 files changed, 176 insertions(+), 14 deletions(-) diff --git a/apps/web/components/github/my-github/use-saved-presets.test.ts b/apps/web/components/github/my-github/use-saved-presets.test.ts index e0bb69daf0..833917c4a4 100644 --- a/apps/web/components/github/my-github/use-saved-presets.test.ts +++ b/apps/web/components/github/my-github/use-saved-presets.test.ts @@ -1,11 +1,31 @@ -import { describe, it, expect, beforeEach } from "vitest"; +import { describe, it, expect, beforeEach, vi } from "vitest"; import { readStorage, type SavedPreset } from "./use-saved-presets"; const STORAGE_KEY = "kandev:github-presets:v1"; +// Provide a simple in-memory localStorage mock so the tests are not sensitive +// to how the test runner exposes window.localStorage (e.g. Node's +// --localstorage-file flag without a valid path). +function makeLocalStorageMock() { + const store = new Map(); + return { + getItem: (key: string) => store.get(key) ?? null, + setItem: (key: string, value: string) => store.set(key, value), + removeItem: (key: string) => store.delete(key), + clear: () => store.clear(), + get length() { + return store.size; + }, + key: (index: number) => Array.from(store.keys())[index] ?? null, + }; +} + +const localStorageMock = makeLocalStorageMock(); +vi.stubGlobal("localStorage", localStorageMock); + function set(raw: string | null) { - if (raw === null) window.localStorage.removeItem(STORAGE_KEY); - else window.localStorage.setItem(STORAGE_KEY, raw); + if (raw === null) localStorageMock.removeItem(STORAGE_KEY); + else localStorageMock.setItem(STORAGE_KEY, raw); } const valid: SavedPreset = { @@ -19,7 +39,7 @@ const valid: SavedPreset = { describe("readStorage", () => { beforeEach(() => { - window.localStorage.clear(); + localStorageMock.clear(); }); it("returns empty array when no value is stored", () => { diff --git a/apps/web/components/github/pr-task-icon.test.ts b/apps/web/components/github/pr-task-icon.test.ts index 4a87a8b896..b9e438efcb 100644 --- a/apps/web/components/github/pr-task-icon.test.ts +++ b/apps/web/components/github/pr-task-icon.test.ts @@ -1,5 +1,10 @@ import { describe, it, expect } from "vitest"; -import { getPRStatusColor, getPRTooltip, isPRReadyToMerge } from "./pr-task-icon"; +import { + getPRStatusColor, + getPRTooltip, + isPRAwaitingReview, + isPRReadyToMerge, +} from "./pr-task-icon"; import type { TaskPR } from "@/lib/types/github"; function makePR(overrides: Partial = {}): TaskPR { @@ -33,7 +38,7 @@ function makePR(overrides: Partial = {}): TaskPR { } describe("isPRReadyToMerge", () => { - it("is true only when open + approved + success + clean", () => { + it("is true when open + approved + success + clean", () => { expect( isPRReadyToMerge( makePR({ @@ -46,6 +51,48 @@ describe("isPRReadyToMerge", () => { ).toBe(true); }); + it("is true when CI succeeds and no reviewers are required (clean + no pending reviews)", () => { + expect( + isPRReadyToMerge( + makePR({ + state: "open", + review_state: "", + checks_state: "success", + mergeable_state: "clean", + pending_review_count: 0, + }), + ), + ).toBe(true); + }); + + it("is false when reviewers are requested even if CI passed and mergeable is clean", () => { + expect( + isPRReadyToMerge( + makePR({ + state: "open", + review_state: "pending", + checks_state: "success", + mergeable_state: "clean", + pending_review_count: 2, + }), + ), + ).toBe(false); + }); + + it("is false when no review state but pending reviewers still requested", () => { + expect( + isPRReadyToMerge( + makePR({ + state: "open", + review_state: "", + checks_state: "success", + mergeable_state: "clean", + pending_review_count: 1, + }), + ), + ).toBe(false); + }); + it("is false when mergeable_state is blocked", () => { expect( isPRReadyToMerge( @@ -120,6 +167,39 @@ describe("getPRStatusColor", () => { expect(getPRStatusColor(pr)).toBe("text-green-500"); }); + it("returns sky-400 when CI passed but review is pending", () => { + const pr = makePR({ + state: "open", + review_state: "pending", + checks_state: "success", + mergeable_state: "clean", + pending_review_count: 2, + }); + expect(getPRStatusColor(pr)).toBe("text-sky-400"); + }); + + it("returns sky-400 when CI passed and reviewers are requested but no review state set", () => { + const pr = makePR({ + state: "open", + review_state: "", + checks_state: "success", + mergeable_state: "blocked", + pending_review_count: 1, + }); + expect(getPRStatusColor(pr)).toBe("text-sky-400"); + }); + + it("returns emerald when CI passed and no reviewers are required", () => { + const pr = makePR({ + state: "open", + review_state: "", + checks_state: "success", + mergeable_state: "clean", + pending_review_count: 0, + }); + expect(getPRStatusColor(pr)).toBe("text-emerald-400"); + }); + it("returns red for changes_requested regardless of mergeable_state", () => { const pr = makePR({ state: "open", @@ -140,6 +220,55 @@ describe("getPRStatusColor", () => { }); }); +describe("isPRAwaitingReview", () => { + it("is true when CI succeeded and review is pending", () => { + expect( + isPRAwaitingReview( + makePR({ + state: "open", + review_state: "pending", + checks_state: "success", + pending_review_count: 1, + }), + ), + ).toBe(true); + }); + + it("is false when CI is still running", () => { + expect( + isPRAwaitingReview( + makePR({ state: "open", checks_state: "pending", pending_review_count: 1 }), + ), + ).toBe(false); + }); + + it("is false when no review is required", () => { + expect( + isPRAwaitingReview( + makePR({ + state: "open", + review_state: "", + checks_state: "success", + pending_review_count: 0, + }), + ), + ).toBe(false); + }); + + it("is false for an approved PR with extra reviewers still pending", () => { + expect( + isPRAwaitingReview( + makePR({ + state: "open", + review_state: "approved", + checks_state: "success", + pending_review_count: 1, + }), + ), + ).toBe(false); + }); +}); + describe("getPRTooltip", () => { it("includes 'Ready to merge' when ready", () => { const pr = makePR({ diff --git a/apps/web/components/github/pr-task-icon.tsx b/apps/web/components/github/pr-task-icon.tsx index d3a2f8017f..3561e1c64d 100644 --- a/apps/web/components/github/pr-task-icon.tsx +++ b/apps/web/components/github/pr-task-icon.tsx @@ -7,15 +7,25 @@ import { useAppStore } from "@/components/state-provider"; import type { TaskPR } from "@/lib/types/github"; // Requires checks_state === "success" (not just "") so repos with no CI configured -// won't trigger ready-to-merge on mergeable_state=clean alone. Loosen if we start -// supporting CI-less repos. +// won't trigger ready-to-merge on mergeable_state=clean alone. export function isPRReadyToMerge(pr: TaskPR): boolean { - return ( - pr.state === "open" && - pr.checks_state === "success" && - pr.review_state === "approved" && - pr.mergeable_state === "clean" - ); + if (pr.state !== "open") return false; + if (pr.checks_state !== "success") return false; + if (pr.mergeable_state !== "clean") 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 + // covers repos without required reviewers. + return pr.review_state === "" && pr.pending_review_count === 0; +} + +// CI passed but the PR is still waiting on human review (reviewers requested +// or pending review state). Distinct from yellow "CI running". +export function isPRAwaitingReview(pr: TaskPR): boolean { + if (pr.state !== "open") return false; + if (pr.checks_state !== "success") return false; + if (pr.review_state === "approved") return false; + return pr.review_state === "pending" || pr.pending_review_count > 0; } export function getPRStatusColor(pr: TaskPR): string { @@ -30,6 +40,9 @@ export function getPRStatusColor(pr: TaskPR): string { if (pr.review_state === "approved" && pr.checks_state === "success") { return "text-green-500"; } + if (isPRAwaitingReview(pr)) { + return "text-sky-400"; + } if (pr.checks_state === "pending" || pr.review_state === "pending") { return "text-yellow-500"; }