mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-15 18:30:39 +09:00
Expand plugin host surface (#5205)
## 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>
This commit is contained in:
parent
d6bee62f02
commit
3c73ed26b5
89 changed files with 27516 additions and 914 deletions
|
|
@ -1020,11 +1020,14 @@ export function issueRoutes(
|
|||
descendantOf: req.query.descendantOf as string | undefined,
|
||||
labelId: req.query.labelId as string | undefined,
|
||||
originKind: req.query.originKind as string | undefined,
|
||||
originKindPrefix: req.query.originKindPrefix as string | undefined,
|
||||
originId: req.query.originId as string | undefined,
|
||||
includeRoutineExecutions:
|
||||
req.query.includeRoutineExecutions === "true" || req.query.includeRoutineExecutions === "1",
|
||||
excludeRoutineExecutions:
|
||||
req.query.excludeRoutineExecutions === "true" || req.query.excludeRoutineExecutions === "1",
|
||||
includePluginOperations:
|
||||
req.query.includePluginOperations === "true" || req.query.includePluginOperations === "1",
|
||||
includeBlockedBy: req.query.includeBlockedBy === "true" || req.query.includeBlockedBy === "1",
|
||||
q: req.query.q as string | undefined,
|
||||
limit,
|
||||
|
|
|
|||
|
|
@ -66,6 +66,13 @@ import {
|
|||
getActorInfo,
|
||||
} from "./authz.js";
|
||||
import { validateInstanceConfig } from "../services/plugin-config-validator.js";
|
||||
import {
|
||||
findLocalFolderDeclaration,
|
||||
getStoredLocalFolders,
|
||||
inspectPluginLocalFolder,
|
||||
requireLocalFolderDeclaration,
|
||||
setStoredLocalFolder,
|
||||
} from "../services/plugin-local-folders.js";
|
||||
import { badRequest, forbidden, notFound, unauthorized, unprocessable } from "../errors.js";
|
||||
|
||||
/** UI slot declaration extracted from plugin manifest */
|
||||
|
|
@ -2379,6 +2386,152 @@ export function pluginRoutes(
|
|||
}
|
||||
});
|
||||
|
||||
// ===========================================================================
|
||||
// Company-scoped trusted local folders
|
||||
// ===========================================================================
|
||||
|
||||
router.get("/plugins/:pluginId/companies/:companyId/local-folders", async (req, res) => {
|
||||
assertBoardOrgAccess(req);
|
||||
const { pluginId, companyId } = req.params;
|
||||
assertCompanyAccess(req, companyId);
|
||||
|
||||
const plugin = await resolvePlugin(registry, pluginId);
|
||||
if (!plugin) {
|
||||
res.status(404).json({ error: "Plugin not found" });
|
||||
return;
|
||||
}
|
||||
|
||||
const settings = await registry.getCompanySettings(plugin.id, companyId);
|
||||
const storedFolders = getStoredLocalFolders(settings?.settingsJson);
|
||||
const declarations = plugin.manifestJson.localFolders ?? [];
|
||||
const folderKeys = declarations.map((declaration) => declaration.folderKey);
|
||||
|
||||
const statuses = await Promise.all(folderKeys.map((folderKey) =>
|
||||
inspectPluginLocalFolder({
|
||||
folderKey,
|
||||
declaration: findLocalFolderDeclaration(declarations, folderKey),
|
||||
storedConfig: storedFolders[folderKey] ?? null,
|
||||
})));
|
||||
|
||||
res.json({
|
||||
pluginId: plugin.id,
|
||||
companyId,
|
||||
declarations,
|
||||
folders: statuses,
|
||||
});
|
||||
});
|
||||
|
||||
router.get("/plugins/:pluginId/companies/:companyId/local-folders/:folderKey/status", async (req, res) => {
|
||||
assertBoardOrgAccess(req);
|
||||
const { pluginId, companyId, folderKey } = req.params;
|
||||
assertCompanyAccess(req, companyId);
|
||||
|
||||
const plugin = await resolvePlugin(registry, pluginId);
|
||||
if (!plugin) {
|
||||
res.status(404).json({ error: "Plugin not found" });
|
||||
return;
|
||||
}
|
||||
|
||||
const settings = await registry.getCompanySettings(plugin.id, companyId);
|
||||
const storedFolders = getStoredLocalFolders(settings?.settingsJson);
|
||||
const declarations = plugin.manifestJson.localFolders ?? [];
|
||||
const declaration = requireLocalFolderDeclaration(declarations, folderKey);
|
||||
const status = await inspectPluginLocalFolder({
|
||||
folderKey,
|
||||
declaration,
|
||||
storedConfig: storedFolders[folderKey] ?? null,
|
||||
});
|
||||
res.json(status);
|
||||
});
|
||||
|
||||
router.post("/plugins/:pluginId/companies/:companyId/local-folders/:folderKey/validate", async (req, res) => {
|
||||
assertBoardOrgAccess(req);
|
||||
const { pluginId, companyId, folderKey } = req.params;
|
||||
assertCompanyAccess(req, companyId);
|
||||
|
||||
const plugin = await resolvePlugin(registry, pluginId);
|
||||
if (!plugin) {
|
||||
res.status(404).json({ error: "Plugin not found" });
|
||||
return;
|
||||
}
|
||||
|
||||
const body = req.body as {
|
||||
path?: unknown;
|
||||
access?: "read" | "readWrite";
|
||||
requiredDirectories?: string[];
|
||||
requiredFiles?: string[];
|
||||
} | undefined;
|
||||
if (typeof body?.path !== "string" || body.path.trim().length === 0) {
|
||||
res.status(400).json({ error: '"path" is required and must be a non-empty string' });
|
||||
return;
|
||||
}
|
||||
|
||||
const declaration = requireLocalFolderDeclaration(plugin.manifestJson.localFolders ?? [], folderKey);
|
||||
const status = await inspectPluginLocalFolder({
|
||||
folderKey,
|
||||
declaration,
|
||||
overrideConfig: {
|
||||
path: body.path,
|
||||
},
|
||||
});
|
||||
res.json(status);
|
||||
});
|
||||
|
||||
router.put("/plugins/:pluginId/companies/:companyId/local-folders/:folderKey", async (req, res) => {
|
||||
assertBoardOrgAccess(req);
|
||||
const { pluginId, companyId, folderKey } = req.params;
|
||||
assertCompanyAccess(req, companyId);
|
||||
|
||||
const plugin = await resolvePlugin(registry, pluginId);
|
||||
if (!plugin) {
|
||||
res.status(404).json({ error: "Plugin not found" });
|
||||
return;
|
||||
}
|
||||
|
||||
const body = req.body as {
|
||||
path?: unknown;
|
||||
access?: "read" | "readWrite";
|
||||
requiredDirectories?: string[];
|
||||
requiredFiles?: string[];
|
||||
} | undefined;
|
||||
if (typeof body?.path !== "string" || body.path.trim().length === 0) {
|
||||
res.status(400).json({ error: '"path" is required and must be a non-empty string' });
|
||||
return;
|
||||
}
|
||||
|
||||
const existing = await registry.getCompanySettings(plugin.id, companyId);
|
||||
const declaration = requireLocalFolderDeclaration(plugin.manifestJson.localFolders ?? [], folderKey);
|
||||
const status = await inspectPluginLocalFolder({
|
||||
folderKey,
|
||||
declaration,
|
||||
storedConfig: getStoredLocalFolders(existing?.settingsJson)[folderKey] ?? null,
|
||||
overrideConfig: {
|
||||
path: body.path,
|
||||
},
|
||||
});
|
||||
|
||||
const nextSettings = setStoredLocalFolder(existing?.settingsJson, folderKey, {
|
||||
path: body.path,
|
||||
access: status.access,
|
||||
requiredDirectories: status.requiredDirectories,
|
||||
requiredFiles: status.requiredFiles,
|
||||
});
|
||||
await registry.upsertCompanySettings(plugin.id, companyId, {
|
||||
enabled: existing?.enabled ?? true,
|
||||
settingsJson: nextSettings,
|
||||
lastError: status.healthy ? null : status.problems.map((item: { message: string }) => item.message).join("; "),
|
||||
});
|
||||
await logPluginMutationActivity(req, "plugin.local_folder.configured", plugin.id, {
|
||||
pluginId: plugin.id,
|
||||
pluginKey: plugin.pluginKey,
|
||||
companyId,
|
||||
folderKey,
|
||||
healthy: status.healthy,
|
||||
});
|
||||
|
||||
res.json(status);
|
||||
});
|
||||
|
||||
// ===========================================================================
|
||||
// Plugin health dashboard — aggregated diagnostics for the settings page
|
||||
// ===========================================================================
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue