mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-22 16:51:28 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Issue comment wake handoffs are part of the control-plane execution loop that decides when agents resume work after comments and issue updates. > - PR #7678 changed that wake handoff behavior in server issue routes, heartbeat context, and related tests. > - The change broke an important workflow after merge, so the safest immediate fix is to restore the pre-#7678 wake behavior. > - This pull request reverts the wake-handoff behavior from PR #7678 while keeping narrow review-requested safeguards that prevent known runtime/test regressions. > - The benefit is that Paperclip returns to the last known working wake behavior without reintroducing avoidable UUID skill lookup and annotation-resolution test gaps. ## Linked Issues or Issue Description Refs: #7678 Bug context: - What happened: PR #7678 was reported to have broken an important Paperclip workflow after it merged. - Expected behavior: Paperclip should preserve the prior issue comment wake handoff behavior until a corrected change is ready. - Steps to reproduce: Use the workflow affected by PR #7678's issue comment wake handoff changes. - Paperclip version/commit: `master` after merge commit `4da79a88c67e54084d40bd18cada5ee5c8be23da`. - Deployment mode: Paperclip control-plane server behavior. ## What Changed - Reverted merge commit `4da79a88c67e54084d40bd18cada5ee5c8be23da` from PR #7678 to restore pre-#7678 wake-handoff behavior. - Preserved the safe accepted-plan routing check so `parseObject(...)` is not used as a boolean. - Preserved UUID filtering for run-scoped skill mentions so legacy non-UUID skill IDs do not reach a Postgres UUID lookup. - Restored the annotation thread-resolution test guard that verifies resolving a thread does not wake the assignee. ## Verification - `pnpm run preflight:workspace-links && NODE_ENV=test PAPERCLIP_HOME=/tmp/... PAPERCLIP_INSTANCE_ID=pap10614-revert TMPDIR=/tmp/... pnpm exec vitest run --project @paperclipai/server --no-file-parallelism --maxWorkers=1 server/src/__tests__/document-annotation-routes.test.ts server/src/__tests__/heartbeat-project-env.test.ts server/src/__tests__/heartbeat-accepted-plan-workspace-refresh.test.ts server/src/__tests__/heartbeat-context-summary.test.ts` - Result: 4 test files passed, 26 tests passed. - Earlier targeted revert verification also passed: 4 test files, 50 tests. ## Risks - This intentionally restores behavior from before PR #7678, so intended wake-handoff improvements from that PR are removed. - The PR is no longer a byte-for-byte revert because Greptile identified two narrow safeguards worth preserving. - Low migration risk: no schema or dependency changes are included. - Follow-up work may still be needed to reintroduce the desired wake handoff behavior without the regression. ## Model Used OpenAI Codex, GPT-5 coding agent in this Paperclip heartbeat, with shell/tool execution and repository write 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 searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [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] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge
249 lines
7.9 KiB
TypeScript
249 lines
7.9 KiB
TypeScript
import { randomUUID } from "node:crypto";
|
|
import express from "express";
|
|
import request from "supertest";
|
|
import { sql } from "drizzle-orm";
|
|
import { afterAll, afterEach, beforeAll, describe, expect, it, vi } from "vitest";
|
|
import {
|
|
companies,
|
|
createDb,
|
|
issueComments,
|
|
issueReferenceMentions,
|
|
issues,
|
|
} from "@paperclipai/db";
|
|
import { companySearchQuerySchema } from "@paperclipai/shared";
|
|
import {
|
|
getEmbeddedPostgresTestSupport,
|
|
startEmbeddedPostgresTestDatabase,
|
|
} from "./helpers/embedded-postgres.js";
|
|
import { errorHandler } from "../middleware/index.js";
|
|
import { issueRoutes } from "../routes/issues.js";
|
|
import { companySearchService } from "../services/company-search.js";
|
|
import { buildPaperclipWakePayload } from "../services/heartbeat.js";
|
|
import { issueReferenceService } from "../services/issue-references.js";
|
|
import { issueService } from "../services/issues.js";
|
|
import type { StorageService } from "../storage/types.js";
|
|
|
|
const embeddedPostgresSupport = await getEmbeddedPostgresTestSupport();
|
|
const describeEmbeddedPostgres = embeddedPostgresSupport.supported ? describe.sequential : describe.skip;
|
|
|
|
if (!embeddedPostgresSupport.supported) {
|
|
console.warn(
|
|
`Skipping embedded Postgres issue comment redaction tests on this host: ${embeddedPostgresSupport.reason ?? "unsupported environment"}`,
|
|
);
|
|
}
|
|
|
|
describeEmbeddedPostgres("deleted issue comment redaction", () => {
|
|
let db!: ReturnType<typeof createDb>;
|
|
let tempDb: Awaited<ReturnType<typeof startEmbeddedPostgresTestDatabase>> | null = null;
|
|
|
|
beforeAll(async () => {
|
|
tempDb = await startEmbeddedPostgresTestDatabase("paperclip-comment-redaction-");
|
|
db = createDb(tempDb.connectionString);
|
|
await db.execute(sql.raw("CREATE EXTENSION IF NOT EXISTS pg_trgm"));
|
|
}, 20_000);
|
|
|
|
afterEach(async () => {
|
|
await db.delete(issueReferenceMentions);
|
|
await db.delete(issueComments);
|
|
await db.delete(issues);
|
|
await db.delete(companies);
|
|
});
|
|
|
|
afterAll(async () => {
|
|
await tempDb?.cleanup();
|
|
});
|
|
|
|
async function seedIssue() {
|
|
const companyId = randomUUID();
|
|
const issueId = randomUUID();
|
|
await db.insert(companies).values({
|
|
id: companyId,
|
|
name: "Comment Redaction Co",
|
|
issuePrefix: `R${companyId.replace(/-/g, "").slice(0, 6).toUpperCase()}`,
|
|
requireBoardApprovalForNewAgents: false,
|
|
});
|
|
await db.insert(issues).values({
|
|
id: issueId,
|
|
companyId,
|
|
identifier: "RED-1",
|
|
title: "Deleted comment redaction",
|
|
status: "todo",
|
|
priority: "medium",
|
|
});
|
|
return { companyId, issueId };
|
|
}
|
|
|
|
function createApp(companyId: string) {
|
|
const app = express();
|
|
app.use(express.json());
|
|
app.use((req, _res, next) => {
|
|
(req as any).actor = {
|
|
type: "board",
|
|
userId: "board-user-1",
|
|
companyIds: [companyId],
|
|
memberships: [{ companyId, membershipRole: "owner", status: "active" }],
|
|
source: "cloud_tenant",
|
|
isInstanceAdmin: true,
|
|
};
|
|
next();
|
|
});
|
|
const storage: StorageService = {
|
|
provider: "local_disk",
|
|
putFile: vi.fn(async () => {
|
|
throw new Error("Unexpected storage.putFile call");
|
|
}),
|
|
getObject: vi.fn(async () => {
|
|
throw new Error("Unexpected storage.getObject call");
|
|
}),
|
|
headObject: vi.fn(async () => ({ exists: false })),
|
|
deleteObject: vi.fn(async () => undefined),
|
|
};
|
|
app.use("/api", issueRoutes(db, storage));
|
|
app.use(errorHandler);
|
|
return app;
|
|
}
|
|
|
|
it("redacts deleted comment bodies from ordinary reads, heartbeat context, and wake payloads", async () => {
|
|
const { companyId, issueId } = await seedIssue();
|
|
const commentId = randomUUID();
|
|
const deletedAt = new Date("2026-06-03T12:00:00.000Z");
|
|
await db.insert(issueComments).values({
|
|
id: commentId,
|
|
companyId,
|
|
issueId,
|
|
authorUserId: "board-user-1",
|
|
body: "secret deleted body",
|
|
presentation: { kind: "system_notice", tone: "warning" },
|
|
metadata: { version: 1, sections: [{ rows: [{ type: "text", text: "secret metadata" }] }] },
|
|
deletedAt,
|
|
deletedByType: "user",
|
|
deletedByUserId: "board-user-1",
|
|
});
|
|
|
|
const comments = await issueService(db).listComments(issueId, { order: "asc" });
|
|
expect(comments).toHaveLength(1);
|
|
expect(comments[0]).toMatchObject({
|
|
id: commentId,
|
|
body: "",
|
|
presentation: null,
|
|
metadata: null,
|
|
deletedAt,
|
|
deletedByType: "user",
|
|
deletedByUserId: "board-user-1",
|
|
});
|
|
|
|
const exactComment = await issueService(db).getComment(commentId);
|
|
expect(exactComment?.body).toBe("");
|
|
expect(exactComment?.metadata).toBeNull();
|
|
|
|
const heartbeatContext = await request(createApp(companyId))
|
|
.get(`/api/issues/${issueId}/heartbeat-context`)
|
|
.query({ wakeCommentId: commentId });
|
|
expect(heartbeatContext.status, JSON.stringify(heartbeatContext.body)).toBe(200);
|
|
expect(heartbeatContext.body.wakeComment).toMatchObject({
|
|
id: commentId,
|
|
body: "",
|
|
metadata: null,
|
|
deletedByUserId: "board-user-1",
|
|
});
|
|
expect(JSON.stringify(heartbeatContext.body)).not.toContain("secret deleted body");
|
|
expect(JSON.stringify(heartbeatContext.body)).not.toContain("secret metadata");
|
|
|
|
const wakePayload = await buildPaperclipWakePayload({
|
|
db,
|
|
companyId,
|
|
contextSnapshot: {
|
|
issueId,
|
|
commentId,
|
|
wakeCommentIds: [commentId],
|
|
wakeReason: "issue_commented",
|
|
},
|
|
});
|
|
|
|
expect(wakePayload?.comments).toEqual([
|
|
expect.objectContaining({
|
|
id: commentId,
|
|
body: "",
|
|
bodyTruncated: false,
|
|
presentation: null,
|
|
metadata: null,
|
|
deletedAt: deletedAt.toISOString(),
|
|
deletedByUserId: "board-user-1",
|
|
}),
|
|
]);
|
|
expect(JSON.stringify(wakePayload)).not.toContain("secret deleted body");
|
|
expect(JSON.stringify(wakePayload)).not.toContain("secret metadata");
|
|
});
|
|
|
|
it("excludes deleted comment bodies from company search", async () => {
|
|
const { companyId, issueId } = await seedIssue();
|
|
await db.insert(issueComments).values({
|
|
companyId,
|
|
issueId,
|
|
body: "vanished-search-needle",
|
|
deletedAt: new Date("2026-06-03T12:00:00.000Z"),
|
|
deletedByType: "user",
|
|
deletedByUserId: "board-user-1",
|
|
});
|
|
|
|
const result = await companySearchService(db).search(
|
|
companyId,
|
|
companySearchQuerySchema.parse({ q: "vanished-search-needle", scope: "comments" }),
|
|
);
|
|
|
|
expect(result.results).toEqual([]);
|
|
});
|
|
|
|
it("clears issue references sourced from deleted comment bodies", async () => {
|
|
const companyId = randomUUID();
|
|
const sourceIssueId = randomUUID();
|
|
const targetIssueId = randomUUID();
|
|
const commentId = randomUUID();
|
|
await db.insert(companies).values({
|
|
id: companyId,
|
|
name: "Reference Redaction Co",
|
|
issuePrefix: "REF",
|
|
requireBoardApprovalForNewAgents: false,
|
|
});
|
|
await db.insert(issues).values([
|
|
{
|
|
id: sourceIssueId,
|
|
companyId,
|
|
identifier: "REF-1",
|
|
title: "Source issue",
|
|
status: "todo",
|
|
priority: "medium",
|
|
},
|
|
{
|
|
id: targetIssueId,
|
|
companyId,
|
|
identifier: "REF-2",
|
|
title: "Target issue",
|
|
status: "todo",
|
|
priority: "medium",
|
|
},
|
|
]);
|
|
await db.insert(issueComments).values({
|
|
id: commentId,
|
|
companyId,
|
|
issueId: sourceIssueId,
|
|
body: "Follow up in REF-2",
|
|
});
|
|
|
|
const refs = issueReferenceService(db);
|
|
await refs.syncComment(commentId);
|
|
expect((await refs.listIssueReferenceSummary(sourceIssueId)).outbound.map((item) => item.issue.id)).toEqual([
|
|
targetIssueId,
|
|
]);
|
|
|
|
await db.update(issueComments).set({
|
|
deletedAt: new Date("2026-06-03T12:00:00.000Z"),
|
|
deletedByType: "user",
|
|
deletedByUserId: "board-user-1",
|
|
});
|
|
await refs.syncComment(commentId);
|
|
|
|
expect((await refs.listIssueReferenceSummary(sourceIssueId)).outbound).toEqual([]);
|
|
});
|
|
});
|