Files
PaperClipAI/ui/src/plugins/bridge.test.ts
T
DottaandPaperclip 76c88e5855 [codex] Move instance settings under company settings (#7680)
## 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>
2026-06-07 17:23:53 -05:00

336 lines
11 KiB
TypeScript

// @vitest-environment jsdom
import * as React from "react";
import * as ReactDOM from "react-dom";
import { flushSync } from "react-dom";
import { createRoot } from "react-dom/client";
import type { MouseEvent as ReactMouseEvent } from "react";
import { renderToStaticMarkup } from "react-dom/server";
import { MemoryRouter } from "react-router-dom";
import { afterEach, describe, expect, it } from "vitest";
import {
FileTree as SdkFileTree,
ManagedRoutinesList as SdkManagedRoutinesList,
MarkdownBlock as SdkMarkdownBlock,
MarkdownEditor as SdkMarkdownEditor,
type FileTreeNode as SdkFileTreeNode,
} from "../../../packages/plugins/sdk/src/ui/components";
import { SidebarProvider, useSidebar } from "@/context/SidebarContext";
import {
PluginBridgeContext,
resolveHostNavigationHref,
shouldHandleHostNavigationClick,
useHostNavigation,
type PluginBridgeContextValue,
} from "./bridge";
import { initPluginBridge } from "./bridge-init";
import { _createReactShimSourceForTests } from "./slots";
function clickEvent(
overrides: Partial<ReactMouseEvent<HTMLAnchorElement>> = {},
): ReactMouseEvent<HTMLAnchorElement> {
return {
defaultPrevented: false,
button: 0,
metaKey: false,
altKey: false,
ctrlKey: false,
shiftKey: false,
currentTarget: {
hasAttribute: () => false,
},
...overrides,
} as ReactMouseEvent<HTMLAnchorElement>;
}
afterEach(() => {
delete globalThis.__paperclipPluginBridge__;
});
function act(callback: () => void) {
flushSync(callback);
}
describe("plugin host navigation", () => {
it("resolves plugin page routes into the active company prefix", () => {
expect(resolveHostNavigationHref("/wiki", "PAP")).toBe("/PAP/wiki");
expect(resolveHostNavigationHref("/wiki?tab=browse#page", "pap")).toBe(
"/PAP/wiki?tab=browse#page",
);
});
it("does not double-prefix active company paths or global host paths", () => {
expect(resolveHostNavigationHref("/PAP/wiki", "PAP")).toBe("/PAP/wiki");
expect(resolveHostNavigationHref("/pap/wiki", "PAP")).toBe("/pap/wiki");
});
it("rewrites legacy instance settings paths into the active company settings scope", () => {
expect(resolveHostNavigationHref("/instance/settings/plugins", "PAP")).toBe(
"/PAP/company/settings/instance/plugins",
);
expect(resolveHostNavigationHref("/settings/experimental?x=1#auto", "pap")).toBe(
"/PAP/company/settings/instance/experimental?x=1#auto",
);
});
it("intercepts only same-origin plain left-click navigation", () => {
expect(shouldHandleHostNavigationClick(clickEvent(), "/PAP/wiki")).toBe(true);
expect(
shouldHandleHostNavigationClick(clickEvent({ ctrlKey: true }), "/PAP/wiki"),
).toBe(false);
expect(
shouldHandleHostNavigationClick(clickEvent(), "/PAP/wiki", "_blank"),
).toBe(false);
expect(
shouldHandleHostNavigationClick(clickEvent(), "https://example.com/wiki"),
).toBe(false);
});
});
describe("useHostNavigation mobile drawer behavior", () => {
// React 19's `act` requires the env flag and React DOM client.
(globalThis as unknown as { IS_REACT_ACT_ENVIRONMENT?: boolean }).IS_REACT_ACT_ENVIRONMENT = true;
function makeBridgeValue(): PluginBridgeContextValue {
return {
pluginId: "test-plugin",
hostContext: {
companyId: "co",
companyPrefix: "PAP",
projectId: null,
entityId: null,
entityType: null,
userId: null,
},
};
}
function setViewport(width: number) {
Object.defineProperty(window, "innerWidth", {
configurable: true,
writable: true,
value: width,
});
if (typeof window.matchMedia !== "function") {
Object.defineProperty(window, "matchMedia", {
configurable: true,
writable: true,
value: (query: string) => ({
matches: /max-width:\s*767px/.test(query) ? width < 768 : false,
media: query,
onchange: null,
addEventListener: () => undefined,
removeEventListener: () => undefined,
addListener: () => undefined,
removeListener: () => undefined,
dispatchEvent: () => false,
}),
});
}
}
it("closes the sidebar drawer on mobile after a same-origin navigate()", () => {
setViewport(390);
let nav: ReturnType<typeof useHostNavigation> | null = null;
let sidebar: ReturnType<typeof useSidebar> | null = null;
function Probe() {
nav = useHostNavigation();
sidebar = useSidebar();
return null;
}
const container = document.createElement("div");
document.body.appendChild(container);
const root = createRoot(container);
act(() => {
root.render(
React.createElement(
MemoryRouter,
{ initialEntries: ["/PAP/wiki"] },
React.createElement(
SidebarProvider,
null,
React.createElement(
PluginBridgeContext.Provider,
{ value: makeBridgeValue() },
React.createElement(Probe),
),
),
),
);
});
expect(sidebar!.isMobile).toBe(true);
act(() => sidebar!.setSidebarOpen(true));
expect(sidebar!.sidebarOpen).toBe(true);
act(() => nav!.navigate("/wiki?section=ingest"));
expect(sidebar!.sidebarOpen).toBe(false);
act(() => root.unmount());
container.remove();
});
it("leaves the sidebar open on desktop after navigate()", () => {
setViewport(1280);
let nav: ReturnType<typeof useHostNavigation> | null = null;
let sidebar: ReturnType<typeof useSidebar> | null = null;
function Probe() {
nav = useHostNavigation();
sidebar = useSidebar();
return null;
}
const container = document.createElement("div");
document.body.appendChild(container);
const root = createRoot(container);
act(() => {
root.render(
React.createElement(
MemoryRouter,
{ initialEntries: ["/PAP/wiki"] },
React.createElement(
SidebarProvider,
null,
React.createElement(
PluginBridgeContext.Provider,
{ value: makeBridgeValue() },
React.createElement(Probe),
),
),
),
);
});
expect(sidebar!.isMobile).toBe(false);
expect(sidebar!.sidebarOpen).toBe(true);
act(() => nav!.navigate("/wiki?section=ingest"));
expect(sidebar!.sidebarOpen).toBe(true);
act(() => root.unmount());
container.remove();
});
});
describe("plugin SDK FileTree bridge", () => {
const nodes: SdkFileTreeNode[] = [
{
name: "wiki",
path: "wiki",
kind: "dir",
children: [
{
name: "index.md",
path: "wiki/index.md",
kind: "file",
children: [],
},
],
},
];
it("injects the host FileTree implementation through the bridge runtime", () => {
initPluginBridge(React, ReactDOM);
const html = renderToStaticMarkup(
React.createElement(SdkFileTree, {
nodes,
expandedPaths: ["wiki"],
selectedFile: "wiki/index.md",
onToggleDir: () => undefined,
onSelectFile: () => undefined,
}),
);
expect(html).toContain('role="tree"');
expect(html).toContain("wiki");
expect(html).toContain("index.md");
});
it("throws a clear error when the host FileTree implementation is missing", () => {
globalThis.__paperclipPluginBridge__ = {
react: React,
reactDom: ReactDOM,
sdkUi: {},
};
expect(() =>
renderToStaticMarkup(
React.createElement(SdkFileTree, {
nodes,
expandedPaths: ["wiki"],
onToggleDir: () => undefined,
onSelectFile: () => undefined,
}),
),
).toThrow('Paperclip plugin UI runtime is not initialized for "FileTree"');
});
});
describe("plugin SDK markdown component bridge", () => {
it("injects markdown display and editor components through the bridge runtime", () => {
initPluginBridge(React, ReactDOM);
const registry = globalThis.__paperclipPluginBridge__?.sdkUi ?? {};
expect(registry.MarkdownBlock).toBeTypeOf("function");
expect(registry.MarkdownEditor).toBeTypeOf("function");
expect(registry.IssuesList).toBeTypeOf("function");
expect(registry.AssigneePicker).toBeTypeOf("function");
expect(registry.ProjectPicker).toBeTypeOf("function");
expect(registry.ManagedRoutinesList).toBeTypeOf("function");
});
it("renders plugin-provided markdown components when registered by the host", () => {
globalThis.__paperclipPluginBridge__ = {
react: React,
reactDom: ReactDOM,
sdkUi: {
MarkdownBlock: ({ content, enableWikiLinks, wikiLinkRoot }: { content: string; enableWikiLinks?: boolean; wikiLinkRoot?: string }) =>
React.createElement("article", {
"data-wiki-links": enableWikiLinks ? "true" : "false",
"data-wiki-root": wikiLinkRoot,
}, content),
MarkdownEditor: ({ value }: { value: string }) =>
React.createElement("textarea", { value, readOnly: true }),
ManagedRoutinesList: ({ routines }: { routines: Array<{ title: string }> }) =>
React.createElement("section", null, routines.map((routine) => routine.title).join(", ")),
},
};
const markdownHtml = renderToStaticMarkup(React.createElement(SdkMarkdownBlock, {
content: "# Wiki",
enableWikiLinks: true,
wikiLinkRoot: "/wiki/page",
}));
expect(markdownHtml).toContain("# Wiki");
expect(markdownHtml).toContain('data-wiki-links="true"');
expect(markdownHtml).toContain('data-wiki-root="/wiki/page"');
expect(renderToStaticMarkup(React.createElement(SdkMarkdownEditor, { value: "# Wiki", onChange: () => undefined }))).toContain("# Wiki");
expect(renderToStaticMarkup(React.createElement(SdkManagedRoutinesList, {
routines: [{ key: "lint", title: "Run lint", status: "active" }],
}))).toContain("Run lint");
});
});
describe("plugin React shim", () => {
it("re-exports every named export from the host React module", () => {
const source = _createReactShimSourceForTests(React);
for (const name of Object.keys(React).sort()) {
if (name === "default") continue;
if (!/^[A-Za-z_$][\w$]*$/.test(name)) continue;
expect(source).toContain(`export const ${name} = R.${name};`);
}
expect(source).toContain("export default R;");
expect(source).toContain("export const useInsertionEffect = R.useInsertionEffect;");
expect(source).toContain("export const useId = R.useId;");
expect(source).toContain("export const useSyncExternalStore = R.useSyncExternalStore;");
expect(source).toContain("export const startTransition = R.startTransition;");
});
});