paperclip/ui/src/lib/document-revisions.ts

73 lines
2.4 KiB
TypeScript
Raw Normal View History

fix(ui): keep latest issue document revision current (#3342) ## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies. > - Board users and agents collaborate on issue-scoped documents such as plans and revisions need to be trustworthy because they are the audit trail for those artifacts. > - The issue document UI now supports revision history and restore, so the UI has to distinguish the current revision from historical revisions correctly even while multiple queries are refreshing. > - In `PAPA-72`, the newest content could appear under an older revision label because the current document snapshot and the revision-history query could temporarily disagree after an edit. > - That made the UI treat the newest revision like a historical restore target, which is the opposite of the intended behavior. > - This pull request derives one authoritative revision view from both sources, sorts revisions newest-first, and keeps the freshest revision marked current. > - The benefit is that revision history stays stable and trustworthy immediately after edits instead of briefly presenting the newest content as an older revision. ## What Changed - Added a `document-revisions` helper that merges the current document snapshot with fetched revision history into one normalized revision state. - Updated `IssueDocumentsSection` to render from that normalized state instead of trusting either query in isolation. - Added focused tests covering the current-revision selection and ordering behavior. ## Verification - `pnpm -r typecheck` - `pnpm build` - Targeted revision tests passed locally. - Manual reviewer check: - Open an issue document with revision history. - Edit and save the document. - Immediately open the revision selector. - Confirm the newest revision remains marked current and older revisions remain the restore targets. ## Risks - Low risk. The change is isolated to issue document revision presentation in the UI. - Main risk is merging the current snapshot with fetched history incorrectly for edge cases, which is why the helper has focused unit coverage. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [ ] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [ ] 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
2026-04-10 17:14:06 -07:00
import type { DocumentRevision, IssueDocument } from "@paperclipai/shared";
type DocumentRevisionState = {
currentRevision: DocumentRevision;
revisions: DocumentRevision[];
};
function toTimestamp(value: Date | string | null | undefined) {
if (!value) return 0;
const timestamp = new Date(value).getTime();
return Number.isNaN(timestamp) ? 0 : timestamp;
}
function sortRevisionsDescending(revisions: DocumentRevision[]) {
return [...revisions].sort((a, b) => {
if (a.revisionNumber !== b.revisionNumber) {
return b.revisionNumber - a.revisionNumber;
}
const createdAtDelta = toTimestamp(b.createdAt) - toTimestamp(a.createdAt);
if (createdAtDelta !== 0) return createdAtDelta;
return b.id.localeCompare(a.id);
});
}
function createCurrentRevisionSnapshot(document: IssueDocument): DocumentRevision {
return {
id: document.latestRevisionId ?? `${document.id}-latest`,
companyId: document.companyId,
documentId: document.id,
issueId: document.issueId,
key: document.key,
revisionNumber: document.latestRevisionNumber,
title: document.title,
format: document.format,
body: document.body,
changeSummary: null,
createdByAgentId: document.updatedByAgentId ?? document.createdByAgentId,
createdByUserId: document.updatedByUserId ?? document.createdByUserId,
createdAt: document.updatedAt,
};
}
export function deriveDocumentRevisionState(
document: IssueDocument,
revisions: DocumentRevision[],
): DocumentRevisionState {
const sortedRevisions = sortRevisionsDescending(revisions);
const currentSnapshot = createCurrentRevisionSnapshot(document);
const highestFetchedRevision = sortedRevisions[0] ?? null;
const documentAppearsStale = Boolean(
highestFetchedRevision && highestFetchedRevision.revisionNumber > document.latestRevisionNumber,
);
const currentRevision = documentAppearsStale
? highestFetchedRevision!
: sortedRevisions.find((revision) => revision.id === document.latestRevisionId) ?? currentSnapshot;
const revisionsWithCurrent = sortRevisionsDescending([currentRevision, ...sortedRevisions]);
const dedupedRevisions: DocumentRevision[] = [];
const seenRevisionIds = new Set<string>();
for (const revision of revisionsWithCurrent) {
if (seenRevisionIds.has(revision.id)) continue;
seenRevisionIds.add(revision.id);
dedupedRevisions.push(revision);
}
return {
currentRevision,
revisions: dedupedRevisions,
};
}