mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-26 18:31:34 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Managed worktree services run isolated Paperclip instances with cloned databases. > - A reachable service was reported as ready even when its database, runtime identity, or login path was not usable. > - The first candidate added verified database seeding and managed repair in #11665. > - This pull request consolidates that candidate with signed login handoff and a complete readiness contract. > - Post-QA fixes close five defects in repair identity, repair responses, UI retry, seed journal handling, and seed-source trust. > - The benefit is a workspace that either opens safely or reports one accurate recovery action. ## Linked Issues or Issue Description No public GitHub issue exists for this work, so the problem is described here. **What happened** Managed workspace URLs could return HTTP 200 and report ready while login failed. QA also found cases where repair used the wrong instance identity, returned a generic error, left the UI stuck, rejected a safe journal lag, or trusted a mutable workspace manifest. **Expected behavior** Opening a ready workspace signs the board user in to the correct isolated instance. Provisioning and repair use a registered source and report a structured recovery state. **Actual behavior** Entry depended on a password copied into the clone. Several failure paths could publish stale readiness, hide the repair precondition, or trust state that the workspace could modify. **Additional context** This pull request includes the commits first published in #11665. That pull request keeps the original base head for review history. This consolidated pull request is the merge candidate. Related open readiness work includes #11575 and #11621. ## What Changed - Adds a short-lived, signed, single-use login ticket. It binds the user, workspace, instance, and runtime origin. - Exchanges the ticket through Better Auth. It creates the session and cookie through the supported adapter path. - Adds protected workspace readiness fields for the database, clone data, login handoff, seed phase, and runtime identity. - Fails readiness closed when the guest has no company or execution-workspace binding. - Binds ticket issuance to the exact cloned user and active company membership selected for the handoff. - Verifies every current active board identity through the exact-user handoff before publication or reuse. - Gates managed runtime publication on the readiness contract and the recorded worktree instance identity. - Refreshes runtime work products from the live runtime row after a port change. - Adds one workspace access card with ready, degraded, repairing, and failed states. - Uses the runtime response identity for repair. It returns structured repair precondition errors. - Lets a valid source journal lag converge during provisioning. - Binds seed and repair manifests to a source registered outside the agent-writable worktree. - Clears recovered UI errors so a successful retry can open the workspace. - Makes runtime tests register canonical sources and avoid ports owned by live host listeners. - Keeps Vitest on source suites when compiled `dist` trees exist. - Isolates CLI and adapter tests from ambient AWS and runtime API environment variables. - Preserves a 404 response for cross-company workspace ID lookups before runtime authorization. - Makes concurrent single-flight coverage independent of path-canonicalization scheduling order. ## Verification The following checks passed on the integrated head: ```sh pnpm -r typecheck pnpm build pnpm check:token-gates pnpm --filter @paperclipai/db check:migrations ``` - The server source lane passed 420 files and 4,953 tests. Five tests were skipped. - The CLI lane passed 57 files and 385 tests. - The database lane passed 26 files and 97 tests. - The shared package passed 58 files and 506 tests. - The adapter utility lane passed 640 tests. Four tests were skipped. - The Claude adapter passed 220 tests. One test was skipped. - The Codex adapter passed 323 tests. - The OpenClaw adapter passed 13 tests. - The OpenCode adapter passed 42 tests. - The plugin SDK passed 45 tests. - The workspace runtime suite passed 124 tests. - The caller-scoped readiness and handoff suite passed 52 tests. - The workspace provisioning shell suite passed 7 tests. - The runtime exposure suite passed 17 tests while live host mappings occupied fixed test ports. - `git diff --check` passed and the worktree is clean. The serialized route lane will run in GitHub CI with its normal shards. No deployment or active-workspace migration was performed. ## Risks - This is a medium-risk authentication and runtime-readiness change. - The login ticket uses exact origin, workspace, instance, and user binding. It has a short expiry and a one-time nonce. - Runtime publication is stricter. A real readiness, identity, per-user handoff, or control-plane database disagreement now blocks publication. - This pull request supersedes #11665 as the merge candidate. Close #11665 after this pull request merges. - No new database migration is included. The lockfile and workflow files are unchanged. - Deployment and active-workspace migration are intentionally outside this pull request. > 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 Claude Opus 5 (`claude-opus-5[1m]`), 1M context, extended thinking, tool use, and code execution produced the main candidate. OpenAI GPT-5 (`gpt-5`) through Codex, with agentic reasoning, tool use, and code execution, integrated the post-QA fixes and hardened the test gates. The Codex context-window size was 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 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>
151 lines
6.1 KiB
TypeScript
151 lines
6.1 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;
|
|
};
|
|
|
|
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 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 can only make this
|
|
* validation fail; they never select the returned source.
|
|
*/
|
|
export function resolveCanonicalWorktreeSeedSource(input: {
|
|
registeredBaseWorkspaceCwd?: string | null;
|
|
explicitSourceConfigPath?: string | null;
|
|
targetConfigPath: string;
|
|
expectedTargetInstanceId: string;
|
|
manifestSource: WorktreeSeedSourceDiagnostic | null | undefined;
|
|
manifestTargetInstanceId?: unknown;
|
|
}): 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.");
|
|
}
|
|
|
|
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) !== canonicalSourceConfigPath || canonicalDiagnosticPath !== canonicalSourceConfigPath) {
|
|
throw new Error("Worktree seed manifest source path does not match the registered canonical source.");
|
|
}
|
|
if (input.manifestSource?.instanceId !== sourceInstanceId) {
|
|
throw new Error("Worktree seed manifest source instance does not match the registered source instance.");
|
|
}
|
|
if (input.manifestTargetInstanceId !== targetInstanceId) {
|
|
throw new Error("Worktree seed manifest target instance does not match the registered target instance.");
|
|
}
|
|
|
|
return {
|
|
baseWorkspaceCwd: canonicalBaseCwd,
|
|
configPath: canonicalSourceConfigPath,
|
|
instanceId: sourceInstanceId,
|
|
targetConfigPath: canonicalTargetConfigPath,
|
|
targetInstanceId,
|
|
};
|
|
}
|