fix(web): open review panes in selected split (#2710)

This commit is contained in:
José Almeida
2026-08-16 15:40:11 +01:00
committed by GitHub
parent 63c21686ff
commit 8d006c4011
17 changed files with 978 additions and 95 deletions
@@ -1,17 +1,28 @@
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import { cleanup, fireEvent, render, screen } from "@testing-library/react";
import { DropdownMenu, DropdownMenuContent, DropdownMenuTrigger } from "@kandev/ui/dropdown-menu";
import { mrTaskKey } from "@/components/gitlab/mr-detail-panel";
import type { TaskPR } from "@/lib/types/github";
import type { TaskMR } from "@/lib/types/gitlab";
import type { ReviewItemSummary } from "@/lib/plugins/types";
import { reviewPanelId } from "@/lib/state/dockview-review-panel-id";
import { AddPanelMenuItems, type AddPanelMenuState } from "./dockview-add-panel-items";
import { pluginRegistry } from "@/lib/plugins/registry";
import { reviewItemId } from "./review-selection";
const { mockAddPRPanel, mockAddTodosPanel } = vi.hoisted(() => ({
mockAddPRPanel: vi.fn(),
mockAddTodosPanel: vi.fn(),
}));
const { mockAddMRPanel, mockAddPRPanel, mockAddReviewPanel, mockAddTodosPanel } = vi.hoisted(
() => ({
mockAddMRPanel: vi.fn(),
mockAddPRPanel: vi.fn(),
mockAddReviewPanel: vi.fn(),
mockAddTodosPanel: vi.fn(),
}),
);
const mockDockviewStore = vi.hoisted(() => ({
api: null,
api: null as null | {
getPanel: (id: string) => { params?: Record<string, unknown> } | undefined;
},
centerGroupId: "group-center",
addBrowserPanel: vi.fn(),
addVscodePanel: vi.fn(),
@@ -21,9 +32,16 @@ const mockDockviewStore = vi.hoisted(() => ({
addChangesPanel: vi.fn(),
addFilesPanel: vi.fn(),
addPRPanel: mockAddPRPanel,
addMRPanel: vi.fn(),
addMRPanel: mockAddMRPanel,
addReviewPanel: mockAddReviewPanel,
addTerminalPanel: vi.fn(),
}));
const CENTER_GROUP_ID = mockDockviewStore.centerGroupId;
const SECONDARY_GROUP_ID = "group-secondary";
const mockNormalizedReviews = vi.hoisted(() => ({
reviews: [] as ReviewItemSummary[],
}));
const mockAppState = vi.hoisted(() => ({
workspaces: { activeId: "workspace-1" },
@@ -54,8 +72,14 @@ vi.mock("@/hooks/domains/workspace/use-repository-scripts", () => ({
useRepositoryScripts: () => ({ scripts: [] }),
}));
vi.mock("./review-panel-provider", () => ({
useNormalizedTaskReviews: () => mockNormalizedReviews.reviews,
}));
const PR_SUBMENU_TEST_ID = "add-panel-pr-submenu";
const PR_ITEM_TEST_ID_PREFIX = "add-panel-pr-item-";
const GITLAB_ORIGIN = "https://gitlab.example";
const TEST_TIMESTAMP = "2026-07-31T00:00:00Z";
function makePR(id: string, number: number, repo = "kandev"): TaskPR {
return {
@@ -81,15 +105,63 @@ function makePR(id: string, number: number, repo = "kandev"): TaskPR {
checks_passing: 0,
additions: 0,
deletions: 0,
created_at: "2026-07-31T00:00:00Z",
created_at: TEST_TIMESTAMP,
merged_at: null,
closed_at: null,
last_synced_at: null,
updated_at: "2026-07-31T00:00:00Z",
updated_at: TEST_TIMESTAMP,
};
}
function renderMenu(state: Partial<AddPanelMenuState> = {}) {
function makeMR(id: string, number: number, projectPath = "acme/kandev"): TaskMR {
return {
id,
task_id: "task-1",
host: GITLAB_ORIGIN,
project_path: projectPath,
mr_iid: number,
mr_url: `${GITLAB_ORIGIN}/${projectPath}/-/merge_requests/${number}`,
mr_title: `MR ${number}`,
head_branch: `feature/${number}`,
base_branch: "main",
author_username: "alice",
state: "open",
approval_state: "",
pipeline_state: "",
merge_status: "",
draft: false,
approval_count: 0,
required_approvals: 0,
pipeline_jobs_total: 0,
pipeline_jobs_pass: 0,
reviewer_count: 0,
unapproved_reviewers: 0,
unresolved_discussions: 0,
created_at: TEST_TIMESTAMP,
updated_at: TEST_TIMESTAMP,
};
}
function makeRegisteredReview(number: number): ReviewItemSummary {
return {
providerId: "bitbucket",
reviewKey: `acme/kandev/${number}`,
title: `Change request ${number}`,
url: `https://bitbucket.example/acme/kandev/pull-requests/${number}`,
connectionScope: "https://bitbucket.example",
repositoryId: "acme/kandev",
changeRequestNumber: number,
state: "open",
};
}
function setOpenPanels(panels: Record<string, Record<string, unknown>>) {
mockDockviewStore.api = {
getPanel: (id) => (Object.hasOwn(panels, id) ? { params: panels[id] } : undefined),
};
}
function renderMenu(state: Partial<AddPanelMenuState> = {}, groupId = CENTER_GROUP_ID) {
const fullState: AddPanelMenuState = {
taskId: null,
isPassthrough: false,
@@ -104,7 +176,7 @@ function renderMenu(state: Partial<AddPanelMenuState> = {}) {
<DropdownMenuTrigger>open</DropdownMenuTrigger>
<DropdownMenuContent>
<AddPanelMenuItems
groupId="group-center"
groupId={groupId}
state={fullState}
onNewSession={() => {}}
onAddTerminal={() => {}}
@@ -123,7 +195,11 @@ async function openPRSubmenu() {
}
beforeEach(() => {
mockDockviewStore.api = null;
mockNormalizedReviews.reviews = [];
mockAddMRPanel.mockClear();
mockAddPRPanel.mockClear();
mockAddReviewPanel.mockClear();
mockAddTodosPanel.mockClear();
});
@@ -163,17 +239,153 @@ describe("AddPanelMenuItems — linked PR rows", () => {
});
it("opens the selected PR panel with its task key and the active session", async () => {
renderMenu({ prs: [makePR("pr-1", 42, "web"), makePR("pr-2", 77, "api")] });
renderMenu({ prs: [makePR("pr-1", 42, "web"), makePR("pr-2", 77, "api")] }, SECONDARY_GROUP_ID);
await openPRSubmenu();
fireEvent.click(screen.getByTestId(`${PR_ITEM_TEST_ID_PREFIX}acme-api-77`));
expect(mockAddPRPanel).toHaveBeenCalledWith("acme/api/77");
expect(mockAddPRPanel).toHaveBeenCalledWith("acme/api/77", {
groupId: SECONDARY_GROUP_ID,
});
});
it("keeps the inline row clickable when exactly one PR is linked", () => {
renderMenu({ prs: [makePR("pr-1", 42)] });
fireEvent.click(screen.getByTestId(`${PR_ITEM_TEST_ID_PREFIX}acme-kandev-42`));
expect(mockAddPRPanel).toHaveBeenCalledWith("acme/kandev/42");
expect(mockAddPRPanel).toHaveBeenCalledWith("acme/kandev/42", {
groupId: CENTER_GROUP_ID,
});
});
it("hides a canonical open PR and renders the sole missing PR inline", () => {
setOpenPanels({ "pr-detail": { prKey: "acme/web/42" } });
renderMenu({ prs: [makePR("pr-1", 42, "web"), makePR("pr-2", 77, "api")] });
expect(screen.queryByTestId(PR_SUBMENU_TEST_ID)).toBeNull();
expect(screen.queryByTestId(`${PR_ITEM_TEST_ID_PREFIX}acme-web-42`)).toBeNull();
expect(screen.getByTestId(`${PR_ITEM_TEST_ID_PREFIX}acme-api-77`)).toBeTruthy();
});
it("hides a keyed open PR by exact task key", () => {
setOpenPanels({ "pr-detail|acme/web/42": {} });
renderMenu({ prs: [makePR("pr-1", 42, "web"), makePR("pr-2", 77, "api")] });
expect(screen.queryByTestId(PR_SUBMENU_TEST_ID)).toBeNull();
expect(screen.queryByTestId(`${PR_ITEM_TEST_ID_PREFIX}acme-web-42`)).toBeNull();
expect(screen.getByTestId(`${PR_ITEM_TEST_ID_PREFIX}acme-api-77`)).toBeTruthy();
});
it("uses the filtered PR count for the submenu and keeps other reviews available", async () => {
setOpenPanels({ "pr-detail": { prKey: "acme/web/42" } });
renderMenu({
prs: [makePR("pr-1", 42, "web"), makePR("pr-2", 77, "api"), makePR("pr-3", 91, "docs")],
});
const trigger = screen.getByTestId(PR_SUBMENU_TEST_ID);
expect(trigger.getAttribute("data-pr-count")).toBe("2");
fireEvent.click(trigger);
expect(await screen.findByTestId(`${PR_ITEM_TEST_ID_PREFIX}acme-api-77`)).toBeTruthy();
expect(screen.getByTestId(`${PR_ITEM_TEST_ID_PREFIX}acme-docs-91`)).toBeTruthy();
expect(screen.queryByTestId(`${PR_ITEM_TEST_ID_PREFIX}acme-web-42`)).toBeNull();
});
it("offers a PR on the next menu mount after its exact panel closes", () => {
setOpenPanels({ "pr-detail|acme/kandev/42": {} });
const firstMenu = renderMenu({ prs: [makePR("pr-1", 42)] });
expect(screen.queryByTestId(`${PR_ITEM_TEST_ID_PREFIX}acme-kandev-42`)).toBeNull();
firstMenu.unmount();
setOpenPanels({});
renderMenu({ prs: [makePR("pr-1", 42)] });
expect(screen.getByTestId(`${PR_ITEM_TEST_ID_PREFIX}acme-kandev-42`)).toBeTruthy();
});
});
describe("AddPanelMenuItems — open review identities", () => {
it("opens a missing GitLab MR in the invoking group", () => {
const mr = makeMR("mr-1", 42);
renderMenu({ mrs: [mr] }, SECONDARY_GROUP_ID);
fireEvent.click(screen.getByTestId("add-panel-mr-item-mr-1"));
expect(mockAddMRPanel).toHaveBeenCalledWith(mrTaskKey(mr), {
groupId: SECONDARY_GROUP_ID,
});
});
it("opens a missing registered-provider review in the invoking group", () => {
const review = makeRegisteredReview(42);
mockNormalizedReviews.reviews = [review];
renderMenu({}, SECONDARY_GROUP_ID);
fireEvent.click(screen.getByTestId(`add-panel-review-item-${reviewItemId(review)}`));
expect(mockAddReviewPanel).toHaveBeenCalledWith(review, {
groupId: SECONDARY_GROUP_ID,
});
});
it("hides canonical and keyed GitLab MRs by exact task key", () => {
const canonicalMR = makeMR("mr-1", 42, "acme/web");
const keyedMR = makeMR("mr-2", 77, "acme/api");
const missingMR = makeMR("mr-3", 91, "acme/docs");
setOpenPanels({
"pr-detail": { mrKey: mrTaskKey(canonicalMR) },
[`mr-detail|${mrTaskKey(keyedMR)}`]: {},
});
renderMenu({ mrs: [canonicalMR, keyedMR, missingMR] });
expect(screen.queryByTestId("add-panel-mr-item-mr-1")).toBeNull();
expect(screen.queryByTestId("add-panel-mr-item-mr-2")).toBeNull();
expect(screen.getByTestId("add-panel-mr-item-mr-3")).toBeTruthy();
});
it("uses the single-MR label when filtering leaves one visible MR", () => {
const openMR = makeMR("mr-1", 42, "acme/web");
const missingMR = makeMR("mr-2", 77, "acme/api");
setOpenPanels({ "pr-detail": { mrKey: mrTaskKey(openMR) } });
renderMenu({ mrs: [openMR, missingMR] });
expect(screen.getByTestId("add-panel-mr-item-mr-2").textContent).toContain("Merge Request !77");
});
it("hides registered-provider reviews with exact canonical and keyed identities", () => {
const canonicalReview = makeRegisteredReview(42);
const keyedReview = makeRegisteredReview(77);
const missingReview = makeRegisteredReview(91);
setOpenPanels({
"pr-detail": {
providerId: canonicalReview.providerId,
connectionScope: canonicalReview.connectionScope,
repositoryId: canonicalReview.repositoryId,
changeRequestNumber: canonicalReview.changeRequestNumber,
},
[reviewPanelId(keyedReview)]: {},
});
mockNormalizedReviews.reviews = [canonicalReview, keyedReview, missingReview];
renderMenu();
expect(
screen.queryByTestId(`add-panel-review-item-${reviewItemId(canonicalReview)}`),
).toBeNull();
expect(screen.queryByTestId(`add-panel-review-item-${reviewItemId(keyedReview)}`)).toBeNull();
expect(screen.getByTestId(`add-panel-review-item-${reviewItemId(missingReview)}`)).toBeTruthy();
});
it("does not hide an individual review for a provider-neutral canonical selector", () => {
const review = makeRegisteredReview(42);
setOpenPanels({ "pr-detail": {} });
mockNormalizedReviews.reviews = [review];
renderMenu();
expect(screen.getByTestId(`add-panel-review-item-${reviewItemId(review)}`)).toBeTruthy();
});
});
@@ -205,7 +417,7 @@ describe("AddPanelMenuItems — plugin task panels (AC1)", () => {
"kandev-plugin-notes",
"notes",
"Notes",
{ groupId: "group-center" },
{ groupId: CENTER_GROUP_ID },
);
});
});
@@ -261,7 +473,7 @@ describe("AddPanelMenuItems — Todos", () => {
expect(item).toBeTruthy();
fireEvent.click(item);
expect(mockAddTodosPanel).toHaveBeenCalledWith({ groupId: "group-center" });
expect(mockAddTodosPanel).toHaveBeenCalledWith({ groupId: CENTER_GROUP_ID });
});
it("hides the Todos row for a passthrough session, matching the Plan row's guard", () => {
@@ -18,10 +18,13 @@ import {
DropdownMenuSubContent,
DropdownMenuSubTrigger,
} from "@kandev/ui/dropdown-menu";
import type { DockviewApi } from "dockview-react";
import { prPanelLabel, prIdentitySlug, prTaskKey } from "@/components/github/pr-utils";
import { useDockviewStore } from "@/lib/state/dockview-store";
import { reviewPanelId } from "@/lib/state/dockview-review-panel-id";
import { pluginRegistry, usePluginRegistry } from "@/lib/plugins/registry";
import { resolvePluginIcon } from "@/lib/plugins/icons";
import type { ReviewItemSummary } from "@/lib/plugins/types";
import type { TaskPR } from "@/lib/types/github";
import type { TaskMR } from "@/lib/types/gitlab";
import { mrTaskKey } from "@/components/gitlab/mr-detail-panel";
@@ -57,6 +60,76 @@ export const MENU_ITEM_CLASS = "cursor-pointer text-xs";
const PR_SUBMENU_TEST_ID = "add-panel-pr-submenu";
type ReviewMenuIdentity = Pick<ReviewItemSummary, "providerId" | "reviewKey"> &
Partial<Pick<ReviewItemSummary, "connectionScope" | "repositoryId" | "changeRequestNumber">>;
type ReviewPanelLookup = Pick<DockviewApi, "getPanel">;
function panelParams(api: ReviewPanelLookup, id: string): Record<string, unknown> | undefined {
return api.getPanel(id)?.params as Record<string, unknown> | undefined;
}
function matchesBuiltInReview(
params: Record<string, unknown> | undefined,
providerId: "github" | "gitlab",
reviewKey: string,
legacyKey: "prKey" | "mrKey",
): boolean {
return (
params?.[legacyKey] === reviewKey ||
((params?.providerId === providerId || params?.provider === providerId) &&
params.reviewKey === reviewKey)
);
}
function matchesRegisteredReview(
params: Record<string, unknown> | undefined,
review: Required<ReviewMenuIdentity>,
): boolean {
return (
params?.providerId === review.providerId &&
params.connectionScope === review.connectionScope &&
params.repositoryId === review.repositoryId &&
params.changeRequestNumber !== undefined &&
String(params.changeRequestNumber) === String(review.changeRequestNumber)
);
}
/** True only when this exact review already has a canonical or keyed live panel. */
export function isReviewPanelOpen(
api: ReviewPanelLookup | null,
review: ReviewMenuIdentity,
): boolean {
if (!api) return false;
const canonicalParams = panelParams(api, "pr-detail");
if (review.providerId === "github") {
return (
Boolean(api.getPanel(`pr-detail|${review.reviewKey}`)) ||
matchesBuiltInReview(canonicalParams, "github", review.reviewKey, "prKey")
);
}
if (review.providerId === "gitlab") {
return (
Boolean(api.getPanel(`mr-detail|${review.reviewKey}`)) ||
matchesBuiltInReview(canonicalParams, "gitlab", review.reviewKey, "mrKey") ||
matchesBuiltInReview(panelParams(api, "mr-detail"), "gitlab", review.reviewKey, "mrKey")
);
}
const { connectionScope, repositoryId, changeRequestNumber } = review;
if (
connectionScope === undefined ||
repositoryId === undefined ||
changeRequestNumber === undefined
) {
return false;
}
const registeredReview = { ...review, connectionScope, repositoryId, changeRequestNumber };
return (
Boolean(api.getPanel(reviewPanelId(registeredReview))) ||
matchesRegisteredReview(canonicalParams, registeredReview)
);
}
/**
* Linked GitHub PR entries for the dockview "+" menu. A single PR renders as
* one inline row; multiple PRs collapse behind a "Pull requests" sub-menu so
@@ -135,6 +208,20 @@ function PluginTaskPanelMenuItems({ groupId }: { groupId: string }) {
);
}
function missingBuiltInReviews(
api: ReviewPanelLookup | null,
state: Pick<AddPanelMenuState, "prs" | "mrs">,
): Pick<AddPanelMenuState, "prs" | "mrs"> {
return {
prs: state.prs.filter(
(pr) => !isReviewPanelOpen(api, { providerId: "github", reviewKey: prTaskKey(pr) }),
),
mrs: state.mrs.filter(
(mr) => !isReviewPanelOpen(api, { providerId: "gitlab", reviewKey: mrTaskKey(mr) }),
),
};
}
export function AddPanelMenuItems({
groupId,
state,
@@ -150,9 +237,7 @@ export function AddPanelMenuItems({
const addTodosPanel = useDockviewStore((s) => s.addTodosPanel);
const addFilesPanel = useDockviewStore((s) => s.addFilesPanel);
const addChangesPanel = useDockviewStore((s) => s.addChangesPanel);
const addPRPanel = useDockviewStore((s) => s.addPRPanel);
const addMRPanel = useDockviewStore((s) => s.addMRPanel);
const api = useDockviewStore((s) => s.api);
return (
<>
{state.taskId && (
@@ -213,40 +298,52 @@ export function AddPanelMenuItems({
{t("task:files")}
</DropdownMenuItem>
)}
<PRPanelMenuItems prs={state.prs} onOpenPR={(pr) => addPRPanel(prTaskKey(pr))} />
{state.mrs.map((mr) => (
<DropdownMenuItem
key={mr.id}
onClick={() => addMRPanel(mrTaskKey(mr))}
className={MENU_ITEM_CLASS}
data-testid={`add-panel-mr-item-${mr.id}`}
>
<IconGitPullRequest className={`${MENU_ICON_CLASS} text-orange-500`} />
{state.mrs.length > 1
? `MR !${mr.mr_iid} - ${mr.project_path}`
: t("task:mergeRequest", { mriid: mr.mr_iid })}
</DropdownMenuItem>
))}
<PluginReviewPanelMenuItems taskId={state.taskId} />
<ReviewPanelMenuItems groupId={groupId} state={state} api={api} />
<RepositoryScriptsMenuItems onRunScript={onRunScript} onRunDevScript={onRunDevScript} />
</>
);
}
function PluginReviewPanelMenuItems({ taskId }: { taskId: string | null }) {
function ReviewPanelMenuItems({
groupId,
state,
api,
}: Pick<AddPanelMenuItemsProps, "groupId" | "state"> & { api: ReviewPanelLookup | null }) {
const { t } = useTranslation();
const addPRPanel = useDockviewStore((s) => s.addPRPanel);
const addMRPanel = useDockviewStore((s) => s.addMRPanel);
const addReviewPanel = useDockviewStore((s) => s.addReviewPanel);
const reviews = useNormalizedTaskReviews(taskId).filter(
(review) => review.providerId !== "github" && review.providerId !== "gitlab",
const { prs, mrs } = missingBuiltInReviews(api, state);
const reviews = useNormalizedTaskReviews(state.taskId)
.filter((review) => review.providerId !== "github" && review.providerId !== "gitlab")
.filter((review) => !isReviewPanelOpen(api, review));
return (
<>
<PRPanelMenuItems prs={prs} onOpenPR={(pr) => addPRPanel(prTaskKey(pr), { groupId })} />
{mrs.map((mr) => (
<DropdownMenuItem
key={mr.id}
onClick={() => addMRPanel(mrTaskKey(mr), { groupId })}
className={MENU_ITEM_CLASS}
data-testid={`add-panel-mr-item-${mr.id}`}
>
<IconGitPullRequest className={`${MENU_ICON_CLASS} text-orange-500`} />
{mrs.length > 1
? `MR !${mr.mr_iid} - ${mr.project_path}`
: t("task:mergeRequest", { mriid: mr.mr_iid })}
</DropdownMenuItem>
))}
{reviews.map((review) => (
<DropdownMenuItem
key={reviewItemId(review)}
onClick={() => addReviewPanel(review, { groupId })}
className={MENU_ITEM_CLASS}
data-testid={`add-panel-review-item-${reviewItemId(review)}`}
>
<IconGitPullRequest className={MENU_ICON_CLASS} />
{review.title}
</DropdownMenuItem>
))}
</>
);
return reviews.map((review) => (
<DropdownMenuItem
key={reviewItemId(review)}
onClick={() => addReviewPanel(review)}
className={MENU_ITEM_CLASS}
data-testid={`add-panel-review-item-${reviewItemId(review)}`}
>
<IconGitPullRequest className={MENU_ICON_CLASS} />
{review.title}
</DropdownMenuItem>
));
}