mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-14 01:50:39 +09:00
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies. > - The REST API is the control-plane boundary for companies, agents, plugins, adapters, costs, invites, and issue mutations. > - Several routes still relied on broad board or company access checks without consistently enforcing the narrower actor, company, and active-checkout boundaries those operations require. > - That can allow agents or non-admin users to mutate sensitive resources outside the intended governance path. > - This pull request hardens the route authorization layer and adds regression coverage for the audited API surfaces. > - The benefit is tighter multi-company isolation, safer plugin and adapter administration, and stronger enforcement of active issue ownership. ## What Changed - Added route-level authorization checks for budgets, plugin administration/scoped routes, adapter management, company import/export, direct agent creation, invite test resolution, and issue mutation/write surfaces. - Enforced active checkout ownership for agent-authenticated issue mutations, while preserving explicit management overrides for permitted managers. - Restricted sensitive adapter and plugin management operations to instance-admin or properly scoped actors. - Tightened company portability and invite probing routes so agents cannot cross company boundaries. - Updated access constants and the Company Access UI copy for the new active-checkout management grant. - Added focused regression tests covering cross-company denial, agent self-mutation denial, admin-only operations, and active checkout ownership. - Rebased the branch onto `public-gh/master` and fixed validation fallout from the rebase: heartbeat-context route ordering and a company import/export e2e fixture that now opts out of direct-hire approval before using direct agent creation. - Updated onboarding and signoff e2e setup to create seed agents through `/agent-hires` plus board approval, so they remain compatible with the approval-gated new-agent default. - Addressed Greptile feedback by removing a duplicate company export API alias, avoiding N+1 reporting-chain lookups in active-checkout override checks, allowing agent mutations on unassigned `in_progress` issues, and blocking NAT64 invite-probe targets. ## Verification - `pnpm exec vitest run server/src/__tests__/issues-goal-context-routes.test.ts cli/src/__tests__/company-import-export-e2e.test.ts` - `pnpm exec vitest run server/src/__tests__/plugin-routes-authz.test.ts server/src/__tests__/adapter-routes-authz.test.ts server/src/__tests__/agent-permissions-routes.test.ts server/src/__tests__/company-portability-routes.test.ts server/src/__tests__/costs-service.test.ts server/src/__tests__/invite-test-resolution-route.test.ts server/src/__tests__/issue-agent-mutation-ownership-routes.test.ts server/src/__tests__/agent-adapter-validation-routes.test.ts` - `pnpm exec vitest run server/src/__tests__/issue-agent-mutation-ownership-routes.test.ts` - `pnpm exec vitest run server/src/__tests__/invite-test-resolution-route.test.ts` - `pnpm -r typecheck` - `pnpm --filter server typecheck` - `pnpm --filter ui typecheck` - `pnpm build` - `pnpm test:e2e -- tests/e2e/onboarding.spec.ts tests/e2e/signoff-policy.spec.ts` - `pnpm test:e2e -- tests/e2e/signoff-policy.spec.ts` - `pnpm test:run` was also run. It failed under default full-suite parallelism with two order-dependent failures in `plugin-routes-authz.test.ts` and `routines-e2e.test.ts`; both files passed when rerun directly together with `pnpm exec vitest run server/src/__tests__/plugin-routes-authz.test.ts server/src/__tests__/routines-e2e.test.ts`. ## Risks - Medium risk: this changes authorization behavior across multiple sensitive API surfaces, so callers that depended on broad board/company access may now receive `403` or `409` until they use the correct governance path. - Direct agent creation now respects the company-level board-approval requirement; integrations that need pending hires should use `/api/companies/:companyId/agent-hires`. - Active in-progress issue mutations now require checkout ownership or an explicit management override, which may reveal workflow assumptions in older automation. > 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-using workflow with local shell, Git, GitHub CLI, and repository tests. ## 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 - [ ] 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>
478 lines
15 KiB
TypeScript
478 lines
15 KiB
TypeScript
import express from "express";
|
|
import request from "supertest";
|
|
import { beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { afterAll, afterEach, beforeAll } from "vitest";
|
|
import { randomUUID } from "node:crypto";
|
|
import { createDb, companies, agents, costEvents, financeEvents, projects } from "@paperclipai/db";
|
|
import { costService } from "../services/costs.ts";
|
|
import { financeService } from "../services/finance.ts";
|
|
import {
|
|
getEmbeddedPostgresTestSupport,
|
|
startEmbeddedPostgresTestDatabase,
|
|
} from "./helpers/embedded-postgres.js";
|
|
|
|
function makeDb(overrides: Record<string, unknown> = {}) {
|
|
const selectChain = {
|
|
from: vi.fn().mockReturnThis(),
|
|
where: vi.fn().mockReturnThis(),
|
|
leftJoin: vi.fn().mockReturnThis(),
|
|
innerJoin: vi.fn().mockReturnThis(),
|
|
groupBy: vi.fn().mockReturnThis(),
|
|
orderBy: vi.fn().mockReturnThis(),
|
|
limit: vi.fn().mockReturnThis(),
|
|
then: vi.fn().mockResolvedValue([]),
|
|
};
|
|
|
|
const thenableChain = Object.assign(Promise.resolve([]), selectChain);
|
|
|
|
return {
|
|
select: vi.fn().mockReturnValue(thenableChain),
|
|
insert: vi.fn().mockReturnValue({
|
|
values: vi.fn().mockReturnValue({ returning: vi.fn().mockResolvedValue([]) }),
|
|
}),
|
|
update: vi.fn().mockReturnValue({
|
|
set: vi.fn().mockReturnValue({ where: vi.fn().mockResolvedValue([]) }),
|
|
}),
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
const mockCompanyService = vi.hoisted(() => ({
|
|
getById: vi.fn(),
|
|
update: vi.fn(),
|
|
}));
|
|
const mockAgentService = vi.hoisted(() => ({
|
|
getById: vi.fn(),
|
|
update: vi.fn(),
|
|
}));
|
|
const mockHeartbeatService = vi.hoisted(() => ({
|
|
cancelBudgetScopeWork: vi.fn().mockResolvedValue(undefined),
|
|
}));
|
|
const mockLogActivity = vi.hoisted(() => vi.fn());
|
|
const mockFetchAllQuotaWindows = vi.hoisted(() => vi.fn());
|
|
const mockCostService = vi.hoisted(() => ({
|
|
createEvent: vi.fn(),
|
|
summary: vi.fn().mockResolvedValue({ spendCents: 0 }),
|
|
byAgent: vi.fn().mockResolvedValue([]),
|
|
byAgentModel: vi.fn().mockResolvedValue([]),
|
|
byProvider: vi.fn().mockResolvedValue([]),
|
|
byBiller: vi.fn().mockResolvedValue([]),
|
|
windowSpend: vi.fn().mockResolvedValue([]),
|
|
byProject: vi.fn().mockResolvedValue([]),
|
|
}));
|
|
const mockFinanceService = vi.hoisted(() => ({
|
|
createEvent: vi.fn(),
|
|
summary: vi.fn().mockResolvedValue({ debitCents: 0, creditCents: 0, netCents: 0, estimatedDebitCents: 0, eventCount: 0 }),
|
|
byBiller: vi.fn().mockResolvedValue([]),
|
|
byKind: vi.fn().mockResolvedValue([]),
|
|
list: vi.fn().mockResolvedValue([]),
|
|
}));
|
|
const mockBudgetService = vi.hoisted(() => ({
|
|
overview: vi.fn().mockResolvedValue({
|
|
companyId: "company-1",
|
|
policies: [],
|
|
activeIncidents: [],
|
|
pausedAgentCount: 0,
|
|
pausedProjectCount: 0,
|
|
pendingApprovalCount: 0,
|
|
}),
|
|
upsertPolicy: vi.fn(),
|
|
resolveIncident: vi.fn(),
|
|
}));
|
|
|
|
function registerModuleMocks() {
|
|
vi.doMock("../services/index.js", () => ({
|
|
budgetService: () => mockBudgetService,
|
|
costService: () => mockCostService,
|
|
financeService: () => mockFinanceService,
|
|
companyService: () => mockCompanyService,
|
|
agentService: () => mockAgentService,
|
|
heartbeatService: () => mockHeartbeatService,
|
|
logActivity: mockLogActivity,
|
|
}));
|
|
|
|
vi.doMock("../services/quota-windows.js", () => ({
|
|
fetchAllQuotaWindows: mockFetchAllQuotaWindows,
|
|
}));
|
|
}
|
|
|
|
async function createApp() {
|
|
const [{ costRoutes }, { errorHandler }] = await Promise.all([
|
|
vi.importActual<typeof import("../routes/costs.js")>("../routes/costs.js"),
|
|
vi.importActual<typeof import("../middleware/index.js")>("../middleware/index.js"),
|
|
]);
|
|
const app = express();
|
|
app.use(express.json());
|
|
app.use((req, _res, next) => {
|
|
req.actor = { type: "board", userId: "board-user", source: "local_implicit" };
|
|
next();
|
|
});
|
|
app.use("/api", costRoutes(makeDb() as any));
|
|
app.use(errorHandler);
|
|
return app;
|
|
}
|
|
|
|
async function createAppWithActor(actor: any) {
|
|
const [{ costRoutes }, { errorHandler }] = await Promise.all([
|
|
vi.importActual<typeof import("../routes/costs.js")>("../routes/costs.js"),
|
|
vi.importActual<typeof import("../middleware/index.js")>("../middleware/index.js"),
|
|
]);
|
|
const app = express();
|
|
app.use(express.json());
|
|
app.use((req, _res, next) => {
|
|
req.actor = actor;
|
|
next();
|
|
});
|
|
app.use("/api", costRoutes(makeDb() as any));
|
|
app.use(errorHandler);
|
|
return app;
|
|
}
|
|
|
|
async function loadCostParsers() {
|
|
const { parseCostDateRange, parseCostLimit } = await import("../routes/costs.js");
|
|
return { parseCostDateRange, parseCostLimit };
|
|
}
|
|
|
|
beforeEach(() => {
|
|
vi.resetModules();
|
|
vi.doUnmock("../services/index.js");
|
|
vi.doUnmock("../services/quota-windows.js");
|
|
vi.doUnmock("../routes/costs.js");
|
|
vi.doUnmock("../middleware/index.js");
|
|
registerModuleMocks();
|
|
vi.clearAllMocks();
|
|
mockCompanyService.update.mockResolvedValue({
|
|
id: "company-1",
|
|
name: "Paperclip",
|
|
budgetMonthlyCents: 100,
|
|
spentMonthlyCents: 0,
|
|
});
|
|
mockAgentService.getById.mockResolvedValue({
|
|
id: "agent-1",
|
|
companyId: "company-1",
|
|
name: "Budget Agent",
|
|
budgetMonthlyCents: 100,
|
|
spentMonthlyCents: 0,
|
|
});
|
|
mockAgentService.update.mockResolvedValue({
|
|
id: "agent-1",
|
|
companyId: "company-1",
|
|
name: "Budget Agent",
|
|
budgetMonthlyCents: 100,
|
|
spentMonthlyCents: 0,
|
|
});
|
|
mockBudgetService.upsertPolicy.mockResolvedValue(undefined);
|
|
});
|
|
|
|
describe("cost routes", () => {
|
|
it("accepts valid ISO date strings", async () => {
|
|
const { parseCostDateRange } = await loadCostParsers();
|
|
expect(parseCostDateRange({
|
|
from: "2026-01-01T00:00:00.000Z",
|
|
to: "2026-01-31T23:59:59.999Z",
|
|
})).toEqual({
|
|
from: new Date("2026-01-01T00:00:00.000Z"),
|
|
to: new Date("2026-01-31T23:59:59.999Z"),
|
|
});
|
|
});
|
|
|
|
it("returns 400 for an invalid 'from' date string", async () => {
|
|
const { parseCostDateRange } = await loadCostParsers();
|
|
expect(() => parseCostDateRange({ from: "not-a-date" })).toThrow(/invalid 'from' date/i);
|
|
});
|
|
|
|
it("returns 400 for an invalid 'to' date string", async () => {
|
|
const { parseCostDateRange } = await loadCostParsers();
|
|
expect(() => parseCostDateRange({ to: "banana" })).toThrow(/invalid 'to' date/i);
|
|
});
|
|
|
|
it("returns finance summary rows for valid requests", async () => {
|
|
const app = await createApp();
|
|
const res = await request(app)
|
|
.get("/api/companies/company-1/costs/finance-summary")
|
|
.query({ from: "2026-02-01T00:00:00.000Z", to: "2026-02-28T23:59:59.999Z" });
|
|
expect(res.status).toBe(200);
|
|
expect(mockFinanceService.summary).toHaveBeenCalled();
|
|
});
|
|
|
|
it("returns 400 for invalid finance event list limits", async () => {
|
|
const { parseCostLimit } = await loadCostParsers();
|
|
expect(() => parseCostLimit({ limit: "0" })).toThrow(/invalid 'limit'/i);
|
|
});
|
|
|
|
it("accepts valid finance event list limits", async () => {
|
|
const { parseCostLimit } = await loadCostParsers();
|
|
expect(parseCostLimit({ limit: "25" })).toBe(25);
|
|
});
|
|
|
|
it("rejects company budget updates for board users outside the company", async () => {
|
|
const app = await createAppWithActor({
|
|
type: "board",
|
|
userId: "board-user",
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
companyIds: ["company-2"],
|
|
});
|
|
|
|
const res = await request(app)
|
|
.patch("/api/companies/company-1/budgets")
|
|
.send({ budgetMonthlyCents: 2500 });
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(mockCompanyService.update).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("rejects agent budget updates for board users outside the agent company", async () => {
|
|
const app = await createAppWithActor({
|
|
type: "board",
|
|
userId: "board-user",
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
companyIds: ["company-2"],
|
|
});
|
|
|
|
const res = await request(app)
|
|
.patch("/api/agents/agent-1/budgets")
|
|
.send({ budgetMonthlyCents: 2500 });
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(mockAgentService.update).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("rejects agent budget updates from the target agent without changing the budget policy", async () => {
|
|
const app = await createAppWithActor({
|
|
type: "agent",
|
|
agentId: "agent-1",
|
|
companyId: "company-1",
|
|
runId: "run-1",
|
|
});
|
|
|
|
const res = await request(app)
|
|
.patch("/api/agents/agent-1/budgets")
|
|
.send({ budgetMonthlyCents: 2500 });
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(res.body).toEqual({ error: "Board access required" });
|
|
expect(mockAgentService.update).not.toHaveBeenCalled();
|
|
expect(mockBudgetService.upsertPolicy).not.toHaveBeenCalled();
|
|
expect(mockLogActivity).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("rejects agent budget updates from another same-company agent without changing the budget policy", async () => {
|
|
const app = await createAppWithActor({
|
|
type: "agent",
|
|
agentId: "agent-2",
|
|
companyId: "company-1",
|
|
runId: "run-2",
|
|
});
|
|
|
|
const res = await request(app)
|
|
.patch("/api/agents/agent-1/budgets")
|
|
.send({ budgetMonthlyCents: 2500 });
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(res.body).toEqual({ error: "Board access required" });
|
|
expect(mockAgentService.update).not.toHaveBeenCalled();
|
|
expect(mockBudgetService.upsertPolicy).not.toHaveBeenCalled();
|
|
expect(mockLogActivity).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("allows authorized board users to update an agent budget and budget policy", async () => {
|
|
mockAgentService.update.mockResolvedValueOnce({
|
|
id: "agent-1",
|
|
companyId: "company-1",
|
|
name: "Budget Agent",
|
|
budgetMonthlyCents: 2500,
|
|
spentMonthlyCents: 0,
|
|
});
|
|
const app = await createAppWithActor({
|
|
type: "board",
|
|
userId: "board-user",
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
companyIds: ["company-1"],
|
|
memberships: [{ companyId: "company-1", status: "active", membershipRole: "admin" }],
|
|
});
|
|
|
|
const res = await request(app)
|
|
.patch("/api/agents/agent-1/budgets")
|
|
.send({ budgetMonthlyCents: 2500 });
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(mockAgentService.update).toHaveBeenCalledWith("agent-1", { budgetMonthlyCents: 2500 });
|
|
expect(mockBudgetService.upsertPolicy).toHaveBeenCalledWith(
|
|
"company-1",
|
|
{
|
|
scopeType: "agent",
|
|
scopeId: "agent-1",
|
|
amount: 2500,
|
|
windowKind: "calendar_month_utc",
|
|
},
|
|
"board-user",
|
|
);
|
|
expect(mockLogActivity).toHaveBeenCalledWith(
|
|
expect.anything(),
|
|
expect.objectContaining({
|
|
companyId: "company-1",
|
|
actorType: "user",
|
|
actorId: "board-user",
|
|
agentId: null,
|
|
action: "agent.budget_updated",
|
|
entityType: "agent",
|
|
entityId: "agent-1",
|
|
details: { budgetMonthlyCents: 2500 },
|
|
}),
|
|
);
|
|
});
|
|
});
|
|
|
|
const embeddedPostgresSupport = await getEmbeddedPostgresTestSupport();
|
|
const describeEmbeddedPostgres = embeddedPostgresSupport.supported ? describe : describe.skip;
|
|
|
|
describeEmbeddedPostgres("cost and finance aggregate overflow handling", () => {
|
|
let db!: ReturnType<typeof createDb>;
|
|
let costs!: ReturnType<typeof costService>;
|
|
let finance!: ReturnType<typeof financeService>;
|
|
let tempDb: Awaited<ReturnType<typeof startEmbeddedPostgresTestDatabase>> | null = null;
|
|
|
|
beforeAll(async () => {
|
|
tempDb = await startEmbeddedPostgresTestDatabase("paperclip-costs-service-");
|
|
db = createDb(tempDb.connectionString);
|
|
costs = costService(db);
|
|
finance = financeService(db);
|
|
}, 20_000);
|
|
|
|
afterEach(async () => {
|
|
await db.delete(financeEvents);
|
|
await db.delete(costEvents);
|
|
await db.delete(projects);
|
|
await db.delete(agents);
|
|
await db.delete(companies);
|
|
});
|
|
|
|
afterAll(async () => {
|
|
await tempDb?.cleanup();
|
|
});
|
|
|
|
it("aggregates cost event sums above int32 without raising Postgres integer overflow", async () => {
|
|
const companyId = randomUUID();
|
|
const agentId = randomUUID();
|
|
const projectId = randomUUID();
|
|
|
|
await db.insert(companies).values({
|
|
id: companyId,
|
|
name: "Paperclip",
|
|
issuePrefix: `T${companyId.replace(/-/g, "").slice(0, 6).toUpperCase()}`,
|
|
requireBoardApprovalForNewAgents: false,
|
|
});
|
|
await db.insert(agents).values({
|
|
id: agentId,
|
|
companyId,
|
|
name: "Cost Agent",
|
|
role: "engineer",
|
|
status: "active",
|
|
adapterType: "codex_local",
|
|
adapterConfig: {},
|
|
runtimeConfig: {},
|
|
permissions: {},
|
|
});
|
|
await db.insert(projects).values({
|
|
id: projectId,
|
|
companyId,
|
|
name: "Overflow Project",
|
|
status: "active",
|
|
});
|
|
|
|
await db.insert(costEvents).values([
|
|
{
|
|
companyId,
|
|
agentId,
|
|
projectId,
|
|
provider: "openai",
|
|
biller: "openai",
|
|
billingType: "metered_api",
|
|
model: "gpt-5",
|
|
inputTokens: 2_000_000_000,
|
|
cachedInputTokens: 0,
|
|
outputTokens: 200_000_000,
|
|
costCents: 2_000_000_000,
|
|
occurredAt: new Date("2026-04-10T00:00:00.000Z"),
|
|
},
|
|
{
|
|
companyId,
|
|
agentId,
|
|
projectId,
|
|
provider: "openai",
|
|
biller: "openai",
|
|
billingType: "metered_api",
|
|
model: "gpt-5",
|
|
inputTokens: 2_000_000_000,
|
|
cachedInputTokens: 10,
|
|
outputTokens: 200_000_000,
|
|
costCents: 2_000_000_000,
|
|
occurredAt: new Date("2026-04-11T00:00:00.000Z"),
|
|
},
|
|
]);
|
|
|
|
const range = {
|
|
from: new Date("2026-04-01T00:00:00.000Z"),
|
|
to: new Date("2026-04-15T23:59:59.999Z"),
|
|
};
|
|
|
|
const [byAgentRow] = await costs.byAgent(companyId, range);
|
|
const [byProjectRow] = await costs.byProject(companyId, range);
|
|
const [byAgentModelRow] = await costs.byAgentModel(companyId, range);
|
|
|
|
expect(byAgentRow?.costCents).toBe(4_000_000_000);
|
|
expect(byAgentRow?.inputTokens).toBe(4_000_000_000);
|
|
expect(byProjectRow?.costCents).toBe(4_000_000_000);
|
|
expect(byAgentModelRow?.costCents).toBe(4_000_000_000);
|
|
});
|
|
|
|
it("aggregates finance event sums above int32 without raising Postgres integer overflow", async () => {
|
|
const companyId = randomUUID();
|
|
|
|
await db.insert(companies).values({
|
|
id: companyId,
|
|
name: "Paperclip",
|
|
issuePrefix: `T${companyId.replace(/-/g, "").slice(0, 6).toUpperCase()}`,
|
|
requireBoardApprovalForNewAgents: false,
|
|
});
|
|
|
|
await db.insert(financeEvents).values([
|
|
{
|
|
companyId,
|
|
biller: "openai",
|
|
eventKind: "invoice",
|
|
amountCents: 2_000_000_000,
|
|
currency: "USD",
|
|
direction: "debit",
|
|
estimated: false,
|
|
occurredAt: new Date("2026-04-10T00:00:00.000Z"),
|
|
},
|
|
{
|
|
companyId,
|
|
biller: "openai",
|
|
eventKind: "invoice",
|
|
amountCents: 2_000_000_000,
|
|
currency: "USD",
|
|
direction: "debit",
|
|
estimated: true,
|
|
occurredAt: new Date("2026-04-11T00:00:00.000Z"),
|
|
},
|
|
]);
|
|
|
|
const range = {
|
|
from: new Date("2026-04-01T00:00:00.000Z"),
|
|
to: new Date("2026-04-15T23:59:59.999Z"),
|
|
};
|
|
|
|
const summary = await finance.summary(companyId, range);
|
|
const [byKindRow] = await finance.byKind(companyId, range);
|
|
|
|
expect(summary.debitCents).toBe(4_000_000_000);
|
|
expect(summary.estimatedDebitCents).toBe(2_000_000_000);
|
|
expect(byKindRow?.debitCents).toBe(4_000_000_000);
|
|
expect(byKindRow?.netCents).toBe(4_000_000_000);
|
|
});
|
|
});
|