38c185fb8b
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies by keeping task ownership, approvals, and operator control inside one control plane. > - Agent permissions and plugin-hosted company settings sit on the boundary between autonomy and governance. > - V1 needs scoped task assignment rules, plugin extension points, and clearer company access surfaces without weakening company boundaries. > - The branch builds the core authorization service, plugin SDK/host APIs, and UI simplifications needed to support those controls. > - Paperclip EE plugin surfaces were intentionally moved out of this core PR per review direction, so this PR now carries only the public core/plugin infrastructure work. > - The latest updates preserve the PAP-9937 branch changes that belong in this PR, remove the `design/` artifacts, and exclude the experimental `plugin-briefs` package. > - Greptile feedback was applied through the authorization/audit paths and the final cleanup commit was re-reviewed at 5/5 with no unresolved Greptile threads. > - The benefit is safer assignment control with extension hooks for richer permission products while preserving simple defaults for normal operators. ## What Changed - Added scoped task-assignment authorization decisions and routed issue/agent assignment mutations through the authorization service. - Added plugin SDK and host APIs for company settings slots, authorization policy/grant management, assignment previews, and bridge invocation scope propagation. - Simplified core company access UI and moved advanced controls behind plugin-provided settings surfaces. - Added retry-now affordances for blocked issue next-step notices. - Added protected-assignment enforcement for persisted agent/project/issue policies, including explicit-grant fallback behavior. - Added incremental principal-access compatibility backfill for active agent memberships and role-default human permission grants. - Added the Markdown code block wrap action fix from the latest branch changes. - Removed `design/` artifacts from the PR and removed `packages/plugins/plugin-briefs` from the final diff. - Addressed Greptile feedback for plugin actor sanitization, legacy membership handling, audit pagination, unknown grant-scope metadata, and startup test mocks. ## Verification - `pnpm exec vitest run server/src/__tests__/access-service.test.ts server/src/__tests__/company-portability.test.ts` -> 2 files passed, 54 tests passed. - `pnpm exec vitest run server/src/__tests__/server-startup-feedback-export.test.ts server/src/__tests__/access-service.test.ts server/src/__tests__/company-portability.test.ts` -> 3 files passed, 62 tests passed. - `pnpm exec vitest run server/src/__tests__/authorization-service.test.ts server/src/__tests__/plugin-access-authorization-host-services.test.ts server/src/__tests__/server-startup-feedback-export.test.ts` -> 3 files passed, 28 tests passed. - `pnpm --filter @paperclipai/server typecheck` -> passed. - `git diff --check` -> passed. - `node ./scripts/check-docker-deps-stage.mjs` -> passed. - `CI=true pnpm install --frozen-lockfile --ignore-scripts` -> passed with no lockfile update. - `pnpm exec vitest run ui/src/components/MarkdownBody.interaction.test.tsx` -> 1 test passed. - `git ls-files design packages/plugins/plugin-briefs | wc -l` -> 0. - GitHub CI on `40cd83b53` -> all checks passed, merge state `CLEAN`. - Greptile on `40cd83b53` -> 5/5, 102 files reviewed, 0 comments/annotations added, 0 unresolved review threads. - Confirmed the PR diff contains no `design/`, `packages/plugins/plugin-briefs`, `pnpm-lock.yaml`, or `.github/workflows` changes. ## Risks - Medium: task assignment authorization paths are behaviorally stricter for protected/private policy data, so existing plugin-authored policies may block assignment until explicit grants or approval flows are configured. - Medium: plugin-host authorization APIs expand the surface area available to trusted plugins and need careful review for company scoping. - Low: startup now performs a principal-access compatibility backfill, but the migration and runtime backfill use conflict-tolerant inserts. > 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, GPT-5 coding agent, tool-enabled workflow with shell, git, and GitHub CLI access. ## 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 - [x] If this change affects the UI, I have included before/after screenshots - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
161 lines
5.5 KiB
TypeScript
161 lines
5.5 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;
|
|
}
|
|
}
|
|
|
|
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()) {
|
|
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;
|
|
}
|