mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-21 08:22:20 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Self-hosted boards need a way to show occasional product announcements. > - An app release should not be required to publish or withdraw a card. > - Native card controls keep publishing consistent; the hero can use a static image or isolated HTML/CSS animation. > - This pull request renders a validated JSON feed with native components. > - It stores dismissals per account on each instance, so a closed card stays closed across companies and browsers. > - Named staging feeds let authors test content before production publication. ## Linked Issues or Issue Description **Subsystem affected** Board application shell, announcement delivery, and user preferences. **Problem or motivation** Operators need a small, optional announcement card. Users need reliable dismissal state. Authors need to test remote content without changing the production feed. **Proposed solution** Add one non-modal AnnouncementWell. Fetch validated JSON and content-addressed media through the instance server. Keep card controls native, with optional sandboxed HTML/CSS animation in the hero. Use stable announcement IDs for dismissal, an explicit empty manifest and quiet 404 handling. Provide a staged publishing helper and isolated test-drive guide. **Alternatives considered** Hosting the entire card as a page would move navigation and dismissal into remote content. This change limits HTML to a scriptless, isolated visual hero and keeps controls native. Browser-only storage would lose dismissals across browsers, so the instance stores account preferences. **Roadmap alignment** ROADMAP.md has no overlapping announcement feature. A GitHub title search found no related announcement pull requests. This work implements a maintainer-requested feature. ## What Changed - Add shared feed types, strict validation of every object, supported routes, expiration and version checks. - Add a board-only current-feed API, constrained media proxy, and idempotent dismissal API. Store the first dismissal and its company audit entry in one transaction. - Cache upstream data for one hour. Use conditional requests, request deduplication, response limits, public destination checks, and a three-second deadline. Treat a remote 404 as an empty feed with a fifteen-minute retry cooldown. - Keep announcement visibility stable when focus moves to browser chrome or another app pane; only tab visibility starts a return check. - Add a responsive native announcement card. Respect onboarding, dialogs and toast placement. Sync pending dismissals across tabs and retry after reconnect or return. - Add idempotent migrations for dismissals and validated publication IDs, design-guide examples, static and animated Storybook examples, and focused tests. The publication registry supports offline retries without accepting caller-invented IDs. - Add HTML/CSS animated heroes with static posters, automatic playback, reduced-motion handling, strict DOMPurify validation, an empty iframe sandbox and CSP that blocks scripts/network resources. - Add validated staging publication, content-addressed assets, an empty production manifest, preview fixtures, and authoring/operator documentation. ## Verification - The preceding implementation passed 98 targeted shared/server/publisher/route/OpenAPI/UI tests and 127 tests including the master rebase. The playback-control removal passes all 21 announcement UI tests, covering the rendered sandbox, fallback, reduced motion, dismissal and slow/stale state lookups. The preceding shared/server tests cover HTML validation and response sandbox headers. - The playback-control removal passes UI typecheck, production UI build, Storybook build and token gates locally. Browser verification confirms the animated card has only its dismiss button and two links, with no page errors. The full canonical CI matrix passed on current head `00e416431edb610861599d50490270bbd0f3c6b6`: 32 successful checks and two optional Storybook deployment checks skipped. This run needed no retries. Greptile reviewed this same head at 5/5 with no outstanding findings. - The local canonical general-server run passed 12,063 tests before reporting embedded-PostgreSQL startup failures in an unrelated fixture. All 31 tests in that fixture passed across isolated retries. The UI group passed 6,219 tests and other workspace groups passed 3,201; two CLI database-startup failures also passed individually. Serialized server suites were verified by the full CI matrix rather than repeating them locally. No source changes were needed for these environment failures. - The real S3/CloudFront staging manifest and both media asset headers were verified. Production remains empty/unpublished. The guide distinguishes the preview host's disabled edge cache from production cache requirements. - In the isolated test-drive, the animation visibly moves without playback controls. A 390×844 browser viewport keeps the card above navigation. Reduced motion makes no animation request. Both themes render correctly and browser page errors are empty. Browser fault injection verified that scripts cannot execute and CSS cannot make network requests; a missing animation leaves its poster and controls. - Refresh leaves the animated card visible. Closing it persists after reload and the API returns null. Earlier live checks verified dismissal across browsers, company-relative CTA navigation, modal deferral/restoration, and new-ID eligibility after restarting the same database. - The deployed empty feed and a real remote 404 return HTTP 200 with null from the board API, with a usable dashboard and no announcement popup or browser warnings. - Authoring documentation covers staging, animated HTML constraints, test-drive, withdrawal, ID reuse and cache-refresh steps. ## Risks - Animation supports self-contained visual HTML/CSS and inline SVG, without JavaScript or external resources. A static image is required. Older builds that do not recognize the optional animation field quietly hide that unsupported feed. - The default feed makes an outbound request from an instance when a board is used. Operators can disable it. Requests contain no account IDs, company data, cookies or interaction events. - Feed publication and withdrawal can take about 65 minutes to reach returning users because of CDN and instance caches. Expiration also removes visible cards locally. - Dismissals follow an account within one instance. No-login instances share the existing local-board identity. Separate installations do not share state. - Both tables are additive. A unique key prevents duplicate dismissals; the transaction prevents duplicate first-dismissal audit entries. The publication registry retains only validated IDs. AGENTS.md and the implementation spec document the required exception to company scope for these instance-level records. - Publication was limited to separate public staging prefixes on the existing preview host. Production remains empty/unpublished. No AWS policies or infrastructure were changed. ## Model Used OpenAI GPT-6 through Codex. The exact runtime model ID and context-window size are not exposed in this session. Capabilities used: reasoning, code editing, shell execution, tests, browser interaction, and tool use. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
1372 lines
39 KiB
TypeScript
1372 lines
39 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import { createRoot } from "react-dom/client";
|
|
import { flushSync } from "react-dom";
|
|
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { Layout } from "./Layout";
|
|
|
|
const mockHealthApi = vi.hoisted(() => ({
|
|
get: vi.fn(),
|
|
}));
|
|
|
|
const mockInstanceSettingsApi = vi.hoisted(() => ({
|
|
getGeneral: vi.fn(),
|
|
getExperimental: vi.fn(),
|
|
}));
|
|
|
|
const mockNavigate = vi.hoisted(() => vi.fn());
|
|
const mockSetSelectedCompanyId = vi.hoisted(() => vi.fn());
|
|
const mockSetSidebarOpen = vi.hoisted(() => vi.fn());
|
|
const mockCompanyState = vi.hoisted(() => ({
|
|
companies: [{ id: "company-1", issuePrefix: "PAP", name: "Paperclip" }],
|
|
selectedCompany: { id: "company-1", issuePrefix: "PAP", name: "Paperclip" },
|
|
selectedCompanyId: "company-1",
|
|
}));
|
|
const mockPluginSlots = vi.hoisted(() => ({
|
|
slots: [] as Array<Record<string, unknown>>,
|
|
}));
|
|
const mockUsePluginSlots = vi.hoisted(() => vi.fn());
|
|
const mockPluginSlotContexts = vi.hoisted(
|
|
() => [] as Array<Record<string, unknown>>,
|
|
);
|
|
const mockSetPeeking = vi.hoisted(() => vi.fn());
|
|
const mockSetForceCollapsed = vi.hoisted(() => vi.fn());
|
|
const mockSidebarState = vi.hoisted(() => ({
|
|
sidebarOpen: true,
|
|
isMobile: false,
|
|
collapsed: false,
|
|
peeking: false,
|
|
}));
|
|
let currentPathname = "/PAP/dashboard";
|
|
|
|
vi.mock("@/lib/router", () => ({
|
|
Outlet: () => <div>Outlet content</div>,
|
|
useLocation: () => ({
|
|
pathname: currentPathname,
|
|
search: "",
|
|
hash: "",
|
|
state: null,
|
|
}),
|
|
useNavigate: () => mockNavigate,
|
|
useNavigationType: () => "PUSH",
|
|
useParams: () => {
|
|
const [firstSegment, secondSegment, entityId] = currentPathname
|
|
.split("/")
|
|
.filter(Boolean);
|
|
return {
|
|
companyPrefix: firstSegment ?? "PAP",
|
|
pluginRoutePath: secondSegment,
|
|
agentId: secondSegment === "agents" ? entityId : undefined,
|
|
routineId: secondSegment === "routines" ? entityId : undefined,
|
|
};
|
|
},
|
|
}));
|
|
|
|
vi.mock("./Sidebar", () => ({
|
|
Sidebar: ({ contentHeaderControls }: { contentHeaderControls?: boolean }) => (
|
|
<div data-content-header-controls={String(contentHeaderControls ?? false)}>
|
|
Main company nav
|
|
</div>
|
|
),
|
|
}));
|
|
|
|
vi.mock("./CompanySettingsSidebar", () => ({
|
|
CompanySettingsSidebar: () => <div>Company settings sidebar</div>,
|
|
}));
|
|
|
|
vi.mock("./AppsSidebar", () => ({
|
|
AppsSidebar: () => <div>Apps sidebar</div>,
|
|
}));
|
|
|
|
vi.mock("./AgentContextualSidebar", () => ({
|
|
AgentContextualSidebar: ({ agentRef }: { agentRef: string }) => (
|
|
<div>Agent sidebar {agentRef}</div>
|
|
),
|
|
}));
|
|
|
|
vi.mock("./RoutineContextualSidebar", () => ({
|
|
RoutineContextualSidebar: ({ routineId }: { routineId: string }) => (
|
|
<div>Routine sidebar {routineId}</div>
|
|
),
|
|
}));
|
|
|
|
vi.mock("./SkillsContextualSidebar", () => ({
|
|
SkillsContextualSidebar: () => <div>Skills sidebar</div>,
|
|
}));
|
|
|
|
vi.mock("./AppConnectionSidebar", () => ({
|
|
AppDetailSidebar: (
|
|
props:
|
|
| { kind: "connection"; connectionId: string }
|
|
| { kind: "application"; applicationId: string },
|
|
) => (
|
|
<div>
|
|
{props.kind === "connection"
|
|
? `App detail sidebar connection ${props.connectionId}`
|
|
: `App detail sidebar application ${props.applicationId}`}
|
|
</div>
|
|
),
|
|
}));
|
|
|
|
vi.mock("./BreadcrumbBar", () => ({
|
|
BreadcrumbBar: () => <div>Breadcrumbs</div>,
|
|
}));
|
|
|
|
vi.mock("./PropertiesPanel", () => ({
|
|
PropertiesPanel: () => null,
|
|
}));
|
|
|
|
vi.mock("./CommandPalette", () => ({
|
|
CommandPalette: () => null,
|
|
}));
|
|
|
|
vi.mock("./NewIssueDialog", () => ({
|
|
NewIssueDialog: () => null,
|
|
}));
|
|
|
|
vi.mock("./NewProjectDialog", () => ({
|
|
NewProjectDialog: () => null,
|
|
}));
|
|
|
|
vi.mock("./NewGoalDialog", () => ({
|
|
NewGoalDialog: () => null,
|
|
}));
|
|
|
|
vi.mock("./NewAgentDialog", () => ({
|
|
NewAgentDialog: () => null,
|
|
}));
|
|
|
|
vi.mock("./KeyboardShortcutsCheatsheet", () => ({
|
|
KeyboardShortcutsCheatsheet: () => null,
|
|
}));
|
|
|
|
vi.mock("./ToastViewport", () => ({
|
|
ToastViewport: () => null,
|
|
}));
|
|
|
|
vi.mock("./AnnouncementWell", () => ({
|
|
AnnouncementWell: () => <div data-announcement-well />,
|
|
}));
|
|
|
|
vi.mock("./MobileBottomNav", () => ({
|
|
MobileBottomNav: () => null,
|
|
}));
|
|
|
|
vi.mock("./WorktreeBanner", () => ({
|
|
WorktreeBanner: () => null,
|
|
}));
|
|
|
|
vi.mock("./DevRestartBanner", () => ({
|
|
DevRestartBanner: () => null,
|
|
}));
|
|
|
|
vi.mock("./SidebarAccountMenu", () => ({
|
|
SidebarAccountMenu: () => <div>Account menu</div>,
|
|
}));
|
|
|
|
vi.mock("../plugins/slots", async () => {
|
|
const actual =
|
|
await vi.importActual<typeof import("../plugins/slots")>(
|
|
"../plugins/slots",
|
|
);
|
|
return {
|
|
resolveRouteSidebarSlot: actual.resolveRouteSidebarSlot,
|
|
usePluginSlots: (params: Record<string, unknown>) => {
|
|
mockUsePluginSlots(params);
|
|
return {
|
|
slots: mockPluginSlots.slots,
|
|
isLoading: false,
|
|
errorMessage: null,
|
|
};
|
|
},
|
|
PluginSlotMount: ({
|
|
slot,
|
|
context,
|
|
className,
|
|
}: {
|
|
slot: { displayName: string };
|
|
context: Record<string, unknown>;
|
|
className?: string;
|
|
}) => {
|
|
mockPluginSlotContexts.push(context);
|
|
return (
|
|
<div data-plugin-slot-class={className}>
|
|
Plugin route sidebar: {slot.displayName}
|
|
</div>
|
|
);
|
|
},
|
|
};
|
|
});
|
|
|
|
vi.mock("../context/DialogContext", () => ({
|
|
useDialog: () => ({
|
|
openNewIssue: vi.fn(),
|
|
openOnboarding: vi.fn(),
|
|
}),
|
|
useDialogActions: () => ({
|
|
openNewIssue: vi.fn(),
|
|
openOnboarding: vi.fn(),
|
|
}),
|
|
}));
|
|
|
|
vi.mock("../context/PanelContext", () => ({
|
|
usePanel: () => ({
|
|
togglePanelVisible: vi.fn(),
|
|
}),
|
|
}));
|
|
|
|
vi.mock("../context/CompanyContext", () => ({
|
|
useCompany: () => ({
|
|
companies: mockCompanyState.companies,
|
|
loading: false,
|
|
selectedCompany: mockCompanyState.selectedCompany,
|
|
selectedCompanyId: mockCompanyState.selectedCompanyId,
|
|
selectionSource: "manual",
|
|
setSelectedCompanyId: mockSetSelectedCompanyId,
|
|
}),
|
|
}));
|
|
|
|
vi.mock("../context/SidebarContext", () => ({
|
|
useSidebar: () => ({
|
|
sidebarOpen: mockSidebarState.sidebarOpen,
|
|
setSidebarOpen: mockSetSidebarOpen,
|
|
toggleSidebar: vi.fn(),
|
|
toggleCollapsed: vi.fn(),
|
|
collapsed: mockSidebarState.collapsed,
|
|
peeking: mockSidebarState.peeking,
|
|
setPeeking: mockSetPeeking,
|
|
setForceCollapsed: mockSetForceCollapsed,
|
|
isMobile: mockSidebarState.isMobile,
|
|
routeRequestsCollapsed: false,
|
|
setRouteRequestsCollapsed: vi.fn(),
|
|
}),
|
|
}));
|
|
|
|
vi.mock("../hooks/useKeyboardShortcuts", () => ({
|
|
useKeyboardShortcuts: () => undefined,
|
|
}));
|
|
|
|
vi.mock("../hooks/useCompanyPageMemory", () => ({
|
|
useCompanyPageMemory: () => undefined,
|
|
}));
|
|
|
|
vi.mock("../api/health", () => ({
|
|
healthApi: mockHealthApi,
|
|
}));
|
|
|
|
vi.mock("../api/instanceSettings", () => ({
|
|
instanceSettingsApi: mockInstanceSettingsApi,
|
|
}));
|
|
|
|
vi.mock("../lib/company-selection", () => ({
|
|
shouldSyncCompanySelectionFromRoute: () => false,
|
|
// No bounce in the shared harness: these tests exercise layout chrome, not
|
|
// archived-company routing (covered by company-selection unit tests and the
|
|
// archived-company-url e2e).
|
|
resolveArchivedCompanyBounce: () => null,
|
|
}));
|
|
|
|
vi.mock("../lib/main-content-focus", () => ({
|
|
scheduleMainContentFocus: () => () => undefined,
|
|
}));
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
(globalThis as any).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
async function act(callback: () => void | Promise<void>) {
|
|
let result: void | Promise<void> = undefined;
|
|
flushSync(() => {
|
|
result = callback();
|
|
});
|
|
await result;
|
|
}
|
|
|
|
async function flushReact() {
|
|
await act(async () => {
|
|
await Promise.resolve();
|
|
await new Promise((resolve) => window.setTimeout(resolve, 0));
|
|
});
|
|
}
|
|
|
|
describe("Layout", () => {
|
|
let container: HTMLDivElement;
|
|
|
|
beforeEach(() => {
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
currentPathname = "/PAP/dashboard";
|
|
mockCompanyState.companies = [
|
|
{ id: "company-1", issuePrefix: "PAP", name: "Paperclip" },
|
|
];
|
|
mockCompanyState.selectedCompany = {
|
|
id: "company-1",
|
|
issuePrefix: "PAP",
|
|
name: "Paperclip",
|
|
};
|
|
mockCompanyState.selectedCompanyId = "company-1";
|
|
mockHealthApi.get.mockResolvedValue({
|
|
status: "ok",
|
|
deploymentMode: "authenticated",
|
|
deploymentExposure: "private",
|
|
version: "1.2.3",
|
|
});
|
|
mockInstanceSettingsApi.getGeneral.mockResolvedValue({
|
|
keyboardShortcuts: false,
|
|
});
|
|
mockInstanceSettingsApi.getExperimental.mockResolvedValue({
|
|
enableApps: true,
|
|
});
|
|
mockPluginSlots.slots = [];
|
|
mockPluginSlotContexts.length = 0;
|
|
mockSidebarState.sidebarOpen = true;
|
|
mockSidebarState.isMobile = false;
|
|
mockSidebarState.collapsed = false;
|
|
mockSidebarState.peeking = false;
|
|
mockSetPeeking.mockClear();
|
|
mockSetForceCollapsed.mockClear();
|
|
});
|
|
|
|
afterEach(() => {
|
|
container.remove();
|
|
document.body.innerHTML = "";
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
it("does not render the deployment explainer in the shared layout", async () => {
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(mockHealthApi.get).toHaveBeenCalled();
|
|
expect(container.textContent).toContain("Breadcrumbs");
|
|
expect(container.textContent).toContain("Outlet content");
|
|
expect(container.querySelectorAll("[data-announcement-well]")).toHaveLength(1);
|
|
expect(container.textContent).not.toContain("Company rail");
|
|
expect(container.textContent).not.toContain("Authenticated private");
|
|
expect(container.textContent).not.toContain(
|
|
"Sign-in is required and this instance is intended for private-network access.",
|
|
);
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("scopes the Streamlined task-detail surface while preserving balanced horizontal gutters", async () => {
|
|
currentPathname = "/PAP/issues/PAP-1";
|
|
mockInstanceSettingsApi.getExperimental.mockResolvedValue({
|
|
enableApps: true,
|
|
enableStreamlinedUi: true,
|
|
});
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(
|
|
container.querySelector(".streamlined-task-detail-surface"),
|
|
).not.toBeNull();
|
|
expect(
|
|
container.querySelector("#main-content")?.classList.contains("pt-0"),
|
|
).toBe(true);
|
|
expect(
|
|
container.querySelector("#main-content")?.classList.contains("md:pt-0"),
|
|
).toBe(true);
|
|
expect(
|
|
container.querySelector("#main-content")?.classList.contains("p-4"),
|
|
).toBe(true);
|
|
expect(
|
|
container.querySelector("#main-content")?.classList.contains("md:p-6"),
|
|
).toBe(true);
|
|
expect(
|
|
container.querySelector("#main-content")?.classList.contains("pr-0"),
|
|
).toBe(false);
|
|
expect(
|
|
container.querySelector("#main-content")?.classList.contains("md:pr-0"),
|
|
).toBe(false);
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("collapses atomically when the pointer is still over the sidebar (no re-peek) — PAP-10676", async () => {
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
const renderLayout = async () => {
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
};
|
|
|
|
// The SidebarShell overlay panel carries the peek mouse handlers.
|
|
const panel = () =>
|
|
[...container.querySelectorAll<HTMLElement>("div")].find(
|
|
(el) =>
|
|
el.className.includes("inset-y-0") &&
|
|
el.className.includes("overflow-hidden"),
|
|
);
|
|
const hover = (el: HTMLElement) => {
|
|
// React derives onMouseEnter from a mouseover crossing in from outside.
|
|
el.dispatchEvent(
|
|
new MouseEvent("mouseover", {
|
|
bubbles: true,
|
|
relatedTarget: document.body,
|
|
}),
|
|
);
|
|
};
|
|
|
|
// Expanded, then hover the panel so the pointer is registered as inside.
|
|
await renderLayout();
|
|
const expandedPanel = panel();
|
|
expect(expandedPanel).toBeTruthy();
|
|
await act(async () => {
|
|
hover(expandedPanel!);
|
|
});
|
|
|
|
// Collapse while the pointer is still over the panel.
|
|
mockSidebarState.collapsed = true;
|
|
await renderLayout();
|
|
// The peek is cancelled atomically on collapse.
|
|
expect(mockSetPeeking).toHaveBeenCalledWith(false);
|
|
|
|
// A lingering/spurious hover while collapsed must NOT re-open the peek.
|
|
mockSetPeeking.mockClear();
|
|
const railPanel = panel();
|
|
await act(async () => {
|
|
hover(railPanel!);
|
|
});
|
|
await act(async () => {
|
|
await new Promise((r) => setTimeout(r, 80));
|
|
});
|
|
expect(mockSetPeeking).not.toHaveBeenCalledWith(true);
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("opens the peek when hovering a collapsed rail (positive control for the hover sim)", async () => {
|
|
mockSidebarState.collapsed = true;
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
|
|
const panel = [...container.querySelectorAll<HTMLElement>("div")].find(
|
|
(el) =>
|
|
el.className.includes("inset-y-0") &&
|
|
el.className.includes("overflow-hidden"),
|
|
);
|
|
expect(panel).toBeTruthy();
|
|
await act(async () => {
|
|
panel!.dispatchEvent(
|
|
new MouseEvent("mouseover", {
|
|
bubbles: true,
|
|
relatedTarget: document.body,
|
|
}),
|
|
);
|
|
});
|
|
await act(async () => {
|
|
await new Promise((r) => setTimeout(r, 80));
|
|
});
|
|
// A normal collapsed-rail hover (not just-collapsed) opens the peek.
|
|
expect(mockSetPeeking).toHaveBeenCalledWith(true);
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("replaces the app sidebar with settings navigation on Streamlined settings routes", async () => {
|
|
currentPathname = "/PAP/company/settings/access";
|
|
mockPluginSlots.slots = [
|
|
{
|
|
type: "page",
|
|
id: "company-page",
|
|
displayName: "Company Page",
|
|
exportName: "CompanyPage",
|
|
routePath: "company",
|
|
pluginId: "plugin-1",
|
|
pluginKey: "fake-plugin",
|
|
pluginDisplayName: "Fake Plugin",
|
|
pluginVersion: "1.0.0",
|
|
},
|
|
{
|
|
type: "routeSidebar",
|
|
id: "company-sidebar",
|
|
displayName: "Company Route Sidebar",
|
|
exportName: "CompanySidebar",
|
|
routePath: "company",
|
|
pluginId: "plugin-1",
|
|
pluginKey: "fake-plugin",
|
|
pluginDisplayName: "Fake Plugin",
|
|
pluginVersion: "1.0.0",
|
|
},
|
|
];
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain("Company settings sidebar");
|
|
expect(container.textContent).not.toContain("Main company nav");
|
|
const secondaryRail = container.querySelector("[data-secondary-sidebar]");
|
|
expect(secondaryRail).not.toBeNull();
|
|
expect(secondaryRail?.classList.contains("w-60")).toBe(false);
|
|
expect(container.textContent).not.toContain("Company rail");
|
|
expect(container.textContent).not.toContain("Instance sidebar");
|
|
expect(container.textContent).not.toContain("Plugin route sidebar");
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("keeps the global sidebar beside legacy settings navigation when Streamlined UI is off", async () => {
|
|
currentPathname = "/PAP/company/settings/access";
|
|
mockInstanceSettingsApi.getExperimental.mockResolvedValue({
|
|
enableApps: true,
|
|
enableStreamlinedUi: false,
|
|
});
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain("Main company nav");
|
|
expect(container.textContent).toContain("Company settings sidebar");
|
|
expect(mockSetForceCollapsed).toHaveBeenCalledWith(true);
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("renders a mobile company settings selector on company settings routes", async () => {
|
|
currentPathname = "/PAP/company/settings/secrets";
|
|
mockSidebarState.isMobile = true;
|
|
mockSidebarState.sidebarOpen = false;
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
const selector = container.querySelector("select");
|
|
expect(selector).not.toBeNull();
|
|
expect(selector?.value).toBe("secrets");
|
|
const selectorText = selector?.textContent?.toLowerCase() ?? "";
|
|
expect(selectorText).toContain("general");
|
|
expect(selectorText).toContain("export");
|
|
expect(selectorText).toContain("import");
|
|
expect(selectorText).toContain("members");
|
|
// Invites live on a tab of the Members page now, so the selector no
|
|
// longer carries a standalone entry for them.
|
|
expect(selectorText).not.toContain("invites");
|
|
expect(selectorText).toContain("secrets");
|
|
expect(selectorText).toContain("profile");
|
|
expect(selectorText).toContain("environments");
|
|
expect(selectorText).toContain("plugins");
|
|
expect(selectorText).not.toContain("instance general");
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("replaces the company nav on instance settings routes", async () => {
|
|
currentPathname = "/PAP/company/settings/instance/general";
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain("Company settings sidebar");
|
|
expect(container.textContent).not.toContain("Main company nav");
|
|
expect(container.textContent).not.toContain("Company rail");
|
|
expect(container.textContent).not.toContain("Plugin route sidebar");
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it.each(["/PAP/company/export", "/PAP/company/import"])(
|
|
"replaces the company nav with the shared settings sidebar on %s",
|
|
async (pathname) => {
|
|
currentPathname = pathname;
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain("Company settings sidebar");
|
|
expect(container.textContent).not.toContain("Main company nav");
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
},
|
|
);
|
|
|
|
it("keeps the company nav beside Apps navigation on legacy tools routes", async () => {
|
|
currentPathname = "/PAP/tools/runtime";
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain("Apps sidebar");
|
|
expect(container.textContent).toContain("Main company nav");
|
|
expect(container.textContent).not.toContain("Company settings sidebar");
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("mounts the Apps secondary sidebar regardless of the retired experimental flag", async () => {
|
|
currentPathname = "/PAP/apps";
|
|
mockInstanceSettingsApi.getExperimental.mockResolvedValue({
|
|
enableApps: false,
|
|
});
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain("Apps sidebar");
|
|
expect(container.textContent).toContain("Main company nav");
|
|
const secondaryRail = container.querySelector("[data-secondary-sidebar]");
|
|
expect(secondaryRail?.classList.contains("w-60")).toBe(true);
|
|
expect(secondaryRail?.classList.contains("shrink-0")).toBe(true);
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("keeps the Apps sidebar on the M8 advanced-setup tabs", async () => {
|
|
currentPathname = "/PAP/apps/advanced/paste-config";
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain("Apps sidebar");
|
|
expect(container.textContent).toContain("Main company nav");
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("keeps the Apps sidebar on legacy developer tabs behind the Advanced door", async () => {
|
|
currentPathname = "/PAP/apps/advanced/runtime";
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain("Apps sidebar");
|
|
expect(container.textContent).toContain("Main company nav");
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
// Reserved Apps subroutes are not connection ids. They must keep the
|
|
// top-level Apps sidebar, never mount a detail sidebar for a phantom app.
|
|
it.each(["browse", "connections", "vercel-connect", "review", "chat"])(
|
|
"keeps the Apps sidebar on the %s surface",
|
|
async (route) => {
|
|
currentPathname = `/PAP/apps/${route}`;
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain("Apps sidebar");
|
|
expect(container.textContent).toContain("Main company nav");
|
|
expect(container.textContent).not.toContain("App detail sidebar");
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
},
|
|
);
|
|
|
|
it("keeps the Apps sidebar on the gateways list and detail routes", async () => {
|
|
for (const pathname of [
|
|
"/PAP/apps/gateways",
|
|
"/PAP/apps/gateways/gw-1/overview",
|
|
]) {
|
|
currentPathname = pathname;
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain("Apps sidebar");
|
|
expect(container.textContent).toContain("Main company nav");
|
|
expect(container.textContent).not.toContain("App detail sidebar");
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
}
|
|
});
|
|
|
|
it("uses the app connection sidebar on app detail routes", async () => {
|
|
currentPathname = "/PAP/apps/conn-1/permissions";
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain(
|
|
"App detail sidebar connection conn-1",
|
|
);
|
|
expect(container.textContent).toContain("Main company nav");
|
|
expect(container.textContent).not.toContain("Apps sidebar");
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("uses the app detail sidebar on not-connected app routes", async () => {
|
|
currentPathname = "/PAP/apps/app/app-1/permissions";
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain(
|
|
"App detail sidebar application app-1",
|
|
);
|
|
expect(container.textContent).toContain("Main company nav");
|
|
expect(container.textContent).not.toContain("Apps sidebar");
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("keeps global navigation beside Skills, Agent, and Routine details", async () => {
|
|
async function renderAt(pathname: string) {
|
|
currentPathname = pathname;
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
return root;
|
|
}
|
|
|
|
for (const [pathname, sidebarText] of [
|
|
["/PAP/skills/studio", "Skills sidebar"],
|
|
["/PAP/agents/briefing-analyst/skills", "Agent sidebar briefing-analyst"],
|
|
[
|
|
"/PAP/agents/briefing-analyst/runs/run-1",
|
|
"Agent sidebar briefing-analyst",
|
|
],
|
|
["/PAP/routines/routine-1/overview", "Routine sidebar routine-1"],
|
|
] as const) {
|
|
const root = await renderAt(pathname);
|
|
expect(container.textContent).toContain(sidebarText);
|
|
expect(container.textContent).toContain("Main company nav");
|
|
const secondaryRail = container.querySelector("[data-secondary-sidebar]");
|
|
expect(secondaryRail?.classList.contains("w-60")).toBe(true);
|
|
expect(secondaryRail?.classList.contains("bg-background")).toBe(true);
|
|
const breadcrumb = Array.from(container.querySelectorAll("div")).find(
|
|
(element) => element.textContent === "Breadcrumbs",
|
|
);
|
|
expect(breadcrumb).toBeDefined();
|
|
expect(
|
|
breadcrumb && secondaryRail
|
|
? breadcrumb.compareDocumentPosition(secondaryRail) &
|
|
Node.DOCUMENT_POSITION_FOLLOWING
|
|
: 0,
|
|
).not.toBe(0);
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
container.innerHTML = "";
|
|
}
|
|
});
|
|
|
|
it("keeps global navigation with agent configuration navigation in the legacy shell", async () => {
|
|
mockInstanceSettingsApi.getExperimental.mockResolvedValue({
|
|
enableApps: true,
|
|
enableStreamlinedUi: false,
|
|
});
|
|
|
|
for (const pathname of [
|
|
"/PAP/agents/briefing-analyst/skills",
|
|
"/PAP/routines/routine-1/overview",
|
|
]) {
|
|
currentPathname = pathname;
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain("Main company nav");
|
|
if (pathname.includes("/agents/")) expect(container.textContent).toContain("Agent sidebar");
|
|
else expect(container.textContent).not.toContain("Agent sidebar");
|
|
expect(container.textContent).not.toContain("Routine sidebar");
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
container.innerHTML = "";
|
|
}
|
|
});
|
|
|
|
it("keeps the global rail beside Skills navigation in the legacy shell", async () => {
|
|
currentPathname = "/PAP/skills/studio";
|
|
mockInstanceSettingsApi.getExperimental.mockResolvedValue({
|
|
enableApps: true,
|
|
enableStreamlinedUi: false,
|
|
});
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain("Main company nav");
|
|
expect(container.textContent).toContain("Skills sidebar");
|
|
expect(mockSetForceCollapsed).toHaveBeenCalledWith(true);
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("keeps Agent and Routine collection routes in global navigation", async () => {
|
|
for (const pathname of [
|
|
"/PAP/agents/all",
|
|
"/PAP/agents/new",
|
|
"/PAP/routines",
|
|
]) {
|
|
currentPathname = pathname;
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain("Main company nav");
|
|
expect(container.textContent).not.toContain("Agent sidebar");
|
|
expect(container.textContent).not.toContain("Routine sidebar");
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
container.innerHTML = "";
|
|
}
|
|
});
|
|
|
|
it("renders a route-scoped plugin sidebar for a matching plugin page route", async () => {
|
|
currentPathname = "/PAP/wiki";
|
|
mockPluginSlots.slots = [
|
|
{
|
|
type: "page",
|
|
id: "wiki-page",
|
|
displayName: "Wiki Page",
|
|
exportName: "WikiPage",
|
|
routePath: "wiki",
|
|
pluginId: "plugin-1",
|
|
pluginKey: "wiki-plugin",
|
|
pluginDisplayName: "Wiki Plugin",
|
|
pluginVersion: "1.0.0",
|
|
},
|
|
{
|
|
type: "routeSidebar",
|
|
id: "wiki-route-sidebar",
|
|
displayName: "Wiki Sidebar",
|
|
exportName: "WikiSidebar",
|
|
routePath: "wiki",
|
|
pluginId: "plugin-1",
|
|
pluginKey: "wiki-plugin",
|
|
pluginDisplayName: "Wiki Plugin",
|
|
pluginVersion: "1.0.0",
|
|
},
|
|
];
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain(
|
|
"Plugin route sidebar: Wiki Sidebar",
|
|
);
|
|
expect(
|
|
container.querySelector("[data-plugin-slot-class='min-h-0 flex-1']"),
|
|
).not.toBeNull();
|
|
expect(container.textContent).not.toContain("Main company nav");
|
|
expect(container.textContent).not.toContain("Company settings sidebar");
|
|
expect(container.textContent).not.toContain("Instance sidebar");
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("keeps the route-scoped plugin sidebar on nested plugin page routes", async () => {
|
|
currentPathname = "/PAP/wiki/page/templates";
|
|
mockPluginSlots.slots = [
|
|
{
|
|
type: "page",
|
|
id: "wiki-page",
|
|
displayName: "Wiki Page",
|
|
exportName: "WikiPage",
|
|
routePath: "wiki",
|
|
pluginId: "plugin-1",
|
|
pluginKey: "wiki-plugin",
|
|
pluginDisplayName: "Wiki Plugin",
|
|
pluginVersion: "1.0.0",
|
|
},
|
|
{
|
|
type: "routeSidebar",
|
|
id: "wiki-route-sidebar",
|
|
displayName: "Wiki Sidebar",
|
|
exportName: "WikiSidebar",
|
|
routePath: "wiki",
|
|
pluginId: "plugin-1",
|
|
pluginKey: "wiki-plugin",
|
|
pluginDisplayName: "Wiki Plugin",
|
|
pluginVersion: "1.0.0",
|
|
},
|
|
];
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(mockUsePluginSlots).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
companyId: "company-1",
|
|
enabled: true,
|
|
}),
|
|
);
|
|
expect(container.textContent).toContain(
|
|
"Plugin route sidebar: Wiki Sidebar",
|
|
);
|
|
expect(container.textContent).not.toContain("Main company nav");
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("uses the route company context for plugin route sidebars on the first render", async () => {
|
|
currentPathname = "/ALT/wiki";
|
|
mockCompanyState.companies = [
|
|
{ id: "company-1", issuePrefix: "PAP", name: "Paperclip" },
|
|
{ id: "company-2", issuePrefix: "ALT", name: "Alternate" },
|
|
];
|
|
mockCompanyState.selectedCompany = {
|
|
id: "company-1",
|
|
issuePrefix: "PAP",
|
|
name: "Paperclip",
|
|
};
|
|
mockCompanyState.selectedCompanyId = "company-1";
|
|
mockPluginSlots.slots = [
|
|
{
|
|
type: "page",
|
|
id: "wiki-page",
|
|
displayName: "Wiki Page",
|
|
exportName: "WikiPage",
|
|
routePath: "wiki",
|
|
pluginId: "plugin-1",
|
|
pluginKey: "wiki-plugin",
|
|
pluginDisplayName: "Wiki Plugin",
|
|
pluginVersion: "1.0.0",
|
|
},
|
|
{
|
|
type: "routeSidebar",
|
|
id: "wiki-route-sidebar",
|
|
displayName: "Wiki Sidebar",
|
|
exportName: "WikiSidebar",
|
|
routePath: "wiki",
|
|
pluginId: "plugin-1",
|
|
pluginKey: "wiki-plugin",
|
|
pluginDisplayName: "Wiki Plugin",
|
|
pluginVersion: "1.0.0",
|
|
},
|
|
];
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(mockUsePluginSlots).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
companyId: "company-2",
|
|
enabled: true,
|
|
}),
|
|
);
|
|
expect(mockPluginSlotContexts).toContainEqual({
|
|
companyId: "company-2",
|
|
companyPrefix: "ALT",
|
|
});
|
|
expect(mockPluginSlotContexts).not.toContainEqual({
|
|
companyId: "company-1",
|
|
companyPrefix: "PAP",
|
|
});
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("keeps the normal company sidebar when a plugin page route is ambiguous", async () => {
|
|
currentPathname = "/PAP/wiki";
|
|
mockPluginSlots.slots = [
|
|
{
|
|
type: "page",
|
|
id: "wiki-page-a",
|
|
displayName: "Wiki Page A",
|
|
exportName: "WikiPageA",
|
|
routePath: "wiki",
|
|
pluginId: "plugin-1",
|
|
pluginKey: "wiki-plugin-a",
|
|
pluginDisplayName: "Wiki Plugin A",
|
|
pluginVersion: "1.0.0",
|
|
},
|
|
{
|
|
type: "page",
|
|
id: "wiki-page-b",
|
|
displayName: "Wiki Page B",
|
|
exportName: "WikiPageB",
|
|
routePath: "wiki",
|
|
pluginId: "plugin-2",
|
|
pluginKey: "wiki-plugin-b",
|
|
pluginDisplayName: "Wiki Plugin B",
|
|
pluginVersion: "1.0.0",
|
|
},
|
|
{
|
|
type: "routeSidebar",
|
|
id: "wiki-route-sidebar",
|
|
displayName: "Wiki Sidebar",
|
|
exportName: "WikiSidebar",
|
|
routePath: "wiki",
|
|
pluginId: "plugin-1",
|
|
pluginKey: "wiki-plugin-a",
|
|
pluginDisplayName: "Wiki Plugin A",
|
|
pluginVersion: "1.0.0",
|
|
},
|
|
];
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain("Main company nav");
|
|
expect(container.textContent).not.toContain("Plugin route sidebar");
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
async function renderLayoutRoot(): Promise<{
|
|
root: ReturnType<typeof createRoot>;
|
|
rootEl: HTMLElement;
|
|
}> {
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
const rootEl = container.firstElementChild as HTMLElement;
|
|
return { root, rootEl };
|
|
}
|
|
|
|
it("clips horizontal overflow on the mobile layout root so the viewport can't scroll sideways", async () => {
|
|
mockSidebarState.isMobile = true;
|
|
mockSidebarState.sidebarOpen = false;
|
|
const { root, rootEl } = await renderLayoutRoot();
|
|
|
|
expect(rootEl.tagName).toBe("DIV");
|
|
expect(rootEl.className).toContain("bg-background");
|
|
// The mobile root must clip horizontal overflow to prevent a stray wide
|
|
// descendant from making the whole viewport scroll sideways. clip (not
|
|
// hidden) keeps overflow-y visible so body scroll keeps working.
|
|
expect(rootEl.classList.contains("overflow-x-clip")).toBe(true);
|
|
expect(rootEl.classList.contains("overflow-hidden")).toBe(false);
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("clips overflow on the desktop layout root", async () => {
|
|
mockSidebarState.isMobile = false;
|
|
const { root, rootEl } = await renderLayoutRoot();
|
|
|
|
expect(rootEl.className).toContain("bg-background");
|
|
expect(rootEl.classList.contains("overflow-clip")).toBe(true);
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
});
|