forked from farhoodlabs/paperclip
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>
162 lines
5.3 KiB
TypeScript
162 lines
5.3 KiB
TypeScript
import { randomBytes } from "node:crypto";
|
|
import { and, eq } from "drizzle-orm";
|
|
import type { Db } from "@paperclipai/db";
|
|
import { companies, companyMemberships, instanceUserRoles } from "@paperclipai/db";
|
|
import type { DeploymentMode } from "@paperclipai/shared";
|
|
import { ensureHumanRoleDefaultGrants } from "./services/principal-access-compatibility.js";
|
|
|
|
const LOCAL_BOARD_USER_ID = "local-board";
|
|
const CLAIM_TTL_MS = 1000 * 60 * 60 * 24;
|
|
|
|
type ChallengeStatus = "available" | "claimed" | "expired" | "invalid";
|
|
|
|
type ClaimChallenge = {
|
|
token: string;
|
|
code: string;
|
|
createdAt: Date;
|
|
expiresAt: Date;
|
|
claimedAt: Date | null;
|
|
claimedByUserId: string | null;
|
|
};
|
|
|
|
let activeChallenge: ClaimChallenge | null = null;
|
|
|
|
function createChallenge(now = new Date()): ClaimChallenge {
|
|
return {
|
|
token: randomBytes(24).toString("hex"),
|
|
code: randomBytes(12).toString("hex"),
|
|
createdAt: now,
|
|
expiresAt: new Date(now.getTime() + CLAIM_TTL_MS),
|
|
claimedAt: null,
|
|
claimedByUserId: null,
|
|
};
|
|
}
|
|
|
|
function getChallengeStatus(token: string, code: string | undefined): ChallengeStatus {
|
|
if (!activeChallenge) return "invalid";
|
|
if (activeChallenge.token !== token) return "invalid";
|
|
if (activeChallenge.code !== (code ?? "")) return "invalid";
|
|
if (activeChallenge.claimedAt) return "claimed";
|
|
if (activeChallenge.expiresAt.getTime() <= Date.now()) return "expired";
|
|
return "available";
|
|
}
|
|
|
|
export async function initializeBoardClaimChallenge(
|
|
db: Db,
|
|
opts: { deploymentMode: DeploymentMode },
|
|
): Promise<void> {
|
|
if (opts.deploymentMode !== "authenticated") {
|
|
activeChallenge = null;
|
|
return;
|
|
}
|
|
|
|
const admins = await db
|
|
.select({ userId: instanceUserRoles.userId })
|
|
.from(instanceUserRoles)
|
|
.where(eq(instanceUserRoles.role, "instance_admin"));
|
|
|
|
const onlyLocalBoardAdmin = admins.length === 1 && admins[0]?.userId === LOCAL_BOARD_USER_ID;
|
|
if (!onlyLocalBoardAdmin) {
|
|
activeChallenge = null;
|
|
return;
|
|
}
|
|
|
|
if (!activeChallenge || activeChallenge.expiresAt.getTime() <= Date.now() || activeChallenge.claimedAt) {
|
|
activeChallenge = createChallenge();
|
|
}
|
|
}
|
|
|
|
export function getBoardClaimWarningUrl(host: string, port: number): string | null {
|
|
if (!activeChallenge) return null;
|
|
if (activeChallenge.claimedAt || activeChallenge.expiresAt.getTime() <= Date.now()) return null;
|
|
const visibleHost = host === "0.0.0.0" ? "localhost" : host;
|
|
return `http://${visibleHost}:${port}/board-claim/${activeChallenge.token}?code=${activeChallenge.code}`;
|
|
}
|
|
|
|
export function inspectBoardClaimChallenge(token: string, code: string | undefined) {
|
|
const status = getChallengeStatus(token, code);
|
|
return {
|
|
status,
|
|
requiresSignIn: true,
|
|
expiresAt: activeChallenge?.expiresAt?.toISOString() ?? null,
|
|
claimedByUserId: activeChallenge?.claimedByUserId ?? null,
|
|
};
|
|
}
|
|
|
|
export async function claimBoardOwnership(
|
|
db: Db,
|
|
opts: { token: string; code: string | undefined; userId: string },
|
|
): Promise<{ status: ChallengeStatus; claimedByUserId?: string }> {
|
|
const status = getChallengeStatus(opts.token, opts.code);
|
|
if (status !== "available") return { status };
|
|
|
|
const claimedCompanyIds: string[] = [];
|
|
await db.transaction(async (tx) => {
|
|
const existingTargetAdmin = await tx
|
|
.select({ id: instanceUserRoles.id })
|
|
.from(instanceUserRoles)
|
|
.where(and(eq(instanceUserRoles.userId, opts.userId), eq(instanceUserRoles.role, "instance_admin")))
|
|
.then((rows) => rows[0] ?? null);
|
|
if (!existingTargetAdmin) {
|
|
await tx.insert(instanceUserRoles).values({
|
|
userId: opts.userId,
|
|
role: "instance_admin",
|
|
});
|
|
}
|
|
|
|
await tx
|
|
.delete(instanceUserRoles)
|
|
.where(and(eq(instanceUserRoles.userId, LOCAL_BOARD_USER_ID), eq(instanceUserRoles.role, "instance_admin")));
|
|
|
|
const allCompanies = await tx.select({ id: companies.id }).from(companies);
|
|
for (const company of allCompanies) {
|
|
claimedCompanyIds.push(company.id);
|
|
const existing = await tx
|
|
.select({ id: companyMemberships.id, status: companyMemberships.status })
|
|
.from(companyMemberships)
|
|
.where(
|
|
and(
|
|
eq(companyMemberships.companyId, company.id),
|
|
eq(companyMemberships.principalType, "user"),
|
|
eq(companyMemberships.principalId, opts.userId),
|
|
),
|
|
)
|
|
.then((rows) => rows[0] ?? null);
|
|
|
|
if (!existing) {
|
|
await tx.insert(companyMemberships).values({
|
|
companyId: company.id,
|
|
principalType: "user",
|
|
principalId: opts.userId,
|
|
status: "active",
|
|
membershipRole: "owner",
|
|
});
|
|
continue;
|
|
}
|
|
|
|
if (existing.status !== "active") {
|
|
await tx
|
|
.update(companyMemberships)
|
|
.set({ status: "active", membershipRole: "owner", updatedAt: new Date() })
|
|
.where(eq(companyMemberships.id, existing.id));
|
|
}
|
|
}
|
|
});
|
|
|
|
for (const companyId of claimedCompanyIds) {
|
|
await ensureHumanRoleDefaultGrants(db, {
|
|
companyId,
|
|
principalId: opts.userId,
|
|
membershipRole: "owner",
|
|
grantedByUserId: opts.userId,
|
|
});
|
|
}
|
|
|
|
if (activeChallenge && activeChallenge.token === opts.token) {
|
|
activeChallenge.claimedAt = new Date();
|
|
activeChallenge.claimedByUserId = opts.userId;
|
|
}
|
|
|
|
return { status: "claimed", claimedByUserId: opts.userId };
|
|
}
|