mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-13 17:40:38 +09:00
## Thinking Path > - Paperclip orchestrates AI-agent companies through issues, documents, runs, and durable company-scoped state. > - Issue documents are where agents and operators capture plans, handoffs, and work products. > - Before this change, document collaboration could only happen through whole-document edits and detached issue comments. > - Inline document annotations need stable anchors, revision-aware persistence, and UI affordances that do not break existing document editing. > - This pull request adds company-scoped document annotation threads, comments, anchor snapshots, API routes, and board UI. > - The benefit is that operators and agents can discuss specific document passages without losing context as documents evolve. ## What Changed - Added document annotation tables, schema exports, shared types, validators, anchor hashing, and text-anchor helpers. - Added server-side document annotation services and issue routes for listing, creating, commenting, resolving, and reopening annotation threads. - Included annotation summaries in relevant issue document reads and backup/recovery document workspace behavior. - Added React UI for inline document highlights, comment panels, mobile sheet behavior, deep-link focus, and resolved/open filtering. - Added annotation design artifacts, Storybook coverage, screenshots, and a screenshot helper script. - Rebased the branch onto current `paperclipai/paperclip` `master` and renumbered the annotation migration from `0085_old_swarm` to `0091_old_swarm`; the SQL uses `IF NOT EXISTS` guards so environments that previously applied the old migration number can safely apply the new one. - Adjusted the new annotation UI tests to use a local async flush helper because this workspace's React 19.2.4 export does not expose `React.act`. ## Verification - `pnpm run preflight:workspace-links && pnpm exec vitest run packages/shared/src/document-anchors.test.ts server/src/__tests__/document-annotation-routes.test.ts server/src/__tests__/document-annotations-service.test.ts ui/src/components/DocumentAnnotationLayer.test.tsx ui/src/components/IssueDocumentAnnotations.test.tsx ui/src/lib/document-annotation-hash.test.ts ui/src/lib/document-annotation-selection.test.ts` - Confirmed `git diff --check` passes. - Confirmed no `pnpm-lock.yaml` or `.github/workflows/*` files are included in the PR diff. ## Risks - Medium risk: this adds new persisted annotation tables and routes across db/shared/server/ui. - Migration risk is reduced by moving the branch migration to `0091_old_swarm` after upstream `0090_resource_memberships` and keeping the SQL idempotent for old `0085_old_swarm` adopters. - UI risk is mostly around text range anchoring and panel positioning across long documents, folded content, and mobile layouts; the PR includes focused unit coverage and design screenshots. > 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 software engineering mode. Context window size is not exposed in this Paperclip runtime. ## 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>
874 lines
32 KiB
TypeScript
874 lines
32 KiB
TypeScript
import { Readable } from "node:stream";
|
|
import express from "express";
|
|
import request from "supertest";
|
|
import { beforeEach, describe, expect, it, vi } from "vitest";
|
|
|
|
const issueId = "11111111-1111-4111-8111-111111111111";
|
|
const companyId = "22222222-2222-4222-8222-222222222222";
|
|
const ownerAgentId = "33333333-3333-4333-8333-333333333333";
|
|
const peerAgentId = "44444444-4444-4444-8444-444444444444";
|
|
const ownerRunId = "55555555-5555-4555-8555-555555555555";
|
|
const recoveryActionId = "77777777-7777-4777-8777-777777777777";
|
|
|
|
const mockIssueService = vi.hoisted(() => ({
|
|
addComment: vi.fn(),
|
|
assertCheckoutOwner: vi.fn(),
|
|
create: vi.fn(),
|
|
createChild: vi.fn(),
|
|
getAttachmentById: vi.fn(),
|
|
getByIdentifier: vi.fn(),
|
|
getById: vi.fn(),
|
|
getRelationSummaries: vi.fn(),
|
|
getWakeableParentAfterChildCompletion: vi.fn(),
|
|
listAttachments: vi.fn(),
|
|
listWakeableBlockedDependents: vi.fn(),
|
|
remove: vi.fn(),
|
|
removeAttachment: vi.fn(),
|
|
update: vi.fn(),
|
|
findMentionedAgents: vi.fn(),
|
|
}));
|
|
|
|
const mockAccessService = vi.hoisted(() => ({
|
|
canUser: vi.fn(),
|
|
decide: vi.fn(),
|
|
hasPermission: vi.fn(),
|
|
}));
|
|
|
|
const mockAgentService = vi.hoisted(() => ({
|
|
getById: vi.fn(),
|
|
list: vi.fn(),
|
|
resolveByReference: vi.fn(),
|
|
}));
|
|
|
|
const mockCompanyService = vi.hoisted(() => ({
|
|
getById: vi.fn(),
|
|
}));
|
|
|
|
const mockDocumentService = vi.hoisted(() => ({
|
|
upsertIssueDocument: vi.fn(),
|
|
}));
|
|
|
|
const mockWorkProductService = vi.hoisted(() => ({
|
|
createForIssue: vi.fn(),
|
|
getById: vi.fn(),
|
|
remove: vi.fn(),
|
|
update: vi.fn(),
|
|
}));
|
|
|
|
const mockStorageService = vi.hoisted(() => ({
|
|
provider: "local_disk",
|
|
putFile: vi.fn(),
|
|
getObject: vi.fn(),
|
|
headObject: vi.fn(),
|
|
deleteObject: vi.fn(),
|
|
}));
|
|
const mockIssueThreadInteractionService = vi.hoisted(() => ({
|
|
expireRequestConfirmationsSupersededByComment: vi.fn(async () => []),
|
|
expireStaleRequestConfirmationsForIssueDocument: vi.fn(async () => []),
|
|
}));
|
|
const mockIssueRecoveryActionService = vi.hoisted(() => ({
|
|
getActiveForIssue: vi.fn(async () => null),
|
|
resolveActiveForIssue: vi.fn(async () => null),
|
|
}));
|
|
const mockHeartbeatService = vi.hoisted(() => ({
|
|
wakeup: vi.fn(async () => undefined),
|
|
reportRunActivity: vi.fn(async () => undefined),
|
|
getRun: vi.fn(async () => null),
|
|
getActiveRunForAgent: vi.fn(async () => null),
|
|
cancelRun: vi.fn(async () => null),
|
|
}));
|
|
|
|
function registerRouteMocks() {
|
|
vi.doMock("@paperclipai/shared/telemetry", () => ({
|
|
trackAgentTaskCompleted: vi.fn(),
|
|
trackErrorHandlerCrash: vi.fn(),
|
|
}));
|
|
|
|
vi.doMock("../telemetry.js", () => ({
|
|
getTelemetryClient: vi.fn(() => ({ track: vi.fn() })),
|
|
}));
|
|
|
|
vi.doMock("../services/access.js", () => ({
|
|
accessService: () => mockAccessService,
|
|
}));
|
|
|
|
vi.doMock("../services/agents.js", () => ({
|
|
agentService: () => mockAgentService,
|
|
}));
|
|
|
|
vi.doMock("../services/documents.js", () => ({
|
|
documentAnnotationService: () => ({ remapOpenThreadsForDocument: async () => [] }),
|
|
documentService: () => mockDocumentService,
|
|
}));
|
|
|
|
vi.doMock("../services/issues.js", () => ({
|
|
issueService: () => mockIssueService,
|
|
}));
|
|
|
|
vi.doMock("../services/work-products.js", () => ({
|
|
workProductService: () => mockWorkProductService,
|
|
}));
|
|
|
|
vi.doMock("../services/activity-log.js", () => ({
|
|
logActivity: vi.fn(async () => undefined),
|
|
}));
|
|
|
|
vi.doMock("../services/index.js", () => ({
|
|
accessService: () => mockAccessService,
|
|
agentService: () => mockAgentService,
|
|
companyService: () => mockCompanyService,
|
|
documentAnnotationService: () => ({ remapOpenThreadsForDocument: async () => [] }),
|
|
documentService: () => mockDocumentService,
|
|
executionWorkspaceService: () => ({}),
|
|
feedbackService: () => ({
|
|
listIssueVotesForUser: vi.fn(async () => []),
|
|
saveIssueVote: vi.fn(async () => ({ vote: null, consentEnabledNow: false, sharingEnabled: false })),
|
|
}),
|
|
goalService: () => ({}),
|
|
heartbeatService: () => mockHeartbeatService,
|
|
instanceSettingsService: () => ({
|
|
get: vi.fn(async () => ({
|
|
id: "instance-settings-1",
|
|
general: {
|
|
censorUsernameInLogs: false,
|
|
feedbackDataSharingPreference: "prompt",
|
|
},
|
|
})),
|
|
listCompanyIds: vi.fn(async () => [companyId]),
|
|
}),
|
|
issueApprovalService: () => ({}),
|
|
issueRecoveryActionService: () => mockIssueRecoveryActionService,
|
|
issueReferenceService: () => ({
|
|
deleteDocumentSource: async () => undefined,
|
|
diffIssueReferenceSummary: () => ({
|
|
addedReferencedIssues: [],
|
|
removedReferencedIssues: [],
|
|
currentReferencedIssues: [],
|
|
}),
|
|
emptySummary: () => ({ outbound: [], inbound: [] }),
|
|
listIssueReferenceSummary: async () => ({ outbound: [], inbound: [] }),
|
|
syncComment: async () => undefined,
|
|
syncDocument: async () => undefined,
|
|
syncIssue: async () => undefined,
|
|
}),
|
|
issueService: () => mockIssueService,
|
|
issueThreadInteractionService: () => mockIssueThreadInteractionService,
|
|
logActivity: vi.fn(async () => undefined),
|
|
projectService: () => ({}),
|
|
routineService: () => ({
|
|
syncRunStatusForIssue: vi.fn(async () => undefined),
|
|
}),
|
|
workProductService: () => mockWorkProductService,
|
|
}));
|
|
}
|
|
|
|
function makeIssue(overrides: Record<string, unknown> = {}) {
|
|
return {
|
|
id: issueId,
|
|
companyId,
|
|
status: "in_progress",
|
|
priority: "high",
|
|
projectId: null,
|
|
goalId: null,
|
|
parentId: null,
|
|
assigneeAgentId: ownerAgentId,
|
|
assigneeUserId: null,
|
|
createdByUserId: "board-user",
|
|
identifier: "PAP-1649",
|
|
title: "Owned active issue",
|
|
executionPolicy: null,
|
|
executionState: null,
|
|
hiddenAt: null,
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
function makeAgent(id: string, overrides: Record<string, unknown> = {}) {
|
|
return {
|
|
id,
|
|
companyId,
|
|
role: "engineer",
|
|
reportsTo: null,
|
|
permissions: { canCreateAgents: false },
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
function createRunContextDb(contextSnapshot: Record<string, unknown> = {}) {
|
|
return {
|
|
transaction: async (callback: (tx: Record<string, never>) => Promise<unknown>) => callback({}),
|
|
select: vi.fn(() => ({
|
|
from: vi.fn(() => ({
|
|
where: vi.fn(() => ({
|
|
then: async (resolve: (rows: unknown[]) => unknown) =>
|
|
resolve([{
|
|
id: ownerRunId,
|
|
companyId,
|
|
agentId: ownerAgentId,
|
|
contextSnapshot,
|
|
}]),
|
|
})),
|
|
})),
|
|
})),
|
|
};
|
|
}
|
|
|
|
async function createApp(actor: Record<string, unknown>, db: unknown = createRunContextDb()) {
|
|
const [{ errorHandler }, { issueRoutes }] = await Promise.all([
|
|
vi.importActual<typeof import("../middleware/index.js")>("../middleware/index.js"),
|
|
vi.importActual<typeof import("../routes/issues.js")>("../routes/issues.js"),
|
|
]);
|
|
const app = express();
|
|
app.use(express.json());
|
|
app.use((req, _res, next) => {
|
|
(req as any).actor = actor;
|
|
next();
|
|
});
|
|
app.use("/api", issueRoutes(db as any, mockStorageService as any));
|
|
app.use(errorHandler);
|
|
return app;
|
|
}
|
|
|
|
function peerActor(overrides: Record<string, unknown> = {}) {
|
|
return {
|
|
type: "agent",
|
|
agentId: peerAgentId,
|
|
companyId,
|
|
source: "agent_key",
|
|
runId: "66666666-6666-4666-8666-666666666666",
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
function ownerActor() {
|
|
return {
|
|
type: "agent",
|
|
agentId: ownerAgentId,
|
|
companyId,
|
|
source: "agent_key",
|
|
runId: ownerRunId,
|
|
};
|
|
}
|
|
|
|
function boardActor() {
|
|
return {
|
|
type: "board",
|
|
userId: "board-user",
|
|
companyIds: [companyId],
|
|
source: "local_implicit",
|
|
isInstanceAdmin: false,
|
|
};
|
|
}
|
|
|
|
describe("agent issue mutation checkout ownership", () => {
|
|
beforeEach(() => {
|
|
vi.resetModules();
|
|
vi.doUnmock("@paperclipai/shared/telemetry");
|
|
vi.doUnmock("../telemetry.js");
|
|
vi.doUnmock("../services/access.js");
|
|
vi.doUnmock("../services/activity-log.js");
|
|
vi.doUnmock("../services/agents.js");
|
|
vi.doUnmock("../services/documents.js");
|
|
vi.doUnmock("../services/index.js");
|
|
vi.doUnmock("../services/issues.js");
|
|
vi.doUnmock("../services/work-products.js");
|
|
vi.doUnmock("../routes/issues.js");
|
|
vi.doUnmock("../routes/authz.js");
|
|
vi.doUnmock("../middleware/index.js");
|
|
registerRouteMocks();
|
|
vi.clearAllMocks();
|
|
mockAccessService.canUser.mockReset();
|
|
mockAccessService.decide.mockReset();
|
|
mockAccessService.decide.mockImplementation(async (input: { action: string }) => ({
|
|
allowed: input.action === "tasks:assign",
|
|
action: input.action,
|
|
reason: input.action === "tasks:assign" ? "allow_explicit_grant" : "deny_missing_grant",
|
|
explanation: input.action === "tasks:assign" ? "Allowed by test assignment default." : "Missing permission.",
|
|
}));
|
|
mockAccessService.hasPermission.mockReset();
|
|
mockAgentService.getById.mockReset();
|
|
mockAgentService.list.mockReset();
|
|
mockAgentService.resolveByReference.mockReset();
|
|
mockCompanyService.getById.mockReset();
|
|
mockIssueService.addComment.mockReset();
|
|
mockIssueService.assertCheckoutOwner.mockReset();
|
|
mockIssueService.create.mockReset();
|
|
mockIssueService.createChild.mockReset();
|
|
mockIssueService.getAttachmentById.mockReset();
|
|
mockIssueService.getByIdentifier.mockReset();
|
|
mockIssueService.getById.mockReset();
|
|
mockIssueService.getRelationSummaries.mockReset();
|
|
mockIssueService.getWakeableParentAfterChildCompletion.mockReset();
|
|
mockIssueService.listAttachments.mockReset();
|
|
mockIssueService.listWakeableBlockedDependents.mockReset();
|
|
mockIssueRecoveryActionService.getActiveForIssue.mockReset();
|
|
mockIssueRecoveryActionService.getActiveForIssue.mockResolvedValue(null);
|
|
mockIssueRecoveryActionService.resolveActiveForIssue.mockReset();
|
|
mockIssueRecoveryActionService.resolveActiveForIssue.mockResolvedValue({
|
|
id: recoveryActionId,
|
|
companyId,
|
|
sourceIssueId: issueId,
|
|
recoveryIssueId: null,
|
|
kind: "issue_graph_liveness",
|
|
status: "resolved",
|
|
ownerType: "agent",
|
|
ownerAgentId,
|
|
ownerUserId: null,
|
|
previousOwnerAgentId: null,
|
|
returnOwnerAgentId: null,
|
|
cause: "issue_graph_liveness",
|
|
fingerprint: "graph-liveness:test",
|
|
evidence: {},
|
|
nextAction: "Restore a live execution path.",
|
|
wakePolicy: null,
|
|
monitorPolicy: null,
|
|
attemptCount: 1,
|
|
maxAttempts: null,
|
|
timeoutAt: null,
|
|
lastAttemptAt: new Date("2026-05-13T18:00:00.000Z"),
|
|
outcome: "restored",
|
|
resolutionNote: "Resolved by recovery owner",
|
|
resolvedAt: new Date("2026-05-13T18:05:00.000Z"),
|
|
createdAt: new Date("2026-05-13T17:55:00.000Z"),
|
|
updatedAt: new Date("2026-05-13T18:05:00.000Z"),
|
|
});
|
|
mockHeartbeatService.wakeup.mockReset();
|
|
mockHeartbeatService.wakeup.mockResolvedValue(undefined);
|
|
mockHeartbeatService.reportRunActivity.mockReset();
|
|
mockHeartbeatService.reportRunActivity.mockResolvedValue(undefined);
|
|
mockHeartbeatService.getRun.mockReset();
|
|
mockHeartbeatService.getRun.mockResolvedValue(null);
|
|
mockHeartbeatService.getActiveRunForAgent.mockReset();
|
|
mockHeartbeatService.getActiveRunForAgent.mockResolvedValue(null);
|
|
mockHeartbeatService.cancelRun.mockReset();
|
|
mockHeartbeatService.cancelRun.mockResolvedValue(null);
|
|
mockIssueService.remove.mockReset();
|
|
mockIssueService.removeAttachment.mockReset();
|
|
mockIssueService.update.mockReset();
|
|
mockIssueService.findMentionedAgents.mockReset();
|
|
mockDocumentService.upsertIssueDocument.mockReset();
|
|
mockWorkProductService.createForIssue.mockReset();
|
|
mockWorkProductService.getById.mockReset();
|
|
mockWorkProductService.remove.mockReset();
|
|
mockWorkProductService.update.mockReset();
|
|
mockStorageService.putFile.mockReset();
|
|
mockStorageService.getObject.mockReset();
|
|
mockStorageService.headObject.mockReset();
|
|
mockStorageService.deleteObject.mockReset();
|
|
mockAccessService.canUser.mockResolvedValue(true);
|
|
mockAccessService.hasPermission.mockResolvedValue(false);
|
|
mockAgentService.getById.mockImplementation(async (id: string) => {
|
|
if (id === ownerAgentId) return makeAgent(ownerAgentId);
|
|
if (id === peerAgentId) return makeAgent(peerAgentId);
|
|
return null;
|
|
});
|
|
mockAgentService.list.mockResolvedValue([
|
|
makeAgent(ownerAgentId),
|
|
makeAgent(peerAgentId),
|
|
]);
|
|
mockAgentService.resolveByReference.mockResolvedValue({ ambiguous: false, agent: null });
|
|
mockCompanyService.getById.mockResolvedValue({ id: companyId, issuePrefix: "PAP" });
|
|
mockIssueService.getById.mockResolvedValue(makeIssue());
|
|
mockIssueService.getByIdentifier.mockResolvedValue(null);
|
|
mockIssueService.assertCheckoutOwner.mockResolvedValue({ adoptedFromRunId: null });
|
|
mockIssueService.create.mockImplementation(async (_companyId: string, input: Record<string, unknown>) => ({
|
|
...makeIssue({
|
|
id: "88888888-8888-4888-8888-888888888888",
|
|
status: "todo",
|
|
assigneeAgentId: null,
|
|
}),
|
|
...input,
|
|
companyId,
|
|
}));
|
|
mockIssueService.createChild.mockImplementation(async (_parentId: string, input: Record<string, unknown>) => ({
|
|
issue: {
|
|
...makeIssue({
|
|
id: "99999999-9999-4999-8999-999999999999",
|
|
status: "todo",
|
|
parentId: issueId,
|
|
assigneeAgentId: null,
|
|
}),
|
|
...input,
|
|
companyId,
|
|
},
|
|
parentBlockerAdded: false,
|
|
}));
|
|
mockIssueService.getRelationSummaries.mockResolvedValue({ blockedBy: [], blocks: [] });
|
|
mockIssueService.listWakeableBlockedDependents.mockResolvedValue([]);
|
|
mockIssueService.getWakeableParentAfterChildCompletion.mockResolvedValue(null);
|
|
mockIssueService.findMentionedAgents.mockResolvedValue([]);
|
|
mockIssueService.update.mockImplementation(async (_id: string, patch: Record<string, unknown>) => ({
|
|
...makeIssue(),
|
|
...patch,
|
|
}));
|
|
mockIssueService.addComment.mockResolvedValue({
|
|
id: "77777777-7777-4777-8777-777777777777",
|
|
issueId,
|
|
companyId,
|
|
body: "comment",
|
|
});
|
|
mockIssueService.listAttachments.mockResolvedValue([]);
|
|
mockIssueService.remove.mockResolvedValue(makeIssue({ status: "cancelled" }));
|
|
mockIssueService.getAttachmentById.mockResolvedValue({
|
|
id: "attachment-1",
|
|
issueId,
|
|
companyId,
|
|
objectKey: "issues/attachment-1/report.txt",
|
|
contentType: "text/plain",
|
|
byteSize: 6,
|
|
originalFilename: "report.txt",
|
|
});
|
|
mockIssueService.removeAttachment.mockResolvedValue({
|
|
id: "attachment-1",
|
|
issueId,
|
|
companyId,
|
|
objectKey: "issues/attachment-1/report.txt",
|
|
});
|
|
mockDocumentService.upsertIssueDocument.mockResolvedValue({
|
|
created: false,
|
|
document: {
|
|
id: "document-1",
|
|
key: "plan",
|
|
title: "Plan",
|
|
format: "markdown",
|
|
latestRevisionNumber: 2,
|
|
},
|
|
});
|
|
mockWorkProductService.createForIssue.mockResolvedValue({
|
|
id: "product-2",
|
|
issueId,
|
|
companyId,
|
|
type: "artifact",
|
|
provider: "test",
|
|
title: "Artifact",
|
|
});
|
|
mockWorkProductService.getById.mockResolvedValue({
|
|
id: "product-1",
|
|
issueId,
|
|
companyId,
|
|
type: "artifact",
|
|
});
|
|
mockWorkProductService.update.mockResolvedValue({
|
|
id: "product-1",
|
|
issueId,
|
|
companyId,
|
|
type: "artifact",
|
|
title: "Updated",
|
|
});
|
|
mockWorkProductService.remove.mockResolvedValue({
|
|
id: "product-1",
|
|
issueId,
|
|
companyId,
|
|
type: "artifact",
|
|
});
|
|
mockStorageService.putFile.mockResolvedValue({
|
|
provider: "local_disk",
|
|
objectKey: "issues/upload.txt",
|
|
contentType: "text/plain",
|
|
byteSize: 6,
|
|
sha256: "sha256",
|
|
originalFilename: "upload.txt",
|
|
});
|
|
mockStorageService.getObject.mockResolvedValue({
|
|
stream: Readable.from(Buffer.from("report")),
|
|
contentLength: 6,
|
|
});
|
|
mockStorageService.deleteObject.mockResolvedValue(undefined);
|
|
});
|
|
|
|
it.each([
|
|
["patch", (app: express.Express) => request(app).patch(`/api/issues/${issueId}`).send({ title: "Blocked" })],
|
|
["delete", (app: express.Express) => request(app).delete(`/api/issues/${issueId}`)],
|
|
["comment", (app: express.Express) => request(app).post(`/api/issues/${issueId}/comments`).send({ body: "blocked" })],
|
|
[
|
|
"document upsert",
|
|
(app: express.Express) =>
|
|
request(app).put(`/api/issues/${issueId}/documents/plan`).send({ format: "markdown", body: "# blocked" }),
|
|
],
|
|
["work product update", (app: express.Express) => request(app).patch("/api/work-products/product-1").send({ title: "Blocked" })],
|
|
[
|
|
"attachment upload",
|
|
(app: express.Express) =>
|
|
request(app)
|
|
.post(`/api/companies/${companyId}/issues/${issueId}/attachments`)
|
|
.attach("file", Buffer.from("report"), { filename: "report.txt", contentType: "text/plain" }),
|
|
],
|
|
["attachment delete", (app: express.Express) => request(app).delete("/api/attachments/attachment-1")],
|
|
])("rejects peer agent %s on another agent's active checkout", async (_name, sendRequest) => {
|
|
const res = await sendRequest(await createApp(peerActor()));
|
|
|
|
expect(res.status, JSON.stringify(res.body)).toBe(409);
|
|
expect(res.body.error).toBe("Issue is checked out by another agent");
|
|
expect(mockIssueService.assertCheckoutOwner).not.toHaveBeenCalled();
|
|
expect(mockIssueService.update).not.toHaveBeenCalled();
|
|
expect(mockIssueService.addComment).not.toHaveBeenCalled();
|
|
expect(mockDocumentService.upsertIssueDocument).not.toHaveBeenCalled();
|
|
expect(mockWorkProductService.update).not.toHaveBeenCalled();
|
|
expect(mockStorageService.putFile).not.toHaveBeenCalled();
|
|
expect(mockStorageService.deleteObject).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("allows the checked-out owner with the matching run id to patch and update documents", async () => {
|
|
const app = await createApp(ownerActor());
|
|
|
|
await request(app).patch(`/api/issues/${issueId}`).send({ title: "Updated" }).expect(200);
|
|
await request(app)
|
|
.put(`/api/issues/${issueId}/documents/plan`)
|
|
.send({ format: "markdown", body: "# updated" })
|
|
.expect(200);
|
|
|
|
expect(mockIssueService.assertCheckoutOwner).toHaveBeenCalledWith(issueId, ownerAgentId, ownerRunId);
|
|
expect(mockIssueService.update).toHaveBeenCalled();
|
|
expect(mockDocumentService.upsertIssueDocument).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
issueId,
|
|
key: "plan",
|
|
createdByAgentId: ownerAgentId,
|
|
createdByRunId: ownerRunId,
|
|
lockedDocumentStrategy: "create_new_document",
|
|
}),
|
|
);
|
|
});
|
|
|
|
it.each([
|
|
[
|
|
"work product create",
|
|
(app: express.Express) =>
|
|
request(app).post(`/api/issues/${issueId}/work-products`).send({
|
|
type: "artifact",
|
|
provider: "test",
|
|
title: "Artifact",
|
|
}),
|
|
],
|
|
["work product update", (app: express.Express) => request(app).patch("/api/work-products/product-1").send({ title: "Blocked" })],
|
|
["work product delete", (app: express.Express) => request(app).delete("/api/work-products/product-1")],
|
|
[
|
|
"attachment upload",
|
|
(app: express.Express) =>
|
|
request(app)
|
|
.post(`/api/companies/${companyId}/issues/${issueId}/attachments`)
|
|
.attach("file", Buffer.from("report"), { filename: "report.txt", contentType: "text/plain" }),
|
|
],
|
|
["attachment delete", (app: express.Express) => request(app).delete("/api/attachments/attachment-1")],
|
|
])("blocks cheap status-only recovery runs from %s", async (_name, sendRequest) => {
|
|
const app = await createApp(
|
|
ownerActor(),
|
|
createRunContextDb({
|
|
modelProfile: "cheap",
|
|
recoveryIntent: "status_only",
|
|
allowDeliverableWork: false,
|
|
allowDocumentUpdates: false,
|
|
resumeRequiresNormalModel: true,
|
|
}),
|
|
);
|
|
|
|
const res = await sendRequest(app);
|
|
|
|
expect(res.status, JSON.stringify(res.body)).toBe(403);
|
|
expect(res.body.error).toContain("Cheap status-only recovery runs cannot update issue documents");
|
|
expect(mockIssueService.assertCheckoutOwner).toHaveBeenCalledWith(issueId, ownerAgentId, ownerRunId);
|
|
expect(mockWorkProductService.createForIssue).not.toHaveBeenCalled();
|
|
expect(mockWorkProductService.update).not.toHaveBeenCalled();
|
|
expect(mockWorkProductService.remove).not.toHaveBeenCalled();
|
|
expect(mockStorageService.putFile).not.toHaveBeenCalled();
|
|
expect(mockStorageService.deleteObject).not.toHaveBeenCalled();
|
|
expect(mockIssueService.removeAttachment).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it.each([
|
|
[
|
|
"issue create",
|
|
(app: express.Express) =>
|
|
request(app).post(`/api/companies/${companyId}/issues`).send({
|
|
title: "Downstream source work",
|
|
assigneeAdapterOverrides: { modelProfile: "cheap" },
|
|
}),
|
|
],
|
|
[
|
|
"child issue create",
|
|
(app: express.Express) =>
|
|
request(app).post(`/api/issues/${issueId}/children`).send({
|
|
title: "Downstream child source work",
|
|
assigneeAdapterOverrides: { modelProfile: "cheap" },
|
|
}),
|
|
],
|
|
[
|
|
"issue update",
|
|
(app: express.Express) =>
|
|
request(app).patch(`/api/issues/${issueId}`).send({
|
|
assigneeAdapterOverrides: { modelProfile: "cheap" },
|
|
}),
|
|
],
|
|
])("blocks cheap status-only recovery runs from propagating cheap profile through %s", async (_name, sendRequest) => {
|
|
const app = await createApp(
|
|
ownerActor(),
|
|
createRunContextDb({
|
|
modelProfile: "cheap",
|
|
recoveryIntent: "status_only",
|
|
allowDeliverableWork: false,
|
|
allowDocumentUpdates: false,
|
|
resumeRequiresNormalModel: true,
|
|
}),
|
|
);
|
|
|
|
const res = await sendRequest(app);
|
|
|
|
expect(res.status, JSON.stringify(res.body)).toBe(403);
|
|
expect(res.body.error).toContain("cannot assign downstream issue work to the cheap model profile");
|
|
expect(mockIssueService.create).not.toHaveBeenCalled();
|
|
expect(mockIssueService.createChild).not.toHaveBeenCalled();
|
|
expect(mockIssueService.update).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("allows board users to set explicit cheap issue assignee profile overrides", async () => {
|
|
const app = await createApp(boardActor());
|
|
|
|
await request(app)
|
|
.patch(`/api/issues/${issueId}`)
|
|
.send({ assigneeAdapterOverrides: { modelProfile: "cheap" } })
|
|
.expect(200);
|
|
|
|
expect(mockIssueService.update).toHaveBeenCalledWith(
|
|
issueId,
|
|
expect.objectContaining({
|
|
assigneeAdapterOverrides: { modelProfile: "cheap" },
|
|
}),
|
|
);
|
|
});
|
|
|
|
it("preserves committed issue updates, comments, documents, and work product writes when recovery revalidation fails", async () => {
|
|
const app = await createApp(ownerActor());
|
|
|
|
mockIssueRecoveryActionService.getActiveForIssue.mockRejectedValueOnce(new Error("revalidation read failed"));
|
|
await request(app)
|
|
.patch(`/api/issues/${issueId}`)
|
|
.send({ title: "Updated after commit" })
|
|
.expect(200);
|
|
|
|
mockIssueRecoveryActionService.getActiveForIssue.mockRejectedValueOnce(new Error("revalidation read failed"));
|
|
await request(app)
|
|
.post(`/api/issues/${issueId}/comments`)
|
|
.send({ body: "progress update" })
|
|
.expect(201);
|
|
|
|
mockIssueRecoveryActionService.getActiveForIssue.mockRejectedValueOnce(new Error("revalidation read failed"));
|
|
await request(app)
|
|
.put(`/api/issues/${issueId}/documents/plan`)
|
|
.send({ format: "markdown", body: "# updated" })
|
|
.expect(200);
|
|
|
|
mockIssueRecoveryActionService.getActiveForIssue.mockRejectedValueOnce(new Error("revalidation read failed"));
|
|
await request(app)
|
|
.patch("/api/work-products/product-1")
|
|
.send({ title: "Updated product" })
|
|
.expect(200);
|
|
|
|
expect(mockIssueService.update).toHaveBeenCalledWith(
|
|
issueId,
|
|
expect.objectContaining({ title: "Updated after commit" }),
|
|
);
|
|
expect(mockIssueService.addComment).toHaveBeenCalledWith(
|
|
issueId,
|
|
"progress update",
|
|
expect.any(Object),
|
|
expect.any(Object),
|
|
);
|
|
expect(mockDocumentService.upsertIssueDocument).toHaveBeenCalled();
|
|
expect(mockWorkProductService.update).toHaveBeenCalledWith("product-1", { title: "Updated product" });
|
|
});
|
|
|
|
it("preserves board mutations on active checkouts", async () => {
|
|
const app = await createApp(boardActor());
|
|
|
|
await request(app).patch(`/api/issues/${issueId}`).send({ title: "Board update" }).expect(200);
|
|
await request(app)
|
|
.put(`/api/issues/${issueId}/documents/plan`)
|
|
.send({ format: "markdown", body: "# board" })
|
|
.expect(200);
|
|
|
|
expect(mockIssueService.assertCheckoutOwner).not.toHaveBeenCalled();
|
|
expect(mockIssueService.update).toHaveBeenCalled();
|
|
expect(mockDocumentService.upsertIssueDocument).toHaveBeenCalled();
|
|
});
|
|
|
|
it("allows agents with the active-checkout management grant to mutate active checkouts", async () => {
|
|
mockAccessService.decide.mockImplementation(async (input: { action: string }) => ({
|
|
allowed: input.action === "tasks:manage_active_checkouts",
|
|
action: input.action,
|
|
reason: input.action === "tasks:manage_active_checkouts" ? "allow_explicit_grant" : "deny_missing_grant",
|
|
explanation: input.action === "tasks:manage_active_checkouts" ? "Allowed by checkout management grant." : "Missing permission.",
|
|
}));
|
|
|
|
const res = await request(await createApp(peerActor())).patch(`/api/issues/${issueId}`).send({ title: "Managed update" });
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(mockIssueService.assertCheckoutOwner).not.toHaveBeenCalled();
|
|
expect(mockIssueService.update).toHaveBeenCalled();
|
|
});
|
|
|
|
it.each([
|
|
["todo", "patch", (app: express.Express) => request(app).patch(`/api/issues/${issueId}`).send({ title: "Todo update" })],
|
|
["todo", "comment", (app: express.Express) => request(app).post(`/api/issues/${issueId}/comments`).send({ body: "Todo noise" })],
|
|
["blocked", "patch", (app: express.Express) => request(app).patch(`/api/issues/${issueId}`).send({ title: "Blocked update" })],
|
|
])("rejects peer agent %s issue %s mutations outside active checkout ownership", async (status, _kind, sendRequest) => {
|
|
mockIssueService.getById.mockResolvedValue(makeIssue({ status: status as "todo" | "blocked", assigneeAgentId: ownerAgentId }));
|
|
|
|
const res = await sendRequest(await createApp(peerActor()));
|
|
|
|
expect(res.status, JSON.stringify(res.body)).toBe(403);
|
|
expect(res.body.error).toBe("Agent cannot mutate another agent's issue");
|
|
expect(mockIssueService.assertCheckoutOwner).not.toHaveBeenCalled();
|
|
expect(mockIssueService.update).not.toHaveBeenCalled();
|
|
expect(mockIssueService.addComment).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("allows same-company agent mutations on unassigned in-progress issues", async () => {
|
|
mockIssueService.getById.mockResolvedValue(makeIssue({ assigneeAgentId: null }));
|
|
mockIssueService.update.mockImplementation(async (_id: string, patch: Record<string, unknown>) => ({
|
|
...makeIssue({ assigneeAgentId: null }),
|
|
...patch,
|
|
}));
|
|
|
|
const res = await request(await createApp(peerActor())).patch(`/api/issues/${issueId}`).send({ title: "Claimable update" });
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(mockIssueService.assertCheckoutOwner).not.toHaveBeenCalled();
|
|
expect(res.body).toMatchObject({
|
|
id: issueId,
|
|
assigneeAgentId: null,
|
|
title: "Claimable update",
|
|
});
|
|
});
|
|
|
|
it("rejects peer-agent status updates that would clear a recovery action they do not own", async () => {
|
|
mockIssueService.getById.mockResolvedValue(
|
|
makeIssue({ status: "blocked", assigneeAgentId: null, assigneeUserId: "board-user" }),
|
|
);
|
|
mockIssueRecoveryActionService.getActiveForIssue.mockResolvedValue({
|
|
id: recoveryActionId,
|
|
ownerAgentId,
|
|
});
|
|
|
|
const res = await request(await createApp(peerActor())).patch(`/api/issues/${issueId}`).send({ status: "todo" });
|
|
|
|
expect(res.status, JSON.stringify(res.body)).toBe(403);
|
|
expect(res.body.error).toBe("Agent cannot resolve another owner's recovery action");
|
|
expect(mockIssueService.update).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("rejects peer-agent recovery resolution on a board-owned source issue", async () => {
|
|
mockIssueService.getById.mockResolvedValue(
|
|
makeIssue({ status: "blocked", assigneeAgentId: null, assigneeUserId: "board-user" }),
|
|
);
|
|
mockIssueRecoveryActionService.getActiveForIssue.mockResolvedValue({
|
|
id: recoveryActionId,
|
|
ownerAgentId,
|
|
});
|
|
|
|
const res = await request(await createApp(peerActor()))
|
|
.post(`/api/issues/${issueId}/recovery-actions/resolve`)
|
|
.send({
|
|
actionId: recoveryActionId,
|
|
outcome: "restored",
|
|
sourceIssueStatus: "done",
|
|
});
|
|
|
|
expect(res.status, JSON.stringify(res.body)).toBe(403);
|
|
expect(res.body.error).toBe("Agent cannot resolve another owner's recovery action");
|
|
expect(mockIssueRecoveryActionService.resolveActiveForIssue).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("allows the named recovery owner to resolve a board-owned source issue", async () => {
|
|
mockIssueService.getById.mockResolvedValue(
|
|
makeIssue({ status: "blocked", assigneeAgentId: null, assigneeUserId: "board-user" }),
|
|
);
|
|
mockIssueService.update.mockImplementation(async (_id: string, patch: Record<string, unknown>) => ({
|
|
...makeIssue({ status: "blocked", assigneeAgentId: null, assigneeUserId: "board-user" }),
|
|
...patch,
|
|
}));
|
|
mockIssueRecoveryActionService.getActiveForIssue.mockResolvedValue({
|
|
id: recoveryActionId,
|
|
ownerAgentId,
|
|
});
|
|
|
|
const res = await request(await createApp(ownerActor()))
|
|
.post(`/api/issues/${issueId}/recovery-actions/resolve`)
|
|
.send({
|
|
actionId: recoveryActionId,
|
|
outcome: "restored",
|
|
sourceIssueStatus: "done",
|
|
});
|
|
|
|
expect(res.status, JSON.stringify(res.body)).toBe(200);
|
|
expect(mockIssueService.update).toHaveBeenCalled();
|
|
expect(mockIssueRecoveryActionService.resolveActiveForIssue).toHaveBeenCalled();
|
|
});
|
|
|
|
it("wakes the assigned agent when recovery resolution restores a source issue to todo", async () => {
|
|
mockIssueService.getById.mockResolvedValue(
|
|
makeIssue({ status: "blocked", assigneeAgentId: ownerAgentId }),
|
|
);
|
|
mockIssueService.update.mockImplementation(async (_id: string, patch: Record<string, unknown>) => ({
|
|
...makeIssue({ status: "blocked", assigneeAgentId: ownerAgentId }),
|
|
...patch,
|
|
}));
|
|
mockIssueRecoveryActionService.getActiveForIssue.mockResolvedValue({
|
|
id: recoveryActionId,
|
|
ownerAgentId,
|
|
});
|
|
|
|
const res = await request(await createApp(ownerActor()))
|
|
.post(`/api/issues/${issueId}/recovery-actions/resolve`)
|
|
.send({
|
|
actionId: recoveryActionId,
|
|
outcome: "restored",
|
|
sourceIssueStatus: "todo",
|
|
});
|
|
|
|
expect(res.status, JSON.stringify(res.body)).toBe(200);
|
|
expect(mockHeartbeatService.wakeup).toHaveBeenCalledWith(
|
|
ownerAgentId,
|
|
expect.objectContaining({
|
|
reason: "issue_recovery_action_restored",
|
|
payload: expect.objectContaining({
|
|
issueId,
|
|
recoveryActionId,
|
|
mutation: "recovery_action_resolution",
|
|
}),
|
|
}),
|
|
);
|
|
});
|
|
|
|
it("uses the authorization decision path for assignment changes", async () => {
|
|
const decide = vi.fn(async () => ({
|
|
allowed: false,
|
|
action: "tasks:assign",
|
|
reason: "deny_policy_restricted",
|
|
explanation: "Target agent requires approval before task assignment.",
|
|
}));
|
|
(mockAccessService as any).decide = decide;
|
|
mockIssueService.getById.mockResolvedValue(makeIssue({ assigneeAgentId: ownerAgentId }));
|
|
mockAgentService.resolveByReference.mockResolvedValue({
|
|
ambiguous: false,
|
|
agent: makeAgent(peerAgentId),
|
|
});
|
|
|
|
const app = await createApp(ownerActor());
|
|
const res = await request(app)
|
|
.patch(`/api/issues/${issueId}`)
|
|
.send({ assigneeAgentId: peerAgentId });
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.error).toContain("requires approval");
|
|
expect(decide).toHaveBeenCalledWith(expect.objectContaining({
|
|
action: "tasks:assign",
|
|
resource: expect.objectContaining({
|
|
type: "issue",
|
|
companyId,
|
|
issueId,
|
|
assigneeAgentId: peerAgentId,
|
|
}),
|
|
}));
|
|
expect(mockIssueService.update).not.toHaveBeenCalled();
|
|
});
|
|
});
|