3c73ed26b5
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies > - The plugin system is the extension boundary for optional product capabilities > - Rich plugins need more than a worker entrypoint: they need scoped database storage, local project folders, managed agents/routines, host navigation, and reusable UI components > - The LLM Wiki work exposed those missing host surfaces while keeping plugin code outside the core control plane > - This pull request expands the core plugin host, SDK, server APIs, and UI bridge so plugins can declare and use those surfaces > - The benefit is that future plugins can integrate with Paperclip through documented, validated contracts instead of bespoke server or UI imports ## What Changed - Added plugin-managed database namespaces and migration tracking, including Drizzle schema/migration files and SQL validation for namespace isolation. - Added server support for plugin local folders, managed agents, managed routines, scoped plugin APIs, and plugin operation visibility. - Expanded shared plugin manifest/types/validators and SDK host/testing/UI exports for richer plugin surfaces. - Added reusable UI pieces for file trees, managed routines, resizable sidebars, route sidebars, and plugin bridge initialization. - Updated plugin docs and example plugins to use the expanded host and SDK surface. ## Verification - `pnpm install --frozen-lockfile` - `pnpm run preflight:workspace-links && pnpm exec vitest run packages/shared/src/validators/plugin.test.ts server/src/__tests__/plugin-database.test.ts server/src/__tests__/plugin-local-folders.test.ts server/src/__tests__/plugin-managed-agents.test.ts server/src/__tests__/plugin-managed-routines.test.ts server/src/__tests__/plugin-orchestration-apis.test.ts ui/src/api/plugins.test.ts ui/src/components/FileTree.test.tsx ui/src/components/ResizableSidebarPane.test.tsx ui/src/pages/PluginPage.test.tsx ui/src/plugins/bridge.test.ts` passed: 11 files, 67 tests. - Confirmed this PR changes 89 files and does not include `pnpm-lock.yaml` or `.github/workflows/*`. ## Risks - Medium: this expands plugin host contracts across db/shared/server/ui and includes a new core migration (`0076_useful_elektra.sql`). - The plugin database namespace validator is intentionally restrictive; plugin authors may need follow-up affordances for SQL patterns that remain blocked. - Merge this before the LLM Wiki plugin PR so the plugin can resolve the new SDK and host APIs. > 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 coding agent, tool-enabled shell/git/GitHub workflow. Context window size 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>
188 lines
6.8 KiB
TypeScript
188 lines
6.8 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
import type { Project } from "@paperclipai/shared";
|
|
import { act, type ReactNode } from "react";
|
|
import { createRoot, type Root } from "react-dom/client";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { ProjectDetail } from "./ProjectDetail";
|
|
|
|
(globalThis as typeof globalThis & { IS_REACT_ACT_ENVIRONMENT?: boolean }).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
const mockProjectsApi = vi.hoisted(() => ({
|
|
get: vi.fn(),
|
|
list: vi.fn(),
|
|
update: vi.fn(),
|
|
}));
|
|
const mockIssuesApi = vi.hoisted(() => ({
|
|
list: vi.fn(),
|
|
update: vi.fn(),
|
|
}));
|
|
const mockAgentsApi = vi.hoisted(() => ({ list: vi.fn() }));
|
|
const mockHeartbeatsApi = vi.hoisted(() => ({ liveRunsForCompany: vi.fn() }));
|
|
const mockBudgetsApi = vi.hoisted(() => ({ overview: vi.fn(), upsertPolicy: vi.fn() }));
|
|
const mockExecutionWorkspacesApi = vi.hoisted(() => ({ list: vi.fn() }));
|
|
const mockInstanceSettingsApi = vi.hoisted(() => ({ getExperimental: vi.fn() }));
|
|
const mockAssetsApi = vi.hoisted(() => ({ uploadImage: vi.fn() }));
|
|
const mockNavigate = vi.hoisted(() => vi.fn());
|
|
const mockSetBreadcrumbs = vi.hoisted(() => vi.fn());
|
|
const mockIssuesList = vi.hoisted(() => vi.fn());
|
|
|
|
vi.mock("../api/projects", () => ({ projectsApi: mockProjectsApi }));
|
|
vi.mock("../api/issues", () => ({ issuesApi: mockIssuesApi }));
|
|
vi.mock("../api/agents", () => ({ agentsApi: mockAgentsApi }));
|
|
vi.mock("../api/heartbeats", () => ({ heartbeatsApi: mockHeartbeatsApi }));
|
|
vi.mock("../api/budgets", () => ({ budgetsApi: mockBudgetsApi }));
|
|
vi.mock("../api/execution-workspaces", () => ({ executionWorkspacesApi: mockExecutionWorkspacesApi }));
|
|
vi.mock("../api/instanceSettings", () => ({ instanceSettingsApi: mockInstanceSettingsApi }));
|
|
vi.mock("../api/assets", () => ({ assetsApi: mockAssetsApi }));
|
|
|
|
vi.mock("@/lib/router", () => ({
|
|
Link: ({ children, to }: { children?: ReactNode; to: string }) => <a href={to}>{children}</a>,
|
|
Navigate: ({ to }: { to: string }) => <div data-testid="navigate">{to}</div>,
|
|
useLocation: () => ({ pathname: "/projects/project-1/plugin-operations", search: "", hash: "", state: null }),
|
|
useNavigate: () => mockNavigate,
|
|
useParams: () => ({ projectId: "project-1" }),
|
|
}));
|
|
|
|
vi.mock("../context/CompanyContext", () => ({
|
|
useCompany: () => ({
|
|
companies: [{ id: "company-1", issuePrefix: "PAP" }],
|
|
selectedCompanyId: "company-1",
|
|
setSelectedCompanyId: vi.fn(),
|
|
}),
|
|
}));
|
|
vi.mock("../context/PanelContext", () => ({ usePanel: () => ({ closePanel: vi.fn() }) }));
|
|
vi.mock("../context/ToastContext", () => ({ useToastActions: () => ({ pushToast: vi.fn() }) }));
|
|
vi.mock("../context/BreadcrumbContext", () => ({ useBreadcrumbs: () => ({ setBreadcrumbs: mockSetBreadcrumbs }) }));
|
|
vi.mock("@/plugins/slots", () => ({
|
|
PluginSlotMount: () => null,
|
|
PluginSlotOutlet: () => null,
|
|
usePluginSlots: () => ({ slots: [], isLoading: false }),
|
|
}));
|
|
vi.mock("@/plugins/launchers", () => ({ PluginLauncherOutlet: () => null }));
|
|
vi.mock("../components/ProjectProperties", () => ({
|
|
ProjectProperties: () => <div data-testid="project-properties" />,
|
|
}));
|
|
vi.mock("../components/BudgetPolicyCard", () => ({
|
|
BudgetPolicyCard: () => <div data-testid="budget-policy-card" />,
|
|
}));
|
|
vi.mock("../components/InlineEditor", () => ({
|
|
InlineEditor: ({ value, placeholder }: { value?: string; placeholder?: string }) => (
|
|
<span>{value || placeholder || null}</span>
|
|
),
|
|
}));
|
|
vi.mock("../components/ProjectWorkspacesContent", () => ({
|
|
ProjectWorkspacesContent: () => <div data-testid="project-workspaces" />,
|
|
}));
|
|
vi.mock("../components/PageTabBar", () => ({
|
|
PageTabBar: ({ items }: { items: Array<{ value: string; label: string }> }) => (
|
|
<div>{items.map((item) => <button key={item.value}>{item.label}</button>)}</div>
|
|
),
|
|
}));
|
|
vi.mock("../components/IssuesList", () => ({
|
|
IssuesList: (props: unknown) => {
|
|
mockIssuesList(props);
|
|
return <div data-testid="issues-list" />;
|
|
},
|
|
}));
|
|
|
|
function project(overrides: Partial<Project> = {}): Project {
|
|
const now = new Date("2026-05-01T00:00:00Z");
|
|
return {
|
|
id: "project-1",
|
|
companyId: "company-1",
|
|
urlKey: "project-1",
|
|
goalId: null,
|
|
goalIds: [],
|
|
goals: [],
|
|
name: "Managed Project",
|
|
description: null,
|
|
status: "in_progress",
|
|
leadAgentId: null,
|
|
targetDate: null,
|
|
color: "#14b8a6",
|
|
env: null,
|
|
pauseReason: null,
|
|
pausedAt: null,
|
|
executionWorkspacePolicy: null,
|
|
codebase: {
|
|
workspaceId: null,
|
|
repoUrl: null,
|
|
repoRef: null,
|
|
defaultRef: null,
|
|
repoName: null,
|
|
localFolder: null,
|
|
managedFolder: "/tmp/project-1",
|
|
effectiveLocalFolder: "/tmp/project-1",
|
|
origin: "managed_checkout",
|
|
},
|
|
workspaces: [],
|
|
primaryWorkspace: null,
|
|
managedByPlugin: {
|
|
id: "managed-1",
|
|
pluginId: "plugin-1",
|
|
pluginKey: "paperclip.missions",
|
|
pluginDisplayName: "Missions",
|
|
resourceKind: "project",
|
|
resourceKey: "operations",
|
|
defaultsJson: {},
|
|
createdAt: now,
|
|
updatedAt: now,
|
|
},
|
|
archivedAt: null,
|
|
createdAt: now,
|
|
updatedAt: now,
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
describe("ProjectDetail", () => {
|
|
let root: Root | null = null;
|
|
let container: HTMLDivElement;
|
|
|
|
beforeEach(() => {
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
mockProjectsApi.get.mockResolvedValue(project());
|
|
mockProjectsApi.list.mockResolvedValue([project()]);
|
|
mockIssuesApi.list.mockResolvedValue([]);
|
|
mockAgentsApi.list.mockResolvedValue([]);
|
|
mockHeartbeatsApi.liveRunsForCompany.mockResolvedValue([]);
|
|
mockBudgetsApi.overview.mockResolvedValue({ policies: [] });
|
|
mockInstanceSettingsApi.getExperimental.mockResolvedValue({ enableIsolatedWorkspaces: false });
|
|
mockExecutionWorkspacesApi.list.mockResolvedValue([]);
|
|
});
|
|
|
|
afterEach(() => {
|
|
act(() => root?.unmount());
|
|
root = null;
|
|
container.remove();
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
it("shows managed plugin affordances and filters the operations tab by plugin origin", async () => {
|
|
const queryClient = new QueryClient({ defaultOptions: { queries: { retry: false } } });
|
|
|
|
await act(async () => {
|
|
root = createRoot(container);
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<ProjectDetail />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await act(async () => {
|
|
await new Promise((resolve) => setTimeout(resolve, 0));
|
|
await new Promise((resolve) => setTimeout(resolve, 0));
|
|
});
|
|
|
|
expect(container.textContent).toContain("Managed by Missions");
|
|
expect(container.textContent).toContain("Plugin operations");
|
|
expect(mockIssuesApi.list).toHaveBeenCalledWith("company-1", {
|
|
projectId: "project-1",
|
|
originKindPrefix: "plugin:paperclip.missions",
|
|
});
|
|
});
|
|
});
|