mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-14 10:00:38 +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>
481 lines
18 KiB
TypeScript
481 lines
18 KiB
TypeScript
import { and, asc, desc, eq } from "drizzle-orm";
|
|
import type { Db } from "@paperclipai/db";
|
|
import { documentRevisions, documents, issueDocuments, issues } from "@paperclipai/db";
|
|
import { isSystemIssueDocumentKey, issueDocumentKeySchema } from "@paperclipai/shared";
|
|
import { conflict, notFound, unprocessable } from "../errors.js";
|
|
|
|
function normalizeDocumentKey(key: string) {
|
|
const normalized = key.trim().toLowerCase();
|
|
const parsed = issueDocumentKeySchema.safeParse(normalized);
|
|
if (!parsed.success) {
|
|
throw unprocessable("Invalid document key", parsed.error.issues);
|
|
}
|
|
return parsed.data;
|
|
}
|
|
|
|
function isUniqueViolation(error: unknown): boolean {
|
|
return !!error && typeof error === "object" && "code" in error && (error as { code?: string }).code === "23505";
|
|
}
|
|
|
|
export function extractLegacyPlanBody(description: string | null | undefined) {
|
|
if (!description) return null;
|
|
const match = /<plan>\s*([\s\S]*?)\s*<\/plan>/i.exec(description);
|
|
if (!match) return null;
|
|
const body = match[1]?.trim();
|
|
return body ? body : null;
|
|
}
|
|
|
|
function mapIssueDocumentRow(
|
|
row: {
|
|
id: string;
|
|
companyId: string;
|
|
issueId: string;
|
|
key: string;
|
|
title: string | null;
|
|
format: string;
|
|
latestBody: string;
|
|
latestRevisionId: string | null;
|
|
latestRevisionNumber: number;
|
|
createdByAgentId: string | null;
|
|
createdByUserId: string | null;
|
|
updatedByAgentId: string | null;
|
|
updatedByUserId: string | null;
|
|
createdAt: Date;
|
|
updatedAt: Date;
|
|
},
|
|
includeBody: boolean,
|
|
) {
|
|
return {
|
|
id: row.id,
|
|
companyId: row.companyId,
|
|
issueId: row.issueId,
|
|
key: row.key,
|
|
title: row.title,
|
|
format: row.format,
|
|
...(includeBody ? { body: row.latestBody } : {}),
|
|
latestRevisionId: row.latestRevisionId ?? null,
|
|
latestRevisionNumber: row.latestRevisionNumber,
|
|
createdByAgentId: row.createdByAgentId,
|
|
createdByUserId: row.createdByUserId,
|
|
updatedByAgentId: row.updatedByAgentId,
|
|
updatedByUserId: row.updatedByUserId,
|
|
createdAt: row.createdAt,
|
|
updatedAt: row.updatedAt,
|
|
};
|
|
}
|
|
|
|
const issueDocumentSelect = {
|
|
id: documents.id,
|
|
companyId: documents.companyId,
|
|
issueId: issueDocuments.issueId,
|
|
key: issueDocuments.key,
|
|
title: documents.title,
|
|
format: documents.format,
|
|
latestBody: documents.latestBody,
|
|
latestRevisionId: documents.latestRevisionId,
|
|
latestRevisionNumber: documents.latestRevisionNumber,
|
|
createdByAgentId: documents.createdByAgentId,
|
|
createdByUserId: documents.createdByUserId,
|
|
updatedByAgentId: documents.updatedByAgentId,
|
|
updatedByUserId: documents.updatedByUserId,
|
|
createdAt: documents.createdAt,
|
|
updatedAt: documents.updatedAt,
|
|
};
|
|
|
|
export function documentService(db: Db) {
|
|
const filterSystemDocuments = <T extends { key: string }>(rows: T[], includeSystem: boolean) =>
|
|
includeSystem ? rows : rows.filter((row) => !isSystemIssueDocumentKey(row.key));
|
|
|
|
return {
|
|
getIssueDocumentPayload: async (
|
|
issue: { id: string; description: string | null },
|
|
options: { includeSystem?: boolean } = {},
|
|
) => {
|
|
const [planDocument, documentSummaries] = await Promise.all([
|
|
db
|
|
.select(issueDocumentSelect)
|
|
.from(issueDocuments)
|
|
.innerJoin(documents, eq(issueDocuments.documentId, documents.id))
|
|
.where(and(eq(issueDocuments.issueId, issue.id), eq(issueDocuments.key, "plan")))
|
|
.then((rows) => rows[0] ?? null),
|
|
db
|
|
.select(issueDocumentSelect)
|
|
.from(issueDocuments)
|
|
.innerJoin(documents, eq(issueDocuments.documentId, documents.id))
|
|
.where(eq(issueDocuments.issueId, issue.id))
|
|
.orderBy(asc(issueDocuments.key), desc(documents.updatedAt)),
|
|
]);
|
|
|
|
const legacyPlanBody = planDocument ? null : extractLegacyPlanBody(issue.description);
|
|
|
|
return {
|
|
planDocument: planDocument ? mapIssueDocumentRow(planDocument, true) : null,
|
|
documentSummaries: filterSystemDocuments(documentSummaries, options.includeSystem ?? false)
|
|
.map((row) => mapIssueDocumentRow(row, false)),
|
|
legacyPlanDocument: legacyPlanBody
|
|
? {
|
|
key: "plan" as const,
|
|
body: legacyPlanBody,
|
|
source: "issue_description" as const,
|
|
}
|
|
: null,
|
|
};
|
|
},
|
|
|
|
listIssueDocuments: async (issueId: string, options: { includeSystem?: boolean } = {}) => {
|
|
const rows = await db
|
|
.select(issueDocumentSelect)
|
|
.from(issueDocuments)
|
|
.innerJoin(documents, eq(issueDocuments.documentId, documents.id))
|
|
.where(eq(issueDocuments.issueId, issueId))
|
|
.orderBy(asc(issueDocuments.key), desc(documents.updatedAt));
|
|
return filterSystemDocuments(rows, options.includeSystem ?? false).map((row) => mapIssueDocumentRow(row, true));
|
|
},
|
|
|
|
getIssueDocumentByKey: async (issueId: string, rawKey: string) => {
|
|
const key = normalizeDocumentKey(rawKey);
|
|
const row = await db
|
|
.select(issueDocumentSelect)
|
|
.from(issueDocuments)
|
|
.innerJoin(documents, eq(issueDocuments.documentId, documents.id))
|
|
.where(and(eq(issueDocuments.issueId, issueId), eq(issueDocuments.key, key)))
|
|
.then((rows) => rows[0] ?? null);
|
|
return row ? mapIssueDocumentRow(row, true) : null;
|
|
},
|
|
|
|
listIssueDocumentRevisions: async (issueId: string, rawKey: string) => {
|
|
const key = normalizeDocumentKey(rawKey);
|
|
return db
|
|
.select({
|
|
id: documentRevisions.id,
|
|
companyId: documentRevisions.companyId,
|
|
documentId: documentRevisions.documentId,
|
|
issueId: issueDocuments.issueId,
|
|
key: issueDocuments.key,
|
|
revisionNumber: documentRevisions.revisionNumber,
|
|
title: documentRevisions.title,
|
|
format: documentRevisions.format,
|
|
body: documentRevisions.body,
|
|
changeSummary: documentRevisions.changeSummary,
|
|
createdByAgentId: documentRevisions.createdByAgentId,
|
|
createdByUserId: documentRevisions.createdByUserId,
|
|
createdAt: documentRevisions.createdAt,
|
|
})
|
|
.from(issueDocuments)
|
|
.innerJoin(documents, eq(issueDocuments.documentId, documents.id))
|
|
.innerJoin(documentRevisions, eq(documentRevisions.documentId, documents.id))
|
|
.where(and(eq(issueDocuments.issueId, issueId), eq(issueDocuments.key, key)))
|
|
.orderBy(desc(documentRevisions.revisionNumber));
|
|
},
|
|
|
|
upsertIssueDocument: async (input: {
|
|
issueId: string;
|
|
key: string;
|
|
title?: string | null;
|
|
format: string;
|
|
body: string;
|
|
changeSummary?: string | null;
|
|
baseRevisionId?: string | null;
|
|
createdByAgentId?: string | null;
|
|
createdByUserId?: string | null;
|
|
createdByRunId?: string | null;
|
|
}) => {
|
|
const key = normalizeDocumentKey(input.key);
|
|
const issue = await db
|
|
.select({ id: issues.id, companyId: issues.companyId })
|
|
.from(issues)
|
|
.where(eq(issues.id, input.issueId))
|
|
.then((rows) => rows[0] ?? null);
|
|
if (!issue) throw notFound("Issue not found");
|
|
|
|
try {
|
|
return await db.transaction(async (tx) => {
|
|
const now = new Date();
|
|
const existing = await tx
|
|
.select({
|
|
id: documents.id,
|
|
companyId: documents.companyId,
|
|
issueId: issueDocuments.issueId,
|
|
key: issueDocuments.key,
|
|
title: documents.title,
|
|
format: documents.format,
|
|
latestBody: documents.latestBody,
|
|
latestRevisionId: documents.latestRevisionId,
|
|
latestRevisionNumber: documents.latestRevisionNumber,
|
|
createdByAgentId: documents.createdByAgentId,
|
|
createdByUserId: documents.createdByUserId,
|
|
updatedByAgentId: documents.updatedByAgentId,
|
|
updatedByUserId: documents.updatedByUserId,
|
|
createdAt: documents.createdAt,
|
|
updatedAt: documents.updatedAt,
|
|
})
|
|
.from(issueDocuments)
|
|
.innerJoin(documents, eq(issueDocuments.documentId, documents.id))
|
|
.where(and(eq(issueDocuments.issueId, issue.id), eq(issueDocuments.key, key)))
|
|
.then((rows) => rows[0] ?? null);
|
|
|
|
if (existing) {
|
|
if (!input.baseRevisionId) {
|
|
throw conflict("Document update requires baseRevisionId", {
|
|
currentRevisionId: existing.latestRevisionId,
|
|
});
|
|
}
|
|
if (input.baseRevisionId !== existing.latestRevisionId) {
|
|
throw conflict("Document was updated by someone else", {
|
|
currentRevisionId: existing.latestRevisionId,
|
|
});
|
|
}
|
|
|
|
const nextRevisionNumber = existing.latestRevisionNumber + 1;
|
|
const [revision] = await tx
|
|
.insert(documentRevisions)
|
|
.values({
|
|
companyId: issue.companyId,
|
|
documentId: existing.id,
|
|
revisionNumber: nextRevisionNumber,
|
|
title: input.title ?? null,
|
|
format: input.format,
|
|
body: input.body,
|
|
changeSummary: input.changeSummary ?? null,
|
|
createdByAgentId: input.createdByAgentId ?? null,
|
|
createdByUserId: input.createdByUserId ?? null,
|
|
createdByRunId: input.createdByRunId ?? null,
|
|
createdAt: now,
|
|
})
|
|
.returning();
|
|
|
|
await tx
|
|
.update(documents)
|
|
.set({
|
|
title: input.title ?? null,
|
|
format: input.format,
|
|
latestBody: input.body,
|
|
latestRevisionId: revision.id,
|
|
latestRevisionNumber: nextRevisionNumber,
|
|
updatedByAgentId: input.createdByAgentId ?? null,
|
|
updatedByUserId: input.createdByUserId ?? null,
|
|
updatedAt: now,
|
|
})
|
|
.where(eq(documents.id, existing.id));
|
|
|
|
await tx
|
|
.update(issueDocuments)
|
|
.set({ updatedAt: now })
|
|
.where(eq(issueDocuments.documentId, existing.id));
|
|
|
|
return {
|
|
created: false as const,
|
|
document: {
|
|
...existing,
|
|
title: input.title ?? null,
|
|
format: input.format,
|
|
body: input.body,
|
|
latestRevisionId: revision.id,
|
|
latestRevisionNumber: nextRevisionNumber,
|
|
updatedByAgentId: input.createdByAgentId ?? null,
|
|
updatedByUserId: input.createdByUserId ?? null,
|
|
updatedAt: now,
|
|
},
|
|
};
|
|
}
|
|
|
|
if (input.baseRevisionId) {
|
|
throw conflict("Document does not exist yet", { key });
|
|
}
|
|
|
|
const [document] = await tx
|
|
.insert(documents)
|
|
.values({
|
|
companyId: issue.companyId,
|
|
title: input.title ?? null,
|
|
format: input.format,
|
|
latestBody: input.body,
|
|
latestRevisionId: null,
|
|
latestRevisionNumber: 1,
|
|
createdByAgentId: input.createdByAgentId ?? null,
|
|
createdByUserId: input.createdByUserId ?? null,
|
|
updatedByAgentId: input.createdByAgentId ?? null,
|
|
updatedByUserId: input.createdByUserId ?? null,
|
|
createdAt: now,
|
|
updatedAt: now,
|
|
})
|
|
.returning();
|
|
|
|
const [revision] = await tx
|
|
.insert(documentRevisions)
|
|
.values({
|
|
companyId: issue.companyId,
|
|
documentId: document.id,
|
|
revisionNumber: 1,
|
|
title: input.title ?? null,
|
|
format: input.format,
|
|
body: input.body,
|
|
changeSummary: input.changeSummary ?? null,
|
|
createdByAgentId: input.createdByAgentId ?? null,
|
|
createdByUserId: input.createdByUserId ?? null,
|
|
createdByRunId: input.createdByRunId ?? null,
|
|
createdAt: now,
|
|
})
|
|
.returning();
|
|
|
|
await tx
|
|
.update(documents)
|
|
.set({ latestRevisionId: revision.id })
|
|
.where(eq(documents.id, document.id));
|
|
|
|
await tx.insert(issueDocuments).values({
|
|
companyId: issue.companyId,
|
|
issueId: issue.id,
|
|
documentId: document.id,
|
|
key,
|
|
createdAt: now,
|
|
updatedAt: now,
|
|
});
|
|
|
|
return {
|
|
created: true as const,
|
|
document: {
|
|
id: document.id,
|
|
companyId: issue.companyId,
|
|
issueId: issue.id,
|
|
key,
|
|
title: document.title,
|
|
format: document.format,
|
|
body: document.latestBody,
|
|
latestRevisionId: revision.id,
|
|
latestRevisionNumber: 1,
|
|
createdByAgentId: document.createdByAgentId,
|
|
createdByUserId: document.createdByUserId,
|
|
updatedByAgentId: document.updatedByAgentId,
|
|
updatedByUserId: document.updatedByUserId,
|
|
createdAt: document.createdAt,
|
|
updatedAt: document.updatedAt,
|
|
},
|
|
};
|
|
});
|
|
} catch (error) {
|
|
if (isUniqueViolation(error)) {
|
|
throw conflict("Document key already exists on this issue", { key });
|
|
}
|
|
throw error;
|
|
}
|
|
},
|
|
|
|
restoreIssueDocumentRevision: async (input: {
|
|
issueId: string;
|
|
key: string;
|
|
revisionId: string;
|
|
createdByAgentId?: string | null;
|
|
createdByUserId?: string | null;
|
|
}) => {
|
|
const key = normalizeDocumentKey(input.key);
|
|
return db.transaction(async (tx) => {
|
|
const existing = await tx
|
|
.select(issueDocumentSelect)
|
|
.from(issueDocuments)
|
|
.innerJoin(documents, eq(issueDocuments.documentId, documents.id))
|
|
.where(and(eq(issueDocuments.issueId, input.issueId), eq(issueDocuments.key, key)))
|
|
.then((rows) => rows[0] ?? null);
|
|
|
|
if (!existing) throw notFound("Document not found");
|
|
|
|
const revision = await tx
|
|
.select({
|
|
id: documentRevisions.id,
|
|
companyId: documentRevisions.companyId,
|
|
documentId: documentRevisions.documentId,
|
|
revisionNumber: documentRevisions.revisionNumber,
|
|
title: documentRevisions.title,
|
|
format: documentRevisions.format,
|
|
body: documentRevisions.body,
|
|
})
|
|
.from(documentRevisions)
|
|
.where(and(eq(documentRevisions.id, input.revisionId), eq(documentRevisions.documentId, existing.id)))
|
|
.then((rows) => rows[0] ?? null);
|
|
|
|
if (!revision) throw notFound("Document revision not found");
|
|
if (existing.latestRevisionId === revision.id) {
|
|
throw conflict("Selected revision is already the latest revision", {
|
|
currentRevisionId: existing.latestRevisionId,
|
|
});
|
|
}
|
|
|
|
const now = new Date();
|
|
const nextRevisionNumber = existing.latestRevisionNumber + 1;
|
|
const [restoredRevision] = await tx
|
|
.insert(documentRevisions)
|
|
.values({
|
|
companyId: existing.companyId,
|
|
documentId: existing.id,
|
|
revisionNumber: nextRevisionNumber,
|
|
title: revision.title ?? null,
|
|
format: revision.format,
|
|
body: revision.body,
|
|
changeSummary: `Restored from revision ${revision.revisionNumber}`,
|
|
createdByAgentId: input.createdByAgentId ?? null,
|
|
createdByUserId: input.createdByUserId ?? null,
|
|
createdAt: now,
|
|
})
|
|
.returning();
|
|
|
|
await tx
|
|
.update(documents)
|
|
.set({
|
|
title: revision.title ?? null,
|
|
format: revision.format,
|
|
latestBody: revision.body,
|
|
latestRevisionId: restoredRevision.id,
|
|
latestRevisionNumber: nextRevisionNumber,
|
|
updatedByAgentId: input.createdByAgentId ?? null,
|
|
updatedByUserId: input.createdByUserId ?? null,
|
|
updatedAt: now,
|
|
})
|
|
.where(eq(documents.id, existing.id));
|
|
|
|
await tx
|
|
.update(issueDocuments)
|
|
.set({ updatedAt: now })
|
|
.where(eq(issueDocuments.documentId, existing.id));
|
|
|
|
return {
|
|
restoredFromRevisionId: revision.id,
|
|
restoredFromRevisionNumber: revision.revisionNumber,
|
|
document: {
|
|
...existing,
|
|
title: revision.title ?? null,
|
|
format: revision.format,
|
|
body: revision.body,
|
|
latestRevisionId: restoredRevision.id,
|
|
latestRevisionNumber: nextRevisionNumber,
|
|
updatedByAgentId: input.createdByAgentId ?? null,
|
|
updatedByUserId: input.createdByUserId ?? null,
|
|
updatedAt: now,
|
|
},
|
|
};
|
|
});
|
|
},
|
|
|
|
deleteIssueDocument: async (issueId: string, rawKey: string) => {
|
|
const key = normalizeDocumentKey(rawKey);
|
|
return db.transaction(async (tx) => {
|
|
const existing = await tx
|
|
.select(issueDocumentSelect)
|
|
.from(issueDocuments)
|
|
.innerJoin(documents, eq(issueDocuments.documentId, documents.id))
|
|
.where(and(eq(issueDocuments.issueId, issueId), eq(issueDocuments.key, key)))
|
|
.then((rows) => rows[0] ?? null);
|
|
|
|
if (!existing) return null;
|
|
|
|
await tx.delete(issueDocuments).where(eq(issueDocuments.documentId, existing.id));
|
|
await tx.delete(documents).where(eq(documents.id, existing.id));
|
|
|
|
return {
|
|
...existing,
|
|
body: existing.latestBody,
|
|
latestRevisionId: existing.latestRevisionId ?? null,
|
|
};
|
|
});
|
|
},
|
|
};
|
|
}
|