mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-15 02:20:38 +09:00
[codex] Add plugin orchestration host APIs (#4114)
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies. > - The plugin system is the extension path for optional capabilities that should not require core product changes for every integration. > - Plugins need scoped host APIs for issue orchestration, documents, wakeups, summaries, activity attribution, and isolated database state. > - Without those host APIs, richer plugins either cannot coordinate Paperclip work safely or need privileged core-side special cases. > - This pull request adds the plugin orchestration host surface, scoped route dispatch, a database namespace layer, and a smoke plugin that exercises the contract. > - The benefit is a broader plugin API that remains company-scoped, auditable, and covered by tests. ## What Changed - Added plugin orchestration host APIs for issue creation, document access, wakeups, summaries, plugin-origin activity, and scoped API route dispatch. - Added plugin database namespace tables, schema exports, migration checks, and idempotent replay coverage under migration `0059_plugin_database_namespaces`. - Added shared plugin route/API types and validators used by server and SDK boundaries. - Expanded plugin SDK types, protocol helpers, worker RPC host behavior, and testing utilities for orchestration flows. - Added the `plugin-orchestration-smoke-example` package to exercise scoped routes, restricted database namespaces, issue orchestration, documents, wakeups, summaries, and UI status surfaces. - Kept the new orchestration smoke fixture out of the root pnpm workspace importer so this PR preserves the repository policy of not committing `pnpm-lock.yaml`. - Updated plugin docs and database docs for the new orchestration and database namespace surfaces. - Rebased the branch onto `public-gh/master`, resolved conflicts, and removed `pnpm-lock.yaml` from the final PR diff. ## Verification - `pnpm install --frozen-lockfile` - `pnpm --filter @paperclipai/db typecheck` - `pnpm exec vitest run packages/db/src/client.test.ts` - `pnpm exec vitest run server/src/__tests__/plugin-database.test.ts server/src/__tests__/plugin-orchestration-apis.test.ts server/src/__tests__/plugin-routes-authz.test.ts server/src/__tests__/plugin-scoped-api-routes.test.ts server/src/__tests__/plugin-sdk-orchestration-contract.test.ts` - From `packages/plugins/examples/plugin-orchestration-smoke-example`: `pnpm exec vitest run --config ./vitest.config.ts` - `pnpm --dir packages/plugins/examples/plugin-orchestration-smoke-example run typecheck` - `pnpm --filter @paperclipai/server typecheck` - PR CI on latest head `293fc67c`: `policy`, `verify`, `e2e`, and `security/snyk` all passed. ## Risks - Medium risk: this expands plugin host authority, so route auth, company scoping, and plugin-origin activity attribution need careful review. - Medium risk: database namespace migration behavior must remain idempotent for environments that may have seen earlier branch versions. - Medium risk: the orchestration smoke fixture is intentionally excluded from the root workspace importer to avoid a `pnpm-lock.yaml` PR diff; direct fixture verification remains listed above. - Low operational risk from the PR setup itself: the branch is rebased onto current `master`, the migration is ordered after upstream `0057`/`0058`, and `pnpm-lock.yaml` is not in the final diff. > 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`. Roadmap checked: this work aligns with the completed Plugin system milestone and extends the plugin surface rather than duplicating an unrelated planned core feature. ## Model Used - OpenAI Codex, GPT-5-based coding agent in a tool-enabled CLI environment. Exact hosted model build and context-window size are not exposed by the runtime; reasoning/tool use were enabled for repository inspection, editing, testing, git operations, and PR creation. ## 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 (N/A: no core UI screen change; example plugin UI contract is covered by tests) - [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
16b2b84d84
commit
9c6f551595
53 changed files with 5584 additions and 53 deletions
|
|
@ -48,6 +48,7 @@ import type { PluginJobScheduler } from "./plugin-job-scheduler.js";
|
|||
import type { PluginJobStore } from "./plugin-job-store.js";
|
||||
import type { PluginToolDispatcher } from "./plugin-tool-dispatcher.js";
|
||||
import type { PluginLifecycleManager } from "./plugin-lifecycle.js";
|
||||
import { pluginDatabaseService } from "./plugin-database.js";
|
||||
|
||||
const execFileAsync = promisify(execFile);
|
||||
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
||||
|
|
@ -147,6 +148,9 @@ export interface PluginLoaderOptions {
|
|||
*/
|
||||
localPluginDir?: string;
|
||||
|
||||
/** Optional direct Postgres connection used for plugin DDL migrations. */
|
||||
migrationDb?: Db;
|
||||
|
||||
/**
|
||||
* Whether to scan the local filesystem directory for plugins.
|
||||
* Defaults to true.
|
||||
|
|
@ -735,6 +739,7 @@ export function pluginLoader(
|
|||
): PluginLoader {
|
||||
const {
|
||||
localPluginDir = DEFAULT_LOCAL_PLUGIN_DIR,
|
||||
migrationDb = db,
|
||||
enableLocalFilesystem = true,
|
||||
enableNpmDiscovery = true,
|
||||
} = options;
|
||||
|
|
@ -1701,14 +1706,22 @@ export function pluginLoader(
|
|||
// 1. Resolve worker entrypoint
|
||||
// ------------------------------------------------------------------
|
||||
const workerEntrypoint = resolveWorkerEntrypoint(plugin, localPluginDir);
|
||||
const packageRoot = resolvePluginPackageRoot(plugin, localPluginDir);
|
||||
|
||||
// ------------------------------------------------------------------
|
||||
// 2. Build host handlers for this plugin
|
||||
// 2. Apply restricted database migrations before worker startup
|
||||
// ------------------------------------------------------------------
|
||||
const databaseNamespace = manifest.database
|
||||
? (await pluginDatabaseService(migrationDb).applyMigrations(pluginId, manifest, packageRoot))?.namespaceName ?? null
|
||||
: null;
|
||||
|
||||
// ------------------------------------------------------------------
|
||||
// 3. Build host handlers for this plugin
|
||||
// ------------------------------------------------------------------
|
||||
const hostHandlers = buildHostHandlers(pluginId, manifest);
|
||||
|
||||
// ------------------------------------------------------------------
|
||||
// 3. Retrieve plugin config (if any)
|
||||
// 4. Retrieve plugin config (if any)
|
||||
// ------------------------------------------------------------------
|
||||
let config: Record<string, unknown> = {};
|
||||
try {
|
||||
|
|
@ -1722,7 +1735,7 @@ export function pluginLoader(
|
|||
}
|
||||
|
||||
// ------------------------------------------------------------------
|
||||
// 4. Spawn worker process
|
||||
// 5. Spawn worker process
|
||||
// ------------------------------------------------------------------
|
||||
const workerOptions: WorkerStartOptions = {
|
||||
entrypointPath: workerEntrypoint,
|
||||
|
|
@ -1730,6 +1743,7 @@ export function pluginLoader(
|
|||
config,
|
||||
instanceInfo,
|
||||
apiVersion: manifest.apiVersion,
|
||||
databaseNamespace,
|
||||
hostHandlers,
|
||||
autoRestart: true,
|
||||
};
|
||||
|
|
@ -1750,7 +1764,7 @@ export function pluginLoader(
|
|||
);
|
||||
|
||||
// ------------------------------------------------------------------
|
||||
// 5. Sync job declarations and register with scheduler
|
||||
// 6. Sync job declarations and register with scheduler
|
||||
// ------------------------------------------------------------------
|
||||
const jobDeclarations = manifest.jobs ?? [];
|
||||
if (jobDeclarations.length > 0) {
|
||||
|
|
@ -1939,6 +1953,26 @@ function resolveWorkerEntrypoint(
|
|||
);
|
||||
}
|
||||
|
||||
function resolvePluginPackageRoot(
|
||||
plugin: PluginRecord & { packagePath?: string | null },
|
||||
localPluginDir: string,
|
||||
): string {
|
||||
if (plugin.packagePath && existsSync(plugin.packagePath)) {
|
||||
return path.resolve(plugin.packagePath);
|
||||
}
|
||||
|
||||
const packageName = plugin.packageName;
|
||||
const packageDir = packageName.startsWith("@")
|
||||
? path.join(localPluginDir, "node_modules", ...packageName.split("/"))
|
||||
: path.join(localPluginDir, "node_modules", packageName);
|
||||
if (existsSync(packageDir)) return packageDir;
|
||||
|
||||
const directDir = path.join(localPluginDir, packageName);
|
||||
if (existsSync(directDir)) return directDir;
|
||||
|
||||
throw new Error(`Package root not found for plugin "${plugin.pluginKey}"`);
|
||||
}
|
||||
|
||||
function resolveManagedInstallPackageDir(localPluginDir: string, packageName: string): string {
|
||||
if (packageName.startsWith("@")) {
|
||||
return path.join(localPluginDir, "node_modules", ...packageName.split("/"));
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue