mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-13 13:38:01 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Execution workspaces need isolated databases, ports, and runtime services > - Concurrent workspaces could reuse ports or lose service ownership after a restart > - A markerless worktree also needed seed recovery, but normal markerless instances still needed to boot > - This pull request makes seed, port, and service ownership state explicit and recoverable > - It also checks live process and listener identity before it reclaims shared resources > - The benefit is reliable workspace startup, restart, adoption, and concurrent provisioning ## Linked Issues or Issue Description **What happened?** Managed workspaces could lose runtime service ownership after a control-plane restart. Concurrent worktrees could also reuse a port when their parent paths differed. A seed recovery change made every markerless instance resolve a worktree seed source, so normal instances without a source could not start. **Expected behavior** Paperclip must preserve healthy managed services across restarts. It must reserve unique ports across worktree parents. It must provision a registered markerless worktree, but it must skip seed work for a normal markerless instance. **Steps to reproduce** 1. Start two managed worktrees under different parent paths at the same time. 2. Restart the control plane while a managed service stays alive. 3. Start Paperclip with a config that has no seed markers and no registered worktree source. 4. Observe duplicate port selection, lost service adoption, or a seed-source startup error. **Paperclip version or commit** Current `master` plus the workspace runtime reliability changes in this pull request. **Deployment mode** Local development with managed execution workspaces and embedded Postgres. ## What Changed - Added a shared port registry with lease heartbeats, process identity checks, and live listener probes. - Reserved worktree ports across custom parent paths and repaired duplicate legacy assignments. - Preserved and adopted healthy managed services across control-plane restarts. - Reconciled guest bind modes and verified listener ownership before termination or reuse. - Provisioned registered markerless worktree databases and kept normal markerless instance startup as a no-op. - Added CLI, shared, server, and shell regression tests for seed, port, listener, restart, and adoption behavior. - Updated the worktree development documentation. ## Verification - `pnpm exec vitest run cli/src/__tests__/worktree.test.ts --reporter=verbose` — 63 tests passed. - `pnpm exec vitest run packages/shared/src/worktree-port-registry.test.ts --reporter=verbose` — 5 tests passed. - Focused runtime Vitest set — 199 tests passed across 37 suites. - `node --test scripts/__tests__/provision-worktree-self-heal.test.mjs` — 10 tests passed. - `git diff --check` passed. ## Risks - Port reservation now depends on lease and process identity data. The fallback listener probe prevents early reclamation when process metadata is incomplete. - Runtime adoption is stricter about bind and owner identity. The tests cover healthy adoption, stale records, PID reuse, and unrelated listeners. - Markerless seed detection now separates registered worktrees from normal instances. The tests cover both paths. - There are no database schema migrations. > 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 with the `gpt-5` model family. The serving snapshot and context-window size are not exposed. The agent used reasoning, repository tools, code execution, and test execution. ## 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 - [x] 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 --------- Co-authored-by: Paperclip <noreply@paperclip.ing> Co-authored-by: Dev Agent <dev@paperclip.ing>
161 lines
6.5 KiB
TypeScript
161 lines
6.5 KiB
TypeScript
import { existsSync, lstatSync, readFileSync, realpathSync } from "node:fs";
|
|
import path from "node:path";
|
|
|
|
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 envPath = path.join(path.dirname(configPath), ".env");
|
|
if (!existsSync(envPath)) {
|
|
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 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}.`);
|
|
}
|
|
registeredConfigPath = path.join(canonicalBaseCwd, ".paperclip", "config.json");
|
|
}
|
|
|
|
const selectedPath = registeredConfigPath ?? explicitSource!;
|
|
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. When both are present,
|
|
* the explicit path must still equal the registered project-workspace config.
|
|
* 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;
|
|
}
|