Skip to content

The agent that grows with you

fix(web): write every page header slot from a layout effect

Austin Pickett681346296cbf
diff --git a/web/src/contexts/PageHeaderProvider.test.tsx b/web/src/contexts/PageHeaderProvider.test.tsx
index 8c6d960c21a..6f593833360 100644
--- a/web/src/contexts/PageHeaderProvider.test.tsx
+++ b/web/src/contexts/PageHeaderProvider.test.tsx
@@ -6,12 +6,19 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import { PageHeaderProvider } from "./PageHeaderProvider";
import { usePageHeader } from "./usePageHeader";
import ChannelsPage from "@/pages/ChannelsPage";
+import FilesPage from "@/pages/FilesPage";
-vi.mock("@/i18n", () => ({ useI18n: () => ({ t: {} }) }));
+vi.mock("@/i18n", () => ({ useI18n: () => ({ t: { common: { cancel: "Cancel", delete: "Delete" } } }) }));
vi.mock("@/lib/resolve-page-title", () => ({ resolvePageTitle: (path: string) => path }));
vi.mock("@/lib/api", () => ({
- api: { getMessagingPlatforms: vi.fn(async () => ({ platforms: [] })) },
+ api: {
+ getMessagingPlatforms: vi.fn(async () => ({ platforms: [] })),
+ listFiles: vi.fn(async () => ({
+ root: "/srv/files", path: "/srv/files", parent: null, locked_root: null, can_change_path: false, entries: [],
+ })),
+ },
}));
+vi.mock("@/plugins", () => ({ PluginSlot: () => null }));
(globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }).IS_REACT_ACT_ENVIRONMENT = true;
let container: HTMLDivElement;
@@ -24,6 +31,7 @@ function Navigate() {
<button onClick={() => navigate("/other")}>Other</button>
<button onClick={() => navigate("/empty")}>Empty</button>
<button onClick={() => navigate("/delayed")}>Delayed</button>
+ <button onClick={() => navigate("/files")}>Files</button>
</nav>;
}
@@ -53,6 +61,7 @@ async function renderAt(path: string) {
<Route path="/other" element={<OtherPage />} />
<Route path="/empty" element={<div>Empty page</div>} />
<Route path="/delayed" element={<DelayedPage />} />
+ <Route path="/files" element={<FilesPage />} />
</Routes>
</PageHeaderProvider>
</MemoryRouter>,
@@ -96,6 +105,14 @@ describe("page header ownership", () => {
expect(header().textContent).not.toContain("Other action");
});
+ it("keeps the incoming page's actions when the outgoing page clears its slots", async () => {
+ await renderAt("/files");
+ expect(header().textContent).toContain("/srv/files");
+ await click("Channels");
+ expect(header().textContent).toContain("Restart gateway");
+ expect(header().textContent).not.toContain("/srv/files");
+ });
+
it("accepts a page that mounts after the route changes", async () => {
await renderAt("/channels");
await click("Delayed");
diff --git a/web/src/contexts/usePageHeader.ts b/web/src/contexts/usePageHeader.ts
index c6e7babf4d2..7d0ecea9f09 100644
--- a/web/src/contexts/usePageHeader.ts
+++ b/web/src/contexts/usePageHeader.ts
@@ -1,6 +1,11 @@
import { useContext } from "react";
import { PageHeaderContext, type PageHeaderContextValue } from "./page-header-context";
+/**
+ * Fill header slots from `useLayoutEffect` and clear them in its cleanup. A
+ * `useEffect` cleanup on the outgoing page runs after the incoming page's
+ * layout effects, so it would erase the new page's header.
+ */
export function usePageHeader(): PageHeaderContextValue {
const ctx = useContext(PageHeaderContext);
if (!ctx) {
diff --git a/web/src/pages/ChatPage.tsx b/web/src/pages/ChatPage.tsx
index 9baf9304985..e488ea125b1 100644
--- a/web/src/pages/ChatPage.tsx
+++ b/web/src/pages/ChatPage.tsx
@@ -365,7 +365,7 @@ export default function ChatPage({ isActive = true }: { isActive?: boolean }) {
[titleScope],
);
- useEffect(() => {
+ useLayoutEffect(() => {
if (!isActive) {
setTitle(null);
return;
diff --git a/web/src/pages/FilesPage.tsx b/web/src/pages/FilesPage.tsx
index 15b13a5bf97..f972130651b 100644
--- a/web/src/pages/FilesPage.tsx
+++ b/web/src/pages/FilesPage.tsx
@@ -1,6 +1,7 @@
import {
useCallback,
useEffect,
+ useLayoutEffect,
useRef,
useState,
type DragEvent as ReactDragEvent,
@@ -125,7 +126,7 @@ export default function FilesPage() {
void load(currentPath);
}, [currentPath]); // eslint-disable-line react-hooks/exhaustive-deps
- useEffect(() => {
+ useLayoutEffect(() => {
setAfterTitle(
<Badge tone="outline" className="max-w-[22rem] truncate text-xs" title={headerPath}>
{headerPath}
diff --git a/web/src/pages/PluginsPage.tsx b/web/src/pages/PluginsPage.tsx
index e240dd72db8..1d35ed94664 100644
--- a/web/src/pages/PluginsPage.tsx
+++ b/web/src/pages/PluginsPage.tsx
@@ -1,4 +1,4 @@
-import { useCallback, useEffect, useMemo, useState } from "react";
+import { useCallback, useEffect, useLayoutEffect, useMemo, useState } from "react";
import { ExternalLink, RefreshCw, Trash2, Eye, EyeOff } from "lucide-react";
import type { Translations } from "@/i18n/types";
import { Link } from "react-router";
@@ -429,7 +429,7 @@ export default function PluginsPage() {
}
}, [loadHub, showToast, t.pluginsPage.refreshDashboard]);
- useEffect(() => {
+ useLayoutEffect(() => {
setAfterTitle(
<Button
ghost
diff --git a/web/src/pages/SessionsPage.test.tsx b/web/src/pages/SessionsPage.test.tsx
index 5bcf6396d1c..21a1427042c 100644
--- a/web/src/pages/SessionsPage.test.tsx
+++ b/web/src/pages/SessionsPage.test.tsx
@@ -1,7 +1,7 @@
// @vitest-environment jsdom
-import { act } from "react";
+import { act, useLayoutEffect } from "react";
import { createRoot, type Root } from "react-dom/client";
-import { MemoryRouter } from "react-router";
+import { MemoryRouter, Route, Routes, useNavigate } from "react-router";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
const apiMocks = vi.hoisted(() => ({
@@ -259,3 +259,60 @@ describe("structured reasoning rendering (#59957)", () => {
expect(document.querySelectorAll("pre code").length).toBe(0);
});
});
+
+describe("SessionsPage header slots across navigation", () => {
+ it("leaves the next page's header action in place", async () => {
+ apiMocks.getSessions.mockResolvedValue({ sessions: [], total: 0, limit: 20, offset: 0 });
+ const [{ default: SessionsPage }, { I18nProvider }, { SystemActionsProvider }, { ProfileProvider }, { PageHeaderProvider }, { usePageHeader }] =
+ await Promise.all([
+ import("./SessionsPage"),
+ import("@/i18n"),
+ import("@/contexts/SystemActions"),
+ import("@/contexts/ProfileProvider"),
+ import("@/contexts/PageHeaderProvider"),
+ import("@/contexts/usePageHeader"),
+ ]);
+ function NextPage() {
+ const { setEnd } = usePageHeader();
+ useLayoutEffect(() => {
+ setEnd(<button>Next action</button>);
+ return () => setEnd(null);
+ }, [setEnd]);
+ return null;
+ }
+ function GoNext() {
+ const navigate = useNavigate();
+ return <button onClick={() => navigate("/next")}>Go next</button>;
+ }
+ container = document.createElement("div");
+ document.body.append(container);
+ root = createRoot(container);
+ await act(async () =>
+ root.render(
+ <I18nProvider>
+ <MemoryRouter initialEntries={["/sessions"]}>
+ <SystemActionsProvider>
+ <ProfileProvider>
+ <GoNext />
+ <PageHeaderProvider pluginTabs={[]}>
+ <Routes>
+ <Route path="/sessions" element={<SessionsPage />} />
+ <Route path="/next" element={<NextPage />} />
+ </Routes>
+ </PageHeaderProvider>
+ </ProfileProvider>
+ </SystemActionsProvider>
+ </MemoryRouter>
+ </I18nProvider>,
+ ),
+ );
+ const header = () => container.querySelector("header")?.textContent ?? "";
+ await waitFor(() => header().includes("Prune old sessions"));
+
+ const goNext = Array.from(container.querySelectorAll("button")).find((b) => b.textContent === "Go next");
+ await act(async () => click(goNext ?? null));
+
+ expect(header()).toContain("Next action");
+ expect(header()).not.toContain("Prune old sessions");
+ });
+});
diff --git a/web/src/pages/SessionsPage.tsx b/web/src/pages/SessionsPage.tsx
index b391f1ccb08..1b1816400e3 100644
--- a/web/src/pages/SessionsPage.tsx
+++ b/web/src/pages/SessionsPage.tsx
@@ -932,7 +932,7 @@ export default function SessionsPage() {
};
}, [loading, setAfterTitle, total]);
- useEffect(() => {
+ useLayoutEffect(() => {
setEnd(
<Button
outlined