Files
PaperClipAI/ui/src/plugins/bridge.test.ts
DottaandPaperclip 5071c4c776 [codex] Add workspace diff viewer plugin (#6071)
## Thinking Path

> - Paperclip orchestrates AI agents for zero-human companies.
> - Operators need to inspect what agents changed inside execution and
project workspaces.
> - The existing workspace detail views did not provide a first-party
rich diff surface for staged, unstaged, head, renamed, binary,
oversized, and untracked changes.
> - The plugin system is the intended extension point for optional rich
UI surfaces.
> - This pull request adds a workspace diff plugin plus host services
and shared contracts so Changes tabs can render workspace diffs through
plugin slots.
> - The diff-renderer dependency should stay owned by the plugin package
rather than the core UI app.
> - The dependency surface must stay aligned with repository PR policy,
including intentionally omitting `pnpm-lock.yaml` from the PR.
> - The benefit is a more reviewable workspace surface without
hard-coding the renderer into every page.

## What Changed

- Added `@paperclipai/plugin-workspace-diff`, including diff
normalization, plugin manifest/worker/UI entrypoints, and focused plugin
tests.
- Kept `@pierre/diffs` scoped to `@paperclipai/plugin-workspace-diff`;
removed the core UI lab diff-renderer surface and direct UI package
dependency.
- Added shared workspace diff types and validators, plus plugin SDK
surface for workspace diff host services.
- Added server workspace diff service support and route coverage for
execution/project workspace diff flows.
- Wired Execution Workspace and Project Workspace Changes tabs to load
the diff plugin, including loading/error fallback behavior.
- Added UI tests and fixtures for the Changes tabs and plugin bridge
behavior.
- Added the new plugin package manifest to the Docker deps stage so PR
policy can validate dependency coverage.
- Addressed review hardening around empty untracked patches, workspace
path exposure, project workspace read capability checks, and default
base refs.

## Verification

- `pnpm --filter @paperclipai/plugin-workspace-diff test`
- `pnpm exec vitest run
packages/shared/src/validators/workspace-diff.test.ts
server/src/__tests__/workspace-diff-service.test.ts
ui/src/pages/ProjectWorkspaceDetail.test.tsx
ui/src/pages/ExecutionWorkspaceDetail.test.tsx`
- `pnpm exec vitest run ui/src/plugins/bridge.test.ts
server/src/__tests__/workspace-runtime-routes-authz.test.ts`
- `pnpm --filter @paperclipai/shared typecheck`
- `pnpm --filter @paperclipai/plugin-workspace-diff typecheck`
- `pnpm --filter @paperclipai/server typecheck`
- `pnpm --filter @paperclipai/ui typecheck`
- `node ./scripts/check-docker-deps-stage.mjs`
- Browser screenshot captured from the local worktree dev server:
https://files.catbox.moe/ofdpsp.png
- Confirmed branch is rebased onto `public-gh/master`,
`.github/workflows/pr.yml` is not included in the PR diff,
`ui/package.json` is not included in the PR diff, and `pnpm-lock.yaml`
is not included in the PR diff.

## Risks

- Medium UI integration risk: the Changes tab depends on the plugin slot
and host diff service path.
- Medium dependency risk: this adds `@pierre/diffs` in the plugin
package, but `pnpm-lock.yaml` is intentionally omitted per packaging
instructions because repository automation manages lockfile updates.
- Current CI blocker: downstream frozen installs fail until the
repository policy path for new plugin package dependencies is chosen.
- Diff rendering edge cases are covered for common working-tree and head
diff states, but very large repositories may still expose performance
limits.
- No migrations are included.

> 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, GPT-5 class coding model, tool-enabled local execution
environment. 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 run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] 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] I will address all Greptile and reviewer comments before
requesting merge

---------

Co-authored-by: Paperclip <noreply@paperclip.ing>
2026-05-18 08:50:06 -05:00

326 lines
10 KiB
TypeScript

// @vitest-environment jsdom
import * as React from "react";
import * as ReactDOM from "react-dom";
import { act } from "react";
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__;
});
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");
expect(resolveHostNavigationHref("/instance/settings/plugins", "PAP")).toBe(
"/instance/settings/plugins",
);
});
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;");
});
});