feat(workspaces): sign the workspace login handoff and gate readiness (#11671)

## 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>
This commit is contained in:
DottaandPaperclip authored and GitHub committed 2026-08-19 02:37:02 -05:00
1 parent 6aaef2998f
commit a2bf936f9a
59 files changed
+7754 -243

No files matched your search

+162 -13
View File
@@ -36,6 +36,16 @@ import { and, desc, eq, gte, inArray, isNull, lte, ne, or } from "drizzle-orm";
import { asNumber, asString, parseObject, renderTemplate } from "../adapters/utils.js";
import { conflict } from "../errors.js";
import { resolveHomeAwarePath } from "../home-paths.js";
import { hasVerifiedWorktreeSeedManifest } from "../worktree-seed-manifest.js";
import {
buildManagedWorkspaceGuestEnv,
logManagedWorkspaceReadinessRejection,
probeManagedWorkspaceHandoffSubjects,
probeManagedWorkspaceReadiness,
resolveManagedWorkspaceIdentity,
shouldBlockPublicationOnReadiness,
waitForManagedWorkspaceReadiness,
} from "./managed-workspace-identity.js";
import {
createLocalServiceKey,
findLocalServiceRegistryRecordByRuntimeServiceId,
@@ -4728,14 +4738,74 @@ function resolveRuntimeServiceHealthUrl(
return url;
}
type RuntimeServiceHealthProbeInput = {
db?: Db;
serviceName?: string | null;
command?: string | null;
provider?: string | null;
port?: number | null;
/**
* Workspace identity, when the caller knows it. Supplying all three upgrades
* the probe from "the port answered with status ok" to the full protected
* readiness contract, which is what stops a relocated port or a half-restored
* clone from masquerading as healthy (PAP-17572).
*/
cwd?: string | null;
executionWorkspaceId?: string | null;
companyId?: string | null;
};
/**
* Whether a managed workspace runtime satisfies the *user* readiness contract.
*
* Returns null when this service is not an identity-resolvable managed workspace
* runtime, so non-workspace services keep their existing behavior.
*
* For a workspace runtime this *replaces* the semantic transport check rather
* than adding to it. The probe reads the same `/api/health` response the legacy
* check read, so every legacy verdict is already implied: reaching
* `readiness_missing` means the response was `200` with `status: ok` (exactly
* what the legacy check asserted), and every other rejection means it was not.
* Stacking a second request on top would double the latency of every reuse
* decision for no extra information.
*/
async function probeManagedWorkspaceRuntimeReadiness(
healthUrl: string,
input: RuntimeServiceHealthProbeInput,
): Promise<boolean | null> {
if (!isPaperclipDevRuntimeService(input)) return null;
const identity = resolveManagedWorkspaceIdentity({
workspaceCwd: input.cwd ?? null,
executionWorkspaceId: input.executionWorkspaceId ?? null,
companyId: input.companyId ?? null,
});
if (!identity) return null;
const result = await probeManagedWorkspaceReadiness({ healthUrl, identity });
const verified = !result.ok
? result
: input.db
? await probeManagedWorkspaceHandoffSubjects({ db: input.db, healthUrl, identity })
: {
ok: false as const,
reason: "not_ready" as const,
readiness: result.readiness,
detail: "control-plane database is unavailable for board identity verification",
};
if (verified.ok) return true;
logManagedWorkspaceReadinessRejection({
executionWorkspaceId: identity.executionWorkspaceId,
healthUrl,
result: verified,
});
// A guest that does not implement the readiness contract yet is not evidence of
// an unhealthy clone; it is only evidence that the contract cannot be checked.
return !shouldBlockPublicationOnReadiness(verified);
}
async function isRuntimeServiceUrlHealthy(
url: string | null,
input?: {
serviceName?: string | null;
command?: string | null;
provider?: string | null;
port?: number | null;
},
input?: RuntimeServiceHealthProbeInput,
) {
const localProbeUrl = input?.provider === "local_process" && input.port && isPaperclipDevRuntimeService(input)
? `http://127.0.0.1:${input.port}`
@@ -4744,6 +4814,10 @@ async function isRuntimeServiceUrlHealthy(
if (!probeUrl) return true;
const healthUrl = resolveRuntimeServiceHealthUrl(probeUrl, input);
if (!healthUrl) return false;
const readiness = await probeManagedWorkspaceRuntimeReadiness(healthUrl, input ?? {});
if (readiness !== null) return readiness;
try {
const response = await fetch(healthUrl, { signal: AbortSignal.timeout(2_000) });
if (!response.ok) return false;
@@ -5015,6 +5089,7 @@ export function resolveRuntimeProvisionCommand(input: {
if (input.workspace.strategy !== "git_worktree") return "";
const stateDir = path.join(input.workspace.cwd, ".paperclip");
const manifestPath = path.join(stateDir, "seed-manifest.json");
const pendingMarker = path.join(stateDir, "seed-pending");
const completeMarker = path.join(stateDir, "seed-complete");
const provisionScript = path.join(
@@ -5022,11 +5097,11 @@ export function resolveRuntimeProvisionCommand(input: {
"scripts",
"provision-worktree-runtime.sh",
);
if (
!existsSync(pendingMarker)
|| existsSync(completeMarker)
|| !existsSync(provisionScript)
) {
let needsSeed = existsSync(pendingMarker) && !existsSync(completeMarker);
if (existsSync(manifestPath)) {
needsSeed = !hasVerifiedWorktreeSeedManifest(manifestPath);
}
if (!needsSeed || !existsSync(provisionScript)) {
return "";
}
@@ -5371,6 +5446,21 @@ async function spawnLocalRuntimeService(input: StartLocalRuntimeServiceInput): P
env[portEnvKey] = String(port);
}
// Per-workspace handoff key, readiness token, and workspace id. Injected for
// the Paperclip dev runtime whether or not it is HTTPS-exposed, because the
// password-independent login handoff and the protected readiness probe are
// both needed for a plain-HTTP loopback workspace too (PAP-17572).
const managedWorkspaceIdentity = isPaperclipDevRuntimeService({ serviceName, command })
? resolveManagedWorkspaceIdentity({
workspaceCwd: input.workspace.cwd,
executionWorkspaceId: input.executionWorkspaceId ?? null,
companyId: input.agent.companyId,
})
: null;
if (managedWorkspaceIdentity) {
Object.assign(env, buildManagedWorkspaceGuestEnv(managedWorkspaceIdentity));
}
if (exposureConfig) {
// Paperclip dev-runtime-specific hardening. Other managed processes are
// still rejected by the broker unless /proc proves loopback-only listeners.
@@ -5426,7 +5516,14 @@ async function spawnLocalRuntimeService(input: StartLocalRuntimeServiceInput): P
});
if (adoptedRecord) {
const adoptedUrl = adoptedRecord.url ?? backendUrl;
if (!(await isRuntimeServiceUrlHealthy(adoptedUrl, { serviceName, command }))) {
if (!(await isRuntimeServiceUrlHealthy(adoptedUrl, {
db: input.db,
serviceName,
command,
cwd: input.workspace.cwd,
executionWorkspaceId: input.executionWorkspaceId ?? null,
companyId: input.agent.companyId,
}))) {
await terminateLocalService(adoptedRecord);
await removeLocalServiceRegistryRecord(adoptedRecord.serviceKey);
} else {
@@ -5698,6 +5795,45 @@ async function spawnLocalRuntimeService(input: StartLocalRuntimeServiceInput): P
);
}
}
// Transport readiness only proves a listener answered. A managed workspace
// must additionally satisfy the protected readiness contract — own database,
// cloned rows, login handoff, and matching instance/workspace identity —
// before it may be published as running/healthy (PAP-17572).
if (managedWorkspaceIdentity) {
const publishHealthUrl = resolveRuntimeServiceHealthUrl(
record.port ? `http://127.0.0.1:${record.port}` : rewriteUrlHostToLoopback(record.url ?? backendUrl),
{ serviceName, command },
);
if (!publishHealthUrl) {
throw new Error("Managed workspace readiness gate could not resolve a health URL");
}
let gate = await waitForManagedWorkspaceReadiness({
healthUrl: publishHealthUrl,
identity: managedWorkspaceIdentity,
});
if (gate.ok) {
if (!record.db) {
throw new Error("Managed workspace readiness gate could not resolve the control-plane database");
}
gate = await probeManagedWorkspaceHandoffSubjects({
db: record.db,
healthUrl: publishHealthUrl,
identity: managedWorkspaceIdentity,
});
}
if (!gate.ok) {
logManagedWorkspaceReadinessRejection({
executionWorkspaceId: managedWorkspaceIdentity.executionWorkspaceId,
healthUrl: publishHealthUrl,
result: gate,
});
if (shouldBlockPublicationOnReadiness(gate)) {
throw new Error(
`Workspace is not ready to publish (${gate.reason}${gate.detail ? `: ${gate.detail}` : ""})`,
);
}
}
}
record.status = "running";
record.healthStatus = "healthy";
record.lastUsedAt = new Date().toISOString();
@@ -5952,10 +6088,14 @@ async function findHealthyRunningRuntimeService(reuseKey: string | null) {
const existing = existingId ? runtimeServicesById.get(existingId) : null;
if (!existing || existing.status !== "running") return null;
const healthInput = {
db: existing.db,
serviceName: existing.serviceName,
command: existing.command,
provider: existing.provider,
port: existing.port,
cwd: existing.cwd,
executionWorkspaceId: existing.executionWorkspaceId,
companyId: existing.companyId,
};
let healthy = await isRuntimeServiceUrlHealthy(existing.url, healthInput);
if (!healthy) {
@@ -7231,6 +7371,9 @@ export async function refreshPersistedRuntimeServiceHealth(input: {
port: workspaceRuntimeServices.port,
url: workspaceRuntimeServices.url,
healthStatus: workspaceRuntimeServices.healthStatus,
cwd: workspaceRuntimeServices.cwd,
executionWorkspaceId: workspaceRuntimeServices.executionWorkspaceId,
companyId: workspaceRuntimeServices.companyId,
})
.from(workspaceRuntimeServices)
.where(and(
@@ -7241,7 +7384,9 @@ export async function refreshPersistedRuntimeServiceHealth(input: {
));
const results = await Promise.all(rows.map(async (row) => ({
row,
healthStatus: await isRuntimeServiceUrlHealthy(row.url, row) ? "healthy" as const : "unhealthy" as const,
healthStatus: await isRuntimeServiceUrlHealthy(row.url, { ...row, db: input.db })
? "healthy" as const
: "unhealthy" as const,
})));
await Promise.all(results.map(async ({ row, healthStatus }) => {
const liveRecord = runtimeServicesById.get(row.id);
@@ -7442,10 +7587,14 @@ export async function reconcilePersistedRuntimeServicesOnStartup(db: Db) {
backfillDecision.action === "reprovision"
|| !exposureHealthMatches
|| !(await isRuntimeServiceUrlHealthy(adoptedUrl, {
db,
serviceName: row.serviceName,
command: row.command,
provider: "local_process",
port: adoptedRecord.port ?? row.port,
cwd: row.cwd,
executionWorkspaceId: row.executionWorkspaceId ?? null,
companyId: row.companyId,
}))
) {
if (backfillDecision.action === "reprovision") backfilled += 1;