forked from farhoodlabs/paperclip
0808b388ee
## Thinking Path > - Paperclip is a control plane for autonomous AI companies, where work must end with a clear disposition rather than ambiguous agent liveness. > - Recovery currently detects stalled or missing-next-step issues, but source issue recovery can become split across child recovery issues, blockers, and comments. > - That makes it harder for operators and agents to see who owns recovery and what exact action is needed on the original issue. > - Source-scoped recovery actions give the original issue a first-class active recovery state with owner, evidence, wake policy, and resolution outcome. > - This pull request adds the recovery-action data model, backend reconciliation and resolution APIs, and board UI indicators/actions. > - The benefit is clearer stalled-work recovery without losing source issue context or relying on comments as the liveness path. ## What Changed - Added the `issue_recovery_actions` schema, shared types/constants/validators, and an idempotent `0084_issue_recovery_actions` migration ordered after current `master` migrations. - Updated stranded/missing-disposition recovery to create source-scoped recovery actions, wake the recovery owner on the source issue, and avoid locking the source issue for recovery-action wakes. - Added API support for reading active recovery actions on issue detail/list surfaces and resolving them with restored, blocked, cancelled, or false-positive outcomes. - Require blocked recovery resolutions to have an unresolved first-class blocker, and removed the UI shortcut that could mark recovery blocked without a blocker selection path. - Surfaced recovery indicators/actions in the issue UI, blocker notices, active run panels, issue rows, and Storybook coverage. - Updated docs and focused tests for recovery semantics, ownership, races, stale comments, and UI behavior. ## Verification - `pnpm exec vitest run server/src/__tests__/issue-recovery-actions.test.ts server/src/__tests__/heartbeat-process-recovery.test.ts ui/src/components/IssueRecoveryActionCard.test.tsx ui/src/components/IssueBlockedNotice.test.tsx ui/src/api/issues.test.ts` — 5 files, 72 tests passed. - `pnpm --filter @paperclipai/shared typecheck` — passed. - `pnpm --filter @paperclipai/db typecheck` — passed, including migration numbering check. - `pnpm --filter @paperclipai/server typecheck` — passed. - `pnpm --filter @paperclipai/ui typecheck` — passed. - Follow-up verification after blocker-resolution guard: `pnpm exec vitest run server/src/__tests__/issue-recovery-actions.test.ts ui/src/components/IssueRecoveryActionCard.test.tsx ui/src/api/issues.test.ts` — 3 files, 27 tests passed. - Follow-up `pnpm --filter @paperclipai/server typecheck` — passed. - Follow-up `pnpm --filter @paperclipai/ui typecheck` — passed. - UI states are available in `ui/storybook/stories/source-issue-recovery.stories.tsx`; screenshot capture helper is `scripts/screenshot-recovery-card.cjs`. ## Risks - Medium: recovery behavior changes from child recovery issue ownership toward source-scoped actions, so operators may see stalled-work state in new places. - Migration risk is mitigated by using the next migration slot after `master` and making the table/constraints/index creation idempotent for anyone who previously applied the old branch-local `0082_dizzy_master_mold` migration. - Existing child recovery issue paths are still guarded for already-created recovery issues, but new source-scoped flows should be watched in CI and Greptile review. > 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 use enabled for shell, Git, GitHub, and local test execution. Context window not exposed by the 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>
379 lines
12 KiB
TypeScript
379 lines
12 KiB
TypeScript
import express from "express";
|
|
import request from "supertest";
|
|
import { beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { errorHandler } from "../middleware/index.js";
|
|
import { issueRoutes } from "../routes/issues.js";
|
|
|
|
const mockIssueService = vi.hoisted(() => ({
|
|
getById: vi.fn(),
|
|
getAncestors: vi.fn(),
|
|
getRelationSummaries: vi.fn(),
|
|
findMentionedProjectIds: vi.fn(),
|
|
getCommentCursor: vi.fn(),
|
|
getComment: vi.fn(),
|
|
listBlockerAttention: vi.fn(),
|
|
listProductivityReviews: vi.fn(),
|
|
getCurrentScheduledRetry: vi.fn(),
|
|
listAttachments: vi.fn(),
|
|
}));
|
|
|
|
const mockProjectService = vi.hoisted(() => ({
|
|
getById: vi.fn(),
|
|
listByIds: vi.fn(),
|
|
}));
|
|
|
|
const mockGoalService = vi.hoisted(() => ({
|
|
getById: vi.fn(),
|
|
getDefaultCompanyGoal: vi.fn(),
|
|
}));
|
|
|
|
const mockDocumentsService = vi.hoisted(() => ({
|
|
getIssueDocumentPayload: vi.fn(),
|
|
getIssueDocumentByKey: vi.fn(),
|
|
}));
|
|
|
|
const mockExecutionWorkspaceService = vi.hoisted(() => ({
|
|
getById: vi.fn(),
|
|
}));
|
|
|
|
const mockAccessService = vi.hoisted(() => ({
|
|
canUser: vi.fn(),
|
|
hasPermission: vi.fn(),
|
|
}));
|
|
|
|
const mockAgentService = vi.hoisted(() => ({
|
|
getById: vi.fn(),
|
|
}));
|
|
|
|
const mockFeedbackService = vi.hoisted(() => ({
|
|
listIssueVotesForUser: vi.fn(async () => []),
|
|
saveIssueVote: vi.fn(async () => ({ vote: null, consentEnabledNow: false, sharingEnabled: false })),
|
|
}));
|
|
|
|
const mockHeartbeatService = vi.hoisted(() => ({
|
|
wakeup: vi.fn(async () => undefined),
|
|
reportRunActivity: vi.fn(async () => undefined),
|
|
}));
|
|
|
|
const mockInstanceSettingsService = vi.hoisted(() => ({
|
|
get: vi.fn(async () => ({
|
|
id: "instance-settings-1",
|
|
general: {
|
|
censorUsernameInLogs: false,
|
|
feedbackDataSharingPreference: "prompt",
|
|
},
|
|
})),
|
|
listCompanyIds: vi.fn(async () => ["company-1"]),
|
|
}));
|
|
|
|
const mockIssueReferenceService = vi.hoisted(() => ({
|
|
deleteDocumentSource: vi.fn(async () => undefined),
|
|
diffIssueReferenceSummary: vi.fn(() => ({
|
|
addedReferencedIssues: [],
|
|
removedReferencedIssues: [],
|
|
currentReferencedIssues: [],
|
|
})),
|
|
emptySummary: vi.fn(() => ({ outbound: [], inbound: [] })),
|
|
listIssueReferenceSummary: vi.fn(async () => ({ outbound: [], inbound: [] })),
|
|
syncComment: vi.fn(async () => undefined),
|
|
syncDocument: vi.fn(async () => undefined),
|
|
syncIssue: vi.fn(async () => undefined),
|
|
}));
|
|
|
|
const mockLogActivity = vi.hoisted(() => vi.fn(async () => undefined));
|
|
|
|
const mockRoutineService = vi.hoisted(() => ({
|
|
syncRunStatusForIssue: vi.fn(async () => undefined),
|
|
}));
|
|
|
|
const mockWorkProductService = vi.hoisted(() => ({
|
|
listForIssue: vi.fn(async () => []),
|
|
}));
|
|
|
|
const mockEnvironmentService = vi.hoisted(() => ({}));
|
|
|
|
const mockDb = vi.hoisted(() => ({
|
|
select: vi.fn(),
|
|
execute: vi.fn(),
|
|
}));
|
|
|
|
vi.mock("../services/index.js", () => ({
|
|
companyService: () => ({
|
|
getById: vi.fn(async () => ({ id: "company-1", attachmentMaxBytes: 10 * 1024 * 1024 })),
|
|
}),
|
|
accessService: () => mockAccessService,
|
|
agentService: () => mockAgentService,
|
|
documentService: () => mockDocumentsService,
|
|
environmentService: () => mockEnvironmentService,
|
|
executionWorkspaceService: () => mockExecutionWorkspaceService,
|
|
feedbackService: () => mockFeedbackService,
|
|
goalService: () => mockGoalService,
|
|
heartbeatService: () => mockHeartbeatService,
|
|
instanceSettingsService: () => mockInstanceSettingsService,
|
|
issueApprovalService: () => ({}),
|
|
issueRecoveryActionService: () => ({
|
|
getActiveForIssue: vi.fn(async () => null),
|
|
listActiveForIssues: vi.fn(async () => new Map()),
|
|
}),
|
|
issueReferenceService: () => mockIssueReferenceService,
|
|
issueService: () => mockIssueService,
|
|
logActivity: mockLogActivity,
|
|
projectService: () => mockProjectService,
|
|
routineService: () => mockRoutineService,
|
|
workProductService: () => mockWorkProductService,
|
|
}));
|
|
|
|
vi.mock("../services/execution-workspaces.js", () => ({
|
|
executionWorkspaceService: () => mockExecutionWorkspaceService,
|
|
}));
|
|
|
|
function createApp() {
|
|
const app = express();
|
|
app.use(express.json());
|
|
app.use((req, _res, next) => {
|
|
(req as any).actor = {
|
|
type: "board",
|
|
userId: "local-board",
|
|
companyIds: ["company-1"],
|
|
source: "local_implicit",
|
|
isInstanceAdmin: false,
|
|
};
|
|
next();
|
|
});
|
|
app.use("/api", issueRoutes(mockDb as any, {} as any));
|
|
app.use(errorHandler);
|
|
return app;
|
|
}
|
|
|
|
const legacyProjectLinkedIssue = {
|
|
id: "11111111-1111-4111-8111-111111111111",
|
|
companyId: "company-1",
|
|
identifier: "PAP-581",
|
|
title: "Legacy onboarding task",
|
|
description: "Seed the first CEO task",
|
|
status: "todo",
|
|
workMode: "planning",
|
|
priority: "medium",
|
|
projectId: "22222222-2222-4222-8222-222222222222",
|
|
goalId: null,
|
|
parentId: null,
|
|
assigneeAgentId: "33333333-3333-4333-8333-333333333333",
|
|
assigneeUserId: null,
|
|
updatedAt: new Date("2026-03-24T12:00:00Z"),
|
|
executionWorkspaceId: null,
|
|
labels: [],
|
|
labelIds: [],
|
|
};
|
|
|
|
const projectGoal = {
|
|
id: "44444444-4444-4444-8444-444444444444",
|
|
companyId: "company-1",
|
|
title: "Launch the company",
|
|
description: null,
|
|
level: "company",
|
|
status: "active",
|
|
parentId: null,
|
|
ownerAgentId: null,
|
|
createdAt: new Date("2026-03-20T00:00:00Z"),
|
|
updatedAt: new Date("2026-03-20T00:00:00Z"),
|
|
};
|
|
|
|
describe.sequential("issue goal context routes", () => {
|
|
beforeEach(() => {
|
|
vi.clearAllMocks();
|
|
mockIssueService.getById.mockResolvedValue(legacyProjectLinkedIssue);
|
|
mockIssueService.getAncestors.mockResolvedValue([]);
|
|
mockIssueService.getRelationSummaries.mockResolvedValue({ blockedBy: [], blocks: [] });
|
|
mockIssueService.findMentionedProjectIds.mockResolvedValue([]);
|
|
mockIssueService.getCommentCursor.mockResolvedValue({
|
|
totalComments: 0,
|
|
latestCommentId: null,
|
|
latestCommentAt: null,
|
|
});
|
|
mockIssueService.getComment.mockResolvedValue(null);
|
|
mockIssueService.listBlockerAttention.mockResolvedValue(new Map());
|
|
mockIssueService.listProductivityReviews.mockResolvedValue(new Map());
|
|
mockIssueService.getCurrentScheduledRetry.mockResolvedValue(null);
|
|
mockIssueService.listAttachments.mockResolvedValue([]);
|
|
mockDocumentsService.getIssueDocumentPayload.mockResolvedValue({});
|
|
mockDocumentsService.getIssueDocumentByKey.mockResolvedValue(null);
|
|
mockExecutionWorkspaceService.getById.mockResolvedValue(null);
|
|
mockDb.select.mockReturnValue({
|
|
from: vi.fn(() => ({
|
|
where: vi.fn(() => ({
|
|
orderBy: vi.fn(async () => []),
|
|
})),
|
|
})),
|
|
});
|
|
mockDb.execute.mockResolvedValue([]);
|
|
mockProjectService.getById.mockResolvedValue({
|
|
id: legacyProjectLinkedIssue.projectId,
|
|
companyId: "company-1",
|
|
urlKey: "onboarding",
|
|
goalId: projectGoal.id,
|
|
goalIds: [projectGoal.id],
|
|
goals: [{ id: projectGoal.id, title: projectGoal.title }],
|
|
name: "Onboarding",
|
|
description: null,
|
|
status: "in_progress",
|
|
leadAgentId: null,
|
|
targetDate: null,
|
|
color: null,
|
|
pauseReason: null,
|
|
pausedAt: null,
|
|
executionWorkspacePolicy: null,
|
|
codebase: {
|
|
workspaceId: null,
|
|
repoUrl: null,
|
|
repoRef: null,
|
|
defaultRef: null,
|
|
repoName: null,
|
|
localFolder: null,
|
|
managedFolder: "/tmp/company-1/project-1",
|
|
effectiveLocalFolder: "/tmp/company-1/project-1",
|
|
origin: "managed_checkout",
|
|
},
|
|
workspaces: [],
|
|
primaryWorkspace: null,
|
|
archivedAt: null,
|
|
createdAt: new Date("2026-03-20T00:00:00Z"),
|
|
updatedAt: new Date("2026-03-20T00:00:00Z"),
|
|
});
|
|
mockProjectService.listByIds.mockResolvedValue([]);
|
|
mockGoalService.getById.mockImplementation(async (id: string) =>
|
|
id === projectGoal.id ? projectGoal : null,
|
|
);
|
|
mockGoalService.getDefaultCompanyGoal.mockResolvedValue(null);
|
|
});
|
|
|
|
it("surfaces the project goal from GET /issues/:id when the issue has no direct goal", async () => {
|
|
const res = await request(createApp()).get("/api/issues/11111111-1111-4111-8111-111111111111");
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body.goalId).toBe(projectGoal.id);
|
|
expect(res.body.goal).toEqual(
|
|
expect.objectContaining({
|
|
id: projectGoal.id,
|
|
title: projectGoal.title,
|
|
}),
|
|
);
|
|
expect(mockIssueService.findMentionedProjectIds).toHaveBeenCalledWith(
|
|
"11111111-1111-4111-8111-111111111111",
|
|
{ includeCommentBodies: false },
|
|
);
|
|
expect(mockGoalService.getDefaultCompanyGoal).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("surfaces the project goal from GET /issues/:id/heartbeat-context", async () => {
|
|
const res = await request(createApp()).get(
|
|
"/api/issues/11111111-1111-4111-8111-111111111111/heartbeat-context",
|
|
);
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body.issue.goalId).toBe(projectGoal.id);
|
|
expect(res.body.issue.workMode).toBe("planning");
|
|
expect(res.body.goal).toEqual(
|
|
expect.objectContaining({
|
|
id: projectGoal.id,
|
|
title: projectGoal.title,
|
|
}),
|
|
);
|
|
expect(mockGoalService.getDefaultCompanyGoal).not.toHaveBeenCalled();
|
|
expect(res.body.attachments).toEqual([]);
|
|
});
|
|
|
|
it("preserves direct continuation summary lookup in GET /issues/:id/heartbeat-context", async () => {
|
|
mockDocumentsService.getIssueDocumentByKey.mockResolvedValue({
|
|
key: "continuation-summary",
|
|
title: "Continuation Summary",
|
|
body: "# Handoff",
|
|
latestRevisionId: "revision-1",
|
|
latestRevisionNumber: 1,
|
|
updatedAt: new Date("2026-04-19T12:00:00.000Z"),
|
|
});
|
|
|
|
const res = await request(createApp()).get(
|
|
"/api/issues/11111111-1111-4111-8111-111111111111/heartbeat-context",
|
|
);
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(mockDocumentsService.getIssueDocumentByKey).toHaveBeenCalledWith(
|
|
"11111111-1111-4111-8111-111111111111",
|
|
"continuation-summary",
|
|
);
|
|
expect(res.body.continuationSummary).toEqual(expect.objectContaining({
|
|
key: "continuation-summary",
|
|
body: "# Handoff",
|
|
}));
|
|
});
|
|
|
|
it("surfaces blocker summaries on GET /issues/:id/heartbeat-context", async () => {
|
|
mockIssueService.getRelationSummaries.mockResolvedValue({
|
|
blockedBy: [
|
|
{
|
|
id: "55555555-5555-4555-8555-555555555555",
|
|
identifier: "PAP-580",
|
|
title: "Finish wakeup plumbing",
|
|
status: "done",
|
|
priority: "medium",
|
|
assigneeAgentId: null,
|
|
assigneeUserId: null,
|
|
},
|
|
],
|
|
blocks: [],
|
|
});
|
|
|
|
const res = await request(createApp()).get(
|
|
"/api/issues/11111111-1111-4111-8111-111111111111/heartbeat-context",
|
|
);
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body.issue.blockedBy).toEqual([
|
|
expect.objectContaining({
|
|
id: "55555555-5555-4555-8555-555555555555",
|
|
identifier: "PAP-580",
|
|
}),
|
|
]);
|
|
});
|
|
|
|
it("surfaces the current execution workspace from GET /issues/:id/heartbeat-context", async () => {
|
|
mockIssueService.getById.mockResolvedValue({
|
|
...legacyProjectLinkedIssue,
|
|
executionWorkspaceId: "55555555-5555-4555-8555-555555555555",
|
|
});
|
|
mockExecutionWorkspaceService.getById.mockResolvedValue({
|
|
id: "55555555-5555-4555-8555-555555555555",
|
|
name: "PAP-581 workspace",
|
|
mode: "isolated_workspace",
|
|
status: "active",
|
|
cwd: "/tmp/pap-581",
|
|
runtimeServices: [
|
|
{
|
|
id: "service-1",
|
|
serviceName: "web",
|
|
status: "running",
|
|
url: "http://127.0.0.1:5173",
|
|
healthStatus: "healthy",
|
|
},
|
|
],
|
|
});
|
|
|
|
const res = await request(createApp()).get(
|
|
"/api/issues/11111111-1111-4111-8111-111111111111/heartbeat-context",
|
|
);
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(mockExecutionWorkspaceService.getById).toHaveBeenCalledWith("55555555-5555-4555-8555-555555555555");
|
|
expect(res.body.currentExecutionWorkspace).toEqual(expect.objectContaining({
|
|
id: "55555555-5555-4555-8555-555555555555",
|
|
mode: "isolated_workspace",
|
|
runtimeServices: [
|
|
expect.objectContaining({
|
|
serviceName: "web",
|
|
url: "http://127.0.0.1:5173",
|
|
}),
|
|
],
|
|
}));
|
|
});
|
|
});
|