Files
paperclip/server/src/__tests__/agent-cross-tenant-authz-routes.test.ts
T
Dotta 2d1b531a49 [codex] Add clear-error agent action (#7695)
## Thinking Path

> - Paperclip is the open source control plane people use to manage AI
agents for work.
> - Agent runtime state is surfaced in both the server API and the board
UI so operators can tell whether an agent is idle, running, paused, or
in error.
> - When an agent is already in `error`, the existing pause/resume
action slot is not useful because there is no running work to pause.
> - Operators need a direct, audited recovery path that clears the stale
error state only for agents in the same company.
> - This pull request adds a company-scoped clear-error mutation,
exposes the shared API contract, and wires the board action cluster to
show Clear error in the pause/resume slot for errored agents.
> - The benefit is that operators can recover CEO/CTO-style errored
agents without resorting to database edits or unrelated session reset
actions.

## Linked Issues or Issue Description

Refs #4021

Paperclip issue: PAP-10515 — right now the CEO and CTO agents are in
error state, but there is no way to clear the error; they appear
otherwise fine.

## What Changed

- Added shared constants, API path, and agent status type support for a
company-scoped clear-error action.
- Added the server service and route to clear an agent from `error` back
to `idle`, with company access enforcement and activity logging.
- Added OpenAPI/docs coverage for the clear-error endpoint.
- Added backend coverage for service behavior and cross-tenant
authorization.
- Updated the board agent action cluster to show a red-tinted Clear
error button only when `agent.status === "error"`.
- Updated agent properties to show a red active last-error indicator
only while the agent is currently errored.
- Added UI component tests for the error-state action and the non-error
pause/resume behavior.

## Verification

Local:

- `pnpm exec vitest run
server/src/__tests__/agents-service-clear-error.test.ts
server/src/__tests__/agent-cross-tenant-authz-routes.test.ts
ui/src/components/AgentActionButtons.test.tsx`
- `pnpm --filter @paperclipai/ui typecheck`
- `pnpm exec vitest run server/src/__tests__/openapi-routes.test.ts`

PR checks:

- Main Paperclip workflow is green on
`a7378e584d50594e7bd507a1a02985bfaaa5abf8`.
- Greptile is 5/5 with no files requiring special attention and no new
comments on the latest review.
- `commitperclip PR Review` is still red because its security-gate step
canceled after filing a draft advisory; the linked `security-review`
check is neutral and says the draft advisory is not a merge block.

Visual artifact:

- ![Clear error visual
comparison](https://gist.githubusercontent.com/cryppadotta/59378c59869b971e92d3edf7b7073aa8/raw/clear-error-visual-comparison.svg)

## Risks

Low to medium risk. The mutation is intentionally narrow, but reviewers
should check that clearing `lastError`/`lastRunError` and returning to
`idle` is the desired recovery semantics for every adapter state. The
remaining red check is from the external commitperclip security-review
workflow, not from the code/test workflow for this PR.

> 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-family coding model, tool-assisted with local shell,
git, GitHub CLI, and targeted Vitest execution.

## 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 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
- [ ] 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
2026-06-07 10:33:29 -05:00

511 lines
16 KiB
TypeScript

import express from "express";
import request from "supertest";
import { beforeEach, describe, expect, it, vi } from "vitest";
vi.unmock("http");
vi.unmock("node:http");
const agentId = "11111111-1111-4111-8111-111111111111";
const companyId = "22222222-2222-4222-8222-222222222222";
const keyId = "33333333-3333-4333-8333-333333333333";
const baseAgent = {
id: agentId,
companyId,
name: "Builder",
urlKey: "builder",
role: "engineer",
title: "Builder",
icon: null,
status: "idle",
reportsTo: null,
capabilities: null,
adapterType: "process",
adapterConfig: {},
runtimeConfig: {},
budgetMonthlyCents: 0,
spentMonthlyCents: 0,
pauseReason: null,
pausedAt: null,
permissions: { canCreateAgents: false },
lastHeartbeatAt: null,
metadata: null,
createdAt: new Date("2026-04-11T00:00:00.000Z"),
updatedAt: new Date("2026-04-11T00:00:00.000Z"),
};
const baseKey = {
id: keyId,
agentId,
companyId,
name: "exploit",
createdAt: new Date("2026-04-11T00:00:00.000Z"),
revokedAt: null,
};
let currentKeyAgentId = agentId;
let currentAccessCanUser = false;
const mockAgentService = vi.hoisted(() => ({
getById: vi.fn(),
pause: vi.fn(),
resume: vi.fn(),
clearError: vi.fn(),
terminate: vi.fn(),
remove: vi.fn(),
listKeys: vi.fn(),
createApiKey: vi.fn(),
getKeyById: vi.fn(),
revokeKey: vi.fn(),
}));
const mockAccessService = vi.hoisted(() => ({
canUser: vi.fn(),
decide: vi.fn(),
hasPermission: vi.fn(),
getMembership: vi.fn(),
ensureMembership: vi.fn(),
listPrincipalGrants: vi.fn(),
setPrincipalPermission: vi.fn(),
}));
const mockApprovalService = vi.hoisted(() => ({
create: vi.fn(),
getById: vi.fn(),
}));
const mockBudgetService = vi.hoisted(() => ({
upsertPolicy: vi.fn(),
}));
const mockHeartbeatService = vi.hoisted(() => ({
cancelActiveForAgent: vi.fn(),
}));
const mockIssueApprovalService = vi.hoisted(() => ({
linkManyForApproval: vi.fn(),
}));
const mockIssueService = vi.hoisted(() => ({
list: vi.fn(),
}));
const mockSecretService = vi.hoisted(() => ({
normalizeAdapterConfigForPersistence: vi.fn(),
resolveAdapterConfigForRuntime: vi.fn(),
}));
const mockAgentInstructionsService = vi.hoisted(() => ({
materializeManagedBundle: vi.fn(),
}));
const mockCompanySkillService = vi.hoisted(() => ({
listRuntimeSkillEntries: vi.fn(),
resolveRequestedSkillKeys: vi.fn(),
}));
const mockWorkspaceOperationService = vi.hoisted(() => ({}));
const mockLogActivity = vi.hoisted(() => vi.fn());
const mockGetTelemetryClient = vi.hoisted(() => vi.fn());
vi.mock("@paperclipai/shared/telemetry", () => ({
trackAgentCreated: vi.fn(),
trackErrorHandlerCrash: vi.fn(),
}));
vi.mock("../telemetry.js", () => ({
getTelemetryClient: mockGetTelemetryClient,
}));
vi.mock("../routes/authz.js", async () => {
const { forbidden, unauthorized } = await vi.importActual<typeof import("../errors.js")>("../errors.js");
function assertAuthenticated(req: Express.Request) {
if (req.actor.type === "none") {
throw unauthorized();
}
}
function assertBoard(req: Express.Request) {
if (req.actor.type !== "board") {
throw forbidden("Board access required");
}
}
function assertCompanyAccess(req: Express.Request, expectedCompanyId: string) {
assertAuthenticated(req);
if (req.actor.type === "agent" && req.actor.companyId !== expectedCompanyId) {
throw forbidden("Agent key cannot access another company");
}
if (req.actor.type === "board" && req.actor.source !== "local_implicit") {
const allowedCompanies = req.actor.companyIds ?? [];
if (!allowedCompanies.includes(expectedCompanyId)) {
throw forbidden("User does not have access to this company");
}
}
}
function assertInstanceAdmin(req: Express.Request) {
assertBoard(req);
if (req.actor.source === "local_implicit" || req.actor.isInstanceAdmin) return;
throw forbidden("Instance admin access required");
}
function getActorInfo(req: Express.Request) {
assertAuthenticated(req);
if (req.actor.type === "agent") {
return {
actorType: "agent" as const,
actorId: req.actor.agentId ?? "unknown-agent",
agentId: req.actor.agentId ?? null,
runId: req.actor.runId ?? null,
};
}
return {
actorType: "user" as const,
actorId: req.actor.userId ?? "board",
agentId: null,
runId: req.actor.runId ?? null,
};
}
return {
assertAuthenticated,
assertBoard,
assertCompanyAccess,
assertInstanceAdmin,
getActorInfo,
};
});
vi.mock("../services/index.js", () => ({
agentService: () => mockAgentService,
agentInstructionsService: () => mockAgentInstructionsService,
accessService: () => mockAccessService,
approvalService: () => mockApprovalService,
companySkillService: () => mockCompanySkillService,
budgetService: () => mockBudgetService,
heartbeatService: () => mockHeartbeatService,
issueApprovalService: () => mockIssueApprovalService,
issueService: () => mockIssueService,
logActivity: mockLogActivity,
secretService: () => mockSecretService,
syncInstructionsBundleConfigFromFilePath: vi.fn((_agent, config) => config),
workspaceOperationService: () => mockWorkspaceOperationService,
}));
vi.mock("../services/instance-settings.js", () => ({
instanceSettingsService: () => ({
getGeneral: vi.fn(async () => ({ censorUsernameInLogs: false })),
}),
}));
let routeModules:
| Promise<[
typeof import("../middleware/index.js"),
typeof import("../routes/agents.js"),
]>
| null = null;
async function loadRouteModules() {
routeModules ??= Promise.all([
import("../middleware/index.js"),
import("../routes/agents.js"),
]);
return routeModules;
}
async function createApp(actor: Record<string, unknown>) {
const [{ errorHandler }, { agentRoutes }] = await loadRouteModules();
const app = express();
app.use(express.json());
app.use((req, _res, next) => {
(req as any).actor = {
...actor,
companyIds: Array.isArray(actor.companyIds) ? [...actor.companyIds] : actor.companyIds,
};
next();
});
app.use("/api", agentRoutes({} as any));
app.use(errorHandler);
return app;
}
async function requestApp(
app: express.Express,
buildRequest: (baseUrl: string) => request.Test,
) {
const { createServer } = await vi.importActual<typeof import("node:http")>("node:http");
const server = createServer(app);
try {
await new Promise<void>((resolve) => {
server.listen(0, "127.0.0.1", resolve);
});
const address = server.address();
if (!address || typeof address === "string") {
throw new Error("Expected HTTP server to listen on a TCP port");
}
return await buildRequest(`http://127.0.0.1:${address.port}`);
} finally {
if (server.listening) {
await new Promise<void>((resolve, reject) => {
server.close((error) => {
if (error) reject(error);
else resolve();
});
});
}
}
}
function resetMockDefaults() {
vi.clearAllMocks();
for (const mock of Object.values(mockAgentService)) mock.mockReset();
for (const mock of Object.values(mockAccessService)) mock.mockReset();
for (const mock of Object.values(mockApprovalService)) mock.mockReset();
for (const mock of Object.values(mockBudgetService)) mock.mockReset();
for (const mock of Object.values(mockHeartbeatService)) mock.mockReset();
for (const mock of Object.values(mockIssueApprovalService)) mock.mockReset();
for (const mock of Object.values(mockIssueService)) mock.mockReset();
for (const mock of Object.values(mockSecretService)) mock.mockReset();
for (const mock of Object.values(mockAgentInstructionsService)) mock.mockReset();
for (const mock of Object.values(mockCompanySkillService)) mock.mockReset();
mockLogActivity.mockReset();
mockGetTelemetryClient.mockReset();
mockGetTelemetryClient.mockReturnValue({ track: vi.fn() });
currentKeyAgentId = agentId;
currentAccessCanUser = false;
mockAgentService.getById.mockImplementation(async () => ({ ...baseAgent }));
mockAgentService.pause.mockImplementation(async () => ({ ...baseAgent }));
mockAgentService.resume.mockImplementation(async () => ({ ...baseAgent }));
mockAgentService.clearError.mockImplementation(async () => ({ ...baseAgent, status: "idle" }));
mockAgentService.terminate.mockImplementation(async () => ({ ...baseAgent }));
mockAgentService.remove.mockImplementation(async () => ({ ...baseAgent }));
mockAgentService.listKeys.mockImplementation(async () => []);
mockAgentService.createApiKey.mockImplementation(async () => ({
id: keyId,
name: baseKey.name,
token: "pcp_test_token",
createdAt: baseKey.createdAt,
}));
mockAgentService.getKeyById.mockImplementation(async () => ({
...baseKey,
agentId: currentKeyAgentId,
}));
mockAgentService.revokeKey.mockImplementation(async () => ({
...baseKey,
revokedAt: new Date("2026-04-11T00:05:00.000Z"),
}));
mockAccessService.canUser.mockImplementation(async () => currentAccessCanUser);
mockAccessService.decide.mockImplementation(async (input: { actor?: { type?: string; source?: string }; action?: string }) => {
const allowed = input.actor?.type === "board" && input.actor.source === "local_implicit"
? true
: currentAccessCanUser;
return {
allowed,
action: input.action,
reason: allowed ? "allow_explicit_grant" : "deny_missing_grant",
explanation: allowed ? "Allowed by test grant." : `Missing permission: ${input.action ?? "action"}`,
};
});
mockAccessService.hasPermission.mockImplementation(async () => false);
mockAccessService.getMembership.mockImplementation(async () => null);
mockAccessService.listPrincipalGrants.mockImplementation(async () => []);
mockAccessService.ensureMembership.mockImplementation(async () => undefined);
mockAccessService.setPrincipalPermission.mockImplementation(async () => undefined);
mockHeartbeatService.cancelActiveForAgent.mockImplementation(async () => undefined);
mockLogActivity.mockImplementation(async () => undefined);
}
describe.sequential("agent cross-tenant route authorization", () => {
beforeEach(() => {
resetMockDefaults();
});
it("enforces company boundaries before mutating or reading agent keys", async () => {
const crossTenantActor = {
type: "board",
userId: "mallory",
companyIds: [],
source: "session",
isInstanceAdmin: false,
};
const deniedCases = [
{
label: "pause",
request: (app: express.Express) =>
requestApp(app, (baseUrl) => request(baseUrl).post(`/api/agents/${agentId}/pause`).send({})),
untouched: [mockAgentService.pause, mockHeartbeatService.cancelActiveForAgent],
},
{
label: "clear error",
request: (app: express.Express) =>
requestApp(app, (baseUrl) => request(baseUrl).post(`/api/agents/${agentId}/clear-error`).send({})),
untouched: [mockAgentService.clearError],
},
{
label: "list keys",
request: (app: express.Express) =>
requestApp(app, (baseUrl) => request(baseUrl).get(`/api/agents/${agentId}/keys`)),
untouched: [mockAgentService.listKeys],
},
{
label: "create key",
request: (app: express.Express) =>
requestApp(app, (baseUrl) => request(baseUrl).post(`/api/agents/${agentId}/keys`).send({ name: "exploit" })),
untouched: [mockAgentService.createApiKey],
},
{
label: "revoke key",
request: (app: express.Express) =>
requestApp(app, (baseUrl) => request(baseUrl).delete(`/api/agents/${agentId}/keys/${keyId}`)),
untouched: [mockAgentService.getKeyById, mockAgentService.revokeKey],
},
];
for (const deniedCase of deniedCases) {
resetMockDefaults();
const app = await createApp(crossTenantActor);
const res = await deniedCase.request(app);
expect(res.status, `${deniedCase.label}: ${JSON.stringify(res.body)}`).toBe(403);
expect(res.body.error).toContain("User does not have access to this company");
expect(mockAgentService.getById).toHaveBeenCalledWith(agentId);
for (const mock of deniedCase.untouched) {
expect(mock).not.toHaveBeenCalled();
}
}
resetMockDefaults();
currentKeyAgentId = "44444444-4444-4444-8444-444444444444";
currentAccessCanUser = true;
const app = await createApp({
type: "board",
userId: "board-user",
companyIds: [companyId],
source: "session",
isInstanceAdmin: false,
});
const res = await requestApp(app, (baseUrl) => request(baseUrl).delete(`/api/agents/${agentId}/keys/${keyId}`));
expect(res.status).toBe(404);
expect(res.body.error).toContain("Key not found");
expect(mockAgentService.getKeyById).toHaveBeenCalledWith(keyId);
expect(mockAgentService.revokeKey).not.toHaveBeenCalled();
});
it("requires board access before clearing an agent error", async () => {
const app = await createApp({
type: "agent",
agentId,
companyId,
runId: "run-1",
});
const res = await requestApp(app, (baseUrl) =>
request(baseUrl).post(`/api/agents/${agentId}/clear-error`).send({}),
);
expect(res.status).toBe(403);
expect(res.body.error).toContain("Board access required");
expect(mockAgentService.clearError).not.toHaveBeenCalled();
});
it("clears error agents and records a distinct audit action", async () => {
const errorAgent = {
...baseAgent,
status: "error",
pauseReason: "system",
pausedAt: new Date("2026-04-11T00:02:00.000Z"),
};
mockAgentService.getById.mockImplementation(async () => ({ ...errorAgent }));
mockAgentService.clearError.mockImplementation(async () => ({
...errorAgent,
status: "idle",
pauseReason: null,
pausedAt: null,
updatedAt: new Date("2026-04-11T00:03:00.000Z"),
}));
const app = await createApp({
type: "board",
userId: "board-user",
companyIds: [companyId],
source: "local_implicit",
isInstanceAdmin: true,
});
const res = await requestApp(app, (baseUrl) =>
request(baseUrl).post(`/api/agents/${agentId}/clear-error`).send({}),
);
expect(res.status).toBe(200);
expect(res.body).toMatchObject({
id: agentId,
status: "idle",
pauseReason: null,
pausedAt: null,
});
expect(mockAgentService.clearError).toHaveBeenCalledWith(agentId);
expect(mockLogActivity).toHaveBeenCalledWith(expect.anything(), expect.objectContaining({
companyId,
actorType: "user",
actorId: "board-user",
action: "agent.error_cleared",
entityType: "agent",
entityId: agentId,
}));
});
it("returns 409 and does not mutate when the agent org chain is invalid", async () => {
mockAgentService.getById.mockImplementation(async () => ({
...baseAgent,
status: "error",
orgChainHealth: {
status: "invalid_org_chain",
reason: "missing_manager",
repairGuidance: "Repair the reporting chain first.",
},
}));
const app = await createApp({
type: "board",
userId: "board-user",
companyIds: [companyId],
source: "local_implicit",
isInstanceAdmin: true,
});
const res = await requestApp(app, (baseUrl) =>
request(baseUrl).post(`/api/agents/${agentId}/clear-error`).send({}),
);
expect(res.status).toBe(409);
expect(res.body.error).toContain("Repair the reporting chain first");
expect(mockAgentService.clearError).not.toHaveBeenCalled();
expect(mockLogActivity).not.toHaveBeenCalled();
});
it("returns a clear 409 for non-error agents", async () => {
const { conflict } = await import("../errors.js");
mockAgentService.getById.mockImplementation(async () => ({ ...baseAgent, status: "idle" }));
mockAgentService.clearError.mockImplementation(async () => {
throw conflict("Only agents in error status can have their error cleared");
});
const app = await createApp({
type: "board",
userId: "board-user",
companyIds: [companyId],
source: "local_implicit",
isInstanceAdmin: true,
});
const res = await requestApp(app, (baseUrl) =>
request(baseUrl).post(`/api/agents/${agentId}/clear-error`).send({}),
);
expect(res.status).toBe(409);
expect(res.body.error).toBe("Only agents in error status can have their error cleared");
expect(mockLogActivity).not.toHaveBeenCalled();
});
});