feat(web): persist PR-merged banner dismissal in sessionStorage (#1129)

This commit is contained in:
Carlos Florêncio
2026-05-29 00:10:33 +01:00
committed by GitHub
parent a627957c5b
commit 2a68a9b7c7
5 changed files with 157 additions and 2 deletions
@@ -29,6 +29,7 @@ import { usePlanActions } from "@/hooks/domains/kanban/use-plan-actions";
import { useExecutorEnvironmentAvailability } from "@/hooks/domains/session/use-executor-environment-availability";
import { useArchiveAndSwitchTask } from "@/hooks/use-task-actions";
import { useToast } from "@/components/toast-provider";
import { markPRMergedBannerDismissed, wasPRMergedBannerDismissed } from "@/lib/local-storage";
import type { DiffComment } from "@/lib/diff/types";
import type { useChatPanelState } from "./use-chat-panel-state";
@@ -241,10 +242,15 @@ export function useChatPanelHandlers(
export function PRMergedBanner({ taskId }: { taskId: string }) {
const taskPRs = useAppStore((state) => state.taskPRs.byTaskId[taskId]);
const [dismissed, setDismissed] = useState(false);
const [dismissed, setDismissed] = useState(() => wasPRMergedBannerDismissed(taskId));
const archiveAndSwitch = useArchiveAndSwitchTask();
const { toast } = useToast();
const handleDismiss = useCallback(() => {
markPRMergedBannerDismissed(taskId);
setDismissed(true);
}, [taskId]);
const handleArchive = useCallback(async () => {
try {
await archiveAndSwitch(taskId);
@@ -282,7 +288,8 @@ export function PRMergedBanner({ taskId }: { taskId: string }) {
<button
type="button"
aria-label="Dismiss"
onClick={() => setDismissed(true)}
data-testid="pr-merged-dismiss-button"
onClick={handleDismiss}
className="p-0.5 hover:bg-purple-500/10 rounded cursor-pointer"
>
<IconX className="h-3 w-3" />
+3
View File
@@ -58,6 +58,9 @@ export class SessionPage {
prMergedArchiveButton() {
return this.page.getByTestId("pr-merged-archive-button");
}
prMergedDismissButton() {
return this.page.getByTestId("pr-merged-dismiss-button");
}
todoIndicator() {
return this.page.getByTestId("todo-indicator");
}
@@ -165,6 +165,93 @@ test.describe("Chat status bar", () => {
);
});
test("dismissed PR merged banner stays hidden across reload and task switch", async ({
testPage,
apiClient,
seedData,
}) => {
test.setTimeout(90_000);
const taskA = await apiClient.createTaskWithAgent(
seedData.workspaceId,
"Dismiss Banner Task A",
seedData.agentProfileId,
{
description: 'e2e:message("dismiss banner alpha response")',
workflow_id: seedData.workflowId,
workflow_step_id: seedData.startStepId,
repository_ids: [seedData.repositoryId],
},
);
await apiClient.createTaskWithAgent(
seedData.workspaceId,
"Dismiss Banner Task B",
seedData.agentProfileId,
{
description: 'e2e:message("dismiss banner beta response")',
workflow_id: seedData.workflowId,
workflow_step_id: seedData.startStepId,
repository_ids: [seedData.repositoryId],
},
);
await apiClient.mockGitHubAssociateTaskPR({
task_id: taskA.id,
owner: "test-org",
repo: "test-repo",
pr_number: 404,
pr_url: "https://github.com/test-org/test-repo/pull/404",
pr_title: "Dismiss Test PR",
head_branch: "feature/dismiss",
base_branch: "main",
author_login: "test-user",
state: "merged",
});
const kanban = new KanbanPage(testPage);
await kanban.goto();
const cardA = kanban.taskCardByTitle("Dismiss Banner Task A");
await expect(cardA).toBeVisible({ timeout: 30_000 });
await cardA.click();
await expect(testPage).toHaveURL(/\/t\//, { timeout: 15_000 });
const session = new SessionPage(testPage);
await session.waitForLoad();
await expect(session.chat.getByText("dismiss banner alpha response").last()).toBeVisible({
timeout: 30_000,
});
// Banner appears, then user dismisses it.
await expect(session.prMergedBanner()).toBeVisible({ timeout: 10_000 });
await session.prMergedDismissButton().click();
await expect(session.prMergedBanner()).not.toBeVisible();
// Persists across reload.
await testPage.reload();
await session.waitForLoad();
await expect(session.chat.getByText("dismiss banner alpha response").last()).toBeVisible({
timeout: 30_000,
});
await expect(session.prMergedBanner()).not.toBeVisible();
// Switch to task B and back. Task B has no merged PR so it never shows
// the banner — the real proof of cross-task-switch persistence is that
// the banner is still hidden on the return trip to task A.
await session.taskInSidebar("Dismiss Banner Task B").first().click();
await expect(session.chat.getByText("dismiss banner beta response").last()).toBeVisible({
timeout: 30_000,
});
await session.taskInSidebar("Dismiss Banner Task A").first().click();
await expect(session.chat.getByText("dismiss banner alpha response").last()).toBeVisible({
timeout: 30_000,
});
await expect(session.prMergedBanner()).not.toBeVisible();
});
test("archive via PR banner switches to next task", async ({ testPage, apiClient, seedData }) => {
test.setTimeout(90_000);
+33
View File
@@ -0,0 +1,33 @@
import { beforeEach, describe, expect, it } from "vitest";
import {
cleanupTaskStorage,
markPRMergedBannerDismissed,
wasPRMergedBannerDismissed,
} from "./local-storage";
describe("PR merged banner dismissal storage", () => {
beforeEach(() => {
window.sessionStorage.clear();
});
it("returns false when no dismissal has been recorded", () => {
expect(wasPRMergedBannerDismissed("task-a")).toBe(false);
});
it("persists dismissal per task and reads it back", () => {
markPRMergedBannerDismissed("task-a");
expect(wasPRMergedBannerDismissed("task-a")).toBe(true);
expect(wasPRMergedBannerDismissed("task-b")).toBe(false);
});
it("clears the dismissal flag via cleanupTaskStorage", () => {
markPRMergedBannerDismissed("task-a");
markPRMergedBannerDismissed("task-b");
cleanupTaskStorage("task-a", []);
expect(wasPRMergedBannerDismissed("task-a")).toBe(false);
expect(wasPRMergedBannerDismissed("task-b")).toBe(true);
});
});
+25
View File
@@ -364,6 +364,28 @@ export function markPRPanelOffered(sessionId: string): void {
}
}
// PR merged banner dismissal — per-task, survives reload + task switch within
// the tab session, resets on tab close.
const PR_MERGED_BANNER_DISMISSED_PREFIX = "kandev.pr-merged-banner-dismissed.";
export function wasPRMergedBannerDismissed(taskId: string): boolean {
if (typeof window === "undefined") return false;
try {
return window.sessionStorage.getItem(`${PR_MERGED_BANNER_DISMISSED_PREFIX}${taskId}`) === "1";
} catch {
return false;
}
}
export function markPRMergedBannerDismissed(taskId: string): void {
if (typeof window === "undefined") return;
try {
window.sessionStorage.setItem(`${PR_MERGED_BANNER_DISMISSED_PREFIX}${taskId}`, "1");
} catch {
// Ignore write failures
}
}
// Internal storage keys for open file tabs
const OPEN_FILES_KEY = "kandev.openFiles";
const ACTIVE_TAB_KEY = "kandev.activeTab";
@@ -573,6 +595,9 @@ export function cleanupTaskStorage(
// Plan notification (localStorage, keyed per task inside a Record)
setPlanLastSeen(taskId, null);
// PR merged banner dismissal (sessionStorage, keyed per task)
removeSessionStorage(`${PR_MERGED_BANNER_DISMISSED_PREFIX}${taskId}`);
// Sidebar collapsed-subtask set (sessionStorage, array keyed by parent taskId)
const collapsed = getStoredCollapsedSubtaskParents();
if (collapsed.includes(taskId)) {