mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-24 18:19:05 +02:00
Enforce private task and project access across direct reads, search, execution, files, plugins, live delivery, and sharing mutations. Preserve downward-only sharing, current responsible-user authorization, and audited emergency access. Bind historical draft assets with migration 0314. Co-Authored-By: Paperclip <noreply@paperclip.ing>
544 lines
20 KiB
TypeScript
544 lines
20 KiB
TypeScript
import { Router, type Request } from "express";
|
|
import { eq } from "drizzle-orm";
|
|
import { heartbeatRuns, type Db } from "@paperclipai/db";
|
|
import {
|
|
addApprovalCommentSchema,
|
|
createApprovalSchema,
|
|
requestApprovalRevisionSchema,
|
|
resolveApprovalSchema,
|
|
resubmitApprovalSchema,
|
|
} from "@paperclipai/shared";
|
|
import { validate } from "../middleware/validate.js";
|
|
import { logger } from "../middleware/logger.js";
|
|
import {
|
|
approvalService,
|
|
accessService,
|
|
heartbeatService,
|
|
issueApprovalService,
|
|
logActivity,
|
|
secretService,
|
|
} from "../services/index.js";
|
|
import { assertBoard, assertCompanyAccess, getAccessibleResource, getActorInfo, hasCompanyAccess } from "./authz.js";
|
|
import { redactEventPayload } from "../redaction.js";
|
|
import type { PluginWorkerManager } from "../services/plugin-worker-manager.js";
|
|
import { issueService } from "../services/issues.js";
|
|
import { approvalReadSqlCondition, canActorReadApproval } from "../services/authorization.js";
|
|
import { REVIEW_PATH_RECOVERY_INSTRUCTION } from "../services/recovery/review-path-recovery.js";
|
|
|
|
function redactApprovalPayload<T extends { payload: Record<string, unknown> }>(approval: T): T {
|
|
return {
|
|
...approval,
|
|
payload: redactEventPayload(approval.payload) ?? {},
|
|
};
|
|
}
|
|
|
|
function isStatusOnlyRecoveryContext(contextSnapshot: unknown) {
|
|
if (!contextSnapshot || typeof contextSnapshot !== "object" || Array.isArray(contextSnapshot)) return false;
|
|
const context = contextSnapshot as Record<string, unknown>;
|
|
return context.recoveryIntent === "status_only" &&
|
|
context.allowDeliverableWork === false &&
|
|
context.allowDocumentUpdates === false &&
|
|
context.resumeRequiresNormalModel === true;
|
|
}
|
|
|
|
export function approvalRoutes(
|
|
db: Db,
|
|
options: { pluginWorkerManager?: PluginWorkerManager } = {},
|
|
) {
|
|
const router = Router();
|
|
router.param("id", async (req, res, next, id) => {
|
|
try {
|
|
if (!(await canActorReadApproval(db, req.actor, id))) {
|
|
res.status(404).json({ error: "Approval not found" });
|
|
return;
|
|
}
|
|
next();
|
|
} catch (error) { next(error); }
|
|
});
|
|
const svc = approvalService(db);
|
|
const access = accessService(db);
|
|
const heartbeat = heartbeatService(db, {
|
|
pluginWorkerManager: options.pluginWorkerManager,
|
|
});
|
|
const issueApprovalsSvc = issueApprovalService(db);
|
|
const issuesSvc = issueService(db);
|
|
const secretsSvc = secretService(db);
|
|
const strictSecretsMode = process.env.PAPERCLIP_SECRETS_STRICT_MODE === "true";
|
|
|
|
async function lostReviewPathIssueIds(
|
|
companyId: string,
|
|
linkedIssues: Awaited<ReturnType<typeof issueApprovalsSvc.listIssuesForApproval>>,
|
|
) {
|
|
const attention = await issuesSvc.listReviewAttention(companyId, linkedIssues);
|
|
return new Set(linkedIssues
|
|
.filter((issue) => attention.get(issue.id)?.state === "stalled")
|
|
.map((issue) => issue.id));
|
|
}
|
|
|
|
function approvalReviewPathContext(approvalId: string) {
|
|
return {
|
|
reviewPathLost: true,
|
|
reviewPathConsumedRef: approvalId,
|
|
reviewPathInstruction: REVIEW_PATH_RECOVERY_INSTRUCTION,
|
|
};
|
|
}
|
|
|
|
async function queueAdditionalApprovalReviewPathWakes(input: {
|
|
approvalId: string;
|
|
approvalStatus: string;
|
|
companyId: string;
|
|
linkedIssues: Awaited<ReturnType<typeof issueApprovalsSvc.listIssuesForApproval>>;
|
|
lostIssueIds: Set<string>;
|
|
alreadyWoken?: { agentId: string; issueId: string } | null;
|
|
requestedByUserId: string;
|
|
}) {
|
|
for (const issue of input.linkedIssues) {
|
|
if (!input.lostIssueIds.has(issue.id) || !issue.assigneeAgentId) continue;
|
|
if (
|
|
input.alreadyWoken?.agentId === issue.assigneeAgentId
|
|
&& input.alreadyWoken.issueId === issue.id
|
|
) continue;
|
|
|
|
const wakeReason = `approval_${input.approvalStatus}`;
|
|
try {
|
|
const wakeRun = await heartbeat.wakeup(issue.assigneeAgentId, {
|
|
source: "automation",
|
|
triggerDetail: "system",
|
|
reason: wakeReason,
|
|
idempotencyKey: `approval-review-path:${input.approvalId}:${issue.id}:${input.approvalStatus}`,
|
|
payload: {
|
|
approvalId: input.approvalId,
|
|
approvalStatus: input.approvalStatus,
|
|
issueId: issue.id,
|
|
...approvalReviewPathContext(input.approvalId),
|
|
},
|
|
requestedByActorType: "user",
|
|
requestedByActorId: input.requestedByUserId,
|
|
contextSnapshot: {
|
|
source: `approval.${input.approvalStatus}`,
|
|
approvalId: input.approvalId,
|
|
approvalStatus: input.approvalStatus,
|
|
issueId: issue.id,
|
|
taskId: issue.id,
|
|
wakeReason,
|
|
...approvalReviewPathContext(input.approvalId),
|
|
},
|
|
});
|
|
|
|
await logActivity(db, {
|
|
companyId: input.companyId,
|
|
actorType: "user",
|
|
actorId: input.requestedByUserId,
|
|
action: "approval.review_path_wakeup_queued",
|
|
entityType: "approval",
|
|
entityId: input.approvalId,
|
|
details: {
|
|
approvalStatus: input.approvalStatus,
|
|
issueId: issue.id,
|
|
assigneeAgentId: issue.assigneeAgentId,
|
|
wakeRunId: wakeRun?.id ?? null,
|
|
},
|
|
});
|
|
} catch (err) {
|
|
logger.warn(
|
|
{ err, approvalId: input.approvalId, issueId: issue.id, agentId: issue.assigneeAgentId },
|
|
"failed to queue review-path wake after approval resolution",
|
|
);
|
|
await logActivity(db, {
|
|
companyId: input.companyId,
|
|
actorType: "user",
|
|
actorId: input.requestedByUserId,
|
|
action: "approval.review_path_wakeup_failed",
|
|
entityType: "approval",
|
|
entityId: input.approvalId,
|
|
details: {
|
|
approvalStatus: input.approvalStatus,
|
|
issueId: issue.id,
|
|
assigneeAgentId: issue.assigneeAgentId,
|
|
error: err instanceof Error ? err.message : String(err),
|
|
},
|
|
});
|
|
}
|
|
}
|
|
}
|
|
|
|
async function requireApprovalAccess(req: Request, id: string) {
|
|
const approval = await svc.getById(id);
|
|
if (!approval || !hasCompanyAccess(req, approval.companyId)) {
|
|
return null;
|
|
}
|
|
assertCompanyAccess(req, approval.companyId);
|
|
return approval;
|
|
}
|
|
|
|
async function assertApprovalAccessAllowed(req: Request, res: any, companyId: string) {
|
|
const decision = await access.decide({
|
|
actor: req.actor,
|
|
action: "company_scope:read",
|
|
resource: { type: "company", companyId },
|
|
});
|
|
if (decision.allowed) return true;
|
|
res.status(403).json({ error: "Approvals are outside this actor's authorization boundary" });
|
|
return false;
|
|
}
|
|
|
|
async function assertApprovalMutationAllowedByRunContext(req: Request, res: any, companyId: string) {
|
|
if (req.actor.type !== "agent") return true;
|
|
const runId = req.actor.runId?.trim();
|
|
if (!runId || !req.actor.agentId) return true;
|
|
|
|
const run = await db
|
|
.select({
|
|
id: heartbeatRuns.id,
|
|
companyId: heartbeatRuns.companyId,
|
|
agentId: heartbeatRuns.agentId,
|
|
contextSnapshot: heartbeatRuns.contextSnapshot,
|
|
})
|
|
.from(heartbeatRuns)
|
|
.where(eq(heartbeatRuns.id, runId))
|
|
.then((rows) => rows[0] ?? null);
|
|
if (!run || run.companyId !== companyId || run.agentId !== req.actor.agentId) return true;
|
|
if (!isStatusOnlyRecoveryContext(run.contextSnapshot)) return true;
|
|
|
|
res.status(403).json({
|
|
error: "Status-only recovery runs cannot create or modify approvals",
|
|
details: {
|
|
companyId,
|
|
runId: run.id,
|
|
recoveryIntent: "status_only",
|
|
resumeRequiresNormalModel: true,
|
|
},
|
|
});
|
|
return false;
|
|
}
|
|
|
|
router.get("/companies/:companyId/approvals", async (req, res) => {
|
|
const companyId = req.params.companyId as string;
|
|
assertCompanyAccess(req, companyId);
|
|
if (!(await assertApprovalAccessAllowed(req, res, companyId))) return;
|
|
const status = req.query.status as string | undefined;
|
|
const result = await svc.list(companyId, status, await approvalReadSqlCondition(db, req.actor));
|
|
res.json(result.map((approval) => redactApprovalPayload(approval)));
|
|
});
|
|
|
|
router.get("/approvals/:id", async (req, res) => {
|
|
const id = req.params.id as string;
|
|
const approval = await getAccessibleResource(req, res, svc.getById(id), "Approval not found");
|
|
if (!approval) return;
|
|
if (!(await assertApprovalAccessAllowed(req, res, approval.companyId))) return;
|
|
res.json(redactApprovalPayload(approval));
|
|
});
|
|
|
|
router.post("/companies/:companyId/approvals", validate(createApprovalSchema), async (req, res) => {
|
|
const companyId = req.params.companyId as string;
|
|
assertCompanyAccess(req, companyId);
|
|
if (!(await assertApprovalAccessAllowed(req, res, companyId))) return;
|
|
if (!(await assertApprovalMutationAllowedByRunContext(req, res, companyId))) return;
|
|
const rawIssueIds = req.body.issueIds;
|
|
const issueIds = Array.isArray(rawIssueIds)
|
|
? rawIssueIds.filter((value: unknown): value is string => typeof value === "string")
|
|
: [];
|
|
const uniqueIssueIds = Array.from(new Set(issueIds));
|
|
const { issueIds: _issueIds, ...approvalInput } = req.body;
|
|
const normalizedPayload =
|
|
approvalInput.type === "hire_agent"
|
|
? await secretsSvc.normalizeHireApprovalPayloadForPersistence(
|
|
companyId,
|
|
approvalInput.payload,
|
|
{ strictMode: strictSecretsMode },
|
|
)
|
|
: approvalInput.payload;
|
|
|
|
const actor = getActorInfo(req);
|
|
const approval = await svc.create(companyId, {
|
|
...approvalInput,
|
|
payload: normalizedPayload,
|
|
requestedByUserId: actor.actorType === "user" ? actor.actorId : null,
|
|
requestedByAgentId:
|
|
approvalInput.requestedByAgentId ?? (actor.actorType === "agent" ? actor.actorId : null),
|
|
status: "pending",
|
|
decisionNote: null,
|
|
decidedByUserId: null,
|
|
decidedAt: null,
|
|
updatedAt: new Date(),
|
|
});
|
|
|
|
if (uniqueIssueIds.length > 0) {
|
|
await issueApprovalsSvc.linkManyForApproval(approval.id, uniqueIssueIds, {
|
|
agentId: actor.agentId,
|
|
userId: actor.actorType === "user" ? actor.actorId : null,
|
|
});
|
|
}
|
|
|
|
await logActivity(db, {
|
|
companyId,
|
|
actorType: actor.actorType,
|
|
actorId: actor.actorId,
|
|
agentId: actor.agentId,
|
|
action: "approval.created",
|
|
entityType: "approval",
|
|
entityId: approval.id,
|
|
details: { type: approval.type, issueIds: uniqueIssueIds },
|
|
});
|
|
|
|
res.status(201).json(redactApprovalPayload(approval));
|
|
});
|
|
|
|
router.get("/approvals/:id/issues", async (req, res) => {
|
|
const id = req.params.id as string;
|
|
const approval = await getAccessibleResource(req, res, svc.getById(id), "Approval not found");
|
|
if (!approval) return;
|
|
if (!(await assertApprovalAccessAllowed(req, res, approval.companyId))) return;
|
|
const issues = await issueApprovalsSvc.listIssuesForApproval(id);
|
|
res.json(issues);
|
|
});
|
|
|
|
router.post("/approvals/:id/approve", validate(resolveApprovalSchema), async (req, res) => {
|
|
assertBoard(req);
|
|
const id = req.params.id as string;
|
|
if (!(await requireApprovalAccess(req, id))) {
|
|
res.status(404).json({ error: "Approval not found" });
|
|
return;
|
|
}
|
|
const decidedByUserId = req.actor.userId ?? "board";
|
|
const { approval, applied } = await svc.approve(id, decidedByUserId, req.body.decisionNote);
|
|
|
|
if (applied) {
|
|
const linkedIssues = await issueApprovalsSvc.listIssuesForApproval(approval.id);
|
|
const linkedIssueIds = linkedIssues.map((issue) => issue.id);
|
|
const primaryIssueId = linkedIssueIds[0] ?? null;
|
|
const lostReviewIssueIds = await lostReviewPathIssueIds(approval.companyId, linkedIssues);
|
|
const primaryReviewPathContext = primaryIssueId && lostReviewIssueIds.has(primaryIssueId)
|
|
? approvalReviewPathContext(approval.id)
|
|
: null;
|
|
|
|
await logActivity(db, {
|
|
companyId: approval.companyId,
|
|
actorType: "user",
|
|
actorId: req.actor.userId ?? "board",
|
|
action: "approval.approved",
|
|
entityType: "approval",
|
|
entityId: approval.id,
|
|
details: {
|
|
type: approval.type,
|
|
requestedByAgentId: approval.requestedByAgentId,
|
|
linkedIssueIds,
|
|
},
|
|
});
|
|
|
|
let primaryReviewPathWakeCovered = false;
|
|
if (approval.requestedByAgentId) {
|
|
try {
|
|
const wakeRun = await heartbeat.wakeup(approval.requestedByAgentId, {
|
|
source: "automation",
|
|
triggerDetail: "system",
|
|
reason: "approval_approved",
|
|
payload: {
|
|
approvalId: approval.id,
|
|
approvalStatus: approval.status,
|
|
issueId: primaryIssueId,
|
|
issueIds: linkedIssueIds,
|
|
...(primaryReviewPathContext ?? {}),
|
|
},
|
|
requestedByActorType: "user",
|
|
requestedByActorId: req.actor.userId ?? "board",
|
|
contextSnapshot: {
|
|
source: "approval.approved",
|
|
approvalId: approval.id,
|
|
approvalStatus: approval.status,
|
|
issueId: primaryIssueId,
|
|
issueIds: linkedIssueIds,
|
|
taskId: primaryIssueId,
|
|
wakeReason: "approval_approved",
|
|
...(primaryReviewPathContext ?? {}),
|
|
},
|
|
});
|
|
primaryReviewPathWakeCovered = Boolean(wakeRun && primaryReviewPathContext);
|
|
|
|
await logActivity(db, {
|
|
companyId: approval.companyId,
|
|
actorType: "user",
|
|
actorId: req.actor.userId ?? "board",
|
|
action: "approval.requester_wakeup_queued",
|
|
entityType: "approval",
|
|
entityId: approval.id,
|
|
details: {
|
|
requesterAgentId: approval.requestedByAgentId,
|
|
wakeRunId: wakeRun?.id ?? null,
|
|
linkedIssueIds,
|
|
},
|
|
});
|
|
} catch (err) {
|
|
logger.warn(
|
|
{
|
|
err,
|
|
approvalId: approval.id,
|
|
requestedByAgentId: approval.requestedByAgentId,
|
|
},
|
|
"failed to queue requester wakeup after approval",
|
|
);
|
|
await logActivity(db, {
|
|
companyId: approval.companyId,
|
|
actorType: "user",
|
|
actorId: req.actor.userId ?? "board",
|
|
action: "approval.requester_wakeup_failed",
|
|
entityType: "approval",
|
|
entityId: approval.id,
|
|
details: {
|
|
requesterAgentId: approval.requestedByAgentId,
|
|
linkedIssueIds,
|
|
error: err instanceof Error ? err.message : String(err),
|
|
},
|
|
});
|
|
}
|
|
}
|
|
|
|
await queueAdditionalApprovalReviewPathWakes({
|
|
approvalId: approval.id,
|
|
approvalStatus: approval.status,
|
|
companyId: approval.companyId,
|
|
linkedIssues,
|
|
lostIssueIds: lostReviewIssueIds,
|
|
alreadyWoken: primaryReviewPathWakeCovered && approval.requestedByAgentId && primaryIssueId
|
|
? { agentId: approval.requestedByAgentId, issueId: primaryIssueId }
|
|
: null,
|
|
requestedByUserId: req.actor.userId ?? "board",
|
|
});
|
|
}
|
|
|
|
res.json(redactApprovalPayload(approval));
|
|
});
|
|
|
|
router.post("/approvals/:id/reject", validate(resolveApprovalSchema), async (req, res) => {
|
|
assertBoard(req);
|
|
const id = req.params.id as string;
|
|
if (!(await requireApprovalAccess(req, id))) {
|
|
res.status(404).json({ error: "Approval not found" });
|
|
return;
|
|
}
|
|
const decidedByUserId = req.actor.userId ?? "board";
|
|
const { approval, applied } = await svc.reject(id, decidedByUserId, req.body.decisionNote);
|
|
|
|
if (applied) {
|
|
const linkedIssues = await issueApprovalsSvc.listIssuesForApproval(approval.id);
|
|
const lostReviewIssueIds = await lostReviewPathIssueIds(approval.companyId, linkedIssues);
|
|
await logActivity(db, {
|
|
companyId: approval.companyId,
|
|
actorType: "user",
|
|
actorId: req.actor.userId ?? "board",
|
|
action: "approval.rejected",
|
|
entityType: "approval",
|
|
entityId: approval.id,
|
|
details: { type: approval.type },
|
|
});
|
|
await queueAdditionalApprovalReviewPathWakes({
|
|
approvalId: approval.id,
|
|
approvalStatus: approval.status,
|
|
companyId: approval.companyId,
|
|
linkedIssues,
|
|
lostIssueIds: lostReviewIssueIds,
|
|
requestedByUserId: req.actor.userId ?? "board",
|
|
});
|
|
}
|
|
|
|
res.json(redactApprovalPayload(approval));
|
|
});
|
|
|
|
router.post(
|
|
"/approvals/:id/request-revision",
|
|
validate(requestApprovalRevisionSchema),
|
|
async (req, res) => {
|
|
assertBoard(req);
|
|
const id = req.params.id as string;
|
|
if (!(await requireApprovalAccess(req, id))) {
|
|
res.status(404).json({ error: "Approval not found" });
|
|
return;
|
|
}
|
|
const decidedByUserId = req.actor.userId ?? "board";
|
|
const approval = await svc.requestRevision(id, decidedByUserId, req.body.decisionNote);
|
|
|
|
await logActivity(db, {
|
|
companyId: approval.companyId,
|
|
actorType: "user",
|
|
actorId: req.actor.userId ?? "board",
|
|
action: "approval.revision_requested",
|
|
entityType: "approval",
|
|
entityId: approval.id,
|
|
details: { type: approval.type },
|
|
});
|
|
|
|
res.json(redactApprovalPayload(approval));
|
|
},
|
|
);
|
|
|
|
router.post("/approvals/:id/resubmit", validate(resubmitApprovalSchema), async (req, res) => {
|
|
const id = req.params.id as string;
|
|
const existing = await getAccessibleResource(req, res, svc.getById(id), "Approval not found");
|
|
if (!existing) return;
|
|
if (!(await assertApprovalMutationAllowedByRunContext(req, res, existing.companyId))) return;
|
|
|
|
if (req.actor.type === "agent" && req.actor.agentId !== existing.requestedByAgentId) {
|
|
res.status(403).json({ error: "Only requesting agent can resubmit this approval" });
|
|
return;
|
|
}
|
|
|
|
const normalizedPayload = req.body.payload
|
|
? existing.type === "hire_agent"
|
|
? await secretsSvc.normalizeHireApprovalPayloadForPersistence(
|
|
existing.companyId,
|
|
req.body.payload,
|
|
{ strictMode: strictSecretsMode },
|
|
)
|
|
: req.body.payload
|
|
: undefined;
|
|
const approval = await svc.resubmit(id, normalizedPayload);
|
|
const actor = getActorInfo(req);
|
|
await logActivity(db, {
|
|
companyId: approval.companyId,
|
|
actorType: actor.actorType,
|
|
actorId: actor.actorId,
|
|
agentId: actor.agentId,
|
|
action: "approval.resubmitted",
|
|
entityType: "approval",
|
|
entityId: approval.id,
|
|
details: { type: approval.type },
|
|
});
|
|
res.json(redactApprovalPayload(approval));
|
|
});
|
|
|
|
router.get("/approvals/:id/comments", async (req, res) => {
|
|
const id = req.params.id as string;
|
|
const approval = await getAccessibleResource(req, res, svc.getById(id), "Approval not found");
|
|
if (!approval) return;
|
|
const comments = await svc.listComments(id);
|
|
res.json(comments);
|
|
});
|
|
|
|
router.post("/approvals/:id/comments", validate(addApprovalCommentSchema), async (req, res) => {
|
|
const id = req.params.id as string;
|
|
const approval = await getAccessibleResource(req, res, svc.getById(id), "Approval not found");
|
|
if (!approval) return;
|
|
if (!(await assertApprovalMutationAllowedByRunContext(req, res, approval.companyId))) return;
|
|
const actor = getActorInfo(req);
|
|
const comment = await svc.addComment(id, req.body.body, {
|
|
agentId: actor.agentId ?? undefined,
|
|
userId: actor.actorType === "user" ? actor.actorId : undefined,
|
|
});
|
|
|
|
await logActivity(db, {
|
|
companyId: approval.companyId,
|
|
actorType: actor.actorType,
|
|
actorId: actor.actorId,
|
|
agentId: actor.agentId,
|
|
action: "approval.comment_added",
|
|
entityType: "approval",
|
|
entityId: approval.id,
|
|
details: { commentId: comment.id },
|
|
});
|
|
|
|
res.status(201).json(comment);
|
|
});
|
|
|
|
return router;
|
|
}
|