0096b56a1c
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies. > - The plugin system needs host contracts and runtime support before large plugins can integrate cleanly. > - The source branch mixed the LLM Wiki package with supporting host/runtime work, managed plugin skills, root-level storage spaces, and a bookmarks reference plugin. > - [PAP-9173](/PAP/issues/PAP-9173) asked for the current branch to be split by file boundary: plugin package separately from everything else. > - [PAP-9188](/PAP/issues/PAP-9188) clarified that LLM Wiki may have plugin-local spaces, but Paperclip core should not reorganize top-level local storage into spaces. > - Follow-up review clarified that the bookmarks example should not ship in this PR either. > - This pull request contains the non-`packages/plugins/plugin-llm-wiki/` host/runtime work, keeps runtime state under the selected Paperclip instance root, and no longer includes the bookmarks example. ## What Changed - Added/updated plugin host contracts, SDK types, worker RPC plumbing, managed plugin skill support, and related server tests. - Removed the bookmarks example plugin package and its bundled-example/workspace references. - Removed the root-level local spaces CLI/migration surface and restored instance-root runtime defaults for config, db, logs, storage, secrets, workspaces, projects, and adapter homes. - Replaced shared root `space-paths` helpers with `home-paths` helpers for core runtime storage. - Tightened stranded recovery unique-conflict detection so concurrent recovery scans reuse the raced recovery issue when Postgres errors are wrapped. - Kept `packages/plugins/plugin-llm-wiki/` out of this PR diff; plugin-local spaces remain in the stacked plugin-only PR. ## Verification - `pnpm exec vitest run cli/src/__tests__/data-dir.test.ts cli/src/__tests__/home-paths.test.ts cli/src/__tests__/onboard.test.ts packages/shared/src/home-paths.test.ts packages/db/src/runtime-config.test.ts server/src/__tests__/agent-instructions-service.test.ts server/src/__tests__/claude-local-execute.test.ts server/src/__tests__/codex-local-execute.test.ts` - `pnpm exec vitest run packages/db/src/runtime-config.test.ts` - `pnpm exec vitest run server/src/__tests__/plugin-routes-authz.test.ts` - `pnpm --filter @paperclipai/server typecheck` - `pnpm exec vitest run server/src/__tests__/heartbeat-process-recovery.test.ts -t "reuses the raced stranded recovery issue"` skipped locally because embedded Postgres did not initialize on this macOS temp host; the code path was typechecked and is covered by Linux CI. - Boundary check: no core references remain for `PAPERCLIP_SPACE_ID`, `spaces migrate-default`, `@paperclipai/shared/space-paths`, `registerSpacesCommands`, or the removed bookmarks example. - Previous PR head `4f23e034` had green GitHub checks: `verify`, all four serialized server shards, `e2e`, `Canary Dry Run`, `policy`, Snyk, and `Greptile Review`. Current head `582f466d` is re-running checks after the bookmarks deletion. ## Risks - Plugin host changes touch shared runtime paths, so regressions would most likely appear in adapter startup, plugin loading, or local dev path defaults. - Removing the bookmarks example also removes one demonstration of plugin database namespaces plus local-folder persistence; remaining plugin examples still cover bundled example discovery and plugin host flows. - The plugin package itself is intentionally deferred to the stacked plugin-only PR, where LLM Wiki plugin-local spaces live. - Existing installs that tested the transient root-level spaces CLI should stop using it; this PR intentionally removes that unsupported migration surface before merge. > 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 GPT-5 Codex via Codex CLI, tool use and local code execution enabled; context window not exposed. ## 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, except where noted above for host-specific embedded Postgres initialization - [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 Stacked follow-up: PR #5592 contains only `packages/plugins/plugin-llm-wiki/` and targets this branch. --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
139 lines
4.3 KiB
TypeScript
139 lines
4.3 KiB
TypeScript
import { createHash } from "node:crypto";
|
|
import fs from "node:fs/promises";
|
|
import os from "node:os";
|
|
import path from "node:path";
|
|
import type { AdapterExecutionContext } from "@paperclipai/adapter-utils";
|
|
import { resolvePaperclipInstanceRootForAdapter } from "@paperclipai/adapter-utils/server-utils";
|
|
|
|
const SEEDED_SHARED_FILES = [
|
|
".credentials.json",
|
|
"credentials.json",
|
|
"settings.json",
|
|
"settings.local.json",
|
|
"CLAUDE.md",
|
|
] as const;
|
|
|
|
function nonEmpty(value: string | undefined): string | null {
|
|
return typeof value === "string" && value.trim().length > 0 ? value.trim() : null;
|
|
}
|
|
|
|
async function pathExists(candidate: string): Promise<boolean> {
|
|
return fs.access(candidate).then(() => true).catch(() => false);
|
|
}
|
|
|
|
function isAlreadyExistsError(error: unknown): boolean {
|
|
if (!error || typeof error !== "object") return false;
|
|
const code = "code" in error ? error.code : null;
|
|
return code === "EEXIST" || code === "ENOTEMPTY";
|
|
}
|
|
|
|
async function collectSeedFiles(sourceDir: string): Promise<Array<{ name: string; sourcePath: string }>> {
|
|
const files: Array<{ name: string; sourcePath: string }> = [];
|
|
for (const name of SEEDED_SHARED_FILES) {
|
|
const sourcePath = path.join(sourceDir, name);
|
|
if (!(await pathExists(sourcePath))) continue;
|
|
files.push({ name, sourcePath });
|
|
}
|
|
return files;
|
|
}
|
|
|
|
async function buildSeedSnapshotKey(files: Array<{ name: string; sourcePath: string }>): Promise<string> {
|
|
if (files.length === 0) return "empty";
|
|
const hash = createHash("sha256");
|
|
for (const file of files) {
|
|
hash.update(file.name);
|
|
hash.update("\0");
|
|
hash.update(await fs.readFile(file.sourcePath));
|
|
hash.update("\0");
|
|
}
|
|
return hash.digest("hex").slice(0, 16);
|
|
}
|
|
|
|
async function materializeSeedSnapshot(input: {
|
|
rootDir: string;
|
|
snapshotKey: string;
|
|
files: Array<{ name: string; sourcePath: string }>;
|
|
}): Promise<string> {
|
|
const targetDir = path.join(input.rootDir, input.snapshotKey);
|
|
if (await pathExists(targetDir)) {
|
|
return targetDir;
|
|
}
|
|
|
|
await fs.mkdir(input.rootDir, { recursive: true });
|
|
const stagingDir = await fs.mkdtemp(path.join(input.rootDir, ".tmp-"));
|
|
try {
|
|
for (const file of input.files) {
|
|
await fs.copyFile(file.sourcePath, path.join(stagingDir, file.name));
|
|
}
|
|
try {
|
|
await fs.rename(stagingDir, targetDir);
|
|
} catch (error) {
|
|
if (!isAlreadyExistsError(error)) {
|
|
throw error;
|
|
}
|
|
await fs.rm(stagingDir, { recursive: true, force: true });
|
|
}
|
|
} catch (error) {
|
|
await fs.rm(stagingDir, { recursive: true, force: true }).catch(() => undefined);
|
|
throw error;
|
|
}
|
|
|
|
return targetDir;
|
|
}
|
|
|
|
export function resolveSharedClaudeConfigDir(
|
|
env: NodeJS.ProcessEnv = process.env,
|
|
): string {
|
|
const fromEnv = nonEmpty(env.CLAUDE_CONFIG_DIR);
|
|
return fromEnv ? path.resolve(fromEnv) : path.join(os.homedir(), ".claude");
|
|
}
|
|
|
|
export function resolveManagedClaudeConfigSeedDir(
|
|
env: NodeJS.ProcessEnv,
|
|
companyId?: string,
|
|
): string {
|
|
const instanceRoot = resolvePaperclipInstanceRootForAdapter({
|
|
homeDir: nonEmpty(env.PAPERCLIP_HOME) ?? undefined,
|
|
instanceId: nonEmpty(env.PAPERCLIP_INSTANCE_ID) ?? undefined,
|
|
env,
|
|
});
|
|
return companyId
|
|
? path.resolve(instanceRoot, "companies", companyId, "claude-config-seed")
|
|
: path.resolve(instanceRoot, "claude-config-seed");
|
|
}
|
|
|
|
export async function prepareClaudeConfigSeed(
|
|
env: NodeJS.ProcessEnv,
|
|
onLog: AdapterExecutionContext["onLog"],
|
|
companyId?: string,
|
|
): Promise<string> {
|
|
const sourceDir = resolveSharedClaudeConfigDir(env);
|
|
const targetRootDir = resolveManagedClaudeConfigSeedDir(env, companyId);
|
|
|
|
if (path.resolve(sourceDir) === path.resolve(targetRootDir)) {
|
|
return targetRootDir;
|
|
}
|
|
|
|
const copiedFiles = await collectSeedFiles(sourceDir);
|
|
const snapshotKey = await buildSeedSnapshotKey(copiedFiles);
|
|
const targetDir = await materializeSeedSnapshot({
|
|
rootDir: targetRootDir,
|
|
snapshotKey,
|
|
files: copiedFiles,
|
|
});
|
|
|
|
if (copiedFiles.length > 0) {
|
|
await onLog(
|
|
"stdout",
|
|
`[paperclip] Prepared Claude config seed "${targetDir}" from "${sourceDir}" (${copiedFiles.map((file) => file.name).join(", ")}).\n`,
|
|
);
|
|
} else {
|
|
await onLog(
|
|
"stdout",
|
|
`[paperclip] No local Claude config seed files were found in "${sourceDir}". Remote Claude auth may still require login.\n`,
|
|
);
|
|
}
|
|
|
|
return targetDir;
|
|
}
|