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>
175 lines
5.2 KiB
TypeScript
175 lines
5.2 KiB
TypeScript
import { constants as fsConstants } from "node:fs";
|
|
import fs from "node:fs/promises";
|
|
import path from "node:path";
|
|
import { createHash, type Hash } from "node:crypto";
|
|
import type { AdapterExecutionContext } from "@paperclipai/adapter-utils";
|
|
import {
|
|
ensurePaperclipSkillSymlink,
|
|
resolvePaperclipInstanceRootForAdapter,
|
|
type PaperclipSkillEntry,
|
|
} from "@paperclipai/adapter-utils/server-utils";
|
|
|
|
type SkillEntry = PaperclipSkillEntry;
|
|
|
|
export interface ClaudePromptBundle {
|
|
bundleKey: string;
|
|
rootDir: string;
|
|
addDir: string;
|
|
instructionsFilePath: string | null;
|
|
}
|
|
|
|
function nonEmpty(value: string | undefined): string | null {
|
|
return typeof value === "string" && value.trim().length > 0 ? value.trim() : null;
|
|
}
|
|
|
|
function resolveManagedClaudePromptCacheRoot(
|
|
env: NodeJS.ProcessEnv,
|
|
companyId: string,
|
|
): string {
|
|
const instanceRoot = resolvePaperclipInstanceRootForAdapter({
|
|
homeDir: nonEmpty(env.PAPERCLIP_HOME) ?? undefined,
|
|
instanceId: nonEmpty(env.PAPERCLIP_INSTANCE_ID) ?? undefined,
|
|
env,
|
|
});
|
|
return path.resolve(
|
|
instanceRoot,
|
|
"companies",
|
|
companyId,
|
|
"claude-prompt-cache",
|
|
);
|
|
}
|
|
|
|
async function hashPathContents(
|
|
candidate: string,
|
|
hash: Hash,
|
|
relativePath: string,
|
|
seenDirectories: Set<string>,
|
|
): Promise<void> {
|
|
const stat = await fs.lstat(candidate);
|
|
|
|
if (stat.isSymbolicLink()) {
|
|
hash.update(`symlink:${relativePath}\n`);
|
|
const resolved = await fs.realpath(candidate).catch(() => null);
|
|
if (!resolved) {
|
|
hash.update("missing\n");
|
|
return;
|
|
}
|
|
await hashPathContents(resolved, hash, relativePath, seenDirectories);
|
|
return;
|
|
}
|
|
|
|
if (stat.isDirectory()) {
|
|
const realDir = await fs.realpath(candidate).catch(() => candidate);
|
|
hash.update(`dir:${relativePath}\n`);
|
|
if (seenDirectories.has(realDir)) {
|
|
hash.update("loop\n");
|
|
return;
|
|
}
|
|
seenDirectories.add(realDir);
|
|
const entries = await fs.readdir(candidate, { withFileTypes: true });
|
|
entries.sort((left, right) => left.name.localeCompare(right.name));
|
|
for (const entry of entries) {
|
|
const childRelativePath = relativePath.length > 0 ? `${relativePath}/${entry.name}` : entry.name;
|
|
await hashPathContents(path.join(candidate, entry.name), hash, childRelativePath, seenDirectories);
|
|
}
|
|
return;
|
|
}
|
|
|
|
if (stat.isFile()) {
|
|
hash.update(`file:${relativePath}\n`);
|
|
hash.update(await fs.readFile(candidate));
|
|
hash.update("\n");
|
|
return;
|
|
}
|
|
|
|
hash.update(`other:${relativePath}:${stat.mode}\n`);
|
|
}
|
|
|
|
async function buildClaudePromptBundleKey(input: {
|
|
skills: SkillEntry[];
|
|
instructionsContents: string | null;
|
|
}): Promise<string> {
|
|
const hash = createHash("sha256");
|
|
hash.update("paperclip-claude-prompt-bundle:v1\n");
|
|
if (input.instructionsContents) {
|
|
hash.update("instructions\n");
|
|
hash.update(input.instructionsContents);
|
|
hash.update("\n");
|
|
} else {
|
|
hash.update("instructions:none\n");
|
|
}
|
|
|
|
const sortedSkills = [...input.skills].sort((left, right) => left.runtimeName.localeCompare(right.runtimeName));
|
|
for (const entry of sortedSkills) {
|
|
hash.update(`skill:${entry.key}:${entry.runtimeName}\n`);
|
|
await hashPathContents(entry.source, hash, entry.runtimeName, new Set<string>());
|
|
}
|
|
|
|
return hash.digest("hex");
|
|
}
|
|
|
|
async function ensureReadableFile(targetPath: string, contents: string): Promise<void> {
|
|
try {
|
|
await fs.access(targetPath, fsConstants.R_OK);
|
|
return;
|
|
} catch {
|
|
// Fall through and materialize the file.
|
|
}
|
|
|
|
await fs.mkdir(path.dirname(targetPath), { recursive: true });
|
|
const tempPath = `${targetPath}.${process.pid}.${Date.now()}.tmp`;
|
|
try {
|
|
await fs.writeFile(tempPath, contents, "utf8");
|
|
await fs.rename(tempPath, targetPath);
|
|
} catch (err) {
|
|
const targetReadable = await fs.access(targetPath, fsConstants.R_OK).then(() => true).catch(() => false);
|
|
if (!targetReadable) {
|
|
throw err;
|
|
}
|
|
} finally {
|
|
await fs.rm(tempPath, { force: true }).catch(() => {});
|
|
}
|
|
}
|
|
|
|
export async function prepareClaudePromptBundle(input: {
|
|
companyId: string;
|
|
skills: SkillEntry[];
|
|
instructionsContents: string | null;
|
|
onLog: AdapterExecutionContext["onLog"];
|
|
}): Promise<ClaudePromptBundle> {
|
|
const { companyId, skills, instructionsContents, onLog } = input;
|
|
const bundleKey = await buildClaudePromptBundleKey({
|
|
skills,
|
|
instructionsContents,
|
|
});
|
|
const rootDir = path.join(resolveManagedClaudePromptCacheRoot(process.env, companyId), bundleKey);
|
|
const skillsHome = path.join(rootDir, ".claude", "skills");
|
|
await fs.mkdir(skillsHome, { recursive: true });
|
|
|
|
for (const entry of skills) {
|
|
const target = path.join(skillsHome, entry.runtimeName);
|
|
try {
|
|
await ensurePaperclipSkillSymlink(entry.source, target);
|
|
} catch (err) {
|
|
await onLog(
|
|
"stderr",
|
|
`[paperclip] Failed to materialize Claude skill "${entry.key}" into ${skillsHome}: ${err instanceof Error ? err.message : String(err)}\n`,
|
|
);
|
|
}
|
|
}
|
|
|
|
const instructionsFilePath = instructionsContents
|
|
? path.join(rootDir, "agent-instructions.md")
|
|
: null;
|
|
if (instructionsFilePath && instructionsContents) {
|
|
await ensureReadableFile(instructionsFilePath, instructionsContents);
|
|
}
|
|
|
|
return {
|
|
bundleKey,
|
|
rootDir,
|
|
addDir: rootDir,
|
|
instructionsFilePath,
|
|
};
|
|
}
|