mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-15 18:30:39 +09:00
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies. > - Heartbeat runs are the control-plane record of each agent execution window. > - Long-running local agents can exhaust context or stop while still holding useful next-step state. > - Operators need that stop reason, next action, and continuation path to be durable and visible. > - This pull request adds run liveness metadata, continuation summaries, and UI surfaces for issue run ledgers. > - The benefit is that interrupted or long-running work can resume with clearer context instead of losing the agent's last useful handoff. ## What Changed - Added heartbeat-run liveness fields, continuation attempt tracking, and an idempotent `0058` migration. - Added server services and tests for run liveness, continuation summaries, stop metadata, and activity backfill. - Wired local and HTTP adapters to surface continuation/liveness context through shared adapter utilities. - Added shared constants, validators, and heartbeat types for liveness continuation state. - Added issue-detail UI surfaces for continuation handoffs and the run ledger, with component tests. - Updated agent runtime docs, heartbeat protocol docs, prompt guidance, onboarding assets, and skills instructions to explain continuation behavior. - Addressed Greptile feedback by scoping document evidence by run, excluding system continuation-summary documents from liveness evidence, importing shared liveness types, surfacing hidden ledger run counts, documenting bounded retry behavior, and moving run-ledger liveness backfill off the request path. ## Verification - `pnpm exec vitest run packages/adapter-utils/src/server-utils.test.ts server/src/__tests__/run-continuations.test.ts server/src/__tests__/run-liveness.test.ts server/src/__tests__/activity-service.test.ts server/src/__tests__/documents-service.test.ts server/src/__tests__/issue-continuation-summary.test.ts server/src/services/heartbeat-stop-metadata.test.ts ui/src/components/IssueRunLedger.test.tsx ui/src/components/IssueContinuationHandoff.test.tsx ui/src/components/IssueDocumentsSection.test.tsx` - `pnpm --filter @paperclipai/db build` - `pnpm exec vitest run server/src/__tests__/activity-service.test.ts ui/src/components/IssueRunLedger.test.tsx` - `pnpm --filter @paperclipai/ui typecheck` - `pnpm --filter @paperclipai/server typecheck` - `pnpm exec vitest run server/src/__tests__/activity-service.test.ts server/src/__tests__/run-continuations.test.ts ui/src/components/IssueRunLedger.test.tsx` - `pnpm exec vitest run server/src/__tests__/heartbeat-process-recovery.test.ts -t "treats a plan document update"` - `pnpm exec vitest run server/src/__tests__/activity-service.test.ts server/src/__tests__/heartbeat-process-recovery.test.ts -t "activity service|treats a plan document update"` - Remote PR checks on head `e53b1a1d`: `verify`, `e2e`, `policy`, and Snyk all passed. - Confirmed `public-gh/master` is an ancestor of this branch after fetching `public-gh master`. - Confirmed `pnpm-lock.yaml` is not included in the branch diff. - Confirmed migration `0058_wealthy_starbolt.sql` is ordered after `0057` and uses `IF NOT EXISTS` guards for repeat application. - Greptile inline review threads are resolved. ## Risks - Medium risk: this touches heartbeat execution, liveness recovery, activity rendering, issue routes, shared contracts, docs, and UI. - Migration risk is mitigated by additive columns/indexes and idempotent guards. - Run-ledger liveness backfill is now asynchronous, so the first ledger response can briefly show historical missing liveness until the background backfill completes. - UI screenshot coverage is not included in this packaging pass; validation is currently through focused component tests. > 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.4, local tool-use coding agent with terminal, git, GitHub connector, GitHub CLI, and Paperclip API access. ## 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 Screenshot note: no before/after screenshots were captured in this PR packaging pass; the UI changes are covered by focused component tests listed above. --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
251 lines
7.5 KiB
TypeScript
251 lines
7.5 KiB
TypeScript
import express from "express";
|
|
import request from "supertest";
|
|
import { beforeEach, describe, expect, it, vi } from "vitest";
|
|
|
|
const mockWakeup = vi.hoisted(() => vi.fn(async () => undefined));
|
|
const mockIssueService = vi.hoisted(() => ({
|
|
getAncestors: vi.fn(),
|
|
getById: vi.fn(),
|
|
getByIdentifier: vi.fn(async () => null),
|
|
getComment: vi.fn(),
|
|
getCommentCursor: vi.fn(),
|
|
getRelationSummaries: vi.fn(),
|
|
update: vi.fn(),
|
|
listWakeableBlockedDependents: vi.fn(),
|
|
getWakeableParentAfterChildCompletion: vi.fn(),
|
|
findMentionedAgents: vi.fn(async () => []),
|
|
}));
|
|
|
|
vi.mock("../services/index.js", () => ({
|
|
accessService: () => ({
|
|
canUser: vi.fn(),
|
|
hasPermission: vi.fn(),
|
|
}),
|
|
agentService: () => ({
|
|
getById: vi.fn(),
|
|
}),
|
|
documentService: () => ({
|
|
getIssueDocumentPayload: vi.fn(async () => ({})),
|
|
}),
|
|
executionWorkspaceService: () => ({
|
|
getById: vi.fn(),
|
|
}),
|
|
feedbackService: () => ({}),
|
|
goalService: () => ({
|
|
getById: vi.fn(),
|
|
getDefaultCompanyGoal: vi.fn(),
|
|
}),
|
|
heartbeatService: () => ({
|
|
wakeup: mockWakeup,
|
|
reportRunActivity: vi.fn(async () => undefined),
|
|
}),
|
|
getIssueContinuationSummaryDocument: vi.fn(async () => null),
|
|
instanceSettingsService: () => ({
|
|
get: vi.fn(),
|
|
listCompanyIds: vi.fn(),
|
|
}),
|
|
issueApprovalService: () => ({}),
|
|
issueService: () => mockIssueService,
|
|
logActivity: vi.fn(async () => undefined),
|
|
projectService: () => ({
|
|
getById: vi.fn(),
|
|
listByIds: vi.fn(async () => []),
|
|
}),
|
|
routineService: () => ({
|
|
syncRunStatusForIssue: vi.fn(async () => undefined),
|
|
}),
|
|
workProductService: () => ({
|
|
listForIssue: vi.fn(async () => []),
|
|
}),
|
|
}));
|
|
|
|
async function createApp() {
|
|
const [{ issueRoutes }, { errorHandler }] = await Promise.all([
|
|
vi.importActual<typeof import("../routes/issues.js")>("../routes/issues.js"),
|
|
vi.importActual<typeof import("../middleware/index.js")>("../middleware/index.js"),
|
|
]);
|
|
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({} as any, {} as any));
|
|
app.use(errorHandler);
|
|
return app;
|
|
}
|
|
|
|
describe("issue dependency wakeups in issue routes", () => {
|
|
beforeEach(() => {
|
|
vi.resetModules();
|
|
vi.doUnmock("../routes/issues.js");
|
|
vi.doUnmock("../routes/authz.js");
|
|
vi.doUnmock("../middleware/index.js");
|
|
vi.resetAllMocks();
|
|
mockIssueService.getAncestors.mockResolvedValue([]);
|
|
mockIssueService.getComment.mockResolvedValue(null);
|
|
mockIssueService.getCommentCursor.mockResolvedValue({
|
|
totalComments: 0,
|
|
latestCommentId: null,
|
|
latestCommentAt: null,
|
|
});
|
|
mockIssueService.getRelationSummaries.mockResolvedValue({ blockedBy: [], blocks: [] });
|
|
mockIssueService.listWakeableBlockedDependents.mockResolvedValue([]);
|
|
mockIssueService.getWakeableParentAfterChildCompletion.mockResolvedValue(null);
|
|
});
|
|
|
|
it("wakes dependents when the final blocker transitions to done", async () => {
|
|
mockIssueService.getById.mockResolvedValue({
|
|
id: "issue-1",
|
|
companyId: "company-1",
|
|
identifier: "PAP-100",
|
|
title: "Finish blocker",
|
|
description: null,
|
|
status: "blocked",
|
|
priority: "medium",
|
|
parentId: null,
|
|
assigneeAgentId: "agent-1",
|
|
assigneeUserId: null,
|
|
createdByAgentId: null,
|
|
createdByUserId: null,
|
|
executionWorkspaceId: null,
|
|
labels: [],
|
|
labelIds: [],
|
|
});
|
|
mockIssueService.update.mockResolvedValue({
|
|
id: "issue-1",
|
|
companyId: "company-1",
|
|
identifier: "PAP-100",
|
|
title: "Finish blocker",
|
|
description: null,
|
|
status: "done",
|
|
priority: "medium",
|
|
parentId: null,
|
|
assigneeAgentId: "agent-1",
|
|
assigneeUserId: null,
|
|
createdByAgentId: null,
|
|
createdByUserId: null,
|
|
executionWorkspaceId: null,
|
|
labels: [],
|
|
labelIds: [],
|
|
});
|
|
mockIssueService.listWakeableBlockedDependents.mockResolvedValue([
|
|
{
|
|
id: "issue-2",
|
|
assigneeAgentId: "agent-2",
|
|
blockerIssueIds: ["issue-1", "issue-3"],
|
|
},
|
|
]);
|
|
|
|
const res = await request(await createApp()).patch("/api/issues/issue-1").send({ status: "done" });
|
|
expect(res.status).toBe(200);
|
|
await vi.waitFor(() => {
|
|
expect(mockWakeup).toHaveBeenCalledWith(
|
|
"agent-2",
|
|
expect.objectContaining({
|
|
reason: "issue_blockers_resolved",
|
|
payload: expect.objectContaining({
|
|
issueId: "issue-2",
|
|
resolvedBlockerIssueId: "issue-1",
|
|
}),
|
|
}),
|
|
);
|
|
});
|
|
});
|
|
|
|
it("wakes the parent when all direct children become terminal", async () => {
|
|
mockIssueService.getById.mockResolvedValue({
|
|
id: "child-1",
|
|
companyId: "company-1",
|
|
identifier: "PAP-101",
|
|
title: "Last child",
|
|
description: null,
|
|
status: "in_progress",
|
|
priority: "medium",
|
|
parentId: "parent-1",
|
|
assigneeAgentId: "agent-1",
|
|
assigneeUserId: null,
|
|
createdByAgentId: null,
|
|
createdByUserId: null,
|
|
executionWorkspaceId: null,
|
|
labels: [],
|
|
labelIds: [],
|
|
});
|
|
mockIssueService.update.mockResolvedValue({
|
|
id: "child-1",
|
|
companyId: "company-1",
|
|
identifier: "PAP-101",
|
|
title: "Last child",
|
|
description: null,
|
|
status: "done",
|
|
priority: "medium",
|
|
parentId: "parent-1",
|
|
assigneeAgentId: "agent-1",
|
|
assigneeUserId: null,
|
|
createdByAgentId: null,
|
|
createdByUserId: null,
|
|
executionWorkspaceId: null,
|
|
labels: [],
|
|
labelIds: [],
|
|
});
|
|
mockIssueService.getWakeableParentAfterChildCompletion.mockResolvedValue({
|
|
id: "parent-1",
|
|
assigneeAgentId: "agent-9",
|
|
childIssueIds: ["child-0", "child-1"],
|
|
childIssueSummaries: [
|
|
{
|
|
id: "child-0",
|
|
identifier: "PAP-100",
|
|
title: "First child",
|
|
status: "done",
|
|
priority: "medium",
|
|
assigneeAgentId: "agent-1",
|
|
assigneeUserId: null,
|
|
updatedAt: new Date("2026-04-18T12:00:00.000Z"),
|
|
summary: "First child finished.",
|
|
},
|
|
{
|
|
id: "child-1",
|
|
identifier: "PAP-101",
|
|
title: "Last child",
|
|
status: "done",
|
|
priority: "medium",
|
|
assigneeAgentId: "agent-1",
|
|
assigneeUserId: null,
|
|
updatedAt: new Date("2026-04-18T12:05:00.000Z"),
|
|
summary: "Last child finished.",
|
|
},
|
|
],
|
|
childIssueSummaryTruncated: false,
|
|
});
|
|
|
|
const res = await request(await createApp()).patch("/api/issues/child-1").send({ status: "done" });
|
|
expect(res.status).toBe(200);
|
|
await vi.waitFor(() => {
|
|
expect(mockWakeup).toHaveBeenCalledWith(
|
|
"agent-9",
|
|
expect.objectContaining({
|
|
reason: "issue_children_completed",
|
|
payload: expect.objectContaining({
|
|
issueId: "parent-1",
|
|
completedChildIssueId: "child-1",
|
|
childIssueSummaries: expect.arrayContaining([
|
|
expect.objectContaining({ identifier: "PAP-101", summary: "Last child finished." }),
|
|
]),
|
|
}),
|
|
contextSnapshot: expect.objectContaining({
|
|
childIssueSummaries: expect.arrayContaining([
|
|
expect.objectContaining({ identifier: "PAP-100", summary: "First child finished." }),
|
|
]),
|
|
}),
|
|
}),
|
|
);
|
|
});
|
|
});
|
|
});
|