mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-24 18:19:05 +02:00
feat: add authoritative issue PATCH receipts (#10478)
<!-- Write all pull request text in Simplified Technical English (ASD-STE100): short sentences, one instruction per sentence, simple approved vocabulary, and the active voice. --> ## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Agents update tasks through the issue API. > - The update response did not state which values changed. > - Blocker updates also did not echo the scalar blocker IDs. > - Agents therefore used an extra GET request to confirm a successful write. > - This pull request adds an authoritative change receipt and an optional small response. > - The benefit is fewer API calls with a clear and compatible write contract. ## Linked Issues or Issue Description No public GitHub issue exists for this change. ### Subsystem affected Cross-cutting: `server/`, `packages/shared`, and the UI issue cache. ### Problem or motivation A successful issue PATCH returned the updated issue, but it did not identify the effective changes. Blocker writes returned relation summaries without the scalar IDs. Agents could not distinguish a confirmed clear operation from missing data. The response must confirm committed field and blocker changes while existing UI clients continue to receive the full issue by default. ### Proposed solution Add a `changes` receipt. Add a conditional `blockedByIssueIds` echo. Support `Prefer: return=minimal`. Keep the full response as the default. ### Alternatives considered Make the small response the default for agent tokens. This would create different response contracts by actor type, so this pull request does not use that design. ### Roadmap alignment This is a focused control-plane reliability improvement. It does not duplicate an open roadmap milestone. ## What Changed - Compute committed issue row and relation changes in the issue service. - Omit no-op fields and truncate changed long text values to 200 characters. - Echo blocker ID arrays for blocker set and clear requests. - Add the opt-in `Prefer: return=minimal` response and `Preference-Applied` header. - Keep receipt metadata out of React Query issue caches. - Add route and embedded Postgres tests for the new contract. ## Verification - `pnpm exec vitest run server/src/__tests__/issue-activity-events-routes.test.ts` - `pnpm exec vitest run server/src/__tests__/issues-service.test.ts -t "returns authoritative update receipts for row fields and blocker relations"` - `pnpm --filter @paperclipai/shared typecheck` - `pnpm --filter @paperclipai/server typecheck` - `pnpm --filter @paperclipai/ui typecheck` - `pnpm check:token-gates` - `git diff --check` ## Risks - Low compatibility risk. The default response only adds receipt fields. - Minimal mode is opt-in. Existing clients do not receive a smaller body. - The receipt excludes `updatedAt` because the response already returns it as the freshness anchor. - Prose API and agent workflow guidance will follow after the server contract is available. > 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 based on GPT-5. The exact deployment ID, context window size, and reasoning mode are not exposed to the agent. The agent used repository tools, code execution, and test execution. ## 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 not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [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 --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
This commit is contained in:
1 parent
b1ac92f305
commit
627728bdde
14 files changed
+486
-5
No files matched your search
@@ -0,0 +1,50 @@
|
||||
import { isDeepStrictEqual } from "node:util";
|
||||
import type { IssueChanges } from "@paperclipai/shared";
|
||||
|
||||
const ISSUE_CHANGE_TEXT_BUDGET = 200;
|
||||
|
||||
function truncateIssueChangeText(value: unknown) {
|
||||
if (typeof value !== "string") return value;
|
||||
return Array.from(value).slice(0, ISSUE_CHANGE_TEXT_BUDGET).join("");
|
||||
}
|
||||
|
||||
function canonicalIdArray(value: unknown): unknown {
|
||||
if (!Array.isArray(value) || !value.every((entry) => typeof entry === "string")) return value;
|
||||
return [...new Set(value)].sort();
|
||||
}
|
||||
|
||||
export function buildIssueChanges(
|
||||
existing: Record<string, unknown>,
|
||||
updated: Record<string, unknown>,
|
||||
relationChanges: {
|
||||
blockedByIssueIds?: { from: string[]; to: string[] };
|
||||
labelIds?: { from: string[]; to: string[] };
|
||||
} = {},
|
||||
): IssueChanges {
|
||||
const changes: IssueChanges = {};
|
||||
const keys = new Set([...Object.keys(existing), ...Object.keys(updated)]);
|
||||
keys.delete("updatedAt");
|
||||
|
||||
for (const key of keys) {
|
||||
const from = existing[key];
|
||||
const to = updated[key];
|
||||
if (isDeepStrictEqual(from, to)) continue;
|
||||
|
||||
const longText =
|
||||
key === "description" ||
|
||||
(key === "title" &&
|
||||
((typeof from === "string" && Array.from(from).length > ISSUE_CHANGE_TEXT_BUDGET) ||
|
||||
(typeof to === "string" && Array.from(to).length > ISSUE_CHANGE_TEXT_BUDGET)));
|
||||
changes[key] = longText
|
||||
? { from: truncateIssueChangeText(from), to: truncateIssueChangeText(to), updated: true }
|
||||
: { from, to };
|
||||
}
|
||||
|
||||
for (const [key, change] of Object.entries(relationChanges)) {
|
||||
const from = canonicalIdArray(change.from);
|
||||
const to = canonicalIdArray(change.to);
|
||||
if (!isDeepStrictEqual(from, to)) changes[key] = { from, to };
|
||||
}
|
||||
|
||||
return changes;
|
||||
}
|
||||
@@ -116,6 +116,7 @@ import { visibleIssueCondition } from "./issue-visibility.js";
|
||||
import { finalizeStatusCardsForStalledGeneration } from "./status-card-finalization.js";
|
||||
import { finalizeSummarySlotsForTerminalIssue } from "./summary-slot-finalization.js";
|
||||
import { logActivity } from "./activity-log.js";
|
||||
import { buildIssueChanges } from "./issue-change-receipt.js";
|
||||
|
||||
const ALL_ISSUE_STATUSES = ["backlog", "todo", "in_progress", "in_review", "blocked", "done", "cancelled"];
|
||||
const MAX_ISSUE_COMMENT_PAGE_LIMIT = 500;
|
||||
@@ -7063,6 +7064,24 @@ export function issueService(db: Db) {
|
||||
}
|
||||
|
||||
const runUpdate = async (tx: any) => {
|
||||
// The receipt baseline must be read under the same row lock as the
|
||||
// write. Otherwise a concurrent update can be mistaken for a change
|
||||
// made by this request.
|
||||
const receiptExisting = await tx
|
||||
.select()
|
||||
.from(issues)
|
||||
.where(eq(issues.id, id))
|
||||
.for("update")
|
||||
.then((rows: Array<typeof issues.$inferSelect>) => rows[0] ?? null);
|
||||
if (!receiptExisting) return null;
|
||||
const [previousLabelsByIssueId, previousRelationSummaries] = await Promise.all([
|
||||
nextLabelIds !== undefined
|
||||
? labelMapForIssues(tx, [id])
|
||||
: Promise.resolve(new Map<string, IssueLabelRow[]>()),
|
||||
blockedByIssueIds !== undefined
|
||||
? getIssueRelationSummaryMap(existing.companyId, [id], tx)
|
||||
: Promise.resolve(new Map<string, IssueRelationSummaryMap>()),
|
||||
]);
|
||||
const defaultCompanyGoal = await getDefaultCompanyGoal(tx, existing.companyId);
|
||||
const [currentProjectGoalId, nextProjectGoalId] = await Promise.all([
|
||||
getProjectDefaultGoalId(tx, existing.companyId, existing.projectId),
|
||||
@@ -7180,6 +7199,31 @@ export function issueService(db: Db) {
|
||||
}
|
||||
}
|
||||
const [enriched] = await withIssueLabels(tx, [updated]);
|
||||
const nextBlockedByIssueIds = blockedByIssueIds === undefined
|
||||
? undefined
|
||||
: [...new Set(blockedByIssueIds)].sort();
|
||||
const changes = buildIssueChanges(
|
||||
receiptExisting as unknown as Record<string, unknown>,
|
||||
updated as unknown as Record<string, unknown>,
|
||||
{
|
||||
...(nextLabelIds !== undefined
|
||||
? {
|
||||
labelIds: {
|
||||
from: (previousLabelsByIssueId.get(id) ?? []).map((label) => label.id),
|
||||
to: enriched.labelIds,
|
||||
},
|
||||
}
|
||||
: {}),
|
||||
...(nextBlockedByIssueIds !== undefined
|
||||
? {
|
||||
blockedByIssueIds: {
|
||||
from: (previousRelationSummaries.get(id)?.blockedBy ?? []).map((relation) => relation.id),
|
||||
to: nextBlockedByIssueIds,
|
||||
},
|
||||
}
|
||||
: {}),
|
||||
},
|
||||
);
|
||||
if (
|
||||
(issueData.status === "done" || issueData.status === "cancelled") &&
|
||||
existing.status !== issueData.status &&
|
||||
@@ -7199,7 +7243,11 @@ export function issueService(db: Db) {
|
||||
);
|
||||
}
|
||||
}
|
||||
return enriched;
|
||||
return {
|
||||
...enriched,
|
||||
...(nextBlockedByIssueIds !== undefined ? { blockedByIssueIds: nextBlockedByIssueIds } : {}),
|
||||
changes,
|
||||
};
|
||||
};
|
||||
|
||||
return dbOrTx === db ? db.transaction(runUpdate) : runUpdate(dbOrTx);
|
||||
|
||||
Reference in new issue
Block a user