forked from farhoodlabs/paperclip
[codex] Add agent permissions and controls plan (#6386)
## 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>
This commit is contained in:
@@ -19,6 +19,7 @@
|
||||
*/
|
||||
|
||||
import { fork, type ChildProcess } from "node:child_process";
|
||||
import { randomUUID } from "node:crypto";
|
||||
import { EventEmitter } from "node:events";
|
||||
import { createInterface, type Interface as ReadlineInterface } from "node:readline";
|
||||
import type { PaperclipPluginManifestV1 } from "@paperclipai/shared";
|
||||
@@ -39,9 +40,12 @@ import {
|
||||
} from "@paperclipai/plugin-sdk";
|
||||
import type {
|
||||
JsonRpcId,
|
||||
PluginInvocationContext,
|
||||
PluginInvocationScope,
|
||||
JsonRpcResponse,
|
||||
JsonRpcRequest,
|
||||
JsonRpcNotification,
|
||||
WorkerHostCallContext,
|
||||
HostToWorkerMethodName,
|
||||
HostToWorkerMethods,
|
||||
WorkerToHostMethodName,
|
||||
@@ -108,6 +112,7 @@ export type WorkerStatus =
|
||||
*/
|
||||
export type WorkerToHostHandler<M extends WorkerToHostMethodName> = (
|
||||
params: WorkerToHostMethods[M][0],
|
||||
context?: WorkerHostCallContext,
|
||||
) => Promise<WorkerToHostMethods[M][1]>;
|
||||
|
||||
/**
|
||||
@@ -201,6 +206,11 @@ interface PendingRequest {
|
||||
sentAt: number;
|
||||
}
|
||||
|
||||
interface ActiveInvocation {
|
||||
scope: PluginInvocationScope;
|
||||
timer?: ReturnType<typeof setTimeout>;
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// PluginWorkerHandle — manages a single worker process
|
||||
// ---------------------------------------------------------------------------
|
||||
@@ -379,6 +389,7 @@ export function createPluginWorkerHandle(
|
||||
// Pending RPC requests awaiting a response
|
||||
const pendingRequests = new Map<string | number, PendingRequest>();
|
||||
let nextRequestId = 1;
|
||||
const activeInvocations = new Map<string, ActiveInvocation>();
|
||||
|
||||
// Optional methods reported by the worker during initialization
|
||||
let supportedMethods: string[] = [];
|
||||
@@ -475,13 +486,78 @@ export function createPluginWorkerHandle(
|
||||
pending.resolve(response);
|
||||
}
|
||||
|
||||
function readNonEmptyString(value: unknown): string | null {
|
||||
return typeof value === "string" && value.trim().length > 0 ? value.trim() : null;
|
||||
}
|
||||
|
||||
function isRecord(value: unknown): value is Record<string, unknown> {
|
||||
return typeof value === "object" && value !== null && !Array.isArray(value);
|
||||
}
|
||||
|
||||
function deriveInvocationScope(
|
||||
method: HostToWorkerMethodName | string,
|
||||
params: unknown,
|
||||
): PluginInvocationScope | null {
|
||||
if (!isRecord(params)) return null;
|
||||
|
||||
const directCompanyId = readNonEmptyString(params.companyId);
|
||||
if (directCompanyId) return { companyId: directCompanyId };
|
||||
|
||||
if (method === "executeTool" && isRecord(params.runContext)) {
|
||||
const companyId = readNonEmptyString(params.runContext.companyId);
|
||||
return companyId ? { companyId } : null;
|
||||
}
|
||||
|
||||
if (method === "onEvent" && isRecord(params.event)) {
|
||||
const companyId = readNonEmptyString(params.event.companyId);
|
||||
return companyId ? { companyId } : null;
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
function registerInvocation(scope: PluginInvocationScope, ttlMs?: number): PluginInvocationContext {
|
||||
const invocation: PluginInvocationContext = {
|
||||
id: randomUUID(),
|
||||
scope,
|
||||
};
|
||||
const entry: ActiveInvocation = { scope };
|
||||
if (ttlMs !== undefined) {
|
||||
entry.timer = setTimeout(() => {
|
||||
activeInvocations.delete(invocation.id);
|
||||
}, ttlMs);
|
||||
if (entry.timer.unref) entry.timer.unref();
|
||||
}
|
||||
activeInvocations.set(invocation.id, entry);
|
||||
return invocation;
|
||||
}
|
||||
|
||||
function clearInvocation(invocation: PluginInvocationContext | null): void {
|
||||
if (!invocation) return;
|
||||
const entry = activeInvocations.get(invocation.id);
|
||||
if (entry?.timer) clearTimeout(entry.timer);
|
||||
activeInvocations.delete(invocation.id);
|
||||
}
|
||||
|
||||
function contextForWorkerMessage(message: JsonRpcRequest | JsonRpcNotification): WorkerHostCallContext {
|
||||
const invocationId = readNonEmptyString(
|
||||
(message as { paperclipInvocationId?: unknown }).paperclipInvocationId,
|
||||
);
|
||||
if (!invocationId) {
|
||||
return activeInvocations.size > 0 ? { invalidInvocationScope: true } : {};
|
||||
}
|
||||
const entry = activeInvocations.get(invocationId);
|
||||
if (!entry) return { invalidInvocationScope: true };
|
||||
return { invocationScope: entry.scope };
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle a JSON-RPC request from the worker (worker→host call).
|
||||
*/
|
||||
async function handleWorkerRequest(request: JsonRpcRequest): Promise<void> {
|
||||
const method = request.method as WorkerToHostMethodName;
|
||||
const handler = options.hostHandlers[method] as
|
||||
| ((params: unknown) => Promise<unknown>)
|
||||
| ((params: unknown, context?: WorkerHostCallContext) => Promise<unknown>)
|
||||
| undefined;
|
||||
|
||||
if (!handler) {
|
||||
@@ -501,7 +577,7 @@ export function createPluginWorkerHandle(
|
||||
}
|
||||
|
||||
try {
|
||||
const result = await handler(request.params);
|
||||
const result = await handler(request.params, contextForWorkerMessage(request));
|
||||
sendMessage({
|
||||
jsonrpc: JSONRPC_VERSION,
|
||||
id: request.id,
|
||||
@@ -509,12 +585,15 @@ export function createPluginWorkerHandle(
|
||||
});
|
||||
} catch (err) {
|
||||
const errorMessage = err instanceof Error ? err.message : String(err);
|
||||
const errorCode = typeof (err as { code?: unknown }).code === "number"
|
||||
? (err as { code: number }).code
|
||||
: JSONRPC_ERROR_CODES.INTERNAL_ERROR;
|
||||
log.error({ method, err: errorMessage }, "host handler error");
|
||||
try {
|
||||
sendMessage(
|
||||
createErrorResponse(
|
||||
request.id,
|
||||
JSONRPC_ERROR_CODES.INTERNAL_ERROR,
|
||||
errorCode,
|
||||
errorMessage,
|
||||
),
|
||||
);
|
||||
@@ -572,12 +651,28 @@ export function createPluginWorkerHandle(
|
||||
notification.method === "streams.close"
|
||||
) {
|
||||
const params = (notification.params ?? {}) as Record<string, unknown>;
|
||||
const companyId = String(params.companyId ?? "");
|
||||
const context = contextForWorkerMessage(notification);
|
||||
if (context.invalidInvocationScope) {
|
||||
log.warn(
|
||||
{ method: notification.method, companyId },
|
||||
"dropping plugin stream notification with invalid invocation scope",
|
||||
);
|
||||
return;
|
||||
}
|
||||
const allowedCompanyId = context.invocationScope?.companyId;
|
||||
if (allowedCompanyId && companyId !== allowedCompanyId) {
|
||||
log.warn(
|
||||
{ method: notification.method, companyId, allowedCompanyId },
|
||||
"dropping plugin stream notification outside invocation company scope",
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
// Track open channels so we can emit synthetic close on crash
|
||||
if (notification.method === "streams.open") {
|
||||
const ch = String(params.channel ?? "");
|
||||
const co = String(params.companyId ?? "");
|
||||
if (ch) openStreamChannels.set(ch, co);
|
||||
if (ch) openStreamChannels.set(ch, companyId);
|
||||
} else if (notification.method === "streams.close") {
|
||||
openStreamChannels.delete(String(params.channel ?? ""));
|
||||
}
|
||||
@@ -760,6 +855,10 @@ export function createPluginWorkerHandle(
|
||||
);
|
||||
}
|
||||
pendingRequests.clear();
|
||||
for (const invocation of activeInvocations.values()) {
|
||||
if (invocation.timer) clearTimeout(invocation.timer);
|
||||
}
|
||||
activeInvocations.clear();
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------
|
||||
@@ -1020,6 +1119,8 @@ export function createPluginWorkerHandle(
|
||||
|
||||
const id = nextRequestId++;
|
||||
const timeout = Math.min(timeoutMs ?? rpcTimeoutMs, MAX_RPC_TIMEOUT_MS);
|
||||
const invocationScope = deriveInvocationScope(method, params);
|
||||
const invocation = invocationScope ? registerInvocation(invocationScope) : null;
|
||||
|
||||
// Guard against double-settlement. When a process exits all pending
|
||||
// requests are rejected via rejectAllPending(), but the timeout timer
|
||||
@@ -1032,6 +1133,7 @@ export function createPluginWorkerHandle(
|
||||
settled = true;
|
||||
clearTimeout(timer);
|
||||
pendingRequests.delete(id);
|
||||
clearInvocation(invocation);
|
||||
fn(value);
|
||||
};
|
||||
|
||||
@@ -1064,11 +1166,15 @@ export function createPluginWorkerHandle(
|
||||
pendingRequests.set(id, pending);
|
||||
|
||||
try {
|
||||
const request = createRequest(method, params, id);
|
||||
const request = {
|
||||
...createRequest(method, params, id),
|
||||
...(invocation ? { paperclipInvocation: invocation } : {}),
|
||||
};
|
||||
sendMessage(request);
|
||||
} catch (err) {
|
||||
clearTimeout(timer);
|
||||
pendingRequests.delete(id);
|
||||
clearInvocation(invocation);
|
||||
reject(
|
||||
new Error(
|
||||
`Failed to send "${method}" to worker: ${
|
||||
@@ -1135,13 +1241,17 @@ export function createPluginWorkerHandle(
|
||||
|
||||
notify(method: string, params: unknown) {
|
||||
if (status !== "running") return;
|
||||
const invocationScope = deriveInvocationScope(method, params);
|
||||
const invocation = invocationScope ? registerInvocation(invocationScope, MAX_RPC_TIMEOUT_MS) : null;
|
||||
try {
|
||||
sendMessage({
|
||||
jsonrpc: JSONRPC_VERSION,
|
||||
method,
|
||||
params,
|
||||
...(invocation ? { paperclipInvocation: invocation } : {}),
|
||||
});
|
||||
} catch {
|
||||
clearInvocation(invocation);
|
||||
log.warn({ method }, "failed to send notification to worker");
|
||||
}
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user