mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-22 11:54:35 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Routines start agent work on a schedule, from a webhook, or on demand > - The routine detail page split one routine across eight sections behind a section sidebar (overview, triggers, variables, secrets, delivery, runs, activity, history) > - People had to hunt through sections to see what a routine does and to change it, and a finished webhook could not be tested again without starting the routine > - This pull request makes the approved two-column routine page, one Edit dialog and one Webhook dialog the real routed page, and lets a live webhook go back into test mode > - The benefit is one page that answers what the routine does, when it runs, who runs it and what it made, with every change in one dialog ## Linked Issues or Issue Description **Problem** The routine detail page spreads one routine over eight sections and a section sidebar. Changing a routine means visiting several sections, each with its own save bar. A webhook that is already live cannot be tested again: the API only accepts `setupPending: false`, so testing a live webhook starts the routine. **Proposed solution** Ship the reviewed design (stories `routine-page-design`, `routine-edit-dialog-design`, `routine-webhook-dialog-design`) as the routed page in both UI shells, wired to the real API. Let `PATCH /api/routine-triggers/:id` accept `setupPending: true` for a live webhook so the next events are checked but never start the routine. **Alternatives considered** Keep the sections and restyle them. The owner rejected this: the section sidebar should go. ## What Changed - `/routines/:id` renders `RoutinePage` in both shells (`RoutineDetail.production.tsx` is removed). Status switch, Repeats rows, default agent, responsible user, project, Asks for, Secrets, Run rules, Managed by plugin, Instructions with Show all, copy and the comment count, and History. - History is paged: 20 tasks per page from `GET /companies/:id/issues?originKind=routine_execution&originId=…&sortField=created&sortDir=desc&limit=21&offset=…`, with a real Load more. Coalesced runs show as "folded into a task". - A failed refetch keeps the loaded page on screen (`useQueryView`); a History failure shows `QueryErrorState` in place. - Header: Edit, "…" (Version history, Audit log, Archive / Restore) and Run now. In the streamlined desktop shell they sit in the breadcrumb toolbar; elsewhere above the page. - Version history (`/routines/:id/history`, restore and restored-webhook keys kept) and Audit log (`/routines/:id/activity`, `RoutineAuditActivity`) open as sub-views with a way back. Old section addresses and `?tab=` redirect to `/routines/:id`. - Edit dialog saves title, instructions, variables, secrets, agent, project and responsible user in one request against the revision the dialog opened with (save conflict shows "changed while you were editing"). The first schedule is created, changed or removed after that. Priority and delivery settings are never sent, so saved values stay. - Webhooks are created, changed, tested and removed (with Undo) right away from the Edit dialog, with the Webhook dialog nested inside it. Closing the Webhook dialog ends setup or test mode. A webhook left in test mode shows "Testing · events don’t run" on the page and offers Finish testing. - Responsibility (only with `enableResponsibilities`): the page shows direct and through-project responsibilities from the link lookup; the dialog links or unlinks the direct one. With the flag off nothing is fetched or shown. - The routines list creates routines with the same dialog in create mode, filed in the open folder, and opens the new routine page. - Server: `setupPending: true` on a live webhook enters test mode (planned by a pure `planTriggerUpdate`, which also gives the activity action) (422 for other trigger kinds; 409 for a disabled or removed webhook or an archived routine). Test deliveries keep the last real delivery as `lastWebhookDelivery.previous`, and finishing testing restores it. Activity `routine.trigger_test_started`. - Additions to the reviewed design, from review, so no capability is lost: the schedule popover has Pause/Resume; standing-check and API rows open a small popover with Pause/Resume and Remove; removing a trigger from the page leaves a "… removed. Undo" line under Repeats. Stories: `StandingCheckOpened`, `ScheduleTriggerPaused(Opened)`, `RemovedWithUndo`. - Save is several requests (routine, schedule, responsibility). It changes only the schedule the form opened with, records each finished step, and a partial failure says what was saved and that saving again finishes it. The dialog cannot be dismissed while saving. Failed reads show a Retry state, never empty choices. - Removed: the routine section sidebar and contextual sidebar, the trigger wizard, trigger cards, save bar, section components and their tests. - Storybook: the three routine stories moved to `stories/routines` as current production stories, a new story mounts the routed page against a fixture API, and stories that used the old page were updated or removed. ## Verification - `pnpm --filter @paperclipai/server exec vitest run src/__tests__/routines-e2e.test.ts` (17/17) and `src/__tests__/routines-service.test.ts` (105/105). - `pnpm exec vitest run` on the routine page, routines list, routine form, webhook instructions, Layout, shell navigation, audit and editor tests: 275 tests pass. - `cd ui && npx tsc -p tsconfig.json --noEmit`, `node scripts/check-token-gates.mjs`, `node scripts/check-maps.mjs`, `node scripts/storybook-catalog.mjs --check`: pass. - `pnpm verify` exits 2 (global CI input changed); required CI supplies the broad coverage. - Manual: an isolated worktree instance (`pnpm paperclipai worktree init --empty`, `pnpm dev`) with a seeded routine. Headless Playwright: an old `/triggers` address redirects, no section sidebar, History shows 20 then 23 after Load more, the schedule popover opens, pause and resume, Edit → Add webhook → created key → Finish, title save, Test webhook → Finish testing, Version history, Audit log shows "Started testing a webhook", phone width has no horizontal overflow, and Create routine from the list opens the new page. No console errors or failed API calls. ## Risks - Behaviour change: the section pages are gone. Old links redirect to the single page. - The delivery-setting editors (concurrency, catch-up, activity gate) and priority are removed from the UI. Saved values stay, and the API still accepts them. - The create dialog no longer offers a folder picker or delivery settings. A new routine goes into the folder the list is showing and takes the default settings. - Replace key in the Webhook dialog acts at once, as in the reviewed design. The old confirmation is gone. - No migration. `lastWebhookDelivery.previous` is an optional field inside the existing jsonb column. ## Model Used - Claude Opus 5.5 (`claude-opus-5-5`), Anthropic, in Claude Code with tool use (shell, file edits, headless browser) and subagents for the server change and the Storybook move. ## 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 - [ ] All Paperclip CI gates are green - [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com>
1306 lines
42 KiB
TypeScript
1306 lines
42 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";
|
|
import { Layout as ProductionLayout } from "./Layout.production";
|
|
import { existsSync, readFileSync } from "node:fs";
|
|
import { act as reactAct } from "react";
|
|
|
|
const classicWorkspace = vi.hoisted(() => ({ enabled: true }));
|
|
vi.mock("./Sidebar.production", async () => await import("./Sidebar"));
|
|
vi.mock("./CompanySettingsSidebar.production", async () => await import("./CompanySettingsSidebar"));
|
|
vi.mock("./AppsSidebar.production", async () => await import("./AppsSidebar"));
|
|
vi.mock("./AppConnectionSidebar.production", async () => await import("./AppConnectionSidebar"));
|
|
vi.mock("./BreadcrumbBar.production", async () => await import("./BreadcrumbBar"));
|
|
vi.mock("./SidebarAccountMenu.production", async () => await import("./SidebarAccountMenu"));
|
|
vi.mock("@/hooks/useCoordinatorWorkspaceEnabled", () => ({
|
|
useCoordinatorWorkspaceEnabled: () => ({ enabled: !classicWorkspace.enabled, loaded: true, userId: "viewer" }),
|
|
}));
|
|
const browserTimeZoneSync = vi.hoisted(() => vi.fn());
|
|
vi.mock("@/hooks/useBrowserTimeZoneSync", () => ({ useBrowserTimeZoneSync: browserTimeZoneSync }));
|
|
|
|
const mockDesignSandbox = vi.hoisted(() => ({ enabled: false }));
|
|
vi.mock("@/context/DesignSandboxContext", () => ({ useDesignSandbox: () => mockDesignSandbox.enabled }));
|
|
vi.mock("./DesignSandboxSidebar", () => ({ DesignSandboxSidebar: () => <div>Proposed sidebar</div> }));
|
|
|
|
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 mockSidebarState = vi.hoisted(() => ({
|
|
sidebarOpen: true,
|
|
isMobile: 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>,
|
|
AppsMobileNav: () => <nav aria-label="Mobile connectors">Browse Review</nav>,
|
|
}));
|
|
|
|
vi.mock("./AgentContextualSidebar", () => ({
|
|
AgentContextualSidebar: ({ agentRef }: { agentRef: string }) => (
|
|
<div>Agent sidebar {agentRef}</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,
|
|
}));
|
|
|
|
// Overlay account/company lifecycle has its own integration test. These tests
|
|
// exercise route navigation with intentionally minimal context providers.
|
|
vi.mock("./PluginAppShellOverlays", () => ({
|
|
PluginAppShellOverlays: () => 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("./GitHubStarPrompt", () => ({
|
|
GitHubStarPrompt: () => null,
|
|
}));
|
|
|
|
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", () => ({
|
|
useDialogState: () => ({ newIssueOpen: false, newProjectOpen: false, newGoalOpen: false, newAgentOpen: false }),
|
|
useDialog: () => ({
|
|
openNewIssue: vi.fn(),
|
|
openOnboarding: vi.fn(),
|
|
}),
|
|
useDialogActions: () => ({
|
|
openNewIssue: vi.fn(),
|
|
openOnboarding: vi.fn(),
|
|
}),
|
|
}));
|
|
|
|
vi.mock("../context/PanelContext", () => ({
|
|
usePanel: () => ({
|
|
togglePanelVisible: vi.fn(),
|
|
setPanelVisible: 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(),
|
|
isMobile: mockSidebarState.isMobile,
|
|
}),
|
|
}));
|
|
|
|
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));
|
|
});
|
|
}
|
|
|
|
function renderLayoutView(root: ReturnType<typeof createRoot>, queryClient: QueryClient) {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
}
|
|
|
|
describe("Layout", () => {
|
|
let container: HTMLDivElement;
|
|
|
|
it.each([
|
|
{ ShellLayout: Layout, width: 1024 },
|
|
{ ShellLayout: Layout, width: 1366 },
|
|
{ ShellLayout: ProductionLayout, width: 1024 },
|
|
{ ShellLayout: ProductionLayout, width: 1366 },
|
|
])("sizes a desktop-width conversation above the keyboard (%#)", async ({ ShellLayout, width }) => {
|
|
const viewport = Object.assign(new EventTarget(), { height: 1024, scale: 1, offsetTop: 0 });
|
|
vi.stubGlobal("visualViewport", viewport);
|
|
vi.stubGlobal("innerWidth", width);
|
|
Object.defineProperty(document.documentElement, "clientHeight", { configurable: true, value: 1024 });
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({ defaultOptions: { queries: { retry: false } } });
|
|
try {
|
|
await reactAct(async () => root.render(<QueryClientProvider client={queryClient}><ShellLayout /></QueryClientProvider>));
|
|
const shell = container.querySelector(".paperclip-app-shell") as HTMLElement;
|
|
const conversation = document.createElement("div");
|
|
conversation.dataset.taskChatShell = "";
|
|
shell.querySelector("#main-content")!.append(conversation);
|
|
viewport.height = 600;
|
|
viewport.dispatchEvent(new Event("resize"));
|
|
expect(shell.dataset.mobile).toBeUndefined();
|
|
expect(shell.dataset.keyboardOpen).toBe("true");
|
|
expect(shell.style.getPropertyValue("--mobile-chat-viewport-height")).toBe("600px");
|
|
|
|
const style = document.createElement("style");
|
|
const css = readFileSync(existsSync("ui/src/index.css") ? "ui/src/index.css" : "src/index.css", "utf8");
|
|
style.textContent = css.slice(css.indexOf("html:has(.paperclip-app-shell"), css.indexOf("@media (prefers-reduced-motion: reduce)", css.indexOf("html:has(.paperclip-app-shell")));
|
|
document.head.append(style);
|
|
try {
|
|
expect(getComputedStyle(shell).position).toBe("fixed");
|
|
const sizingRule = Array.from(style.sheet!.cssRules).find((rule) =>
|
|
"selectorText" in rule && shell.matches((rule as CSSStyleRule).selectorText) && (rule as CSSStyleRule).style.height,
|
|
) as CSSStyleRule;
|
|
expect(sizingRule.style.height).toBe("var(--mobile-chat-viewport-height)");
|
|
expect(getComputedStyle(shell.querySelector(".app-main-row")!).minHeight).toBe("0px");
|
|
expect(getComputedStyle(shell.querySelector("#main-content")!).overflow).toBe("hidden");
|
|
viewport.scale = 2;
|
|
viewport.height = 300;
|
|
viewport.dispatchEvent(new Event("resize"));
|
|
expect(shell.style.getPropertyValue("--mobile-chat-viewport-height")).toBe("600px");
|
|
viewport.scale = 1;
|
|
viewport.height = 1024;
|
|
viewport.dispatchEvent(new Event("resize"));
|
|
expect(shell.dataset.keyboardOpen).toBeUndefined();
|
|
expect(getComputedStyle(shell).position).not.toBe("fixed");
|
|
viewport.height = 600;
|
|
viewport.dispatchEvent(new Event("resize"));
|
|
conversation.remove();
|
|
expect(getComputedStyle(shell).position).not.toBe("fixed");
|
|
} finally { style.remove(); }
|
|
} finally {
|
|
await reactAct(async () => root.unmount());
|
|
queryClient.clear();
|
|
Reflect.deleteProperty(document.documentElement, "clientHeight");
|
|
vi.unstubAllGlobals();
|
|
}
|
|
});
|
|
|
|
beforeEach(() => {
|
|
classicWorkspace.enabled = true;
|
|
mockDesignSandbox.enabled = false;
|
|
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({
|
|
censorUsernameInLogs: false,
|
|
});
|
|
mockInstanceSettingsApi.getExperimental.mockResolvedValue({
|
|
enableApps: true,
|
|
});
|
|
mockPluginSlots.slots = [];
|
|
mockPluginSlotContexts.length = 0;
|
|
mockSidebarState.sidebarOpen = true;
|
|
mockSidebarState.isMobile = false;
|
|
});
|
|
|
|
afterEach(() => {
|
|
container.remove();
|
|
document.body.innerHTML = "";
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
it("uses the standard workspace presentation when Classic is off", async () => {
|
|
classicWorkspace.enabled = false;
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({ defaultOptions: { queries: { retry: false } } });
|
|
try {
|
|
await act(async () => renderLayoutView(root, queryClient));
|
|
await flushReact();
|
|
expect(container.querySelector(".coordinator-workspace")).not.toBeNull();
|
|
classicWorkspace.enabled = true;
|
|
await act(async () => renderLayoutView(root, queryClient));
|
|
expect(container.querySelector(".coordinator-workspace")).toBeNull();
|
|
} finally { await act(async () => root.unmount()); queryClient.clear(); }
|
|
});
|
|
|
|
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 () => {
|
|
renderLayoutView(root, queryClient);
|
|
});
|
|
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 () => {
|
|
renderLayoutView(root, queryClient);
|
|
});
|
|
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("retains settings navigation and route content beside the proposed sandbox sidebar", async () => {
|
|
currentPathname = "/PAP/company/settings/access";
|
|
mockDesignSandbox.enabled = 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();
|
|
expect(container.textContent).toContain("Proposed sidebar");
|
|
expect(container.textContent).toContain("Company settings sidebar");
|
|
expect(container.textContent).toContain("Outlet content");
|
|
expect(container.textContent).not.toContain("Main company nav");
|
|
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 () => {
|
|
renderLayoutView(root, queryClient);
|
|
});
|
|
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 () => {
|
|
renderLayoutView(root, queryClient);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain("Main company nav");
|
|
expect(container.textContent).toContain("Company settings sidebar");
|
|
expect(container.querySelector<HTMLElement>(".sidebar-shell-panel")?.style.width).toBe("240px");
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it.each(["/PAP/apps", "/PAP/apps/review"])("shows top connector segments without a side rail on mobile: %s", async (path) => {
|
|
currentPathname = path;
|
|
mockSidebarState.isMobile = true;
|
|
mockSidebarState.sidebarOpen = false;
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({ defaultOptions: { queries: { retry: false } } });
|
|
await act(async () => renderLayoutView(root, queryClient));
|
|
await flushReact();
|
|
expect(container.querySelector('#main-content [aria-label="Mobile connectors"]')).not.toBeNull();
|
|
expect(container.querySelector('.app-content-row [data-secondary-sidebar]')).toBeNull();
|
|
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 () => {
|
|
renderLayoutView(root, queryClient);
|
|
});
|
|
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 () => {
|
|
renderLayoutView(root, queryClient);
|
|
});
|
|
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 () => {
|
|
renderLayoutView(root, queryClient);
|
|
});
|
|
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 () => {
|
|
renderLayoutView(root, queryClient);
|
|
});
|
|
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 () => {
|
|
renderLayoutView(root, queryClient);
|
|
});
|
|
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 () => {
|
|
renderLayoutView(root, queryClient);
|
|
});
|
|
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 () => {
|
|
renderLayoutView(root, queryClient);
|
|
});
|
|
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 () => {
|
|
renderLayoutView(root, queryClient);
|
|
});
|
|
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 () => {
|
|
renderLayoutView(root, queryClient);
|
|
});
|
|
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 () => {
|
|
renderLayoutView(root, queryClient);
|
|
});
|
|
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 () => {
|
|
renderLayoutView(root, queryClient);
|
|
});
|
|
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 Agent details", async () => {
|
|
async function renderAt(pathname: string) {
|
|
currentPathname = pathname;
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
renderLayoutView(root, queryClient);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
return root;
|
|
}
|
|
|
|
for (const [pathname, sidebarText] of [
|
|
["/PAP/agents/briefing-analyst/skills", "Agent sidebar briefing-analyst"],
|
|
[
|
|
"/PAP/agents/briefing-analyst/runs/run-1",
|
|
"Agent sidebar briefing-analyst",
|
|
],
|
|
] 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 () => {
|
|
renderLayoutView(root, queryClient);
|
|
});
|
|
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");
|
|
if (pathname.includes("/routines/")) expect(container.querySelector("[data-secondary-sidebar]")).toBeNull();
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
container.innerHTML = "";
|
|
}
|
|
});
|
|
|
|
it("uses the global rail without secondary Skills navigation in the streamlined shell", async () => {
|
|
for (const path of ["/PAP/skills", "/PAP/skills?tab=discover", "/PAP/skills/studio", "/PAP/skills/sources"]) {
|
|
currentPathname = path;
|
|
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("Skills sidebar");
|
|
await act(async () => root.unmount());
|
|
container.innerHTML = "";
|
|
}
|
|
});
|
|
|
|
it("keeps the global sidebar 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 () => {
|
|
renderLayoutView(root, queryClient);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain("Main company nav");
|
|
expect(container.textContent).toContain("Skills sidebar");
|
|
expect(container.querySelector<HTMLElement>(".sidebar-shell-panel")?.style.width).toBe("240px");
|
|
|
|
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 () => {
|
|
renderLayoutView(root, queryClient);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain("Main company nav");
|
|
expect(container.textContent).not.toContain("Agent sidebar");
|
|
if (pathname.includes("/routines/")) expect(container.querySelector("[data-secondary-sidebar]")).toBeNull();
|
|
|
|
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 () => {
|
|
renderLayoutView(root, queryClient);
|
|
});
|
|
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 () => {
|
|
renderLayoutView(root, queryClient);
|
|
});
|
|
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 () => {
|
|
renderLayoutView(root, queryClient);
|
|
});
|
|
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 () => {
|
|
renderLayoutView(root, queryClient);
|
|
});
|
|
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 () => {
|
|
renderLayoutView(root, queryClient);
|
|
});
|
|
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();
|
|
});
|
|
});
|
|
});
|