76c88e5855
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Operators manage both company-scoped configuration and instance-level runtime/admin settings from the board UI > - Instance settings previously lived as their own top-level sidebar area, separate from the company settings context operators already use > - That split made settings navigation feel heavier and made instance configuration less discoverable from the settings tab > - This pull request moves instance settings under company settings while preserving the existing instance settings routes and plugin/admin surfaces > - The benefit is a smaller primary sidebar and a more coherent settings hierarchy for operators ## Linked Issues or Issue Description - Refs #338 - Internal: PAP-10491, PAP-10538 ## What Changed - Moved instance settings navigation under the company settings area. - Added route helpers and sidebar entries for nested instance settings paths. - Updated plugin/admin settings routes to use the company settings instance scope. - Preserved legacy instance-settings bookmarks through compatibility redirects that keep the active company prefix. - Updated focused UI and plugin tests for the new navigation shape. - Stabilized the process-loss retry test that was failing the serialized server shard in CI. - Rebased the branch onto current `paperclipai/paperclip` `master` and pushed the current head. ## Verification - `pnpm exec vitest run ui/src/components/CompanySettingsSidebar.test.tsx ui/src/components/access/CompanySettingsNav.test.tsx ui/src/lib/instance-settings.test.ts ui/src/components/InstanceSidebar.test.tsx ui/src/components/Layout.test.tsx ui/src/components/SidebarAccountMenu.test.tsx ui/src/pages/PluginPage.test.tsx ui/src/plugins/bridge.test.ts packages/shared/src/validators/plugin.test.ts` - `pnpm exec vitest run ui/src/lib/instance-settings.test.ts ui/src/components/CompanySettingsSidebar.test.tsx ui/src/components/access/CompanySettingsNav.test.tsx ui/src/components/Layout.test.tsx ui/src/plugins/bridge.test.ts` - `pnpm exec vitest run server/src/__tests__/heartbeat-process-recovery.test.ts -t "queues exactly one retry when the recorded local pid is dead"` - `pnpm test:run:serialized -- --shard-index 0 --shard-count 4` - GitHub PR checks are green on head `fe7b0955169dcae55cbe10889c1876a70ab0b80c`, including `verify`, `General tests (server)`, all serialized server shards, build, e2e, policy, security checks, and Greptile. - Confirmed the PR diff does not include `pnpm-lock.yaml` or `.github/workflows` changes. ## Risks - Medium UI/navigation risk: instance settings links are intentionally moving under company settings, so stale external bookmarks to legacy paths rely on the compatibility routing in this branch. - Low test-only risk from the CI stabilization commit: it makes the recovery assertion select the actual retry run by `retryOfRunId` instead of whichever non-original run appears first. - No database migrations. - No dependency lockfile or workflow changes. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used - OpenAI Codex coding agent based on GPT-5, with shell/tool execution in a local repository worktree. Exact context window was not exposed by the runtime. ## 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 run tests locally and they pass - [x] I have added or updated tests where applicable - [ ] If this change affects the UI, I have included before/after screenshots - [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>
401 lines
11 KiB
TypeScript
401 lines
11 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import { createRoot } from "react-dom/client";
|
|
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { CompanySettingsSidebar } from "./CompanySettingsSidebar";
|
|
|
|
const sidebarNavItemMock = vi.hoisted(() => vi.fn());
|
|
const mockSidebarBadgesApi = vi.hoisted(() => ({
|
|
get: vi.fn(),
|
|
}));
|
|
const mockInstanceSettingsApi = vi.hoisted(() => ({
|
|
getExperimental: vi.fn(),
|
|
}));
|
|
const mockPluginsApi = vi.hoisted(() => ({
|
|
list: vi.fn(),
|
|
}));
|
|
const mockUsePluginSlots = vi.hoisted(() => vi.fn());
|
|
|
|
vi.mock("@/lib/router", () => ({
|
|
Link: ({
|
|
children,
|
|
to,
|
|
onClick,
|
|
}: {
|
|
children: React.ReactNode;
|
|
to: string;
|
|
onClick?: () => void;
|
|
}) => (
|
|
<button type="button" data-to={to} onClick={onClick}>
|
|
{children}
|
|
</button>
|
|
),
|
|
NavLink: ({
|
|
children,
|
|
to,
|
|
}: {
|
|
children: React.ReactNode;
|
|
to: string;
|
|
}) => <a href={to}>{children}</a>,
|
|
}));
|
|
|
|
vi.mock("@/context/CompanyContext", () => ({
|
|
useCompany: () => ({
|
|
selectedCompanyId: "company-1",
|
|
selectedCompany: { id: "company-1", name: "Paperclip" },
|
|
}),
|
|
}));
|
|
|
|
vi.mock("@/context/SidebarContext", () => ({
|
|
useSidebar: () => ({
|
|
isMobile: false,
|
|
setSidebarOpen: vi.fn(),
|
|
}),
|
|
}));
|
|
|
|
vi.mock("./SidebarNavItem", () => ({
|
|
SidebarNavItem: (props: {
|
|
to: string;
|
|
label: string;
|
|
end?: boolean;
|
|
badge?: number;
|
|
}) => {
|
|
sidebarNavItemMock(props);
|
|
return <div>{props.label}</div>;
|
|
},
|
|
}));
|
|
|
|
vi.mock("./SidebarCompanyMenu", () => ({
|
|
SidebarCompanyMenu: () => <div>Workspace switcher</div>,
|
|
}));
|
|
|
|
vi.mock("@/api/sidebarBadges", () => ({
|
|
sidebarBadgesApi: mockSidebarBadgesApi,
|
|
}));
|
|
|
|
vi.mock("@/api/instanceSettings", () => ({
|
|
instanceSettingsApi: mockInstanceSettingsApi,
|
|
}));
|
|
|
|
vi.mock("@/api/plugins", () => ({
|
|
pluginsApi: mockPluginsApi,
|
|
}));
|
|
|
|
vi.mock("@/plugins/slots", () => ({
|
|
usePluginSlots: mockUsePluginSlots,
|
|
}));
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
(globalThis as any).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
async function act(callback: () => void | Promise<void>) {
|
|
await callback();
|
|
await Promise.resolve();
|
|
await new Promise((resolve) => window.setTimeout(resolve, 0));
|
|
}
|
|
|
|
async function flushReact() {
|
|
for (let i = 0; i < 3; i += 1) {
|
|
await Promise.resolve();
|
|
await new Promise((resolve) => window.setTimeout(resolve, 0));
|
|
}
|
|
}
|
|
|
|
describe("CompanySettingsSidebar", () => {
|
|
let container: HTMLDivElement;
|
|
|
|
beforeEach(() => {
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
mockSidebarBadgesApi.get.mockResolvedValue({
|
|
inbox: 0,
|
|
approvals: 0,
|
|
failedRuns: 0,
|
|
joinRequests: 2,
|
|
});
|
|
mockInstanceSettingsApi.getExperimental.mockResolvedValue({
|
|
enableCloudSync: false,
|
|
});
|
|
mockPluginsApi.list.mockResolvedValue([]);
|
|
mockUsePluginSlots.mockReturnValue({
|
|
slots: [],
|
|
isLoading: false,
|
|
errorMessage: null,
|
|
});
|
|
mockInstanceSettingsApi.getExperimental.mockResolvedValue({
|
|
enableCloudSync: false,
|
|
});
|
|
});
|
|
|
|
afterEach(() => {
|
|
container.remove();
|
|
document.body.innerHTML = "";
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
it("renders the company back link and the settings sections in the sidebar", async () => {
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<CompanySettingsSidebar />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain("Paperclip");
|
|
expect(container.textContent).toContain("Company Settings");
|
|
expect(container.textContent).toContain("Company settings");
|
|
expect(container.textContent).toContain("Instance settings");
|
|
expect(container.textContent).toContain("General");
|
|
expect(container.textContent).toContain("Environments");
|
|
expect(container.textContent).not.toContain("Cloud upstream");
|
|
expect(container.textContent).toContain("Members");
|
|
expect(container.textContent).not.toContain("Cloud upstream");
|
|
expect(container.textContent).toContain("Invites");
|
|
expect(container.textContent).toContain("Secrets");
|
|
expect(sidebarNavItemMock).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
to: "/company/settings",
|
|
label: "General",
|
|
end: true,
|
|
}),
|
|
);
|
|
expect(sidebarNavItemMock).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
to: "/company/settings/environments",
|
|
label: "Environments",
|
|
end: true,
|
|
}),
|
|
);
|
|
expect(sidebarNavItemMock).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
to: "/company/settings/members",
|
|
label: "Members",
|
|
badge: 2,
|
|
end: true,
|
|
}),
|
|
);
|
|
expect(sidebarNavItemMock).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
to: "/company/settings/invites",
|
|
label: "Invites",
|
|
end: true,
|
|
}),
|
|
);
|
|
expect(sidebarNavItemMock).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
to: "/company/settings/secrets",
|
|
label: "Secrets",
|
|
end: true,
|
|
}),
|
|
);
|
|
expect(sidebarNavItemMock).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
to: "/company/settings/instance/profile",
|
|
label: "Profile",
|
|
end: true,
|
|
}),
|
|
);
|
|
expect(sidebarNavItemMock).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
to: "/company/settings/instance/general",
|
|
label: "General",
|
|
end: true,
|
|
}),
|
|
);
|
|
expect(sidebarNavItemMock).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
to: "/company/settings/instance/plugins",
|
|
label: "Plugins",
|
|
}),
|
|
);
|
|
expect(sidebarNavItemMock).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
to: "/company/settings/instance/adapters",
|
|
label: "Adapters",
|
|
}),
|
|
);
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("shows cloud upstream only when cloud sync is enabled", async () => {
|
|
mockInstanceSettingsApi.getExperimental.mockResolvedValue({
|
|
enableCloudSync: true,
|
|
});
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<CompanySettingsSidebar />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain("Cloud upstream");
|
|
expect(sidebarNavItemMock).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
to: "/company/settings/cloud-upstream",
|
|
label: "Cloud upstream",
|
|
end: true,
|
|
}),
|
|
);
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("renders company settings pages contributed by ready plugins", async () => {
|
|
mockUsePluginSlots.mockReturnValue({
|
|
slots: [
|
|
{
|
|
type: "companySettingsPage",
|
|
id: "permissions",
|
|
displayName: "Permissions",
|
|
exportName: "PermissionsPage",
|
|
routePath: "permissions",
|
|
pluginId: "plugin-1",
|
|
pluginKey: "permissions-extension",
|
|
pluginDisplayName: "Permissions Extension",
|
|
pluginVersion: "0.1.0",
|
|
},
|
|
],
|
|
isLoading: false,
|
|
errorMessage: null,
|
|
});
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<CompanySettingsSidebar />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain("Permissions");
|
|
expect(sidebarNavItemMock).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
to: "/company/settings/permissions",
|
|
label: "Permissions",
|
|
end: true,
|
|
}),
|
|
);
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("shows cloud upstream only when cloud sync is enabled", async () => {
|
|
mockInstanceSettingsApi.getExperimental.mockResolvedValue({
|
|
enableCloudSync: true,
|
|
});
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<CompanySettingsSidebar />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain("Cloud upstream");
|
|
expect(sidebarNavItemMock).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
to: "/company/settings/cloud-upstream",
|
|
label: "Cloud upstream",
|
|
end: true,
|
|
}),
|
|
);
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("renders instance plugin links while filtering sandbox-provider-only plugins", async () => {
|
|
mockPluginsApi.list.mockResolvedValue([
|
|
{
|
|
id: "linear",
|
|
packageName: "@example/linear",
|
|
manifestJson: {
|
|
displayName: "Linear",
|
|
environmentDrivers: [],
|
|
},
|
|
},
|
|
{
|
|
id: "sandbox-only",
|
|
packageName: "@example/sandbox",
|
|
manifestJson: {
|
|
displayName: "Sandbox only",
|
|
environmentDrivers: [{ kind: "sandbox_provider", driverKey: "e2b" }],
|
|
},
|
|
},
|
|
{
|
|
id: "hybrid",
|
|
packageName: "@example/hybrid",
|
|
manifestJson: {
|
|
displayName: "Hybrid",
|
|
environmentDrivers: [
|
|
{ kind: "sandbox_provider", driverKey: "e2b" },
|
|
{ kind: "environment_driver", driverKey: "ssh" },
|
|
],
|
|
},
|
|
},
|
|
]);
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<CompanySettingsSidebar />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
|
|
const pluginLinks = Array.from(
|
|
container.querySelectorAll<HTMLAnchorElement>('a[href^="/company/settings/instance/plugins/"]'),
|
|
);
|
|
expect(pluginLinks.map((link) => link.getAttribute("href"))).toEqual([
|
|
"/company/settings/instance/plugins/linear",
|
|
"/company/settings/instance/plugins/hybrid",
|
|
]);
|
|
expect(container.textContent).toContain("Linear");
|
|
expect(container.textContent).toContain("Hybrid");
|
|
expect(container.textContent).not.toContain("Sandbox only");
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
});
|