mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-08 00:54:38 +02:00
## Thinking Path
> - Paperclip is the open source app people use to manage AI agents for
work
> - Agents do that work in isolated git worktrees, and a managed
worktree runs its own Paperclip instance with a cloned database
> - That clone needs a seed source, and the source must come from
server-owned registration, never from state the workspace itself can
rewrite
> - The seed-source resolver requires the registered base project
workspace to hold its own `.paperclip/config.json`
> - A managed project workspace is a plain `git clone`, and no code
writes that file into it
> - Every isolated worktree provision, deferred seed, and workspace
repair therefore fails on a managed checkout
> - This pull request lets a named source supply the config when the
base checkout has none
> - The benefit is that managed worktrees provision again, and the seed
source stays server-owned
## Linked Issues or Issue Description
No public GitHub issue exists for this problem. It is described below.
**What happened?**
Agent runs that need an isolated worktree fail during provisioning. The
provision command exits with this error (paths redacted):
```
Execution workspace provision command "bash ./scripts/provision-worktree.sh" failed:
Registered base project workspace has no canonical Paperclip config:
<instance-home>/instances/default/projects/<company-id>/<project-id>/<repo>/.paperclip/config.json
```
`resolveRegisteredWorktreeSeedSource` sets `registeredConfigPath` to
`<baseCwd>/.paperclip/config.json` whenever the caller names a
registered base workspace. It then requires that file to exist.
`scripts/provision-worktree.sh` applies the same rule.
A managed project workspace never has that file.
`materializeManagedProjectWorkspace` creates it with `git clone` and a
rename, so the checkout holds repository content only. The control plane
keeps its config at `<home>/instances/<id>/config.json` instead.
The failure reaches three paths: worktree provisioning, deferred seeding
through `worktree ensure-seeded`, and workspace repair.
The behavior changed in #11671. That pull request replaced a fallback
chain with a single hard requirement. Fixture code in
`scripts/__tests__/provision-worktree-self-heal.test.mjs` writes a
config into the fake base workspace, so tests kept passing.
**Expected behavior**
A managed worktree provisions and seeds from the registered source. The
seed manifest still never selects that source.
**Steps to reproduce**
1. Register the Paperclip repository as a project with a `repoUrl`, so
the server materializes a managed checkout.
2. Assign an issue to an agent whose workspace strategy is
`git_worktree`.
3. Watch the workspace operation log for the provision command.
4. The command exits non-zero with the error above.
**Paperclip version or commit**
Reproduced on `master` at 01ddc26a3.
**Deployment mode**
`local_trusted`, single instance.
**Database mode**
Embedded PostgreSQL.
**Operating system**
Linux, Node.js 22.
**Related pull requests**
- Refs #11671 — introduced the requirement this pull request relaxes.
- Refs #11733 — open work on seed-source preflight. It reads the same
base-workspace config path and skips when the file is absent. It does
not change source selection.
- Refs #11735 — open work on provisioning reliability. It edits the same
four files and will need a rebase after either lands.
## What Changed
- `resolveRegisteredWorktreeSeedSource` sets the registered config path
only when `<baseCwd>/.paperclip/config.json` exists. This makes the
existing `registeredConfigPath ?? explicitSource` branch reachable for a
plain checkout.
- A base workspace that does hold its own config stays authoritative. A
mismatched explicit source is still rejected.
- The resolver throws a named error when the base workspace has no
config and no source is named.
- `readInstanceId` accepts an instance-root config at
`<home>/instances/<id>/config.json`. That layout names its instance by
directory and has no adjacent `.env`. Validation reuses
`resolvePaperclipInstanceId`.
- `scripts/provision-worktree.sh` and
`scripts/provision-worktree-runtime.sh` name the control plane's
instance config as the source when the base workspace has none. The
canonical-path and symlink checks stay.
- The workspace repair route supplies the same fallback, and only when
the base workspace has no config of its own.
- `doc/DEVELOPING.md` records the two source layouts.
## Verification
- `node --test scripts/__tests__/provision-worktree-self-heal.test.mjs`
— 10 tests pass. The fixture no longer writes a config into the base
workspace, so it models a real managed checkout. One test now creates
that config mid-test, which covers both layouts.
- `npx vitest run src/worktree-seed-source.test.ts` in `packages/shared`
— 4 tests pass. Two are new: one resolves an instance-root source, and
one still fails closed when no source exists.
- `npx vitest run src/__tests__/workspace-runtime.test.ts
src/__tests__/execution-workspaces-routes.test.ts
src/__tests__/execution-workspace-runtime-control-conflict.test.ts
src/__tests__/workspace-operations-reconciliation.test.ts
src/__tests__/worktree-seed-server-spawn.test.ts` in `server` — all
pass. Run them one file at a time. They share one test database, and
concurrent runs fail teardown.
- `npx vitest run src/__tests__/worktree.test.ts` in `cli` — 63 tests
pass.
- `pnpm --filter @paperclipai/shared typecheck` — clean.
- Manual check on a live instance: the resolver now returns the instance
config as the source for a managed checkout, with the source instance
`default` and a distinct target instance.
## Risks
Low to moderate.
- The relaxed rule applies only when the base workspace holds no config.
A base workspace that holds one keeps full authority, so the trust model
from #11671 is unchanged. The seed manifest still never selects the
source.
- The instance-id fallback reads a directory name. It applies only to
the `<home>/instances/<id>/config.json` layout, and
`resolvePaperclipInstanceId` rejects an unsafe segment.
- #11735 edits the same four files. Whichever pull request lands second
needs a rebase.
- `pnpm --filter @paperclipai/server typecheck` currently fails on this
checkout with duplicate `drizzle-orm` type instantiations. The failure
is present with and without this change, and the error count is
identical. It comes from an unrelated lockfile state, not from this pull
request.
## Model Used
Claude Opus 5 (`claude-opus-5`), by Anthropic, running in Claude Code.
Extended thinking was on. The model used file, search, and shell tools
to diagnose the failure on a live instance and to run the test suites.
## 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 searched GitHub for duplicate or related PRs and linked
them above
- [x] I have either (a) linked existing issues with `Fixes: #` / `Closes
#` / `Refs #` OR (b) described the issue in-PR following the relevant
issue template
- [x] I have not referenced internal/instance-local Paperclip issues or
links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip`
URLs)
- [x] My branch name describes the change (e.g. `docs/...`, `fix/...`)
and contains no internal Paperclip ticket id or instance-derived details
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [ ] All Paperclip CI gates are green
- [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge
🤖 Generated with [Claude Code](https://claude.com/claude-code)
---------
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
228 lines
9.5 KiB
TypeScript
228 lines
9.5 KiB
TypeScript
import { existsSync, lstatSync, readFileSync, realpathSync, statSync, type Stats } from "node:fs";
|
|
import path from "node:path";
|
|
import { resolvePaperclipInstanceId } from "./home-paths.js";
|
|
|
|
export type WorktreeSeedSourceDiagnostic = {
|
|
configPath?: unknown;
|
|
instanceId?: unknown;
|
|
};
|
|
|
|
export type CanonicalWorktreeSeedSource = {
|
|
baseWorkspaceCwd: string | null;
|
|
configPath: string;
|
|
instanceId: string;
|
|
targetConfigPath: string;
|
|
targetInstanceId: string;
|
|
};
|
|
|
|
export type RegisteredWorktreeSeedSourceInput = {
|
|
registeredBaseWorkspaceCwd?: string | null;
|
|
explicitSourceConfigPath?: string | null;
|
|
targetConfigPath: string;
|
|
expectedTargetInstanceId: string;
|
|
};
|
|
|
|
function readInstanceId(configPath: string, label: "source" | "target"): string {
|
|
const configDir = path.dirname(configPath);
|
|
const envPath = path.join(configDir, ".env");
|
|
if (!existsSync(envPath)) {
|
|
// An instance-root config (`<home>/instances/<id>/config.json`) names its instance
|
|
// by directory rather than by an adjacent .env; worktree configs always ship one.
|
|
if (path.basename(path.dirname(configDir)) === "instances") {
|
|
return resolvePaperclipInstanceId(path.basename(configDir));
|
|
}
|
|
throw new Error(`Registered ${label} Paperclip config is missing its adjacent .env instance pointer.`);
|
|
}
|
|
const contents = readFileSync(envPath, "utf8");
|
|
for (const rawLine of contents.split(/\r?\n/)) {
|
|
const match = rawLine.match(
|
|
/^\s*(?:export\s+)?PAPERCLIP_INSTANCE_ID\s*=\s*(?:"([^"]*)"|'([^']*)'|([^\s#]+))/,
|
|
);
|
|
const value = (match?.[1] ?? match?.[2] ?? match?.[3] ?? "").trim();
|
|
if (value) return value;
|
|
}
|
|
throw new Error(`Registered ${label} Paperclip config has no PAPERCLIP_INSTANCE_ID binding.`);
|
|
}
|
|
|
|
function errorCode(error: unknown): string {
|
|
return (error as NodeJS.ErrnoException | null)?.code ?? "unknown error";
|
|
}
|
|
|
|
/**
|
|
* Inspect a directory entry without following it, returning null only when it is absent.
|
|
*
|
|
* Any other failure means the declared path is unreadable or malformed, and a guess there
|
|
* would silently seed from a different instance.
|
|
*/
|
|
function inspectDeclaredEntry(entryPath: string, configPath: string, detail?: string): Stats | null {
|
|
try {
|
|
return lstatSync(entryPath);
|
|
} catch (error) {
|
|
if (errorCode(error) === "ENOENT") return null;
|
|
throw new Error(
|
|
`Registered base project workspace Paperclip config at ${configPath} cannot be inspected (${errorCode(error)}${detail ?? ""}).`,
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Whether a base project workspace declares an instance config of its own.
|
|
*
|
|
* This tests directory entries and does not follow them. A dangling or aliased symlink,
|
|
* at the config itself or at the `.paperclip` directory holding it, still counts as a
|
|
* declared config, so the resolver rejects the malformed source instead of falling back
|
|
* to another one.
|
|
*/
|
|
export function baseWorkspaceDeclaresInstanceConfig(baseWorkspaceCwd: string): boolean {
|
|
const configDir = path.join(baseWorkspaceCwd, ".paperclip");
|
|
const configPath = path.join(configDir, "config.json");
|
|
if (inspectDeclaredEntry(configPath, configPath)) return true;
|
|
|
|
// The probe above resolves `.paperclip` before it reaches the config, so a broken link
|
|
// there also reports ENOENT. Only an absent or traversable `.paperclip` lets the caller
|
|
// name another source; a link that hides whatever it points at is malformed, not empty.
|
|
const configDirEntry = inspectDeclaredEntry(configDir, configPath, " on its .paperclip entry");
|
|
if (configDirEntry?.isSymbolicLink()) {
|
|
try {
|
|
statSync(configDir);
|
|
} catch (error) {
|
|
throw new Error(
|
|
`Registered base project workspace Paperclip config at ${configPath} cannot be inspected (${errorCode(error)} on its .paperclip symlink target).`,
|
|
);
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
function canonicalRegularFile(filePath: string, label: string): string {
|
|
const resolved = path.resolve(filePath);
|
|
let canonical: string;
|
|
try {
|
|
canonical = realpathSync(resolved);
|
|
} catch {
|
|
throw new Error(`${label} does not exist at ${resolved}.`);
|
|
}
|
|
if (canonical !== resolved || lstatSync(resolved).isSymbolicLink()) {
|
|
throw new Error(`${label} must be a canonical path and cannot use a symlink alias.`);
|
|
}
|
|
if (!lstatSync(canonical).isFile()) {
|
|
throw new Error(`${label} is not a regular file at ${canonical}.`);
|
|
}
|
|
return canonical;
|
|
}
|
|
|
|
/** Resolve the authoritative source and target identities without consulting diagnostics. */
|
|
export function resolveRegisteredWorktreeSeedSource(
|
|
input: RegisteredWorktreeSeedSourceInput,
|
|
): CanonicalWorktreeSeedSource {
|
|
const registeredCwd = input.registeredBaseWorkspaceCwd?.trim();
|
|
const explicitSource = input.explicitSourceConfigPath?.trim();
|
|
if (!registeredCwd && !explicitSource) {
|
|
throw new Error(
|
|
"Worktree seed source is not registered. Managed boot requires a project workspace; manual boot requires --from-config.",
|
|
);
|
|
}
|
|
|
|
let canonicalBaseCwd: string | null = null;
|
|
let registeredConfigPath: string | null = null;
|
|
if (registeredCwd) {
|
|
const resolvedRegisteredCwd = path.resolve(registeredCwd);
|
|
try {
|
|
canonicalBaseCwd = realpathSync(resolvedRegisteredCwd);
|
|
} catch {
|
|
throw new Error(`Registered base project workspace does not exist at ${resolvedRegisteredCwd}.`);
|
|
}
|
|
if (canonicalBaseCwd !== resolvedRegisteredCwd) {
|
|
throw new Error("Registered base project workspace must be canonical and cannot use a symlink alias.");
|
|
}
|
|
if (!lstatSync(canonicalBaseCwd).isDirectory()) {
|
|
throw new Error(`Registered base project workspace is not a directory at ${canonicalBaseCwd}.`);
|
|
}
|
|
// A base workspace that is a plain checkout carries no instance config of its own.
|
|
// The caller's explicit source supplies it, and stays subject to every check below.
|
|
registeredConfigPath = baseWorkspaceDeclaresInstanceConfig(canonicalBaseCwd)
|
|
? path.join(canonicalBaseCwd, ".paperclip", "config.json")
|
|
: null;
|
|
}
|
|
|
|
const selectedPath = registeredConfigPath ?? explicitSource;
|
|
if (!selectedPath) {
|
|
throw new Error(
|
|
"Registered base project workspace has no Paperclip config of its own and no explicit source was provided.",
|
|
);
|
|
}
|
|
const canonicalSourceConfigPath = canonicalRegularFile(selectedPath, "Registered source Paperclip config");
|
|
if (registeredConfigPath && canonicalSourceConfigPath !== registeredConfigPath) {
|
|
throw new Error("Registered source Paperclip config escapes the base project workspace or uses a symlink alias.");
|
|
}
|
|
|
|
if (explicitSource) {
|
|
const canonicalExplicitSource = canonicalRegularFile(explicitSource, "Explicit source Paperclip config");
|
|
if (canonicalExplicitSource !== canonicalSourceConfigPath) {
|
|
throw new Error("Explicit source Paperclip config does not match the registered base project workspace.");
|
|
}
|
|
}
|
|
|
|
const canonicalTargetConfigPath = canonicalRegularFile(
|
|
input.targetConfigPath,
|
|
"Target worktree Paperclip config",
|
|
);
|
|
if (canonicalSourceConfigPath === canonicalTargetConfigPath) {
|
|
throw new Error("Source and target Paperclip configs are the same canonical file.");
|
|
}
|
|
|
|
const sourceInstanceId = readInstanceId(canonicalSourceConfigPath, "source");
|
|
const targetInstanceId = readInstanceId(canonicalTargetConfigPath, "target");
|
|
if (targetInstanceId !== input.expectedTargetInstanceId) {
|
|
throw new Error("Target Paperclip instance does not match the registered worktree instance.");
|
|
}
|
|
if (sourceInstanceId === targetInstanceId) {
|
|
throw new Error("Source and target Paperclip configs name the same instance.");
|
|
}
|
|
|
|
return {
|
|
baseWorkspaceCwd: canonicalBaseCwd,
|
|
configPath: canonicalSourceConfigPath,
|
|
instanceId: sourceInstanceId,
|
|
targetConfigPath: canonicalTargetConfigPath,
|
|
targetInstanceId,
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Resolve a worktree seed source without granting authority to the seed manifest.
|
|
*
|
|
* A managed caller supplies the project-workspace cwd from its server-owned row.
|
|
* An operator may instead supply an explicit source config. A base workspace that
|
|
* carries its own `.paperclip/config.json` stays authoritative, so an explicit path
|
|
* must equal it; a base workspace that is a plain checkout has none, and the explicit
|
|
* path supplies the source. Manifest source fields are diagnostic assertions only and
|
|
* never select the returned source.
|
|
*/
|
|
export function resolveCanonicalWorktreeSeedSource(input: RegisteredWorktreeSeedSourceInput & {
|
|
manifestSource: WorktreeSeedSourceDiagnostic | null | undefined;
|
|
manifestTargetInstanceId?: unknown;
|
|
}): CanonicalWorktreeSeedSource {
|
|
const registered = resolveRegisteredWorktreeSeedSource(input);
|
|
const diagnosticPath = typeof input.manifestSource?.configPath === "string"
|
|
? input.manifestSource.configPath.trim()
|
|
: "";
|
|
if (!diagnosticPath) {
|
|
throw new Error("Worktree seed manifest is missing source path diagnostics.");
|
|
}
|
|
const canonicalDiagnosticPath = canonicalRegularFile(
|
|
diagnosticPath,
|
|
"Worktree seed manifest source diagnostic",
|
|
);
|
|
if (path.resolve(diagnosticPath) !== registered.configPath || canonicalDiagnosticPath !== registered.configPath) {
|
|
throw new Error("Worktree seed manifest source path does not match the registered canonical source.");
|
|
}
|
|
if (input.manifestSource?.instanceId !== registered.instanceId) {
|
|
throw new Error("Worktree seed manifest source instance does not match the registered source instance.");
|
|
}
|
|
if (input.manifestTargetInstanceId !== registered.targetInstanceId) {
|
|
throw new Error("Worktree seed manifest target instance does not match the registered target instance.");
|
|
}
|
|
return registered;
|
|
}
|