Flush shared feedback traces immediately

Co-Authored-By: Paperclip <noreply@paperclip.ing>
This commit is contained in:
dottaandPaperclip committed 2026-04-03 08:33:58 -05:00
1 parent cba1ec6374
commit 6940e3834b
6 files changed
+247 -16

No files matched your search

+5 -4
View File
@@ -19,7 +19,7 @@ Each vote creates two local records:
All data lives in your local Paperclip database. Nothing leaves your machine unless you explicitly choose to share.
When a vote is marked for sharing, Paperclip also queues the trace bundle for background export through the Telemetry Backend. The app server never uploads raw feedback trace bundles directly to object storage.
When a vote is marked for sharing, Paperclip immediately tries to upload the trace bundle through the Telemetry Backend. If that immediate push fails, the trace is left in a retriable failed state for later flush attempts. The app server never uploads raw feedback trace bundles directly to object storage.
## Viewing your votes
@@ -168,19 +168,20 @@ Your preference is saved per-company. You can change it any time via the feedbac
| Status | Meaning |
|--------|---------|
| `local_only` | Vote stored locally, not marked for sharing |
| `pending` | Marked for sharing, waiting to be sent |
| `pending` | Marked for sharing, saved locally, and waiting for the immediate upload attempt |
| `sent` | Successfully transmitted |
| `failed` | Transmission attempted but failed (will retry) |
| `failed` | Transmission attempted but failed (for example the backend is unreachable or not configured); later flushes retry once a backend is available |
Your local database always retains the full vote and trace data regardless of sharing status.
## Remote sync
Votes you choose to share are queued as `pending` traces and flushed by the server's background worker to the Telemetry Backend. The Telemetry Backend validates the request, then persists the bundle into its configured object storage.
Votes you choose to share are sent to the Telemetry Backend immediately from the vote request. The server also keeps a background flush worker so failed traces can retry later. The Telemetry Backend validates the request, then persists the bundle into its configured object storage.
- App server responsibility: build the bundle, POST it to Telemetry Backend, update trace status
- Telemetry Backend responsibility: authenticate the request, validate payload shape, compress/store the bundle, return the final object key
- Retry behavior: failed uploads move to `failed` with an error message in `failureReason`, and the worker retries them on later ticks
- Configuration requirement: remote export only works when `PAPERCLIP_FEEDBACK_EXPORT_BACKEND_URL` or `PAPERCLIP_TELEMETRY_BACKEND_URL` is configured on the app server
Exported objects use a deterministic key pattern so they are easy to inspect:
@@ -1065,6 +1065,73 @@ describe("feedbackService.saveIssueVote", () => {
});
});
it("can flush a single shared trace immediately by trace id", async () => {
const { companyId, issueId, commentId: firstCommentId } = await seedIssueWithAgentComment();
const secondCommentId = randomUUID();
const agentId = await db
.select({ authorAgentId: issueComments.authorAgentId })
.from(issueComments)
.where(eq(issueComments.id, firstCommentId))
.then((rows) => rows[0]?.authorAgentId ?? null);
await db.insert(issueComments).values({
id: secondCommentId,
companyId,
issueId,
authorAgentId: agentId,
body: "Second AI generated update",
});
const uploadTraceBundle = vi.fn().mockResolvedValue({
objectKey: `feedback-traces/${companyId}/2026/04/01/test-trace.json`,
});
const flushingSvc = feedbackService(db, {
shareClient: {
uploadTraceBundle,
},
});
const first = await flushingSvc.saveIssueVote({
issueId,
targetType: "issue_comment",
targetId: firstCommentId,
vote: "up",
authorUserId: "user-1",
allowSharing: true,
});
await flushingSvc.saveIssueVote({
issueId,
targetType: "issue_comment",
targetId: secondCommentId,
vote: "up",
authorUserId: "user-1",
allowSharing: true,
});
const flushResult = await flushingSvc.flushPendingFeedbackTraces({
companyId,
traceId: first.traceId ?? undefined,
limit: 1,
});
expect(flushResult).toMatchObject({
attempted: 1,
sent: 1,
failed: 0,
});
expect(uploadTraceBundle).toHaveBeenCalledTimes(1);
const traces = await flushingSvc.listFeedbackTraces({
companyId,
issueId,
includePayload: true,
});
const firstTrace = traces.find((trace) => trace.targetId === firstCommentId);
const secondTrace = traces.find((trace) => trace.targetId === secondCommentId);
expect(firstTrace?.status).toBe("sent");
expect(secondTrace?.status).toBe("pending");
});
it("marks pending shared traces as failed when remote export upload fails", async () => {
const { companyId, issueId, commentId } = await seedIssueWithAgentComment();
const uploadTraceBundle = vi.fn().mockRejectedValue(new Error("telemetry unavailable"));
@@ -1102,4 +1169,39 @@ describe("feedbackService.saveIssueVote", () => {
expect(traces[0]?.exportedAt).toBeNull();
expect(uploadTraceBundle).toHaveBeenCalledTimes(1);
});
it("marks pending shared traces as failed when no feedback export backend is configured", async () => {
const { companyId, issueId, commentId } = await seedIssueWithAgentComment();
const result = await svc.saveIssueVote({
issueId,
targetType: "issue_comment",
targetId: commentId,
vote: "up",
authorUserId: "user-1",
allowSharing: true,
});
const flushResult = await svc.flushPendingFeedbackTraces({
companyId,
traceId: result.traceId ?? undefined,
limit: 1,
});
expect(flushResult).toMatchObject({
attempted: 1,
sent: 0,
failed: 1,
});
const traces = await svc.listFeedbackTraces({
companyId,
issueId,
includePayload: true,
});
expect(traces[0]?.status).toBe("failed");
expect(traces[0]?.attemptCount).toBe(1);
expect(traces[0]?.failureReason).toBe("Feedback export backend is not configured");
expect(traces[0]?.exportedAt).toBeNull();
});
});
@@ -5,6 +5,7 @@ import { errorHandler } from "../middleware/index.js";
import { issueRoutes } from "../routes/issues.js";
const mockFeedbackService = vi.hoisted(() => ({
flushPendingFeedbackTraces: vi.fn(),
getFeedbackTraceById: vi.fn(),
getFeedbackTraceBundle: vi.fn(),
listIssueVotesForUser: vi.fn(),
@@ -12,6 +13,13 @@ const mockFeedbackService = vi.hoisted(() => ({
saveIssueVote: vi.fn(),
}));
const mockIssueService = vi.hoisted(() => ({
getById: vi.fn(),
update: vi.fn(),
addComment: vi.fn(),
findMentionedAgents: vi.fn(),
}));
vi.mock("../services/index.js", () => ({
accessService: () => ({
canUser: vi.fn(),
@@ -42,12 +50,7 @@ vi.mock("../services/index.js", () => ({
listCompanyIds: vi.fn(async () => ["company-1"]),
}),
issueApprovalService: () => ({}),
issueService: () => ({
getById: vi.fn(),
update: vi.fn(),
addComment: vi.fn(),
findMentionedAgents: vi.fn(),
}),
issueService: () => mockIssueService,
logActivity: vi.fn(async () => undefined),
projectService: () => ({}),
routineService: () => ({
@@ -63,7 +66,7 @@ function createApp(actor: Record<string, unknown>) {
(req as any).actor = actor;
next();
});
app.use("/api", issueRoutes({} as any, {} as any));
app.use("/api", issueRoutes({} as any, {} as any, { feedbackExportService: mockFeedbackService }));
app.use(errorHandler);
return app;
}
@@ -73,6 +76,62 @@ describe("issue feedback trace routes", () => {
vi.clearAllMocks();
});
it("flushes a newly shared trace immediately after saving a vote", async () => {
mockIssueService.getById.mockResolvedValue({
id: "11111111-1111-4111-8111-111111111111",
companyId: "company-1",
status: "todo",
identifier: "PAP-1",
title: "Feedback test",
});
mockFeedbackService.saveIssueVote.mockResolvedValue({
vote: {
id: "vote-1",
companyId: "company-1",
issueId: "11111111-1111-4111-8111-111111111111",
targetType: "issue_comment",
targetId: "22222222-2222-4222-8222-222222222222",
authorUserId: "user-1",
vote: "up",
reason: null,
sharedWithLabs: true,
sharedAt: new Date(),
consentVersion: "feedback-data-sharing-v1",
redactionSummary: null,
createdAt: new Date(),
updatedAt: new Date(),
},
traceId: "trace-1",
consentEnabledNow: false,
persistedSharingPreference: null,
sharingEnabled: true,
});
const app = createApp({
type: "board",
userId: "user-1",
source: "session",
isInstanceAdmin: false,
companyIds: ["company-1"],
});
const res = await request(app)
.post("/api/issues/11111111-1111-4111-8111-111111111111/feedback-votes")
.send({
targetType: "issue_comment",
targetId: "22222222-2222-4222-8222-222222222222",
vote: "up",
allowSharing: true,
});
expect(res.status).toBe(201);
expect(mockFeedbackService.flushPendingFeedbackTraces).toHaveBeenCalledWith({
companyId: "company-1",
traceId: "trace-1",
limit: 1,
});
});
it("rejects non-board callers before fetching a feedback trace", async () => {
const app = createApp({
type: "agent",
+3 -1
View File
@@ -152,7 +152,9 @@ export async function createApp(
api.use(agentRoutes(db));
api.use(assetRoutes(db, opts.storageService));
api.use(projectRoutes(db));
api.use(issueRoutes(db, opts.storageService));
api.use(issueRoutes(db, opts.storageService, {
feedbackExportService: opts.feedbackExportService,
}));
api.use(routineRoutes(db));
api.use(executionWorkspaceRoutes(db));
api.use(goalRoutes(db));
+27 -1
View File
@@ -52,7 +52,20 @@ const updateIssueRouteSchema = updateIssueSchema.extend({
interrupt: z.boolean().optional(),
});
export function issueRoutes(db: Db, storage: StorageService) {
export function issueRoutes(
db: Db,
storage: StorageService,
opts?: {
feedbackExportService?: {
flushPendingFeedbackTraces(input?: {
companyId?: string;
traceId?: string;
limit?: number;
now?: Date;
}): Promise<unknown>;
};
},
) {
const router = Router();
const svc = issueService(db);
const access = accessService(db);
@@ -67,6 +80,7 @@ export function issueRoutes(db: Db, storage: StorageService) {
const workProductsSvc = workProductService(db);
const documentsSvc = documentService(db);
const routinesSvc = routineService(db);
const feedbackExportService = opts?.feedbackExportService;
const upload = multer({
storage: multer.memoryStorage(),
limits: { fileSize: MAX_ATTACHMENT_BYTES, files: 1 },
@@ -1867,6 +1881,18 @@ export function issueRoutes(db: Db, storage: StorageService) {
);
}
if (result.sharingEnabled && result.traceId && feedbackExportService) {
try {
await feedbackExportService.flushPendingFeedbackTraces({
companyId: issue.companyId,
traceId: result.traceId,
limit: 1,
});
} catch (err) {
logger.warn({ err, issueId: issue.id, traceId: result.traceId }, "failed to flush shared feedback trace immediately");
}
}
res.status(201).json(result.vote);
});
+44 -3
View File
@@ -63,6 +63,7 @@ const MAX_SKILLS = 20;
const MAX_INSTRUCTION_FILES = 20;
const MAX_TRACE_FILE_CHARS = 10_000_000;
const DEFAULT_INSTANCE_SETTINGS_SINGLETON_KEY = "default";
const FEEDBACK_EXPORT_BACKEND_NOT_CONFIGURED = "Feedback export backend is not configured";
type FeedbackTraceRow = typeof feedbackExports.$inferSelect & {
issueIdentifier: string | null;
@@ -1742,15 +1743,48 @@ export function feedbackService(db: Db, options: FeedbackServiceOptions = {}) {
flushPendingFeedbackTraces: async (input?: {
companyId?: string;
traceId?: string;
limit?: number;
now?: Date;
}) => {
const shareClient = options.shareClient;
if (!shareClient) {
const filters = [eq(feedbackExports.status, "pending")];
if (input?.companyId) {
filters.push(eq(feedbackExports.companyId, input.companyId));
}
if (input?.traceId) {
filters.push(eq(feedbackExports.id, input.traceId));
}
const rows = await db
.select({
id: feedbackExports.id,
attemptCount: feedbackExports.attemptCount,
})
.from(feedbackExports)
.where(and(...filters))
.orderBy(asc(feedbackExports.createdAt), asc(feedbackExports.id))
.limit(Math.max(1, Math.min(input?.limit ?? 25, 200)));
const attemptAt = input?.now ?? new Date();
for (const row of rows) {
await db
.update(feedbackExports)
.set({
status: "failed",
attemptCount: row.attemptCount + 1,
lastAttemptedAt: attemptAt,
failureReason: FEEDBACK_EXPORT_BACKEND_NOT_CONFIGURED,
updatedAt: attemptAt,
})
.where(eq(feedbackExports.id, row.id));
}
return {
attempted: 0,
attempted: rows.length,
sent: 0,
failed: 0,
failed: rows.length,
};
}
@@ -1761,6 +1795,9 @@ export function feedbackService(db: Db, options: FeedbackServiceOptions = {}) {
if (input?.companyId) {
filters.push(eq(feedbackExports.companyId, input.companyId));
}
if (input?.traceId) {
filters.push(eq(feedbackExports.id, input.traceId));
}
const rows = await db
.select({
@@ -1983,7 +2020,7 @@ export function feedbackService(db: Db, options: FeedbackServiceOptions = {}) {
})
.where(eq(feedbackVotes.id, savedVote.id));
await tx
const [savedTrace] = await tx
.insert(feedbackExports)
.values({
companyId: issue.companyId,
@@ -2030,6 +2067,9 @@ export function feedbackService(db: Db, options: FeedbackServiceOptions = {}) {
failureReason: null,
updatedAt: now,
},
})
.returning({
id: feedbackExports.id,
});
return {
@@ -2037,6 +2077,7 @@ export function feedbackService(db: Db, options: FeedbackServiceOptions = {}) {
...savedVote,
redactionSummary: artifacts.redactionSummary,
},
traceId: savedTrace?.id ?? null,
consentEnabledNow,
persistedSharingPreference,
sharingEnabled: sharedWithLabs,