c297ba2a80
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies > - codex_local runs Codex CLI under a per-company "managed home" so multiple companies don't trample on each other's session state > - For `auth.json` specifically, the managed home keeps a SYMLINK to the user's real `~/.codex/auth.json` rather than a copy — Codex refresh tokens rotate and are single-use, so any copy goes stale the moment the source rotates and every subsequent run dies with `401 refresh_token_reused` > - Older Paperclip versions copied `auth.json` instead. After upgrading, `ensureSymlink()` saw a regular file at the target, hit `if (!existing.isSymbolicLink()) return;`, and silently kept the stale copy > - This pull request makes the upgrade path self-healing inside `ensureSymlink()` itself: when the target is a regular file, unlink it and create the symlink, since the target lives under the Paperclip-managed home and is safe to delete. Directories are skipped to avoid `EISDIR` on Unix (and inconsistent behavior on Windows) > - The benefit is operators who upgraded from a copy-based version stop getting refresh-token-reused failures without having to manually purge `companies/<id>/codex-home/auth.json`, and the healing is defense-in-depth even outside the `prepareManagedCodexHome` cleanup path ## What Changed - `packages/adapters/codex-local/src/server/codex-home.ts` — `ensureSymlink()` previously bailed out of the `!existing.isSymbolicLink()` branch, leaving any pre-existing regular file untouched. Now unlinks and recreates the symlink in that branch via the existing `createExpectedSymlink()` helper (preserves the EEXIST race-tolerance behavior added in #5119). A guard skips directories so the call never throws `EISDIR` and aborts `prepareManagedCodexHome`. Inline comment explains the safety: target is always under the company-scoped managed home (`<paperclipHome>/instances/<id>/companies/<companyId>/codex-home/`), never the user's real `~/.codex`. - `packages/adapters/codex-local/src/server/codex-home.test.ts` — adds a regression test for #5028: pre-seed a stale copy at the target, run `prepareManagedCodexHome`, assert the target is now a symlink and reads through to the fresh source. The existing concurrent-symlink test is preserved. ## Verification ``` pnpm --filter @paperclipai/adapter-codex-local exec vitest run # Test Files 8 passed (8) # Tests 26 passed (26) pnpm --filter @paperclipai/adapter-codex-local exec tsc --noEmit # clean ``` Manual repro flow that the regression test mirrors: 1. Create a stale copy: `echo '{"token":"old"}' > <managedHome>/auth.json`. 2. Rotate source: `echo '{"token":"new"}' > ~/.codex/auth.json`. 3. Trigger any codex_local run — `prepareManagedCodexHome` is called from the execute path, the managed file is now a symlink to the source, and the CLI sees the fresh token. ## Risks - **Low risk.** The new branch only fires when the target file is a regular file (the upgrade path) — a pure copy that Codex couldn't have written, since Codex never writes into the managed home. Operators in steady-state on the symlink-based version are unaffected. - The `fs.unlink` only runs against the per-company managed-home path, never the user's real `~/.codex`. Inline comment makes this guarantee explicit. - A directory at the auth.json path is left in place (no silent `EISDIR` crash) — this requires operator inspection rather than autonomous deletion. - The healing uses `createExpectedSymlink()` so it remains tolerant of EEXIST races with concurrent prepare calls (the concurrent-symlink test still passes). - No DB / migration / schema impact. ## Model Used - Anthropic Claude Opus 4.7 (claude-opus-4-7), via Claude Code CLI with extended tool use (Read / Edit / Bash / Grep). No extended-thinking budget consumed beyond default. ## 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 - [x] I have added or updated tests where applicable - [ ] If this change affects the UI, I have included before/after screenshots — N/A, adapter-only - [x] I have updated relevant documentation to reflect my changes — inline comment explains the why and the safety of the unlink - [x] I have considered and documented any risks above - [x] I will address all Greptile and reviewer comments before requesting merge - [x] I searched the GitHub PR list for similar PRs and confirmed this is not a duplicate Fixes #5028. --------- Co-authored-by: Devin Foley <devin@paperclip.ing> Co-authored-by: Paperclip <noreply@paperclip.ing>
174 lines
6.4 KiB
TypeScript
174 lines
6.4 KiB
TypeScript
import fs from "node:fs/promises";
|
|
import os from "node:os";
|
|
import path from "node:path";
|
|
import type { AdapterExecutionContext } from "@paperclipai/adapter-utils";
|
|
import { resolvePaperclipInstanceRootForAdapter } from "@paperclipai/adapter-utils/server-utils";
|
|
|
|
const TRUTHY_ENV_RE = /^(1|true|yes|on)$/i;
|
|
const COPIED_SHARED_FILES = ["config.json", "config.toml", "instructions.md"] as const;
|
|
const SYMLINKED_SHARED_FILES = ["auth.json"] as const;
|
|
|
|
function nonEmpty(value: string | undefined): string | null {
|
|
return typeof value === "string" && value.trim().length > 0 ? value.trim() : null;
|
|
}
|
|
|
|
export async function pathExists(candidate: string): Promise<boolean> {
|
|
return fs.access(candidate).then(() => true).catch(() => false);
|
|
}
|
|
|
|
export function resolveSharedCodexHomeDir(
|
|
env: NodeJS.ProcessEnv = process.env,
|
|
): string {
|
|
const fromEnv = nonEmpty(env.CODEX_HOME);
|
|
return fromEnv ? path.resolve(fromEnv) : path.join(os.homedir(), ".codex");
|
|
}
|
|
|
|
function isWorktreeMode(env: NodeJS.ProcessEnv): boolean {
|
|
return TRUTHY_ENV_RE.test(env.PAPERCLIP_IN_WORKTREE ?? "");
|
|
}
|
|
|
|
export function resolveManagedCodexHomeDir(
|
|
env: NodeJS.ProcessEnv,
|
|
companyId?: string,
|
|
): string {
|
|
const instanceRoot = resolvePaperclipInstanceRootForAdapter({
|
|
homeDir: nonEmpty(env.PAPERCLIP_HOME) ?? undefined,
|
|
instanceId: nonEmpty(env.PAPERCLIP_INSTANCE_ID) ?? undefined,
|
|
env,
|
|
});
|
|
return companyId
|
|
? path.resolve(instanceRoot, "companies", companyId, "codex-home")
|
|
: path.resolve(instanceRoot, "codex-home");
|
|
}
|
|
|
|
async function ensureParentDir(target: string): Promise<void> {
|
|
await fs.mkdir(path.dirname(target), { recursive: true });
|
|
}
|
|
|
|
async function isExpectedSymlink(target: string, source: string): Promise<boolean> {
|
|
const existing = await fs.lstat(target).catch(() => null);
|
|
if (!existing?.isSymbolicLink()) return false;
|
|
|
|
const linkedPath = await fs.readlink(target).catch(() => null);
|
|
if (!linkedPath) return false;
|
|
|
|
return path.resolve(path.dirname(target), linkedPath) === path.resolve(source);
|
|
}
|
|
|
|
async function createExpectedSymlink(target: string, source: string): Promise<void> {
|
|
try {
|
|
await fs.symlink(source, target);
|
|
} catch (error) {
|
|
const code = (error as NodeJS.ErrnoException).code;
|
|
if (code === "EEXIST" && await isExpectedSymlink(target, source)) return;
|
|
throw error;
|
|
}
|
|
}
|
|
|
|
export async function ensureSymlink(target: string, source: string): Promise<void> {
|
|
const existing = await fs.lstat(target).catch(() => null);
|
|
if (!existing) {
|
|
await ensureParentDir(target);
|
|
await createExpectedSymlink(target, source);
|
|
return;
|
|
}
|
|
|
|
if (!existing.isSymbolicLink()) {
|
|
// A previous Paperclip version copied this file into the managed home
|
|
// instead of symlinking it. Codex refresh tokens rotate and are
|
|
// single-use, so a stale copy fails with refresh_token_reused on the next
|
|
// run (#5028). Replace the regular file with a symlink so the CLI follows
|
|
// the live source. Safe to delete: target is always under the
|
|
// Paperclip-managed company home, never the user's real ~/.codex.
|
|
// Directories are left alone — `fs.unlink` would throw EISDIR on Unix
|
|
// (and behave inconsistently on Windows). A directory at this path is not
|
|
// a Paperclip-written stale copy and warrants operator inspection rather
|
|
// than silent removal.
|
|
if (existing.isDirectory()) return;
|
|
await fs.unlink(target);
|
|
await createExpectedSymlink(target, source);
|
|
return;
|
|
}
|
|
|
|
if (await isExpectedSymlink(target, source)) return;
|
|
|
|
await fs.unlink(target);
|
|
await createExpectedSymlink(target, source);
|
|
}
|
|
|
|
async function ensureCopiedFile(target: string, source: string): Promise<void> {
|
|
const existing = await fs.lstat(target).catch(() => null);
|
|
if (existing) return;
|
|
await ensureParentDir(target);
|
|
await fs.copyFile(source, target);
|
|
}
|
|
|
|
/**
|
|
* Writes an `auth.json` containing only `OPENAI_API_KEY` so the codex CLI can
|
|
* authenticate via API key. Overwrites any existing file or symlink at that
|
|
* path. Required because the codex CLI (>= 0.122) ignores the `OPENAI_API_KEY`
|
|
* environment variable and only reads credentials from `$CODEX_HOME/auth.json`.
|
|
*/
|
|
export async function writeApiKeyAuthJson(home: string, apiKey: string): Promise<void> {
|
|
await fs.mkdir(home, { recursive: true });
|
|
const target = path.join(home, "auth.json");
|
|
await fs.rm(target, { force: true });
|
|
await fs.writeFile(target, JSON.stringify({ OPENAI_API_KEY: apiKey }), { mode: 0o600 });
|
|
}
|
|
|
|
export async function prepareManagedCodexHome(
|
|
env: NodeJS.ProcessEnv,
|
|
onLog: AdapterExecutionContext["onLog"],
|
|
companyId?: string,
|
|
options: { apiKey?: string | null } = {},
|
|
): Promise<string> {
|
|
const targetHome = resolveManagedCodexHomeDir(env, companyId);
|
|
const apiKey = nonEmpty(options.apiKey ?? undefined);
|
|
|
|
const sourceHome = resolveSharedCodexHomeDir(env);
|
|
const seedFromShared = path.resolve(sourceHome) !== path.resolve(targetHome);
|
|
|
|
await fs.mkdir(targetHome, { recursive: true });
|
|
|
|
// If a previous run wrote an apikey-mode auth.json (regular file) and this
|
|
// run has no apiKey, remove it so the chatgpt-mode symlink can be restored.
|
|
// Without this cleanup, ensureSymlink bails on a non-symlink and Codex keeps
|
|
// authenticating with the stale key after it is removed from configuration.
|
|
if (!apiKey && seedFromShared) {
|
|
const authPath = path.join(targetHome, "auth.json");
|
|
const existing = await fs.lstat(authPath).catch(() => null);
|
|
if (existing && !existing.isSymbolicLink()) {
|
|
await fs.rm(authPath, { force: true });
|
|
}
|
|
}
|
|
|
|
if (seedFromShared) {
|
|
for (const name of SYMLINKED_SHARED_FILES) {
|
|
const source = path.join(sourceHome, name);
|
|
if (!(await pathExists(source))) continue;
|
|
await ensureSymlink(path.join(targetHome, name), source);
|
|
}
|
|
|
|
for (const name of COPIED_SHARED_FILES) {
|
|
const source = path.join(sourceHome, name);
|
|
if (!(await pathExists(source))) continue;
|
|
await ensureCopiedFile(path.join(targetHome, name), source);
|
|
}
|
|
|
|
await onLog(
|
|
"stdout",
|
|
`[paperclip] Using ${isWorktreeMode(env) ? "worktree-isolated" : "Paperclip-managed"} Codex home "${targetHome}" (seeded from "${sourceHome}").\n`,
|
|
);
|
|
}
|
|
|
|
if (apiKey) {
|
|
await writeApiKeyAuthJson(targetHome, apiKey);
|
|
await onLog(
|
|
"stdout",
|
|
`[paperclip] Wrote API-key auth.json into Codex home "${targetHome}" from configured OPENAI_API_KEY.\n`,
|
|
);
|
|
}
|
|
|
|
return targetHome;
|
|
}
|